Esri arcgis-notebook-server-ha-upgrade.template.json Amazon Web Services (AWS) CloudFormation テンプレートは、「CloudFormation を使用した高可用性 ArcGIS Notebook Server サイトのデプロイメント」で説明したテンプレートを使用して作成された ArcGIS Notebook Server 10.9、10.9.1、11.0、または 11.1 サイトをアップグレードします。
arcgis-notebook-server-ha-upgrade.template.json テンプレートは、2 つの同一の Linux Amazon Elastic Compute Cloud (EC2) インスタンス上で構成された、次のプロダクトをアップグレードします。
- ArcGIS Notebook Server
- ArcGIS Web Adaptor
前提条件
CloudFormation テンプレートを実行する前に取得する必要があるアイテム (ファイル、アカウントなど) や、実行する必要があるタスクごとに、前提条件がグループ化されています。
必須アイテム
このテンプレートを実行する前に、次のアイテムが必要です。
- アップグレードするデプロイメントにアクセスできる Amazon Web Services アカウント。
- ArcGIS Notebook Server ライセンス ファイル (*.ecp または *.prvc)。
- SSL 認証ファイルまたは証明書 (.pfx 形式) およびそれに対応するパスワード 証明書は証明局から取得する必要があります。
- Esri Amazon Web Services CloudFormation テンプレート arcgis-notebook-server-ha.template.json を使用して作成した、可用性の高い既存の ArcGIS Notebook Server サイト。
- CloudFormation アップグレード テンプレートの arcgis-notebook-server-ha-upgrade.template.json。
注意:
デプロイメントをアップグレードするには、この CloudFormation アップグレード テンプレートを実行します。これにより、新しい CloudFormation スタックが作成されます。 このテンプレートを使用して、既存のデプロイメントの CloudFormation スタックを更新しないでください。
必須タスク
このテンプレートを実行する前に、次のタスクを実行する必要があります。
- AWS アカウントにデプロイメントの Amazon Simple Storage Service (S3) バケットを準備します。 スタックを起動するときに、テンプレートのバケット名を指定します。
- バケットを作成するか、既存の S3 バケットを使用します。 ユーザーはバケットの所有者でなくてはなりません。
- バケットに ArcGIS ソフトウェア認証情報ファイルをアップロードします。
- SSL 証明書ファイルをデプロイメント バケットにアップロードします。
- 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 オプションの設定)」をご参照ください。
パラメーター
次の表に、このテンプレートで使用されるパラメーターと、各パラメーターの説明を示します。
ArcGIS Notebook Server Configuration
| パラメーター名 | 必須かどうか | パラメーターの説明 |
|---|---|---|
自動スケーリング グループ名 | 必須 | 既存の ArcGIS Notebook Server サイトが構成された AWS の自動スケーリング グループの名前を指定します。 既存のサイトが、Esri CloudFormation テンプレートまたは Cloud Builder を使用して作成されている場合は、AWS Management Console の既存の CloudFormation スタックの [リソース] セクションで自動スケーリング グループ名を確認できます。 リソースの論理 ID は [AutoScalingGroup] です。 |
Deployment Bucket Name | 必須 | ソフトウェア ライセンス ファイルと SSL 証明書を含む Amazon S3 バケットの名前を指定します。 このバケットがすでに存在することと、配置用のライセンス ファイルおよび SSL 証明書が含まれていることが必要です。 ユーザーはバケットの所有者でなくてはならず、バケットは配置と同じ AWS アカウントにある必要があります。 |
License File Name | 必須 | ArcGIS Notebook Server 認証ファイル オブジェクト キー名を指定します。 このスタックを起動する前に、デプロイメント バケットにライセンス ファイル (.ecp または .prvc) をアップロードする必要があります。 Amazon S3 コンソールの配置バケット内にあるファイルを参照することで、ファイル オブジェクト キー名を取得できます。 たとえば、notebook.prvc や resources/licenses/server/notebook.prvc などがあります。 ライセンス ファイル名では大文字と小文字が区別されます。 正しい名前を、大文字と小文字の区別を付けて入力します。 |
License Level | 必須 | ArcGIS Notebook Server ライセンス レベルを選択します。 次のようなオプションがあります。
|
Site Administrator User Name | 必須 | 既存の ArcGIS Notebook Server サイトのプライマリ サイト管理者のユーザー名を指定します。 |
Site Administrator User Password | 必須 | 既存の ArcGIS Notebook Server のサイトのプライマリ サイト管理者のパスワードを指定します。 プレーン テキストのパスワードを入力することも、AWS Secrets Manager のシークレット ID の ARN を入力することもできます。 |
Site Domain Name | 必須 | 既存の ArcGIS Notebook Server サイトの完全修飾ドメイン名を指定します。 |
Web Adaptor Name | 必須 | 既存の ArcGIS Notebook Server サイトのノートブック サーバーの Web Adaptor の名前を指定します。 |
SSL Certificate File Name | 必須 | 証明機関から取得した SSL 証明書 (.pfx ファイル) を指定します。 既存の配置の作成時に使用したのと同じ (または更新した) SSL 証明書を使用します。 このスタックを起動する前に、配置バケットに証明書をアップロードする必要があります。 AWS S3 コンソールのデプロイメント バケット内にあるファイルを参照することで、ファイル オブジェクト キー名を取得できます (domainname.pfx や resources/sslcerts/domainname.pfx など)。 |
SSL 証明書のパスワード | 必須 | SSL 証明書のパスワードを指定します。 プレーン テキストのパスワードを入力することも、AWS Secrets Manager のシークレット ID の ARN を入力することもできます。 パスワード用の Amazon Resource Name を作成する方法については、「AWS CloudFormation および ArcGIS」をご参照ください。 |
出力
スタックの作成が成功した場合は、AWS Management Console の CloudFormation スタックの [Outputs (出力)] タブに、次の出力パラメーターが表示されます。
| 出力名 | 出力の説明 |
|---|---|
ServerAdminDirURL | |
ServerServicesURL | |
DeploymentLogsURL | これは、すべての配置ログが格納される Amazon CloudWatch ログの URL です。 配置が失敗した場合は、これらのログをトラブルシューティングの際に参照できます。 |
検討事項
ArcGIS デプロイメントを含む CloudFormation スタックを作成した後に検討すべき重要な点は次のとおりです。
- スタックが問題なく作成された場合 (つまりスタック ステータスが [CREATE_COMPLETE] の場合)、ArcGIS Notebook Server サイトが問題なくアップグレードされたことを意味します。 サイトの ArcGIS Notebook Server Admin Directory にサイン インして、これを確認できます。
- CloudFormation スタックの作成に失敗した場合 (つまりスタック ステータスが [CREATE_FAILED] の場合)、後述の「トラブルシューティング」セクションからリンクされたページの内容に従ってエラーを解決します。 エラーの根本原因を特定して必要な対応を行った後、失敗したスタックを削除して新しいスタックを作成し、既存の ArcGIS Notebook Server サイトをアップグレードすることができます。
トラブルシューティング
この CloudFormation スタックの作成時に障害が発生した場合は、「AWS における ArcGIS デプロイメントのトラブルシューティング」をご参照ください。