4.14. AWS Local Zones 上のコンピュートノードを使用して AWS にクラスターをインストールする

手順

1. 次のコマンドを実行して、AWS リージョンで利用可能なゾーンをリスト表示します。

   AWS リージョンで利用可能な AWS Local Zones をリスト表示するコマンドの例

   $ aws --region "<value_of_AWS_Region>" ec2 describe-availability-zones \
       --query 'AvailabilityZones[].[{ZoneName: ZoneName, GroupName: GroupName, Status: OptInStatus}]' \
       --filters Name=zone-type,Values=local-zone \
       --all-availability-zones

   AWS リージョンによっては、利用可能なゾーンのリストが長くなる場合があります。このコマンドは次のフィールドを返します。

   ZoneName

   Local Zones の名前。

   GroupName

   ゾーンで構成されるグループ。リージョンにオプトインするには、この名前を保存しておきます。

   Status

   Local Zones グループのステータス。ステータスが not-opted-in の場合は、次の手順で説明するように GroupName をオプトインする必要があります。

2. 次のコマンドを実行して、AWS アカウントのゾーングループにオプトインします。

   $ aws ec2 modify-availability-zone-group \
       --group-name "<value_of_GroupName>" \1
       --opt-in-status opted-in

   1

   <value_of_GroupName> は、サブネットを作成する Local Zones のグループの名前に置き換えます。たとえば、ゾーン us-east-1-nyc-1a (米国東部 (ニューヨーク)) を使用するには us-east-1-nyc-1 と指定します。

手順

1. AWS Marketplace で OpenShift Container Platform サブスクリプションを完了します。

2. ご使用の AWS リージョンの AMI ID を記録します。インストールプロセスの一環として、クラスターをデプロイする前に、この値で install-config.yaml ファイルを更新する必要があります。

   AWS Marketplace コンピュートノードを含む install-config.yaml ファイルのサンプル

   apiVersion: v1
   baseDomain: example.com
   compute:
   - hyperthreading: Enabled
     name: worker
     platform:
       aws:
         amiID: ami-06c4d345f7c207239 1
         type: m5.4xlarge
     replicas: 3
   metadata:
     name: test-cluster
   platform:
     aws:
       region: us-east-2 2
   sshKey: ssh-ed25519 AAAA...
   pullSecret: '{"auths": ...}'

   1

   AWS Marketplace サブスクリプションの AMI ID。

   2

   AMI ID は特定の AWS リージョンに関連付けられています。インストール設定ファイルを作成するときは、サブスクリプションの設定時に指定したものと同じ AWS リージョンを選択してください。

手順

1. Red Hat カスタマーポータルの OpenShift Container Platform ダウンロードページ に移動します。
2. Product Variant ドロップダウンリストからアーキテクチャーを選択します。
3. バージョン ドロップダウンリストから適切なバージョンを選択します。
4. OpenShift v4.15 Linux Client エントリーの横にある Download Now をクリックして、ファイルを保存します。

5. アーカイブを展開します。

   $ tar xvf <file>

6. oc バイナリーを、PATH にあるディレクトリーに配置します。

   PATH を確認するには、以下のコマンドを実行します。

   $ echo $PATH

手順

1. Red Hat カスタマーポータルの OpenShift Container Platform ダウンロードページ に移動します。
2. バージョン ドロップダウンリストから適切なバージョンを選択します。
3. OpenShift v4.15 Windows Client エントリーの横にある Download Now をクリックして、ファイルを保存します。
4. ZIP プログラムでアーカイブを展開します。

5. oc バイナリーを、PATH にあるディレクトリーに移動します。

   PATH を確認するには、コマンドプロンプトを開いて以下のコマンドを実行します。

   C:\> path

手順

1. Red Hat カスタマーポータルの OpenShift Container Platform ダウンロードページ に移動します。
2. バージョン ドロップダウンリストから適切なバージョンを選択します。

3. OpenShift v4.15 macOS Client エントリーの横にある Download Now をクリックして、ファイルを保存します。

   注記

   macOS arm64 の場合は、OpenShift v4.15 macOS arm64 Client エントリーを選択します。

4. アーカイブを展開し、解凍します。

5. oc バイナリーをパスにあるディレクトリーに移動します。

   PATH を確認するには、ターミナルを開き、以下のコマンドを実行します。

   $ echo $PATH

手順

1. OpenShift Cluster Manager サイトの インフラストラクチャープロバイダー ページにアクセスします。Red Hat アカウントがある場合は、認証情報を使用してログインします。アカウントがない場合はこれを作成します。
2. インフラストラクチャープロバイダーを選択します。

3. インストールタイプのページに移動し、ホストオペレーティングシステムとアーキテクチャーに対応するインストールプログラムをダウンロードして、インストール設定ファイルを保存するディレクトリーにファイルを配置します。

   重要

   インストールプログラムは、クラスターのインストールに使用するコンピューターにいくつかのファイルを作成します。クラスターのインストール完了後は、インストールプログラムおよびインストールプログラムが作成するファイルを保持する必要があります。ファイルはいずれもクラスターを削除するために必要になります。

   重要

   インストールプログラムで作成されたファイルを削除しても、クラスターがインストール時に失敗した場合でもクラスターは削除されません。クラスターを削除するには、特定のクラウドプロバイダー用の OpenShift Container Platform のアンインストール手順を実行します。

4. インストールプログラムを展開します。たとえば、Linux オペレーティングシステムを使用するコンピューターで以下のコマンドを実行します。

   $ tar -xvf openshift-install-linux.tar.gz

5. Red Hat OpenShift Cluster Manager からインストールプルシークレット をダウンロードします。このプルシークレットを使用し、OpenShift Container Platform コンポーネントのコンテナーイメージを提供する Quay.io など、組み込まれた各種の認証局によって提供されるサービスで認証できます。

手順

1. クラスターノードへの認証に使用するローカルマシンに既存の SSH キーペアがない場合は、これを作成します。たとえば、Linux オペレーティングシステムを使用するコンピューターで以下のコマンドを実行します。

   $ ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1

   1

   新しい SSH キーのパスとファイル名 (~/.ssh/id_ed25519 など) を指定します。既存のキーペアがある場合は、公開鍵が ~/.ssh ディレクトリーにあることを確認します。

   注記

   x86_64、ppc64le、および s390x アーキテクチャーのみで FIPS 140-2/140-3 検証のために NIST に提出された RHEL 暗号化ライブラリーを使用する OpenShift Container Platform クラスターをインストールする予定がある場合は、ed25519 アルゴリズムを使用するキーを作成しないでください。代わりに、rsa アルゴリズムまたは ecdsa アルゴリズムを使用するキーを作成します。

2. 公開 SSH キーを表示します。

   $ cat <path>/<file_name>.pub

   たとえば、次のコマンドを実行して ~/.ssh/id_ed25519.pub 公開鍵を表示します。

   $ cat ~/.ssh/id_ed25519.pub

3. ローカルユーザーの SSH エージェントに SSH 秘密鍵 ID が追加されていない場合は、それを追加します。キーの SSH エージェント管理は、クラスターノードへのパスワードなしの SSH 認証、または ./openshift-install gather コマンドを使用する場合は必要になります。

   注記

   一部のディストリビューションでは、~/.ssh/id_rsa および ~/.ssh/id_dsa などのデフォルトの SSH 秘密鍵のアイデンティティーは自動的に管理されます。

   1. ssh-agent プロセスがローカルユーザーに対して実行されていない場合は、バックグラウンドタスクとして開始します。

      $ eval "$(ssh-agent -s)"

      出力例

      Agent pid 31874

      注記

      クラスターが FIPS モードにある場合は、FIPS 準拠のアルゴリズムのみを使用して SSH キーを生成します。鍵は RSA または ECDSA のいずれかである必要があります。

4. SSH プライベートキーを ssh-agent に追加します。

   $ ssh-add <path>/<file_name> 1

   1

   ~/.ssh/id_ed25519 などの、SSH プライベートキーのパスおよびファイル名を指定します。

   出力例

   Identity added: /home/<you>/<path>/<file_name> (<computer_name>)

1. 1 vCPU は、同時マルチスレッド (SMT) またはハイパースレッディングが有効にされていない場合に 1 つの物理コアと同等です。これが有効にされている場合、数式「(コアごとのスレッド × コア数) × ソケット数 = 仮想 CPU」を使用して対応する比率を計算します。
2. OpenShift Container Platform および Kubernetes はディスクのパフォーマンスに敏感であり、特に 10 ms p99 fsync 期間を必要とするコントロールプレーンノード上の etcd については、高速ストレージが推奨されます。多くのクラウドプラットフォームでは、ストレージサイズと IOPS スケールが一緒にあるため、十分なパフォーマンスを得るためにストレージボリュームの割り当てが必要になる場合があります。
3. すべての user-provisioned installation と同様に、クラスターで RHEL コンピュートマシンの使用を選択する場合は、システム更新の実行、パッチの適用、その他すべての必要なタスクの完了など、オペレーティングシステムのライフサイクルの管理と保守をすべて担当します。RHEL 7 コンピューティングマシンの使用は推奨されておらず、OpenShift Container Platform 4.10 以降では削除されています。

手順

1. install-config.yaml ファイルを作成します。

   1. インストールプログラムが含まれるディレクトリーに切り替え、以下のコマンドを実行します。

      $ ./openshift-install create install-config --dir <installation_directory> 1

      1

      <installation_directory> の場合、インストールプログラムが作成するファイルを保存するためにディレクトリー名を指定します。

      重要

      空のディレクトリーを指定します。ブートストラップ X.509 証明書などの一部のインストールアセットの有効期限は短く設定されているため、インストールディレクトリーを再利用することができません。別のクラスターインストールの個別のファイルを再利用する必要がある場合は、それらをディレクトリーにコピーすることができます。ただし、インストールアセットのファイル名はリリース間で変更される可能性があります。インストールファイルを以前のバージョンの OpenShift Container Platform からコピーする場合は注意してコピーを行ってください。

   2. プロンプト時に、クラウドの設定の詳細情報を指定します。

      1. オプション: クラスターマシンにアクセスするために使用する SSH キーを選択します。

         注記

         インストールのデバッグまたは障害復旧を実行する必要のある実稼働用の OpenShift Container Platform クラスターでは、ssh-agent プロセスが使用する SSH キーを指定します。

      2. ターゲットに設定するプラットフォームとして aws を選択します。

      3. AWS プロファイルをコンピューターに保存していない場合、インストールプログラムを実行するように設定したユーザーの AWS アクセスキー ID およびシークレットアクセスキーを入力します。

         注記

         AWS アクセスキー ID およびシークレットアクセスキーは、インストールホストの現行ユーザーのホームディレクトリーの ~/.aws/credentials に保存されます。エクスポートされたプロファイルの認証情報がファイルにない場合は、インストールプログラムにより認証情報の入力が求めるプロンプトが出されます。インストールプログラムに指定する認証情報は、ファイルに保存されます。

      4. クラスターのデプロイ先とする AWS リージョンを選択します。
      5. クラスターに設定した Route 53 サービスのベースドメインを選択します。
      6. クラスターの記述名を入力します。
      7. Red Hat OpenShift Cluster Manager からプルシークレット を貼り付けます。

2. オプション: install-config.yaml ファイルをバックアップします。

   重要

   install-config.yaml ファイルはインストールプロセス時に使用されます。このファイルを再利用する必要がある場合は、この段階でこれをバックアップしてください。

手順

1. install-config.yaml ファイルを変更して、エッジコンピュートプールの platform.aws.zones プロパティーで Local Zones 名を指定します。

   # ...
   platform:
     aws:
       region: <region_name> 1
   compute:
   - name: edge
     platform:
       aws:
         zones: 2
         - <local_zone_name>
   #...

   1

   AWS リージョン名。

   2

   使用する Local Zones 名のリストは、platform.aws.region フィールドで指定した同じ AWS リージョンに存在する必要があります。

   エッジノードを Los Angeles と Las Vegas の Local Zones に拡張する us-west-2 AWS リージョンにクラスターをインストールする設定の例

   apiVersion: v1
   baseDomain: example.com
   metadata:
     name: cluster-name
   platform:
     aws:
       region: us-west-2
   compute:
   - name: edge
     platform:
       aws:
         zones:
         - us-west-2-lax-1a
         - us-west-2-lax-1b
         - us-west-2-las-1a
   pullSecret: '{"auths": ...}'
   sshKey: 'ssh-ed25519 AAAA...'
   #...

2. クラスターをデプロイします。

手順

1. CloudFormation テンプレートが必要とするパラメーター値が含まれる JSON ファイルを作成します。

   [
     {
       "ParameterKey": "VpcCidr", 1
       "ParameterValue": "10.0.0.0/16" 2
     },
     {
       "ParameterKey": "AvailabilityZoneCount", 3
       "ParameterValue": "3" 4
     },
     {
       "ParameterKey": "SubnetBits", 5
       "ParameterValue": "12" 6
     }
   ]

   1

   VPC の CIDR ブロック。

   2

   x.x.x.x/16-24 形式で CIDR ブロックを指定します。

   3

   VPC をデプロイするアベイラビリティーゾーンの数。

   4

   1 から 3 の間の整数を指定します。

   5

   各アベイラビリティーゾーン内の各サブネットのサイズ。

   6

   5 から 13 の間の整数を指定します。ここで、5 は /27 であり、13 は /19 です。

2. このドキュメントの「VPC の CloudFormation テンプレート」セクションに移動し、記載されているテンプレートから構文をコピーします。コピーしたテンプレートの構文を YAML ファイルとしてローカルシステムに保存します。このテンプレートは、クラスターに必要な VPC について記述しています。

3. 次のコマンドを実行して、CloudFormation テンプレートを起動し、VPC を表す AWS リソースのスタックを作成します。

   重要

   単一行にコマンドを入力してください。

   $ aws cloudformation create-stack --stack-name <name> \1
        --template-body file://<template>.yaml \2
        --parameters file://<parameters>.json  3

   1

   <name> は cluster-vpc などの CloudFormation スタックの名前です。クラスターを削除する場合に、このスタックの名前が必要になります。

   2

   <template> は、保存した CloudFormation テンプレート YAML ファイルへの相対パスまたはその名前です。

   3

   <parameters> は、CloudFormation パラメーターの JSON ファイルの相対パスと名前です。

   出力例

   arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-vpc/dbedae40-2fd3-11eb-820e-12a48460849f

4. 次のコマンドを実行して、テンプレートコンポーネントが存在することを確認します。

   $ aws cloudformation describe-stacks --stack-name <name>

   StackStatus が CREATE_COMPLETE を表示した後に、出力には以下のパラメーターの値が表示されます。これらのパラメーター値を、クラスターを作成するために実行する他の CloudFormation テンプレートに指定する必要があります。

   VpcId	VPC の ID。
   PublicSubnetIds	新規パブリックサブネットの ID。
   PrivateSubnetIds	新規プライベートサブネットの ID。
   PublicRouteTableId	新しいパブリックルートテーブル ID の ID。

手順

1. このドキュメントの「VPC サブネット用の CloudFormation テンプレート」セクションに移動し、テンプレートから構文をコピーします。コピーしたテンプレートの構文を YAML ファイルとしてローカルシステムに保存します。このテンプレートは、クラスターに必要な VPC について記述しています。

2. 次のコマンドを実行して CloudFormation テンプレートをデプロイします。これにより、VPC を表す AWS リソースのスタックが作成されます。

   $ aws cloudformation create-stack --stack-name <stack_name> \1
     --region ${CLUSTER_REGION} \
     --template-body file://<template>.yaml \2
     --parameters \
       ParameterKey=VpcId,ParameterValue="${VPC_ID}" \3
       ParameterKey=ClusterName,ParameterValue="${CLUSTER_NAME}" \4
       ParameterKey=ZoneName,ParameterValue="${ZONE_NAME}" \5
       ParameterKey=PublicRouteTableId,ParameterValue="${ROUTE_TABLE_PUB}" \6
       ParameterKey=PublicSubnetCidr,ParameterValue="${SUBNET_CIDR_PUB}" \7
       ParameterKey=PrivateRouteTableId,ParameterValue="${ROUTE_TABLE_PVT}" \8
       ParameterKey=PrivateSubnetCidr,ParameterValue="${SUBNET_CIDR_PVT}" 9

   1

   <stack_name> は、CloudFormation スタックの名前です (cluster-wl-<local_zone_shortname> など)。クラスターを削除する場合に、このスタックの名前が必要になります。

   2

   <template> は、保存した CloudFormation テンプレート YAML ファイルの相対パスと名前です。

   3

   ${VPC_ID} は VPC ID であり、VPC 用の CloudFormation テンプレートの出力に含まれる値 VpcID です。

   4

   ${ZONE_NAME} は、サブネットを作成する Local Zones 名の値です。

   5

   ${CLUSTER_NAME} は、新しい AWS リソース名の接頭辞として使用する ClusterName の値です。

   6

   ${SUBNET_CIDR_PUB} は、パブリックサブネットの作成に使用する有効な CIDR ブロックです。このブロックは、VPC CIDR ブロック VpcCidr の一部である必要があります。

   7

   ${ROUTE_TABLE_PVT} は、VPC の CloudFormation スタックの出力から抽出した PrivateRouteTableId です。

   8

   ${SUBNET_CIDR_PVT} は、プライベートサブネットの作成に使用する有効な CIDR ブロックです。このブロックは、VPC CIDR ブロック VpcCidr の一部である必要があります。

手順

1. kubeadmin 認証情報をエクスポートします。

   $ export KUBECONFIG=<installation_directory>/auth/kubeconfig 1

   1

   <installation_directory> には、インストールファイルを保存したディレクトリーへのパスを指定します。

2. エクスポートされた設定を使用して、oc コマンドを正常に実行できることを確認します。

   $ oc whoami

   出力例

   system:admin

手順

1. インストールホストで kubeadmin-password ファイルから kubeadmin ユーザーのパスワードを取得します。

   $ cat <installation_directory>/auth/kubeadmin-password

   注記

   または、インストールホストで <installation_directory>/.openshift_install.log ログファイルから kubeadmin パスワードを取得できます。

2. OpenShift Container Platform Web コンソールルートをリスト表示します。

   $ oc get routes -n openshift-console | grep 'console-openshift'

   注記

   または、インストールホストで <installation_directory>/.openshift_install.log ログファイルからで OpenShift Container Platform ルートを取得できます。

   出力例

   console     console-openshift-console.apps.<cluster_name>.<base_domain>            console     https   reencrypt/Redirect   None

3. Web ブラウザーで前述のコマンドの出力で詳細に説明されたルートに移動し、kubeadmin ユーザーとしてログインします。

1. install-config.yaml ファイルに追加したサブネットから作成されたマシンセットを確認するには、次のコマンドを実行します。

   $ oc get machineset -n openshift-machine-api

   出力例

   NAME                                  DESIRED   CURRENT   READY   AVAILABLE   AGE
   cluster-7xw5g-edge-us-east-1-nyc-1a   1         1         1       1           3h4m
   cluster-7xw5g-worker-us-east-1a       1         1         1       1           3h4m
   cluster-7xw5g-worker-us-east-1b       1         1         1       1           3h4m
   cluster-7xw5g-worker-us-east-1c       1         1         1       1           3h4m

2. マシンセットから作成されたマシンを確認するには、次のコマンドを実行します。

   $ oc get machines -n openshift-machine-api

   出力例

   NAME                                        PHASE     TYPE          REGION      ZONE               AGE
   cluster-7xw5g-edge-us-east-1-nyc-1a-wbclh   Running   c5d.2xlarge   us-east-1   us-east-1-nyc-1a   3h
   cluster-7xw5g-master-0                      Running   m6i.xlarge    us-east-1   us-east-1a         3h4m
   cluster-7xw5g-master-1                      Running   m6i.xlarge    us-east-1   us-east-1b         3h4m
   cluster-7xw5g-master-2                      Running   m6i.xlarge    us-east-1   us-east-1c         3h4m
   cluster-7xw5g-worker-us-east-1a-rtp45       Running   m6i.xlarge    us-east-1   us-east-1a         3h
   cluster-7xw5g-worker-us-east-1b-glm7c       Running   m6i.xlarge    us-east-1   us-east-1b         3h
   cluster-7xw5g-worker-us-east-1c-qfvz4       Running   m6i.xlarge    us-east-1   us-east-1c         3h

3. エッジロールを持つノードを確認するには、次のコマンドを実行します。

   $ oc get nodes -l node-role.kubernetes.io/edge

   出力例

   NAME                           STATUS   ROLES         AGE    VERSION
   ip-10-0-207-188.ec2.internal   Ready    edge,worker   172m   v1.25.2+d2e245f