Esri arcgis-portal-ha.template.json Amazon Web Services (AWS) CloudFormation テンプレートは、Portal for ArcGIS がインストールされた 2 つの Amazon Elastic Compute Cloud (EC2) インスタンスを作成し、高可用性ポータルを作成します。
このテンプレートを使用して Portal for ArcGIS をデプロイする場合、次のオプションがあります。
- Portal for ArcGIS コンテンツ ディレクトリを Amazon Simple Storage Service (S3) バケットに配置するか、Portal for ArcGIS コンテンツ ディレクトリをファイル サーバーの EC2 インスタンスに配置します。
- 各 Portal for ArcGIS コンピューターに ArcGIS Web Adaptor を構成します。
このテンプレートは、Amazon Web Services で次のアーキテクチャを作成します。
上記の図では、ポータル コンテンツのディレクトリ ストレージに対し、ファイル サーバーと S3 バケットの両方が示されています。 スタックを起動するときに、コンテンツ ディレクトリ用に 1 つの場所を選択します。ポータル コンテンツ ディレクトリは、同一ポータルについて、両方の場所に格納されません。
ライセンス:
図内の特定のアイコンは、Amazon Web Services の許可を得て使用されています。
ヒント:
このテンプレートは、「CloudFormation を使用して個別のコンピューターに ArcGIS Enterprise コンポーネントをデプロイする」で説明したとおり、ArcGIS Enterprise デプロイメントを作成する際に使用します。前提条件
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 サービスにアクセスできる必要があります。
- Portal for ArcGIS ライセンス ファイル (.json)。
- Amazon Virtual Private Cloud (VPC) とサブネット。
同じ ArcGIS Enterprise コンポーネントのすべてのコンポーネントは、同じ VPC で実行される必要があります。 このポータルで使用する ArcGIS GIS Server または ArcGIS Data Store を作成した場合は、それらのコンポーネントに使用したのと同じ VPC およびサブネットを使用します。 まだこれらのコンポーネントを作成しておらず、使用する既存の VPC が存在しない場合は、2 つのパブリック サブネットを含む VPC、または NAT ゲートウェイを備えた 2 つのパブリック サブネットおよびプライベート サブネットを含む VPC のいずれかの CloudFormation テンプレートを使用して VPC を作成できます。
- ポータルで ArcGIS Web Adaptor を使用し、SSL 証明書を構成しようとしている場合は、認証局から SSL 証明書を取得します。
- AWS GovCloud の Ubuntu EC2 インスタンスにデプロイメントを作成する場合は、AMI ID が必要です。 Canonical によるベース Ubuntu AMI を使用する場合は、Esri Amazon Web Services CloudFormation テンプレートの手順に従って ID を特定します。
- arcgis-portal-ha.template.json CloudFormation テンプレート。
必須タスク
このテンプレートを実行する前に、次のタスクを実行する必要があります。
- AWS アカウントに配置の Amazon Simple Storage Service (S3) バケットを準備します。 スタックを起動するときに、テンプレートのバケット名を指定します。
- バケットを作成するか、既存の S3 バケットを使用します。 ユーザーはバケットの所有者でなくてはなりません。
- バケットに Portal for ArcGIS ソフトウェア認証ファイルをアップロードします。
- SSL 証明書ファイル (*.pfx) を配置バケットにアップロードします。 このステップは、ポータルで ArcGIS Web Adaptor を使用し、そこに SSL 証明書を構成する場合にのみ必要です。
- デプロイメント用の完全修飾ドメイン名を作成します。 このドメイン名は解決可能である必要があります。 ドメイン名の作成および構成方法が不明の場合は、IT 管理者にご確認ください。
- 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」をご参照ください。
- Portal for ArcGIS 配置でアプリケーションまたは従来の ELB (Elastic Load Balancer) を使用するには、このスタックを起動する前に ELB を作成し、高可用性 Portal for ArcGIS 配置を作成します。 ELB を作成するには、アプリケーション ロード バランサー テンプレートまたは従来のロード バランサー テンプレートを使用します。
ヒント:
デフォルトでは、スタックの作成に失敗すると、CloudFormation は部分的に作成されたリソースを削除します。 これにより、使用できないデプロイメントがアカウントから削除されるため便利ですが、トラブルシューティングが難しくなる可能性もあります。 スタックを失敗した状態で保持するには、スタックを起動する前に CloudFormation スタック作成オプションの [Rollback on failure (失敗時にロールバックする)] を無効にします。 詳細については、AWS ヘルプの「Setting AWS CloudFormation options (AWS CloudFormation オプションの設定)」をご参照ください。
パラメーター
この CloudFormation テンプレートで使用されるパラメーターの説明については、次の表をご参照ください。 表はパラメーターのタイプ別に分けられています。
Amazon EC2 Configuration
| パラメーター名 | 必須 | パラメーターの説明 |
|---|---|---|
Platform Type | 必須 | オペレーティング システム プラットフォームを選択してください。 サポートされているタイプは次のとおりです。
特定のオペレーティング システムのバージョンについては、「CloudFormation を使用して AWS に ArcGIS を配置する際にサポートされているオペレーティング システム」をご参照ください。 |
EC2 Instance AMI ID | オプション | このパラメーター値は空のままにしておいてもかまいません。 その場合、CloudFormation テンプレートでは、選択したプラットフォームのタイプに応じて、Microsoft Windows Server 2019 または Ubuntu Server 18.04 LTS の最新の Amazon Machine Image (AMI) ID を使用します。 注意:Linux プラットフォームの AWS GovCloud に配置する場合は、このパラメーターは空のままにしておくことはできません。 Canonical から基本の Ubuntu AMI ID を検索する方法については、Esri Amazon Web Services CloudFormation テンプレートをご参照ください。 Ubuntu 以外のサポート対象の Linux オペレーティング システムを配置する場合は、AWS Management Console を使用するか、AWS Marketplace で、AMI ID を検索できます。 特定のリリースに対して、いずれかのデフォルト AMI を初めて使用するときは、AWS Marketplace の利用条件に同意する必要があります。 独自のカスタム AMI を使用するには、次のいずれかの方法で AMI ID を入力します。
カスタム AMI を使用する場合は、次の要件を満たしていることを確認します。
|
EC2 Instance Keypair Name | 必須 | EC2 インスタンスへのリモート アクセスを許可するため、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 を取得できます。 |
Subnet ID 2 | 必須 | 2 つ目のサブネット ID を選択します。 これは、サブネット ID 1 パラメーターとは異なるサブネット ID でなくてはなりません。 選択したサブネット ID は、この配置に対して指定した VPC 内に含まれている必要があります。 Esri CloudFormation テンプレートを使用して VPC を作成した場合は、そのテンプレートの出力パラメーターからサブネット ID を取得できます。 |
Domain Name System (DNS) Configuration
| パラメーター名 | 必須 | パラメーターの説明 |
|---|---|---|
Portal for ArcGIS Site Domain Name | 必須 | ポータルの完全修飾ドメイン名を指定します。 ドメイン名がすでに存在し、解決可能である必要があります (test.abc.com など)。使用するドメイン名が不明な場合は、IT 管理者にお問い合わせください。 |
Elastic Load Balancer DNS Name | オプション | 配置で ELB (Elastic Load Balancer) を使用するには、アプリケーションの値か、従来の ELB DNS 名を指定します。 この ELB はすでに存在している必要があります。 ELB を使用したくない場合、または後から自分で構成したい場合は、このパラメーター値を空のままにしておきます。 ELB DNS 名を取得するには、AWS Management Console 内の Amazon EC2 サービスの [Load Balancers (ロード バランサー)] セクションを参照します。あるいは、Esri CloudFormation テンプレートを使用して ELB を作成した場合は、テンプレートの出力パラメーターから取得することもできます。 有効な ELB DNS 名の末尾は .elb.amazonaws.com です。 |
Portal for ArcGIS Configuration
| パラメーター名 | 必須 | パラメーターの説明 |
|---|---|---|
EC2 Instance Type | 必須 | プライマリおよびスタンバイ ポータル コンピューターの EC2 インスタンス タイプを選択します。 デフォルトは m5.2xlarge です。 |
EC2 Instance Root Drive Disk Space | 必須 | ルート ドライブのサイズを GB 単位で指定します。 デフォルトは 100 GB です。 最小は 100 GB です。 最大は 1024 GB です。 |
Deployment Bucket Name | 必須 | ソフトウェア ライセンス ファイルを含む Amazon S3 バケットの名前と、SSL 証明書 (使用する場合) を指定します。 このバケットがすでに存在することと、配置用のライセンス ファイルおよび SSL 証明書が含まれていることが必要です。 ユーザーはバケットの所有者でなくてはならず、バケットは配置と同じ AWS アカウントにある必要があります。 |
License File Name | 必須 | Portal for ArcGIS 認証ファイル オブジェクト キー名を指定します。 このスタックを起動する前に、配置バケットにライセンス ファイル (.json) をアップロードする必要があります。 AWS S3 コンソールの配置バケット内にあるファイルを参照することで、ファイル オブジェクト キー名を取得できます (portal.json や resources/licenses/portal/portal.json など)。 ライセンス ファイル名では大文字と小文字が区別されます。 正しい名前を、大文字と小文字の区別を付けて入力します。 |
User License Type ID | オプション | ポータル ユーザー ライセンス タイプ ID を指定します。 ユーザー タイプの詳細については、「ユーザー タイプ、ロール、権限」をご参照ください。 使用するタイプがわからない場合は、このフィールドは空のままにしておきます。 その場合は、一時的なユーザー ライセンス タイプ ID が使用されます。 注意:この時点でユーザー ライセンス タイプ ID を指定しない場合は、配置を作成した後にユーザー ライセンス タイプを変更する必要があります。 |
Administrator User Name | 必須 | 初期ポータル管理者のユーザー名を指定します。 名前は 6 文字以上の英数字またはアンダースコア (_) を含み、先頭は文字にする必要があります。 |
Administrator User Password | 必須 | 初期ポータル管理者のパスワードを指定します。 プレーン テキストのパスワードを入力することも、AWS Secrets Manager のシークレット ID の ARN を入力することもできます。 パスワードには 8 文字以上の英数字を使用する必要があり、ドット (.) も使用できます。 パスワードは AWS Secrets Manager で管理することをお勧めします。 パスワード用の Amazon Resource Name を作成する方法については、「AWS CloudFormation および ArcGIS」をご参照ください。 |
Windows arcgis user password | 条件 | arcgis ユーザーのパスワードを指定します。 arcgis ユーザーは、ArcGIS ソフトウェア サービスの実行に使用されるローカルの Windows ログインです。したがって、このパスワードは、Windows に配置する場合にのみ必須です。 プレーン テキストのパスワードを入力することも、AWS Secrets Manager のシークレット ID の ARN を入力することもできます。 パスワードは AWS Secrets Manager で管理することをお勧めします。 パスワード用の Amazon Resource Name を作成する方法については、「AWS CloudFormation および ArcGIS」をご参照ください。 |
Content Store Type | 必須 | ポータル コンテンツ ディレクトリのストレージ場所のタイプを選択します。 デフォルトは [FileSystem] です。
|
ArcGIS File Server Instance Type | 条件 | ArcGIS ファイル サーバーの EC2 インスタンス タイプを選択します。 デフォルトのインスタンス タイプは m5.2xlarge です。 これは、Content Store Type パラメーターとして [FileSystem] を選択した場合にのみ必要です。 |
ArcGIS File Server EC2 Instance Root Drive Disk Space | 条件 | ルート ドライブのサイズを GB 単位で指定します。 デフォルトは 100 GB です。 最小は 100 GB です。 最大は 1024 GB です。 ArcGIS ファイル サーバーの EC2 インスタンスのルート ドライブのディスク容量のサイズ。 これは、Content Store Type パラメーターとして [FileSystem] を選択した場合にのみ必要です。 |
Web Adaptor Name | オプション | ArcGIS Web Adaptor を使用しない場合や、サイトの URL の形式が https://<fully qualified domain name><PortNumber>/arcgis である場合は、このパラメーター値は空のままにしておきます。 |
SSL Certificate File Name | オプション | ポータルに ArcGIS Web Adaptor を含める場合は、証明機関から取得した SSL 証明書 (.pfx ファイル) を指定できます。 証明書ファイルを指定するには、このスタックを起動する前に配置バケットにアップロードする必要があります。 AWS S3 コンソールの配置バケット内にあるファイルを参照することで、ファイル オブジェクト キー名を取得できます。 証明書名の例として、配置バケットのルート レベルに格納される証明書ファイルである domainname.pfx や、配置バケットのフォルダーに格納される証明書ファイルである resources/sslcerts/domainname.pfx が挙げられます。 Web Adaptor を使用するときに、このパラメーター値を空のままにしておくと、Web Adaptor では自動生成された自己署名証明書が使用されます。 |
SSL Certificate Password | 条件 | ポータルに ArcGIS Web Adaptor を含め、証明機関から取得した SSL 証明書を使用する場合は、プレーン テキスト パスワードか、AWS Secrets Manager のシークレット ID の ARN を入力します。 パスワード用の Amazon Resource Name を作成する方法については、「AWS CloudFormation および ArcGIS」をご参照ください。 |
出力
スタックの作成が成功した場合は、AWS Management Console の CloudFormation スタックの [Outputs (出力)] タブに、次の出力パラメーターが表示されます。
| 出力名 | 出力の説明 |
|---|---|
DeploymentLogsURL | これは、すべての配置ログが格納される Amazon CloudWatch ログの URL です。 配置が失敗した場合は、これらのログをトラブルシューティングの際に参照できます。 |
PortalHomeAppURL | ポータルへのアクセスに使用する 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 分待機してください。
- サイト管理者のユーザー パスワードや Windows の arcgis ユーザー パスワードなどのパスワードを AWS Secrets Manager を使用して設定し、後で (デプロイメントの作成後に) それらのパスワードを変更する場合は、必ず、更新したパスワードを使用して適切な AWS Secrets Manager の ARN のパスワードを更新します。
- デプロイメントでアプリケーション ロード バランサーを使用する場合は、デプロイメントの作成後に、アプリケーション ロード バランサーのアイドル タイムアウトを調整できます。 たとえば、デプロイメント内のいずれかのコンピューターで、時間のかかる操作を確実に完了できるよう、アイドル タイムアウトを増やす必要があります。 AWS Management Console で、アプリケーション ロード バランサーのアイドル タイムアウトの値を調整します。
トラブルシューティング
この CloudFormation スタックの作成時に障害が発生した場合は、「AWS における ArcGIS デプロイメントのトラブルシューティング」をご参照ください。