Esri arcgis-notebook-server-singlemachine.template.json Amazon Web Services (AWS) CloudFormation テンプレートは、単一の Ubuntu Amazon Elastic Compute Cloud (EC2) インスタンス上に ArcGIS Notebook Server サイトを作成します。
ArcGIS Notebook Server サイトは、Ubuntu インスタンスでのみサポートされています。
このテンプレートは、Amazon Web Services で次のアーキテクチャを作成します。
ライセンス:
図内の特定のアイコンは、Amazon Web Services の許可を得て使用されています。
前提条件
CloudFormation テンプレートを実行する前に取得する必要があるアイテム (ファイル、アカウントなど) や、実行する必要があるタスクごとに、前提条件がグループ化されています。
必須アイテム
このテンプレートを使用する前に、次のアイテムが必要です。
- Amazon Web Services アカウント。
アカウントを使用して、CloudFormation、Amazon Elastic Compute Cloud (EC2)、Amazon Virtual Private Cloud (VPC)、Amazon Simple Storage Service (S3)、Systems Manager、Amazon CloudWatch、Lambda、AWS Identity and Access Management (IAM)、Amazon DynamoDB、Secrets Manager、AWS Certificate Manager、Amazon Relational Database Service (RDS) などの基本的な AWS サービスにアクセスできる必要があります。
- SSL 認証ファイル (*.pfx 形式) およびそれに対応するパスワード
証明書は証明局から取得する必要があります。
- Amazon Virtual Private Cloud (VPC) とサブネット。
同じ ArcGIS Enterprise 配置のすべてのコンポーネントは、同じ VPC で実行される必要があります。 ポータルが存在する場合は、ポータルに使用したのと同じ VPC およびサブネットを使用します。 まだポータルを作成しておらず、既存の VPC が存在しない場合は、2 つのパブリック サブネットを含む VPC、または NAT ゲートウェイを備えた 2 つのパブリック サブネットおよびプライベート サブネットを含む VPC のいずれかの CloudFormation テンプレートを使用して VPC を作成できます。
- ArcGIS Notebook Server ライセンス ファイル (*.ecp または *.prvc)。
- AWS GovCloud の Ubuntu EC2 インスタンスに配置を作成する場合は、AMI ID が必要です。 Canonical によるベース Ubuntu AMI を使用する場合は、Esri Amazon Web Services CloudFormation テンプレートの手順に従って ID を特定します。
- CloudFormation テンプレート。
arcgis-notebook-server-singlemachine.template.json テンプレートのローカル コピーを開き、保存します。
必須タスク
このテンプレートを実行する前に、次のタスクを実行する必要があります。
- AWS アカウントに配置の Amazon Simple Storage Service (S3) バケットを準備します。 スタックを起動するときに、テンプレートのバケット名を指定します。
- バケットを作成するか、既存の S3 バケットを使用します。 ユーザーはバケットの所有者でなくてはなりません。
- バケットに ArcGIS Notebook Server 認証ファイルをアップロードします。
- SSL 証明書ファイルを配置バケットにアップロードします。
- DNS (ドメイン名システム) を構成します。
ArcGIS Notebook Server サイトの完全修飾ドメイン名が必要です。 このスタックを起動する前にドメイン名が存在しており、解決可能である必要があります。 完全修飾ドメイン名の取得と、DNS の構成の方法がわからない場合は、IT 部門にお問い合わせください。
- この配置で Elastic IP アドレスを使用する場合 (オプション)、このテンプレートを実行する前に Elastic IP を作成する必要があります。
Elastic IP アドレスを作成するには、AWS Management Console を使用できます。
- AWS Secrets Manager でのパスワードの構成 (オプション、推奨)
サイト管理者のユーザー名や Windows の arcgis ユーザーのパスワードなどのアカウントのパスワードは、AWS Secrets Manager で構成できます。 これにより、シークレットの Amazon Resource Name (ARN) が提供されます。 スタックを起動するときに、テンプレートのパラメーターにパスワードの代わりに ARN を使用します。 パスワードの格納に AWS Secrets Manager を使用しない場合は、スタックの起動時にテンプレートのパラメーターにパスワードをプレーン テキストで入力する必要があります。
注意:
Esri CloudFormation テンプレートで使用するパスワードのために AWS Secrets Manager でシークレットの ARN を作成する場合、シークレット タイプに [Other type of secrets (他の種類のシークレット)] を使用し、[Plaintext (プレーンテキスト)] オプションを使用する必要があります。 パスワード用の Amazon Resource Name を作成する方法については、「AWS CloudFormation および ArcGIS」をご参照ください。
ヒント:
デフォルトでは、スタックの作成に失敗すると、CloudFormation は部分的に作成されたリソースを削除します。 これにより、使用できない配置がアカウントから削除されるため便利ですが、トラブルシューティングが難しくなる可能性もあります。 スタックを失敗した状態で保持するには、スタックを起動する前に CloudFormation スタック作成オプションの [Rollback on failure (失敗時にロールバックする)] を無効にします。 詳細については、AWS ヘルプの「Setting AWS CloudFormation options (AWS CloudFormation オプションの設定)」をご参照ください。
パラメーター
この CloudFormation テンプレートで使用されるパラメーターの説明については、次の表をご参照ください。 表はパラメーターのタイプ別に分けられています。
Amazon EC2 Configuration
| パラメーター名 | 必須 | パラメーターの説明 |
|---|---|---|
EC2 Instance AMI ID | オプション | このパラメーター値は空のままにしておいてもかまいません。 その場合は、CloudFormation テンプレートは、Ubuntu 用の最新の Amazon Machine Image (AMI) ID を使用します。 注意:Ubuntu Server の AWS GovCloud に配置する場合は、このパラメーターは空のままにしておくことはできません。 Canonical から基本の Ubuntu AMI ID を検索する方法については、Esri Amazon Web Services CloudFormation テンプレートをご参照ください。 特定のリリースに対して、いずれかのデフォルト AMI を初めて使用するときは、AWS Marketplace の利用条件に同意する必要があります。 独自のカスタム AMI を使用するには、次のいずれかの方法で AMI ID を入力します。
カスタム AMI を使用する場合は、次の要件を満たしていることを確認します。
|
EC2 Instance Keypair Name | 必須 | EC2 インスタンスへのリモート アクセスを許可するため、EC2 キーペア名を選択します。 |
Elastic IP Address Allocation ID | オプション | 「eipalloc-XXXXXXXX」の形式で、Elastic IP アドレスのアロケーション ID を指定します。 Elastic IP アドレスにサイト ドメイン名をマッピングし、AWS 環境外で RDP/SSH 経由で EC2 インスタンスにアクセスする場合は、Elastic IP アドレスが必要になることがあります。 Elastic IP アドレスを EC2 インスタンスに割り当てない場合は、このパラメーターを空のままにしておきます。 |
Amazon VPC Configuration
| パラメーター名 | 必須 | パラメーターの説明 |
|---|---|---|
VPC ID | 必須 | VPC ID を選択します。 注意:同じ配置を構成するすべての ArcGIS Enterprise コンポーネントは、同じ VPC に配置する必要があります。 VPC を作成する必要がある場合は、VPC のサンプル テンプレートのいずれか (パブリック サブネットを持つ VPC またはパブリックおよびプライベート サブネット、および NAT Gateway を持つ VPC) を使用できます。 |
Subnet ID 1 | 必須 | サブネット ID を選択します。 選択したサブネット ID は、上記で選択した VPC 内に含まれている必要があります。 Esri CloudFormation テンプレートを使用して VPC を作成した場合は、そのテンプレートの出力パラメーターからサブネット ID を取得できます。 |
Domain Name System (DNS) Configuration
| パラメーター名 | 必須 | パラメーターの説明 |
|---|---|---|
ArcGIS Notebook Server Site Domain Name | 必須 | ArcGIS Notebook Server サイトの完全修飾ドメイン名を指定します。 ドメイン名が存在しており、解決可能である必要があります。 使用するドメイン名が不明な場合は、IT 管理者にお問い合わせください。 |
ArcGIS Notebook Server Configuration
| パラメーター名 | 必須 | パラメーターの説明 |
|---|---|---|
EC2 Instance Type | 必須 | EC2 インスタンス タイプを選択します。 デフォルトは m5.2xlarge です。 ArcGIS Notebook Server コンピューターに使用するインスタンス タイプ。 この EC2 インスタンスは、AWS Auto Recovery 機能で構成されます。 |
EC2 Instance Root Drive Disk Space | 必須 | ArcGIS Notebook Server EC2 インスタンスのルート ドライブのディスク容量のサイズです。 ルート ドライブのサイズを GB 単位で指定します。 デフォルトは 100 GB です。 最小は 100 GB です。 最大は 1024 GB です。 |
Deployment Bucket Name | 必須 | ソフトウェア ライセンス ファイルと SSL 証明書を含む Amazon S3 バケットの名前を指定します。 このバケットがすでに存在することと、配置用のライセンス ファイルおよび SSL 証明書が含まれていることが必要です。 ユーザーはバケットの所有者でなくてはならず、バケットは配置と同じ AWS アカウントにある必要があります。 |
License File Name | 必須 | ArcGIS Notebook Server 認証ファイル オブジェクト キー名を指定します。 このスタックを起動する前に、配置バケットにライセンス ファイル (*.ecp または *.prvc) をアップロードする必要があります。 Amazon S3 コンソールの配置バケット内にあるファイルを参照することで、ファイル オブジェクト キー名を取得できます。 たとえば、notebook.prvc や resources/licenses/109/server/notebook.prvc などがあります。 ライセンス ファイル名では大文字と小文字が区別されます。 名前が正しく入力されていることを確認します。 |
License Level | 必須 | ArcGIS Notebook Server ライセンス レベルを選択します。 次のようなオプションがあります。
|
Site Administrator User Name | 必須 | ArcGIS Notebook Server サイトのプライマリ サイト管理者のユーザー名を指定します。 名前は 6 文字以上の英数字またはアンダースコア (_) を含み、先頭は文字にする必要があります。 |
Site Administrator User Password | 必須 | ArcGIS Notebook Server サイトのプライマリ サイト管理者のパスワードを指定します。 プレーン テキストのパスワードを入力することも、AWS Secrets Manager のシークレット ID の ARN を入力することもできます。 パスワード用の Amazon Resource Name を作成する方法については、「AWS CloudFormation および ArcGIS」をご参照ください。 パスワードには 8 文字以上の英数字を使用し、アンダースコア (_)、アット記号 (@)、ドット (.) を使用できます。 |
Web Adaptor Name | オプション | ArcGIS Notebook Server サイトで ArcGIS Web Adaptor を使用するには、Web Adaptor 名を入力します。 ArcGIS Notebook Server サイトにアクセスするには、https://<fully qualified domain name>/<web adaptor name> という形式の URL を使用します。 名前の先頭は文字で、英数字のみで指定する必要があります。 ArcGIS Web Adaptor を使用しない場合や、サイトの URL の形式が https://<fully qualified domain name><PortNumber>/arcgis である場合は、このパラメーター値は空のままにしておきます。 |
SSL Certificate File Name | オプション | サイトに Web Adaptor を含める場合は、証明機関から取得した SSL 証明書 (*.pfx ファイル) を指定できます。 証明書を指定した場合は、このスタックを起動する前に配置バケットにアップロードする必要があります。 AWS S3 コンソールの配置バケット内にあるファイルを参照することで、ファイル オブジェクト キー名を取得できます。 証明書名の例として、配置バケットのルート レベルに格納される証明書ファイルである domainname.pfx や、配置バケットのフォルダーに格納される証明書ファイルである resources/sslcerts/domainname.pfx が挙げられます。 Web Adaptor を使用するときに、このパラメーター値を空のままにしておくと、Web Adaptor では自動生成された自己署名証明書が使用されます。 |
SSL Certificate Password | 条件付き | SSL 証明書のパスワードを指定します。 プレーン テキストのパスワードを入力することも、AWS Secrets Manager のシークレット ID の ARN を入力することもできます。 パスワード用の Amazon Resource Name を作成する方法については、「AWS CloudFormation および ArcGIS」をご参照ください。 |
出力
スタックの作成が成功した場合は、AWS Management Console の CloudFormation スタックの [Outputs (出力)] タブに、次の出力パラメーターが表示されます。
| 出力名 | 出力の説明 |
|---|---|
DeploymentLogsURL | これは、すべての配置ログが格納される Amazon CloudWatch ログの URL です。 配置が失敗した場合は、これらのログをトラブルシューティングの際に参照できます。 |
ServerAdminURL | ArcGIS Notebook Server Administrator Directory の URL。 |
ServerServicesURL | ArcGIS Notebook Server サービス URL。 この URL をフェデレート サーバー テンプレートの入力パラメーターとして使用できます。 |
StopStackFunctionName | これは、[Stop Stack Lambda (スタック ラムダ停止)] 関数の URL です。 このラムダ関数を使用し、スタック内のすべての EC2 インスタンスを停止できます。 |
StartStackFunctionName | これは、[Start Stack Lambda (スタック ラムダ開始)] 関数の URL です。 このラムダ関数を使用し、以前に停止したスタック内のすべての EC2 インスタンスを開始できます。 |
検討事項
ArcGIS 配置を含む CloudFormation スタックを作成した後に検討すべき重要な点は次のとおりです。
- この CloudFormation テンプレートで作成された AWS リソースを削除しないでください。 このテンプレートで作成された AWS リソースを知りたい場合は、AWS Management Console のこのスタックの [Resource (リソース)] タブをご参照ください。 Esri CloudFormation テンプレートで作成された各リソースには、メタデータ タグも含まれています。 ただし、AWS Management Console では一部のリソースのタグが表示されません。
- スタックの出力 (このページの「出力」セクションを参照) に表示される AWS Lambda 関数を使用して、このスタックの EC2 インスタンスを使用していないときに停止し、必要に応じて再起動することができます。 これらの関数はコストの管理に役立ちます。
Lambda 関数を実行して配置内の EC2 インスタンスを停止すると、関数はインスタンスが停止されたことを示すメッセージを返します。 ただし、インスタンスが自動スケーリング グループに含まれている場合は、そのグループからインスタンスをデタッチする必要があります。 これには最大 10 分かかる場合があります。 このため、Lambda start 関数を実行して配置を再起動する前に、少なくとも 10 分待機してください。
トラブルシューティング
この CloudFormation スタックの作成時に障害が発生した場合は、「AWS における ArcGIS の配置のトラブルシューティング」をご参照ください。