Red Hat Developer Hub の Orchestrator

手順

1. デフォルト設定で Orchestrator プラグインを有効にするには、パッケージに disabled: false を設定します。たとえば、package: "@redhat/backstage-plugin-orchestrator@<plugin_version> が disabled: false に設定されている場合:

   - package: "@redhat/backstage-plugin-orchestrator@<plugin_version>"
     disabled: false

   注記

   プラグインを有効にすると、事前に読み込まれたプラグイン設定が使用されます。さらに、ref: sonataflow フィールドは Openshift Serverless および Openshift Serverless Logic リソースをインストールします。これは、Operator の使用時に自動的に実行されます。

   例: Orchestrator プラグインの完全な設定

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: orchestrator-plugin
   data:
       dynamic-plugins.yaml: |
         includes:
           - dynamic-plugins.default.yaml
         plugins:
           - package: "@redhat/backstage-plugin-orchestrator@1.7.1"
             disabled: false
             pluginConfig:
               dynamicPlugins:
                   frontend:
                     red-hat-developer-hub.backstage-plugin-orchestrator:
                       appIcons:
                         - importName: OrchestratorIcon
                           name: orchestratorIcon
                       dynamicRoutes:
                         - importName: OrchestratorPage
                           menuItem:
                             icon: orchestratorIcon
                             text: Orchestrator
                           path: /orchestrator
                       entityTabs:
                         - path: /workflows
                           title: Workflows
                           mountPoint: entity.page.workflows
                       mountPoints:
                         - mountPoint: entity.page.workflows/cards
                         importName: OrchestratorCatalogTab
                         config:
                           layout:
                             gridColumn: '1 / -1'
                             if:
                               anyOf:
                                 - IsOrchestratorCatalogTabAvailable
           - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.7.1"
             disabled: false
             pluginConfig:
               orchestrator:
                 dataIndexService:
                   url: http://sonataflow-platform-data-index-service
             dependencies:
               - ref: sonataflow
           - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.7.1"
             disabled: false
             pluginConfig:
               orchestrator:
                 dataIndexService:
                   url: http://sonataflow-platform-data-index-service
           - package: "@redhat/backstage-plugin-orchestrator-form-widgets@1.7.1"
             disabled: false
             pluginConfig:
               dynamicPlugins:
                 frontend:
                   red-hat-developer-hub.backstage-plugin-orchestrator-form-widgets: { }
   ---
   apiVersion: rhdh.redhat.com/v1alpha3
   kind: Backstage
   metadata:
     name: orchestrator
   spec:
     application:
       appConfig:
         configMaps:
           - name: app-config-rhdh
       dynamicPluginsConfigMapName: orchestrator-plugin

2. 次の例に示すように、BACKEND_SECRET 値を含むシークレットを作成します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: app-config-rhdh
   data:
     app-config.yaml: |-
       auth:
         environment: development
         providers:
           guest:
             # using the guest user to query the '/api/dynamic-plugins-info/loaded-plugins' endpoint.
             dangerouslyAllowOutsideDevelopment: true
       backend:
         auth:
           externalAccess:
             - type: static
               options:
                 token: ${BACKEND_SECRET}
                 subject: orchestrator
   ---
   apiVersion: v1
   kind: Secret
   metadata:
     name: backend-auth-secret
   stringData:
     # generated with the command below (from https://backstage.io/docs/auth/service-to-service-auth/#setup):
     # node -p 'require("crypto").randomBytes(24).toString("base64")'
     # notsecret
     BACKEND_SECRET: "R2FxRVNrcmwzYzhhN3l0V1VRcnQ3L1pLT09WaVhDNUEK"

3. 次の例のように、Backstage CR を設定して、extraEnvs フィールドのシークレット名を更新します。

   apiVersion: rhdh.redhat.com/v1alpha4
   kind: Backstage
   metadata:
     name: orchestrator
   spec:
     application:
       appConfig:
         configMaps:
           - name: app-config-rhdh
       dynamicPluginsConfigMapName: orchestrator-plugin
       extraEnvs:
         secrets:
             # secret that contains the BACKEND_SECRET key
           - name: backend-auth-secret

手順

1. Operator のインストール計画を手動で承認します。インストールを承認するには、出力に示された oc patch installplan コマンドを実行する必要があります。

1. 管理者として、関連するクラスター全体のリソースをインストールします。

   helm repo add openshift-helm-charts https://charts.openshift.io/
   helm install <release_name> openshift-helm-charts/redhat-developer-hub-orchestrator-infra

   重要

   redhat-developer-hub-orchestrator-infra Helm チャートは追加のクラスタースコープの OpenShift Serverless および OpenShift Serverless Logic Operator をデプロイするため、これをインストールするには管理者である必要があります。管理者は、OpenShift Serverless および Serverless Logic Operator のインストールプランを手動で承認する必要があります。

2. 以下の例のように、オーケストレーターを有効にして Backstage チャートをインストールします。

   $ helm install <release_name> openshift-helm-charts/redhat-developer-hub --version 1.7.3 \
     --set orchestrator.enabled=true

3. (オプション) 次の例に示すように、values.yaml ファイルの global.dynamic.plugins リストに Notifications と Signals プラグインを追加して有効にします。

   global:
     dynamic:
       plugins:
         - disabled: false
           package: "./dynamic-plugins/dist/backstage-plugin-notifications"
         - disabled: false
           package: "./dynamic-plugins/dist/backstage-plugin-signals"
         - disabled: false
           package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic"
         - disabled: false
           package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"

4. (オプション) 次の例に示すように、値を false に設定し、Serverless Logic と Serverless Operator を個別または一緒に無効にできます。

   helm install <release_name> openshift-helm-charts/redhat-developer-hub \
     --version 1.7.3 \
     --set orchestrator.enabled=true \
     --set orchestrator.serverlessOperator=false \
     --set orchestrator.serverlessLogicOperator=false

5. (オプション) 外部データベースを使用している場合は、values.yaml ファイルの orchestrator.sonataflowPlatform の下に次の設定を追加します。

   orchestrator:
     sonataflowPlatform:
       externalDBsecretRef: "<cred-secret>"
       externalDBName: "<database_name>" # The name of the user-configured existing database (Not the database that the orchestrator and sonataflow resources use).
       externalDBHost: "<database_host>"
       externalDBPort: "<database_port>"

   注記

   この手順では、Orchestrator による外部データベースの使用のみを設定します。外部 PostgreSQL インスタンスを使用するように Red Hat Developer Hub を設定するには、Helm を使用して PostgreSQL インスタンスを設定する の手順に従います。

検証

1. Orchestrator プラグインが Red Hat Developer Hub UI に表示されていることを確認します。
2. サンプルワークフローを作成して実行し、オーケストレーションが正しく機能していることを確認します。

手順

1. OpenShift Container Platform Web コンソールで、Helm Charts に移動し、Red Hat Developer Hub Helm チャートリポジトリーが利用可能であることを確認します。

2. Red Hat Developer Hub の Orchestrator インフラストラクチャーを検索し、Install を選択します。

   重要

   Orchestrator Infrastructure for Red Hat Developer Hub Helm チャートはクラスタースコープのリソースをデプロイするため、インストールするには管理者である必要があります。管理者は、OpenShift Serverless および Serverless Logic Operator のインストールプランを手動で承認する必要があります。

   通常のユーザーとして、Red Hat Developer Hub チャートを検索し、orchestrator.enabled の値を true に設定してインストールします。それ以外の場合は、Orchestrator はデプロイされません。

3. 正常にデプロイされるまで待ちます。
4. Pod またはリリースに移動してデプロイメントステータスを監視します。

1. デフォルトのリソース制限

1. これらの値は、以下のいずれかの方法でオーバーライドできます。

   • values.yaml の使用
   • --set フラグの使用

2. オーバーライドは、次の例に示すように、values.yaml をデフォルトとします。

   orchestrator:
     enabled: true
     sonataflowPlatform:
     resources:
         limits:
           cpu: "500m"
           memory: "1Gi"

3. 次の例に示すように、--set でオーバーライドします。

   helm upgrade --install <release_name>  openshift-helm-charts/redhat-developer-hub \
     --set orchestrator.enabled=true \
     --set orchestrator.sonataflowPlatform.resources.requests.cpu=500m \
     --set orchestrator.sonataflowPlatform.resources.requests.memory=128Mi \
     --set orchestrator.sonataflowPlatform.resources.limits.cpu=1 \
     --set orchestrator.sonataflowPlatform.resources.limits.memory=2Gi

   注記

   --set 設定は、orchestrator.enabled が true の場合にのみ適用されます。デフォルトでは false に設定されます。

手順

1. Red Hat OpenShift Serverless ドキュメント の手順に従って、OpenShift Serverless コンポーネントを手動でインストールします。
2. また、Pod の再起動時にワークフローのコンテキストが失われないように、ワークフローの永続性を設定する必要もあります。この設定は、SonataFlowPlatform または SonataFlow カスタムリソース (CR) を使用して namespace レベルで実行できます。SonataFlowPlatform または SonataFlow カスタムリソースを使用して永続性を設定する詳細な手順は、ワークフローの永続性の管理 を参照してください。
3. (オプション) 必要に応じて、カスタム PostgreSQL データベースをデプロイします。

手順

1. oc-mirror の ImageSetConfiguration ファイルを作成します。oc-mirror は、すべてのイメージを自動的にミラーリングしないため、Serverless Logic Operator に必要なイメージと Operator を ImageSetConfiguration ファイルに含める必要があります。次のサンプルを使用してください。

   apiVersion: mirror.openshift.io/v2alpha1
   kind: ImageSetConfiguration
   mirror:
     additionalimages:
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:1.36.0
     operators:
       - catalog: registry.redhat.io/redhat/redhat-operator-index:4.19
         # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19
         packages:
         - name: logic-operator-rhel8
           channels:
           - name: alpha
             minVersion: 1.36.0
             maxVersion: 1.36.0
         - name: serverless-operator
           channels:
           - name: stable
             minVersion: 1.36.0
             maxVersion: 1.36.1

   または、podman コマンドを使用して、不足しているイメージを見つけて、バージョンが変更された場合はそのイメージを additionalimages リストに追加することもできます。

   IMG=registry.redhat.io/openshift-serverless-1/logic-operator-bundle:1.36
   mkdir local-manifests-osl
   podman create --name temp-container "$IMG" -c "cat /manifests/logic-operator-rhel8.clusterserviceversion.yaml"
   podman cp temp-container:/manifests ./local-manifests-osl
   podman rm temp-container
   yq -r '.data."controllers_cfg.yaml" | from_yaml | .. | select(tag == "!!str") | select(test("^.\\/.:.*$"))' ./local-manifests-osl/manifests/logic-operator-rhel8-controllers-config_v1_configmap.yaml

2. oc-mirror コマンドを実行して、ImageSetConfiguration.yaml ファイル内のイメージをミラーリングします。以下に例を示します。

   oc-mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile  --v2

   注記

   oc-mirror コマンドは、ミラーアーカイブファイルと必要なクラスターマニフェストを含むローカルワークスペースを生成します。

3. /path/to/mirror-archive で指定されたディレクトリーを、非接続環境内の踏み台ホストに転送します。

4. ミラーレジストリーにアクセスできる踏み台ホストから、ディスクディレクトリーのイメージをターゲットレジストリーにミラーリングします。以下に例を示します。

   oc-mirror --v2 --from <mirror-archive-file> docker://<target-registry-url:port> --workspace file://<workspace folder> --authfile /path/to/authfile

   ここでは、以下のようになります。

   <mirror-archive-file>

   転送された tar ファイルの名前を入力します。

   <target-registry-url:port>

   ローカルレジストリーを入力します (例: registry.localhost:5000)。

5. 次の例に示すように、プッシュステップ中に生成されたクラスター全体のリソースを適用して、すべてのイメージプルをローカルレジストリーにリダイレクトします。

   cd <workspace folder>/working-dir/cluster-resources/
   oc apply -f .

6. 以下のいずれかの方法を使用して、オーケストレーター 1.7.1 の Node Package Manager (NPM)パッケージをダウンロードします。

   • 次のレジストリーから tgz ファイルとしてダウンロードします。

     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-1.7.1.tgz

   • または、次の例に示すように Red Hat NPM registry からの NPM パッケージを使用します。

     npm pack "@redhat/backstage-plugin-orchestrator@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.7.1 --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-form-widgets@1.7.1" --registry=https://npm.registry.redhat.com

7. 次の例に示すように、ダウンロードした NPM パッケージを NPM サーバーにプッシュします。

   npm publish backstage-plugin-orchestrator-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-form-widgets-1.7.1.tgz
   npm publish backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz

8. OperatorHub を使用して OpenShift Serverless Operator と OpenShift Serverless Logic Operator をインストールします。
9. Backstage カスタムリソース (CR) を作成します。

10. Operator インストールの Orchestrator プラグインの依存関係 の説明に従って、Orchestrator の Backstage CR を設定します。

    すべてのリソースを作成し、それに応じて Backstage インスタンスを設定します。RHDH でカスタム NPM レジストリーを参照する方法は、カスタム NPM レジストリーの設定 を参照してください。

手順

1. oc-mirror の ImageSetConfiguration ファイルを作成します。oc-mirror は、すべてのイメージを自動的にミラーリングしないため、Serverless Logic Operator に必要なイメージと Operator を ImageSetConfiguration ファイルに含める必要があります。次のサンプルを使用してください。

   apiVersion: mirror.openshift.io/v2alpha1
   kind: ImageSetConfiguration
   mirror:
     additionalimages:
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:1.36.0
     operators:
       - catalog: registry.redhat.io/redhat/redhat-operator-index:4.19
         # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19
         packages:
         - name: logic-operator-rhel8
           channels:
           - name: alpha
             minVersion: 1.36.0
             maxVersion: 1.36.0
         - name: serverless-operator
           channels:
           - name: stable
             minVersion: 1.36.0
             maxVersion: 1.36.1

   または、podman コマンドを使用して不足しているイメージを見つけ、バージョンが変更された場合はそのイメージを additionalimages リストに追加することもできます。

   IMG=registry.redhat.io/openshift-serverless-1/logic-operator-bundle:1.36.0-8
   mkdir local-manifests-osl
   podman create --name temp-container "$IMG" -c "cat /manifests/logic-operator-rhel8.clusterserviceversion.yaml"
   podman cp temp-container:/manifests ./local-manifests-osl
   podman rm temp-container
   yq -r '.data."controllers_cfg.yaml" | from_yaml | .. | select(tag == "!!str") | select(test("^.\\/.:.*$"))' ./local-manifests-osl/manifests/logic-operator-rhel8-controllers-config_v1_configmap.yaml

2. oc-mirror コマンドを実行して、ImageSetConfiguration.yaml ファイル内のイメージをミラーリングします。以下に例を示します。

   oc-mirror --config=imagesetconfiguration.yaml docker://<registry URL:port> --workspace file://<workspace folder> --authfile /path/to/authfile  --v2
   cd <workspace folder>/working-dir/cluster-resources/
   oc apply -f .

3. 以下のいずれかの方法を使用して、オーケストレーター 1.7.1 の Node Package Manager (NPM)パッケージをダウンロードします。

   • 次のレジストリーから tgz ファイルとしてダウンロードします。

     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-1.7.1.tgz

   • または、次の例に示すように Red Hat NPM registry からの NPM パッケージを使用します。

     npm pack "@redhat/backstage-plugin-orchestrator@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.7.1 --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-form-widgets@1.7.1" --registry=https://npm.registry.redhat.com

4. 次の例に示すように、ダウンロードした NPM パッケージを NPM サーバーにプッシュします。

   npm publish backstage-plugin-orchestrator-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-form-widgets-1.7.1.tgz
   npm publish backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz

5. OperatorHub を使用して OpenShift Serverless Operator と OpenShift Serverless Logic Operator をインストールします。
6. Backstage カスタムリソース (CR) を作成します。

7. Operator インストールの Orchestrator プラグインの依存関係 の説明に従って、Orchestrator の Backstage CR を設定します。

   すべてのリソースを作成し、それに応じて Backstage インスタンスを設定します。RHDH でカスタム NPM レジストリーを参照する方法は、カスタム NPM レジストリーの設定 を参照してください。

手順

1. oc-mirror 用の ImageSetConfiguration.yaml ファイルを作成します。次の例に示すように、Serverless Logic Operator に必要なすべてのミラーリングされたイメージを含めるには、ImageSetConfiguration ファイルを使用する必要があります。

   apiVersion: mirror.openshift.io/v2alpha1
   kind: ImageSetConfiguration
   mirror:
     additionalimages:
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:1.36.0
   
     helm:
       repositories:
         - name: openshift-charts
           url: https://charts.openshift.io
           charts:
             - name: redhat-developer-hub
               version: "1.7.3"
             - name: redhat-developer-hub-orchestrator-infra
               version: "1.7.3"
     operators:
       - catalog: registry.redhat.io/redhat/redhat-operator-index:4.19
         # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19
         packages:
         - name: logic-operator-rhel8
           channels:
           - name: alpha
             minVersion: 1.36.0
             maxVersion: 1.36.0
         - name: serverless-operator
           channels:
           - name: stable
             minVersion: 1.36.0
             maxVersion: 1.36.1

   または、podman コマンドを使用して、不足しているイメージを見つけて、バージョンが変更された場合はそのイメージを additionalimages リストに追加することもできます。

   IMG=registry.redhat.io/openshift-serverless-1/logic-operator-bundle:1.36
   mkdir local-manifests-osl
   podman create --name temp-container "$IMG" -c "cat /manifests/logic-operator-rhel8.clusterserviceversion.yaml"
   podman cp temp-container:/manifests ./local-manifests-osl
   podman rm temp-container
   yq -r '.data."controllers_cfg.yaml" | from_yaml | .. | select(tag == "!!str") | select(test("^.\\/.:.*$"))' ./local-manifests-osl/manifests/logic-operator-rhel8-controllers-config_v1_configmap.yaml

2. oc-mirror コマンドを実行して、ImageSetConfiguration.yaml ファイル内のイメージをミラーリングします。以下に例を示します。

   oc-mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile  --v2

   注記

   oc-mirror コマンドは、ImageSetConfiguration ファイルにリストされているチャートをプルし、/path/to/mirror-archive ディレクトリーの下の tgz アーカイブとして使用できるようにします。

3. 次の例に示すように、プッシュステップ中に生成されたクラスター全体のリソースを適用して、すべてのイメージプルをローカルレジストリーにリダイレクトします。

   cd <workspace folder>/working-dir/cluster-resources/
   oc apply -f .

4. 生成されたミラーアーカイブファイル (例: /path/to/mirror-archive/mirror_000001.tar) を、非接続環境内の踏み台ホストに転送します。

5. ミラーレジストリーにアクセスできる、非接続環境の踏み台ホストから、アーカイブファイルのイメージをターゲットレジストリーにミラーリングします。以下に例を示します。

   oc-mirror --v2 --from <mirror-archive-file> docker://<target-registry-url:port> --workspace file://<workspace folder> --authfile /path/to/authfile

   ここでは、以下のようになります。

   <mirror-archive-file>

   転送された tar ファイルの名前を入力します。

   <target-registry-url:port>

   ローカルレジストリーを入力します (例: registry.localhost:5000)。

6. 以下のいずれかの方法を使用して、オーケストレーター 1.7.1 の Node Package Manager (NPM)パッケージをダウンロードします。

   • 次のレジストリーから tgz ファイルとしてダウンロードします。

     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-1.7.1.tgz

   • または、次の例に示すように Red Hat NPM registry からの NPM パッケージを使用します。

     npm pack "@redhat/backstage-plugin-orchestrator@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.7.1 --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-form-widgets@1.7.1" --registry=https://npm.registry.redhat.com

7. 次の例に示すように、ダウンロードした NPM パッケージを NPM サーバーにプッシュします。

   npm publish backstage-plugin-orchestrator-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-form-widgets-1.7.1.tgz
   npm publish backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz

8. redhat-developer-hub-orchestrator-infra Helm チャートを適用し、インストールプランを承認します。詳細は、Helm チャートを使用したエアギャップインストールの手順 を参照してください。

9. RHDH 1.7 Helm チャートを適用します。以下の例のように、バージョン 1.7.3 を含め、Orchestrator プラグインを有効にします。

   orchestrator.enabled=true

10. RHDH 1.7 Helm チャートは、完全な URL 参照を使用して、公式の Red Hat NPM レジストリーから Orchestrator プラグインをプルすることをデフォルトとしています。ローカルレジストリーを指すようにこの動作をオーバーライドする必要があります。

    カスタムレジストリーを使用するように Orchestrator プラグインを設定するには、次の手順を実行します。

    • values.yaml ファイルを開きます。

    • Orchestrator. plugins セクションで Orchestrator プラグインパッケージを 一覧表示します。次の例に示すように、簡略化されたパッケージ参照を、カスタム NPM レジストリーを指す完全な URL に置き換える必要があります。

      orchestrator:
        plugins:
          - disabled: false
            package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz
            integrity: sha512-xxxxxx
          - disabled: false
            package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-{product-bundle-version}.tgz
            integrity: sha512-xxxxxy
          - disabled: false
            package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz
            integrity: sha512-xxxxxz
          - disabled: false
            package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz
            integrity: sha512-xxxx1

      ここでは、以下のようになります。

      <custom_NPM_registry_URL>

      カスタムレジストリーのアドレスを入力し、sha512-xxxxxx などの整合性チェックサムがレジストリー内のファイルと一致していることを確認します。

手順

1. oc-mirror の ImageSetConfiguration ファイルを作成します。oc-mirror は、すべてのイメージを自動的にミラーリングしないため、Serverless Logic Operator に必要なイメージと Operator を ImageSetConfiguration ファイルに含める必要があります。次のサンプルを使用してください。

   apiVersion: mirror.openshift.io/v2alpha1
   kind: ImageSetConfiguration
   mirror:
     additionalimages:
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:1.36.0
     - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:1.36.0
   
     helm:
       repositories:
         - name: openshift-charts
           url: https://charts.openshift.io
           charts:
             - name: redhat-developer-hub
               version: "1.7.3"
             - name: redhat-developer-hub-orchestrator-infra
               version: "1.7.3"
     operators:
       - catalog: registry.redhat.io/redhat/redhat-operator-index:4.19
         # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19
         packages:
         - name: logic-operator-rhel8
           channels:
           - name: alpha
             minVersion: 1.36.0
             maxVersion: 1.36.0
         - name: serverless-operator
           channels:
           - name: stable
             minVersion: 1.36.0
             maxVersion: 1.36.1

2. oc-mirror コマンドを実行してイメージとチャートをプルし、イメージをターゲットレジストリーに直接プッシュすることで、ImageSetConfiguration.yaml ファイル内のイメージをミラーリングします。以下に例を示します。

   oc-mirror --config=imagesetconfiguration.yaml docker://<registry URL:port> --workspace file://<workspace folder> --authfile /path/to/authfile  --v2

   注記

   oc-mirror コマンドは、ImageSetConfiguration ファイルにリストされているチャートをプルし、<workspace folder> ディレクトリーの下に tgz アーカイブとして使用できるようにします。

3. 生成されたクラスターリソースを非接続クラスターに適用します。以下に例を示します。

   cd <workspace folder>/working-dir/cluster-resources/
   oc apply -f .

4. 以下のいずれかの方法を使用して、オーケストレーター 1.7.1 の Node Package Manager (NPM)パッケージをダウンロードします。

   • 次のレジストリーから tgz ファイルとしてダウンロードします。

     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz
     • https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-1.7.1.tgz

   • または、次の例に示すように Red Hat NPM registry からの NPM パッケージを使用します。

     npm pack "@redhat/backstage-plugin-orchestrator@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.7.1" --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.7.1 --registry=https://npm.registry.redhat.com
     npm pack "@redhat/backstage-plugin-orchestrator-form-widgets@1.7.1" --registry=https://npm.registry.redhat.com

5. 次の例に示すように、ダウンロードした NPM パッケージを NPM サーバーにプッシュします。

   npm publish backstage-plugin-orchestrator-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-backend-dynamic-1.7.1.tgz
   npm publish backstage-plugin-orchestrator-form-widgets-1.7.1.tgz
   npm publish backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.7.1.tgz

6. redhat-developer-hub-orchestrator-infra Helm チャートを適用し、インストールプランを承認します。詳細は、Helm チャートを使用したエアギャップインストールの手順 を参照してください。

7. RHDH 1.7 Helm チャートを適用します。以下の例のように、バージョン 1.7.3 を含め、Orchestrator プラグインを有効にします。

   orchestrator.enabled=true

8. RHDH 1.7 Helm チャートは、完全な URL 参照を使用して、公式の Red Hat NPM レジストリーから Orchestrator プラグインをプルすることをデフォルトとしています。ローカルレジストリーを指すようにこの動作をオーバーライドする必要があります。

   カスタムレジストリーを使用するように Orchestrator プラグインを設定するには、次の手順を実行します。

   • values.yaml ファイルを開きます。

   • Orchestrator プラグインパッケージを、orchestrator.plugins セクションの下に明示的にリストします。

     次の例に示すように、簡略化されたパッケージ参照を、カスタム NPM レジストリーを指す完全な URL に置き換える必要があります。

     orchestrator:
       plugins:
         - disabled: false
           package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz
           integrity: sha512-xxxxxx
         - disabled: false
           package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-{product-bundle-version}.tgz
           integrity: sha512-xxxxxy
         - disabled: false
           package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz
           integrity: sha512-xxxxxz
         - disabled: false
           package: <custom_NPM_registry_URL>[:<port>]/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz
           integrity: sha512-xxxx1

     ここでは、以下のようになります。

     <custom_NPM_registry_URL>

     カスタムレジストリーのアドレスを入力し、sha512-xxxxxx などの整合性チェックサムがレジストリー内のファイルと一致していることを確認します。

手順

1. 次の例に示すように、プロジェクトを複製します。

   git clone git@github.com:rhdhorchestrator/orchestrator-demo.git
   cd orchestrator-demo

2. スクリプトのヘルプメニューを確認します。

   ./scripts/build.sh --help

3. イメージパス (-i)、ワークフローソースディレクトリー (-w)、マニフェスト出力ディレクトリー (-m) などの必要なフラグを指定して、build.sh スクリプトを実行します。

   重要

   次の例に示すように、タグを使用して完全なターゲットイメージパスを指定する必要があります。

   ./scripts/build.sh --image=quay.io/orchestrator/demo-basic:test -w 01_basic/ -m 01_basic/manifests

手順

1. 次の例に示すように、ターゲット namespace を指定して kubectl create コマンドを使用し、Kubernetes マニフェストを適用します。

   kubectl create -n <your_namespace> -f ./01_basic/manifests/.

2. デプロイ後、次の例に示すようにワークフロー Pod のステータスを監視します。

   kubectl get pods -n <your_namespace> -l app=basic

   Secret または ConfigMap の設定が欠落しているか不完全であるため、Pod の状態が最初は Error になる場合があります。

3. 次の例に示すように、Pod ログを検査します。

   oc logs -n <your_namespace> basic-f7c6ff455-vwl56

   次のコードは出力例です。

   SRCFG00040: The config property quarkus.openapi-generator.notifications.auth.BearerToken.bearer-token is defined as the empty String ("") which the following Converter considered to be null: io.smallrye.config.Converters$BuiltInConverter
   java.lang.RuntimeException: Failed to start quarkus
   ...
   Caused by: io.quarkus.runtime.configuration.ConfigurationException: Failed to read configuration properties

   このエラーは、quarkus.openapi-generator.notifications.auth.BearerToken.bearer-token プロパティーが欠落していることを示しています。

4. ログに ConfigurationException: Failed to read configuration properties エラーが表示されたり、値が欠落していることが示される場合は、次の例に示すように ConfigMap を取得します。

   oc get -n <your_namespace> configmaps basic-props -o yaml

   次のコードはサンプル出力の例です。

   apiVersion: v1
   data:
     application.properties: |
       # Backstage notifications service
       quarkus.rest-client.notifications.url=${BACKSTAGE_NOTIFICATIONS_URL}
       quarkus.openapi-generator.notifications.auth.BearerToken.bearer-token=${NOTIFICATIONS_BEARER_TOKEN}
   ...

   Secret を使用して提供された値でプレースホルダーを解決します。

5. 次の例に示すように、対応する Secret を編集し、適切な base64 エンコード値を指定して、application.properties 内のプレースホルダーを解決する必要があります。

   kubectl edit secrets -n <your_namespace> basic-secrets

6. ワークフロー Pod を再起動して、OpenShift Serverless Logic v1.36 で Secret の変更を有効にします。

検証

1. 次の例に示すように、Pod を再度確認して、デプロイメントのステータスを検証します。

   oc get pods -n <your_namespace> -l app=basic

   正常にデプロイされたワークフロー Pod では、次の例のようなステータスが期待されます。

   NAME                    READY   STATUS    RESTARTS   AGE
   basic-f7c6ff455-grkxd   1/1     Running   0          47s

2. Pod が Running 状態になると、ワークフローが Red Hat Developer Hub 内の Orchestrator プラグインに表示されます。

手順

1. 以下の例のように plugin-infra.sh スクリプトをダウンロードします。

   curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs/heads/release-1.7/config/profile/rhdh/plugin-infra/plugin-infra.sh # Specify the Red Hat Developer Hub version in the URL or use main

2. スクリプトを実行します。

   $ ./plugin-infra.sh