Red Hat Ansible Automation Platform Operator の OpenShift Container Platform へのデプロイ

手順

1. Operators → Installed Operators に移動し、Ansible Automation Platform Operator をクリックします。
2. Automation controller タブを見つけて、Create instance をクリックします。

1. 以下のテンプレートに従って、.yaml ファイル postgres_configuration_secret を作成します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: external-postgres-configuration
     namespace: <target_namespace> 

   1

   
   stringData:
     host: "<external_ip_or_url_resolvable_by_the_cluster>" 

   2

   
     port: "<external_port>" 

   3

   
     database: "<desired_database_name>"
     username: "<username_to_connect_as>"
     password: "<password_to_connect_with>" 

   4

   
     sslmode: "prefer" 

   5

   
     type: "unmanaged"
   type: Opaque

   Copy to Clipboard Toggle word wrap

   1

   シークレットを作成する namespace。これは、デプロイ先の namespace と同じにする必要があります。

   2

   データベースノードの解決可能なホスト名です。

   3

   外部ポートのデフォルトは 5432 です。

   4

   変数 password の値には、デプロイ、バックアップ、または復元中の問題を回避するために、一重引用符 (')、二重引用符 (")、またはバックスラッシュ (\) を含めないでください。

   5

   変数 sslmode は、external データベースに対してのみ有効です。使用できる値は、prefer、disable、allow、require、verify-ca、および verify-full です。

2. oc create コマンドを使用して、external-postgres-configuration-secret.yml をクラスターに適用します。

   $ oc create -f external-postgres-configuration-secret.yml

   Copy to Clipboard Toggle word wrap

3. AutomationController カスタムリソースオブジェクトを作成するときは、以下の例に従って、仕様にシークレットを指定します。

   apiVersion: automationcontroller.ansible.com/v1beta1
   kind: AutomationController
   metadata:
     name: controller-dev
   spec:
     postgres_configuration_secret: external-postgres-configuration

   Copy to Clipboard Toggle word wrap

手順

1. データベースサーバーの /var/lib/pgsql/data/postgres.conf ファイルを編集します。

   # vi /var/lib/pgsql/data/postgres.conf

   Copy to Clipboard Toggle word wrap

2. 行を見つけ、コメントアウトします。

   #datestyle = 'Redwood, SHOW_TIME'

   Copy to Clipboard Toggle word wrap

3. 新たに調整した行のすぐ下に、以下の設定を追加します。

   datestyle = 'iso, mdy'

   Copy to Clipboard Toggle word wrap
4. postgres.conf ファイルを保存して閉じます。

5. データベース設定を再読み込みします。

   # systemctl reload postgresql

   Copy to Clipboard Toggle word wrap
   注記

   このコマンドを実行しても、データベース操作が中断されることはありません。

手順

1. デプロイメント namespace にある既存 PVC をリスト表示します。

   oc get pvc -n <namespace>

   Copy to Clipboard Toggle word wrap
2. 以前のデプロイメント名と PVC 名を比較して、以前のデプロイメントに関連付けられている PVC を特定します。

3. 以前の PVC を削除します。

   oc delete pvc -n <namespace> <pvc-name>

   Copy to Clipboard Toggle word wrap

手順

1. Operators → Installed Operators に移動します。
2. Automation hub エントリーを見つけて、Create instance をクリックします。
3. Form view をクリックします。
4. 新しいコントローラーの名前を入力します。
5. オプション: 必要なラベルを追加します。
6. Advanced configuration をクリックします。

7. PostgreSQL container storage requirements ドロップダウンメニューから、requests を選択します。

   1. ストレージ フィールドに "100Gi" と入力します。

8. PostgreSQL container resource requirements ドロップダウンメニューから、requests を選択します。

   1. cpu フィールドに 200 と入力します。
   2. memory フィールドに "512Mi" と入力します。

手順

1. Networking → Routes に移動します。
2. Location で、Automation Hub インスタンスの URL をクリックします。

1. 以下のテンプレートに従って、.yaml ファイル postgres_configuration_secret を作成します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: external-postgres-configuration
     namespace: <target_namespace> 

   1

   
   stringData:
     host: "<external_ip_or_url_resolvable_by_the_cluster>" 

   2

   
     port: "<external_port>" 

   3

   
     database: "<desired_database_name>"
     username: "<username_to_connect_as>"
     password: "<password_to_connect_with>" 

   4

   
     sslmode: "prefer" 

   5

   
     type: "unmanaged"
   type: Opaque

   Copy to Clipboard Toggle word wrap

   1

   シークレットを作成する namespace。これは、デプロイ先の namespace と同じにする必要があります。

   2

   データベースノードの解決可能なホスト名です。

   3

   外部ポートのデフォルトは 5432 です。

   4

   変数 password の値には、デプロイ、バックアップ、または復元中の問題を回避するために、一重引用符 (')、二重引用符 (")、またはバックスラッシュ (\) を含めないでください。

   5

   変数 sslmode は、external データベースに対してのみ有効です。使用できる値は、prefer、disable、allow、require、verify-ca、および verify-full です。

2. oc create コマンドを使用して、external-postgres-configuration-secret.yml をクラスターに適用します。

   $ oc create -f external-postgres-configuration-secret.yml

   Copy to Clipboard Toggle word wrap

3. AutomationHub カスタムリソースオブジェクトを作成するときは、以下の例に従って、仕様にシークレットを指定します。

   apiVersion: automationhub.ansible.com/v1beta1
   kind: AutomationHub
   metadata:
     name: hub-dev
   spec:
     postgres_configuration_secret: external-postgres-configuration

   Copy to Clipboard Toggle word wrap

手順

1. デプロイメント namespace にある既存 PVC をリスト表示します。

   oc get pvc -n <namespace>

   Copy to Clipboard Toggle word wrap
2. 以前のデプロイメント名と PVC 名を比較して、以前のデプロイメントに関連付けられている PVC を特定します。

3. 以前の PVC を削除します。

   oc delete pvc -n <namespace> <pvc-name>

   Copy to Clipboard Toggle word wrap

手順

1. Operator にプロジェクトを作成します。

   oc new-project ansible-automation-platform

   Copy to Clipboard Toggle word wrap
2. sub.yaml という名前のファイルを作成します。

3. 以下の YAML コードを sub.yaml ファイルに追加します。

   ---
   apiVersion: v1
   kind: Namespace
   metadata:
     labels:
       openshift.io/cluster-monitoring: "true"
     name: ansible-automation-platform
   ---
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: ansible-automation-platform-operator
     namespace: ansible-automation-platform
   spec:
     targetNamespaces:
       - ansible-automation-platform
   ---
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: ansible-automation-platform
     namespace: ansible-automation-platform
   spec:
     channel: 'stable-2.4'
     installPlanApproval: Automatic
     name: ansible-automation-platform-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
   ---
   apiVersion: automationcontroller.ansible.com/v1beta1
   kind: AutomationController
   metadata:
     name: example
     namespace: ansible-automation-platform
   spec:
     replicas: 1

   Copy to Clipboard Toggle word wrap

   このファイルは、ansible-automation-platform namespace を ansible-automation-platform-operator Operator にサブスクライブする ansible-automation-platform という Subscription オブジェクトを作成します。

   次に、ansible-automation-platform namespace に example という名前の AutomationController オブジェクトを作成します。

   example の Automation Controller 名を変更するには、sub.yaml の kind: AutomationController セクションの name フィールドを編集し、<automation_controller_name> を、使用する名前に置き換えます。

   apiVersion: automationcontroller.ansible.com/v1beta1
   kind: AutomationController
   metadata:
     name: <automation_controller_name>
     namespace: ansible-automation-platform

   Copy to Clipboard Toggle word wrap

4. oc apply コマンドを実行して、sub.yaml ファイルで指定されたオブジェクトを作成します。

   oc apply -f sub.yaml

   Copy to Clipboard Toggle word wrap

手順

1. Operator → Installed Operators に移動します。
2. rh-sso プロジェクトを選択します。
3. Red Hat Single Sign-On Operator を選択します。
4. Red Hat Single Sign-On Operator の詳細ページで、Keycloak を選択します。
5. Create instance をクリックします。

6. YAML ビュー をクリックします。

   デフォルトの Keycloak カスタムリソースは次のとおりです。

   apiVersion: keycloak.org/v1alpha1
   kind: Keycloak
   metadata:
     name: example-keycloak
     labels:
   	app: sso
     namespace: aap
   spec:
     externalAccess:
   	enabled: true
     instances: 1

   Copy to Clipboard Toggle word wrap
7. Create をクリックします。
8. デプロイメントが完了すると、この認証情報を使用して管理コンソールにログインできます。
9. 管理者の認証情報は、namespace の credential-<custom-resource> (keycloak の例) シークレットにあります。

手順

1. Operator → Installed Operators に移動します。
2. Red Hat Single Sign-On Operator プロジェクトを選択します。
3. Keycloak Realm タブを選択し、Create Keycloak Realm をクリックします。

4. Keycloak Realm フォームで、YAML view を選択します。YAML ファイルを次のように編集します。

   kind: KeycloakRealm
   apiVersion: keycloak.org/v1alpha1
   metadata:
     name: ansible-automation-platform-keycloakrealm
     namespace: rh-sso
     labels:
       app: sso
       realm: ansible-automation-platform
   spec:
     realm:
       id: ansible-automation-platform
       realm: ansible-automation-platform
       enabled: true
       displayName: Ansible Automation Platform
     instanceSelector:
       matchLabels:
         app: sso

   Copy to Clipboard Toggle word wrap
   Expand

   フィールド	説明
   metadata.name	設定リソース (CR) の名前のメタデータに一意の値を設定します。
   metadata.namespace	設定リソース (CR) の名前のメタデータに一意の値を設定します。
   metadata.labels.app	ラベルを一意の値に設定します。これは、クライアント CR を作成するときに使用されます。
   metadata.labels.realm	ラベルを一意の値に設定します。これは、クライアント CR を作成するときに使用されます。
   spec.realm.id	レルム名と ID を設定します。同じものを設定する必要があります。
   spec.realm.realm	レルム名と ID を設定します。同じものを設定する必要があります。
   spec.realm.displayname	表示する名前を設定します。

   Show more
5. Create をクリックし、プロセスが完了するまで待ちます。

手順

1. Operator → Installed Operators に移動します。
2. Red Hat Single Sign-On Operator プロジェクトを選択します。
3. Keycloak Client タブを選択し、Create Keycloak Client をクリックします。
4. Keycloak Realm フォームで、YAML view を選択します。

5. デフォルトの YAML ファイルを次のものに置き換えます。

   kind: KeycloakClient
   apiVersion: keycloak.org/v1alpha1
   metadata:
     name: automation-hub-client-secret
     labels:
       app: sso
       realm: ansible-automation-platform
     namespace: rh-sso
   spec:
     realmSelector:
       matchLabels:
         app: sso
         realm: ansible-automation-platform
     client:
       name: Automation Hub
       clientId: automation-hub
       secret: <client-secret>                        

   1

   
       clientAuthenticatorType: client-secret
       description: Client for automation hub
       attributes:
         user.info.response.signature.alg: RS256
         request.object.signature.alg: RS256
       directAccessGrantsEnabled: true
       publicClient: true
       protocol: openid-connect
       standardFlowEnabled: true
       protocolMappers:
         - config:
             access.token.claim: "true"
             claim.name: "family_name"
             id.token.claim: "true"
             jsonType.label: String
             user.attribute: lastName
             userinfo.token.claim: "true"
           consentRequired: false
           name: family name
           protocol: openid-connect
           protocolMapper: oidc-usermodel-property-mapper
         - config:
             userinfo.token.claim: "true"
             user.attribute: email
             id.token.claim: "true"
             access.token.claim: "true"
             claim.name: email
             jsonType.label: String
           name: email
           protocol: openid-connect
           protocolMapper: oidc-usermodel-property-mapper
           consentRequired: false
         - config:
             multivalued: "true"
             access.token.claim: "true"
             claim.name: "resource_access.${client_id}.roles"
             jsonType.label: String
           name: client roles
           protocol: openid-connect
           protocolMapper: oidc-usermodel-client-role-mapper
           consentRequired: false
         - config:
             userinfo.token.claim: "true"
             user.attribute: firstName
             id.token.claim: "true"
             access.token.claim: "true"
             claim.name: given_name
             jsonType.label: String
           name: given name
           protocol: openid-connect
           protocolMapper: oidc-usermodel-property-mapper
           consentRequired: false
         - config:
             id.token.claim: "true"
             access.token.claim: "true"
             userinfo.token.claim: "true"
           name: full name
           protocol: openid-connect
           protocolMapper: oidc-full-name-mapper
           consentRequired: false
         - config:
             userinfo.token.claim: "true"
             user.attribute: username
             id.token.claim: "true"
             access.token.claim: "true"
             claim.name: preferred_username
             jsonType.label: String
           name: <username>
           protocol: openid-connect
           protocolMapper: oidc-usermodel-property-mapper
           consentRequired: false
         - config:
             access.token.claim: "true"
             claim.name: "group"
             full.path: "true"
             id.token.claim: "true"
             userinfo.token.claim: "true"
           consentRequired: false
           name: group
           protocol: openid-connect
           protocolMapper: oidc-group-membership-mapper
         - config:
             multivalued: 'true'
             id.token.claim: 'true'
             access.token.claim: 'true'
             userinfo.token.claim: 'true'
             usermodel.clientRoleMapping.clientId:  'automation-hub'
             claim.name: client_roles
             jsonType.label: String
           name: client_roles
           protocolMapper: oidc-usermodel-client-role-mapper
           protocol: openid-connect
         - config:
             id.token.claim: "true"
             access.token.claim: "true"
             included.client.audience: 'automation-hub'
           protocol: openid-connect
           name: audience mapper
           protocolMapper: oidc-audience-mapper
     roles:
       - name: "hubadmin"
         description: "An administrator role for automation hub"

   Copy to Clipboard Toggle word wrap

   1

   これを一意の値に置き換えます。

6. Create をクリックし、プロセスが完了するまで待ちます。

手順

1. Operator → Installed Operators に移動します。
2. Red Hat Single Sign-On Operator プロジェクトを選択します。
3. Keycloak Realm タブを選択し、Create Keycloak User をクリックします。
4. Keycloak User フォームで、YAML view を選択します。

5. デフォルトの YAML ファイルを次のものに置き換えます。

   apiVersion: keycloak.org/v1alpha1
   kind: KeycloakUser
   metadata:
     name: hubadmin-user
     labels:
       app: sso
       realm: ansible-automation-platform
     namespace: rh-sso
   spec:
     realmSelector:
       matchLabels:
         app: sso
         realm: ansible-automation-platform
     user:
       username: hub_admin
       firstName: Hub
       lastName: Admin
       email: hub_admin@example.com
       enabled: true
       emailVerified: false
       credentials:
         - type: password
           value: <ch8ngeme>
       clientRoles:
         automation-hub:
           - hubadmin

   Copy to Clipboard Toggle word wrap
6. Create をクリックし、プロセスが完了するまで待ちます。

手順

1. https://<sso_host>/auth/realms/ansible-automation-platform に移動します。
2. public_key 値をコピーします。
3. OpenShift Web UI で、Workloads → Secrets に移動します。
4. ansible-automation-platform プロジェクトを選択します。
5. Create をクリックし、From YAML を選択します。

6. 次の YAML を編集してシークレットを作成します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: automation-hub-sso                       

   1

   
     namespace: ansible-automation-platform
   type: Opaque
   stringData:
     keycloak_host: "keycloak-rh-sso.apps-crc.testing"
     keycloak_port: "443"
     keycloak_protocol: "https"
     keycloak_realm: "ansible-automation-platform"
     keycloak_admin_role: "hubadmin"
     social_auth_keycloak_key: "automation-hub"
     social_auth_keycloak_secret: "client-secret"   

   2

   
     social_auth_keycloak_public_key: >-            

   3

   Copy to Clipboard Toggle word wrap

   1

   この名前は、Automation Hub インスタンスを作成する際の次のステップで使用されます。

   2

   Automation Hub 用の Keycloak クライアントを作成するときにシークレットが変更した場合は、必ずこの値を変更して一致させます。

   3

   Ansible Automation Platform Operator デプロイメントの public_key の値を入力します。

7. Create をクリックし、プロセスが完了するまで待ちます。

手順

1. Operator → Installed Operators に移動します。
2. Ansible Automation Platform Operator のデプロイメントを選択します。
3. Automation Hub タブを選択します。
4. Create Automation hub をクリックします。

5. YAML view を選択します。YAML は次のようになります。

   apiVersion: automationhub.ansible.com/v1beta1
   kind: AutomationHub
   metadata:
     name: private-ah                              

   1

   
     namespace: aap
   spec:
     sso_secret: automation-hub-sso                

   2

   
     pulp_settings:
       verify_ssl: false
     route_tls_termination_mechanism: Edge
     ingress_type: Route
     loadbalancer_port: 80
     file_storage_size: 100Gi
     image_pull_policy: IfNotPresent
     replicas: 1                                   

   3

   
     web_replicas: N
     task_replicas: N
     file_storage_access_mode: ReadWriteMany
     content:
       log_level: INFO
       replicas: 2
     postgres_storage_requirements:
       limits:
         storage: 50Gi
       requests:
         storage: 8Gi
     api:
       log_level: INFO
       replicas: 1
     postgres_resource_requirements:
       limits:
         cpu: 1000m
         memory: 8Gi
       requests:
         cpu: 500m
         memory: 2Gi
     loadbalancer_protocol: http
     resource_manager:
       replicas: 1
     worker:
       replicas: 2

   Copy to Clipboard Toggle word wrap

   1

   インスタンスに使用する名前に metadata.name を設定します。

   2

   spec.sso_secret を、Red Hat Single Sign On 接続の詳細を保持するためにシークレットを作成 で作成したシークレットの名前に設定します。

   3

   web_replicas または task_replicas をそれぞれ使用して、デプロイメントごとにレプリカをスケールアップまたはスケールダウンします。ここで、N は作成するレプリカの数を表します。あるいは、replicas を使用して、両方のデプロイメントにわたってすべての Pod をスケーリングすることもできます。詳細は、Scaling the Web and Task Pods independently を参照してください。

   注記

   この YAML は SSL 検証をオフにします (ssl_verify: false)。OpenShift に自己署名証明書を使用していない場合は、この設定を削除できます。

6. Create をクリックし、プロセスが完了するまで待ちます。

手順

1. Red Hat OpenShift Container Platform にログインします。
2. Home → Search に移動します。
3. Resources ドロップダウンリストを選択し、Image と入力します。
4. Image (config,openshift.io/v1) を選択します。
5. Name の見出しの下にある Cluster をクリックします。
6. YAML タブを選択します。

7. 次のように spec value の下に貼り付けます。

   spec:
     registrySources:
       allowedRegistries:
       - quay.io
       - registry.redhat.io
       - image-registry.openshift-image-registry.svc:5000
       - <OCP route for your automation hub>

   Copy to Clipboard Toggle word wrap
8. Save をクリックします。

手順

1. Networking → Routes に移動します。
2. インストールに使用したプロジェクトを選択します。
3. private-ah-web-svc サービスの場所をコピーします。Automation Hub インスタンスの作成時に別の名前を使用した場合は、サービスの名前が異なります。これは、後で Red Hat Single Sign-On クライアントを更新するために使用されます。

手順

1. Operator → Installed Operators に移動します。
2. RH-SSO プロジェクトを選択します。
3. Red Hat Single Sign-On Operator をクリックします。
4. Keycloak Client を選択します。
5. automation-hub-client-secret client クライアントをクリックします。
6. YAML を選択します。

7. クライアント YAML を更新して、Valid Redirect URIs 設定と Web Origins 設定を追加します。

   redirectUris:
     - 'https://private-ah-ansible-automation-platform.apps-crc.testing/*'
   webOrigins:
     - 'https://private-ah-ansible-automation-platform.apps-crc.testing'

   Copy to Clipboard Toggle word wrap
   Expand

   フィールド	説明
   redirectURIs	これは、Automation Hub ルートの決定 で決定されたロケーションです。/* を redirectUris 設定の末尾に必ず追加してください。
   webOrigins	これは、Automation Hub ルートの決定 で決定されたロケーションです。

   Show more
   注記

   これらの設定を入力するときは、インデントが正しいことを確認してください。

8. Save をクリックします。

接続を確認するには

1. Automation Hub ルートに移動します。
2. hub_admin ユーザー認証情報を入力してサインインします。
3. Red Hat Single Sign-On は認証を処理し、Automation Hub にリダイレクトします。

手順

1. OpenShift Container Platform にログインします。
2. Operators → Installed Operators に移動します。
3. Subscriptions タブを選択します。
4. Upgrade status で、Upgrade Available をクリックします。
5. Preview InstallPlan をクリックします。
6. Approve をクリックします。

1. ナビゲーションパネルから、Access → Users を選択します。
2. トークンを作成するユーザー名を選択します。
3. Tokens をクリックし、Add をクリックします。
4. Applications は空のままにしておくことができます。説明を追加し、Scope に Read または Write を選択します。

手順

1. 以下は、接続シークレットの YAML の例です。次の例をファイル (例: automation-controller-connection-secret.yml) に保存します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: controller-access
     type: Opaque
   stringData:
     token: <generated-token>
     host: https://my-controller-host.example.com/

   Copy to Clipboard Toggle word wrap
2. ホストとトークンの値を使用してファイルを編集します。
3. kubectl create コマンドを実行して、これをクラスターに適用します。

手順

1. 起動する接続シークレットとジョブテンプレートを指定します。

   apiVersion: tower.ansible.com/v1alpha1
   kind: AnsibleJob
   metadata:
     generateName: demo-job-1 # generate a unique suffix per 'kubectl create'
   spec:
     connection_secret: controller-access
     job_template_name: Demo Job Template

   Copy to Clipboard Toggle word wrap

2. インベントリー、追加変数、ジョブの有効期間などの機能を設定します。

   spec:
     connection_secret: controller-access
     job_template_name: Demo Job Template
     inventory: Demo Inventory                    # Inventory prompt on launch needs to be enabled
     runner_image: quay.io/ansible/controller-resource-runner
     runner_version: latest
     job_ttl: 100
     extra_vars:                                  # Extra variables prompt on launch needs to be enabled
        test_var: test
     job_tags: "provision,install,configuration"  # Specify tags to run
     skip_tags: "configuration,restart"           # Skip tasks with a given tag

   Copy to Clipboard Toggle word wrap
   注記

   インベントリーや追加変数を設定する場合は、起動時にプロンプトを有効にする必要があります。Prompt on launch を有効にするには、Automation Controller UI 内で、Resources → Templates ページでテンプレートを選択し、Inventory セクションと Variables セクションの横にある Prompt on launch チェックボックスをオンにします。

3. job_template_name の代わりに workflow_template_name を指定して、AnsibleJob オブジェクトでワークフロージョブテンプレートを起動します。

   apiVersion: tower.ansible.com/v1alpha1
   kind: AnsibleJob
   metadata:
     generateName: demo-job-1 # generate a unique suffix per 'kubectl create'
   spec:
     connection_secret: controller-access
     workflow_template_name: Demo Workflow Template

   Copy to Clipboard Toggle word wrap