Red Hat Developer Hub 管理ガイド

手順

1. 次のコマンドを実行し、oc コマンドラインツールを使用して OpenShift Container Platform アカウントにログインします。

   oc login -u <user> -p <password> https://api.<hostname>:6443

2. 以下のコマンドを実行し、podman コマンドラインツールを使用して OpenShift Container Platform イメージレジストリーにログインします。

   podman login -u kubeadmin -p $(oc whoami -t) default-route-openshift-image-registry.<hostname>

   注記

   次のコマンドを実行して OpenShift Container Platform イメージレジストリーの完全なホスト名を取得し、そのホスト名をコマンドで使用してログインできます。

   REGISTRY_HOST=$(oc get route default-route -n openshift-image-registry --template='{{ .spec.host }}')

   podman login -u kubeadmin -p $(oc whoami -t) $REGISTRY_HOST

3. 以下のコマンドを実行して、podman の registry.redhat.io にログインします。

   podman login registry.redhat.io

   レジストリー認証の詳細は、Red Hat コンテナーレジストリーの認証 を参照してください。

4. 次のコマンドを実行して、Red Hat Image registry から Developer Hub および PostgreSQL イメージをワークステーションにプルします。

   podman pull registry.redhat.io/rhdh/rhdh-hub-rhel9:{product-chart-version}

   podman pull registry.redhat.io/rhel9/postgresql-15:latest

5. 次のコマンドを実行して、両方のイメージを内部 OpenShift Container Platform イメージレジストリーにプッシュします。

   podman push --remove-signatures registry.redhat.io/rhdh/rhdh-hub-rhel9:{product-chart-version} default-route-openshift-image-registry.<hostname>/<project_name>/rhdh-hub-rhel9:{product-chart-version}

   podman push --remove-signatures registry.redhat.io/rhel9/postgresql-15:latest default-route-openshift-image-registry.<hostname>/<project_name>/postgresql-15:latest

   イメージを OpenShift Container Platform イメージレジストリーに直接プッシュする方法の詳細は、How do I push an Image directly into the OpenShift 4 registry を参照してください。

   重要

   x509 エラーが発生した場合は、OpenShift Container Platform ルートに使用される CA 証明書がシステムにインストール されていることを確認してください。

6. 次のコマンドを使用して、両方のイメージが OpenShift Container Platform の内部レジストリーに存在することを確認します。

   oc get imagestream -n <project_name>

7. 次のコマンドを実行して、両方のイメージのローカルイメージ検索を有効にします。

   oc set image-lookup postgresql-15

   oc set image-lookup  rhdh-hub-rhel9

8. YAML view に移動し、次の値を使用して backstage と postgresql の image セクションを更新します。

   Developer Hub イメージの値の例

   upstream:
     backstage:
       image:
         registry: ""
         repository: rhdh-hub-rhel9
         tag: latest

   PostgreSQL イメージの値の例

   upstream:
     postgresql:
       image:
         registry: ""
         repository: postgresql-15
         tag: latest

9. Helm Chart を使用して Red Hat Developer Hub をインストールします。Developer Hub のインストールの詳細は、「Helm Chart を使用した OpenShift Container Platform への Red Hat Developer Hub のデプロイ」 を参照してください。

手順

1. OpenShift Container Platform Web コンソールから、ConfigMaps タブを選択します。
2. Create ConfigMap をクリックします。

3. Create ConfigMap ページで、Configure via の YAML view オプションを選択し、必要に応じてファイルを編集します。

   GitHub 動的プラグインを使用した ConfigMap オブジェクトの例

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: dynamic-plugins-rhdh
   data:
     dynamic-plugins.yaml: |
       includes:
         - dynamic-plugins.default.yaml
       plugins:
         - package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic'
           disabled: false
           pluginConfig: {}

4. Create をクリックします。
5. Topology タブに移動します。

6. 使用する Red Hat Developer Hub インスタンスのオーバーフローメニューをクリックし、Edit Backstage を選択して、Red Hat Developer Hub インスタンスの YAML ビューを読み込みます。

   

7. dynamicPluginsConfigMapName フィールドを Backstage CR に追加します。以下に例を示します。

   apiVersion: rhdh.redhat.com/v1alpha1
   kind: Backstage
   metadata:
     name: my-rhdh
   spec:
     application:
   # ...
       dynamicPluginsConfigMapName: dynamic-plugins-rhdh
   # ...

8. Save をクリックします。
9. Topology ビューに戻り、Red Hat Developer Hub Pod が起動するまで待ちます。
10. Open URL アイコンをクリックして、新しい設定変更を適用した Red Hat Developer Hub プラットフォームの使用を開始します。

手順

1. ミラーリングスクリプトをダウンロードして実行し、カスタム Operator カタログをインストールし、関連するイメージをミラーリングします (prepare-restricted-environment.sh (source))。

   curl -sSLO https://raw.githubusercontent.com/janus-idp/operator/1.1.x/.rhdh/scripts/prepare-restricted-environment.sh
   
   # if you do not already have a target mirror registry
   # and want the script to create one for you
   # use the following example:
   bash prepare-restricted-environment.sh \
      --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.14" \
      --prod_operator_package_name "rhdh" \
      --prod_operator_bundle_name "rhdh-operator" \
      --prod_operator_version "v1.1.1"
   
   # if you already have a target mirror registry
   # use the following example:
   bash prepare-restricted-environment.sh \
      --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.14" \
      --prod_operator_package_name "rhdh" \
      --prod_operator_bundle_name "rhdh-operator" \
      --prod_operator_version "v1.1.1" \
      --use_existing_mirror_registry "my_registry"

   注記

   このスクリプトは複数のイメージをミラーレジストリーにコピーするため、完了までに数分かかる場合があります。

手順

1. ターミナルで次のコマンドを実行して、Operator がインストールされている rhdh-operator namespace を作成します。

   kubectl create namespace rhdh-operator

2. 次のコマンドを使用してプルシークレットを作成します。

   kubectl -n rhdh-operator create secret docker-registry rhdh-pull-secret \
       --docker-server=registry.redhat.io \
       --docker-username=<user_name> \ 1
       --docker-password=<password> \ 2
       --docker-email=<email> 3

   1

   コマンドにユーザー名を入力します。

   2

   コマンドにパスワードを入力します。

   3

   コマンドにメールアドレスを入力します。

   作成されたプルシークレットは、Red Hat エコシステムから Developer Hub イメージをプルするために使用されます。

3. Red Hat エコシステムからの Operators を含む CatalogSource リソースを作成します。

   cat <<EOF | kubectl -n rhdh-operator apply -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: redhat-catalog
   spec:
     sourceType: grpc
     image: registry.redhat.io/redhat/redhat-operator-index:v4.15
     secrets:
     - "rhdh-pull-secret"
     displayName: Red Hat Operators
   EOF

4. 次のように OperatorGroup リソースを作成します。

   cat <<EOF | kubectl apply -n rhdh-operator -f -
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: rhdh-operator-group
   EOF

5. 次のコードを使用して Subscription リソースを作成します。

   cat <<EOF | kubectl apply -n rhdh-operator -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: rhdh
     namespace: rhdh-operator
   spec:
     channel: fast
     installPlanApproval: Automatic
     name: rhdh
     source: redhat-catalog
     sourceNamespace: rhdh-operator
     startingCSV: rhdh-operator.v1.1.2
   EOF

6. 次のコマンドを実行して、作成した Operator が実行されていることを確認します。

   kubectl -n rhdh-operator get pods -w

   Operator Pod に ImagePullBackOff ステータスが表示される場合は、Operator デプロイメントのマニフェスト内でイメージを直接プルする権限が必要な可能性があります。

   ヒント

   必要なシークレット名を deployment.spec.template.spec.imagePullSecrets リストに含め、kubectl get deployment -n rhdh-operator コマンドを使用してデプロイメント名を確認できます。

   kubectl -n rhdh-operator patch deployment \
       rhdh.fast --patch '{"spec":{"template":{"spec":{"imagePullSecrets":[{"name":"rhdh-pull-secret"}]}}}}' \
       --type=merge

7. 次の手順を使用して Operator のデフォルト設定を更新して、Developer Hub リソースが EKS で正常に起動できるようにします。

   1. 次のコマンドを使用して、rhdh-operator namespace の backstage-default-config ConfigMap を編集します。

      kubectl -n rhdh-operator edit configmap backstage-default-config

   2. 次の例に示すように、db-statefulset.yaml 文字列を見つけて、その spec.template.spec.securityContext に fsGroup を追加します。

        db-statefulset.yaml: |
          apiVersion: apps/v1
          kind: StatefulSet
      --- TRUNCATED ---
          spec:
          --- TRUNCATED ---
            restartPolicy: Always
            securityContext:
            # You can assign any random value as fsGroup
              fsGroup: 2000
            serviceAccount: default
            serviceAccountName: default
      --- TRUNCATED ---

   3. 次の例に示すように、deployment.yaml 文字列を見つけて、その仕様に fsGroup を追加します。

        deployment.yaml: |
          apiVersion: apps/v1
          kind: Deployment
      --- TRUNCATED ---
          spec:
            securityContext:
              # You can assign any random value as fsGroup
              fsGroup: 3000
            automountServiceAccountToken: false
      --- TRUNCATED ---

   4. 次のように、service.yaml 文字列を見つけて、type を NodePort に変更します。

        service.yaml: |
          apiVersion: v1
          kind: Service
          spec:
           # NodePort is required for the ALB to route to the Service
            type: NodePort
      --- TRUNCATED ---

   5. 保存して終了します。

      変更が Operator Pod に自動的に適用されるまで、数分間待ちます。

手順

1. 次のコマンドを使用して、Operator リポジトリーのクローンをローカルマシンに作成します。

   git clone --depth=1 https://github.com/janus-idp/operator.git rhdh-operator && cd rhdh-operator

2. 次のコマンドを実行して、デプロイメントマニフェストを生成します。

   make deployment-manifest

   前のコマンドは rhdh-operator-<VERSION>.yaml という名前のファイルを生成します。これは手動で更新されます。

3. 次のコマンドを実行して、生成したデプロイメントマニフェストに置換を適用します。

   sed -i "s/backstage-operator/rhdh-operator/g" rhdh-operator-*.yaml
   sed -i "s/backstage-system/rhdh-operator/g" rhdh-operator-*.yaml
   sed -i "s/backstage-controller-manager/rhdh-controller-manager/g" rhdh-operator-*.yaml

4. 生成したデプロイメントマニフェストファイルをエディターで開き、次の手順を実行します。

   1. 次の例に示すように、db-statefulset.yaml 文字列を見つけて、その spec.template.spec.securityContext に fsGroup を追加します。

         db-statefulset.yaml: |
          apiVersion: apps/v1
          kind: StatefulSet
      --- TRUNCATED ---
          spec:
          --- TRUNCATED ---
            restartPolicy: Always
            securityContext:
              # You can assign any random value as fsGroup
              fsGroup: 2000
            serviceAccount: default
            serviceAccountName: default
      --- TRUNCATED ---

   2. 次の例に示すように、deployment.yaml 文字列を見つけて、その仕様に fsGroup を追加します。

        deployment.yaml: |
          apiVersion: apps/v1
          kind: Deployment
      --- TRUNCATED ---
          spec:
            securityContext:
              # You can assign any random value as fsGroup
              fsGroup: 3000
            automountServiceAccountToken: false
      --- TRUNCATED ---

   3. 次のように、service.yaml 文字列を見つけて、type を NodePort に変更します。

        service.yaml: |
          apiVersion: v1
          kind: Service
          spec:
            # NodePort is required for the ALB to route to the Service
            type: NodePort
      --- TRUNCATED ---

   4. デフォルトのイメージを Red Hat エコシステムからプルしたイメージに置き換えます。

      sed -i "s#gcr.io/kubebuilder/kube-rbac-proxy:.*#registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.15#g" rhdh-operator-*.yaml
      
      sed -i "s#quay.io/janus-idp/operator:.*#registry.redhat.io/rhdh/rhdh-rhel9-operator:1.1#g" rhdh-operator-*.yaml
      
      sed -i "s#quay.io/janus-idp/backstage-showcase:.*#registry.redhat.io/rhdh/rhdh-hub-rhel9:1.1#g" rhdh-operator-*.yaml
      
      sed -i "s#quay.io/fedora/postgresql-15:.*#registry.redhat.io/rhel9/postgresql-15:latest#g" rhdh-operator-*.yaml

5. 次のように、イメージプルシークレットを Deployment リソースのマニフェストに追加します。

   --- TRUNCATED ---
   
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     labels:
       app.kubernetes.io/component: manager
       app.kubernetes.io/created-by: rhdh-operator
       app.kubernetes.io/instance: controller-manager
       app.kubernetes.io/managed-by: kustomize
       app.kubernetes.io/name: deployment
       app.kubernetes.io/part-of: rhdh-operator
       control-plane: controller-manager
     name: rhdh-controller-manager
     namespace: rhdh-operator
   spec:
     replicas: 1
     selector:
       matchLabels:
         control-plane: controller-manager
     template:
       metadata:
         annotations:
           kubectl.kubernetes.io/default-container: manager
         labels:
           control-plane: controller-manager
       spec:
         imagePullSecrets:
           - name: rhdh-pull-secret
   --- TRUNCATED ---

6. 次のコマンドを使用してマニフェストを適用し、Operator をデプロイします。

   kubectl apply -f rhdh-operator-VERSION.yaml

7. 以下のコマンドを実行して、Operator が実行されていることを確認します。

   kubectl -n rhdh-operator get pods -w

手順

1. 次のテンプレートを使用して、Developer Hub 設定を含む app-config-rhdh という名前の ConfigMap を作成します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: app-config-rhdh
   data:
     "app-config-rhdh.yaml": |
       app:
         title: Red Hat Developer Hub
         baseUrl: https://<rhdh_dns_name>
       backend:
         auth:
           keys:
             - secret: "${BACKEND_SECRET}"
         baseUrl: https://<rhdh_dns_name>
         cors:
           origin: https://<rhdh_dns_name>

2. secrets-rhdh という名前の Secret を作成し、値として Base64-encoded 文字列を持つ BACKEND_SECRET という名前のキーを追加します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: secrets-rhdh
   stringData:
     # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup
     BACKEND_SECRET: "xxx"

   重要

   各 Developer Hub インスタンスには、必ず一意の値の BACKEND_SECRET を使用してください。

   次のコマンドを使用してキーを生成できます。

   node-p'require("crypto").randomBytes(24).toString("base64")'

3. Red Hat エコシステムカタログから PostgreSQL イメージをプルできるようにするには、Developer Hub インスタンスがデプロイされている namespace 内のデフォルトのサービスアカウントにイメージプルシークレットを追加します。

   kubectl patch serviceaccount default \
       -p '{"imagePullSecrets": [{"name": "rhdh-pull-secret"}]}' \
       -n <your_namespace>

4. 次のテンプレートを使用してカスタムリソースファイルを作成します。

   apiVersion: rhdh.redhat.com/v1alpha1
   kind: Backstage
   metadata:
    # TODO: this the name of your Developer Hub instance
     name: my-rhdh
   spec:
     application:
       imagePullSecrets:
       - "rhdh-pull-secret"
       route:
         enabled: false
       appConfig:
         configMaps:
           - name: "app-config-rhdh"
       extraEnvs:
         secrets:
           - name: "secrets-rhdh"

5. 次のテンプレートを使用して Ingress リソースを作成し、必要に応じて名前をカスタマイズします。

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     # TODO: this the name of your Developer Hub Ingress
     name: my-rhdh
     annotations:
       alb.ingress.kubernetes.io/scheme: internet-facing
   
       alb.ingress.kubernetes.io/target-type: ip
   
       # TODO: Using an ALB HTTPS Listener requires a certificate for your own domain. Fill in the ARN of your certificate, e.g.:
       alb.ingress.kubernetes.io/certificate-arn: arn:aws:acm:us-xxx:xxxx:certificate/xxxxxx
   
        alb.ingress.kubernetes.io/listen-ports: '[{"HTTP": 80}, {"HTTPS":443}]'
   
       alb.ingress.kubernetes.io/ssl-redirect: '443'
   
       # TODO: Set your application domain name.
       external-dns.alpha.kubernetes.io/hostname: <rhdh_dns_name>
   
   spec:
     ingressClassName: alb
     rules:
       # TODO: Set your application domain name.
       - host: <rhdh_dns_name>
         http:
           paths:
           - path: /
             pathType: Prefix
             backend:
               service:
                 # TODO: my-rhdh is the name of your Backstage Custom Resource.
                 # Adjust if you changed it!
                 name: backstage-my-rhdh
                 port:
                   name: http-backend

   前のテンプレートで、` <rhdh_dns_name>` を Developer Hub ドメイン名に置き換え、alb.ingress.kubernetes.io/certificate-arn の値を証明書 ARN で更新します。

手順

1. ターミナルを開き、次のコマンドを実行して Helm チャートリポジトリーを追加します。

   helm repo add openshift-helm-charts https://charts.openshift.io/

2. ImagePull Secret を作成するには、次のコマンドを実行します。

   kubectl -n <your_namespace> create secret docker-registry rhdh-pull-secret \
       --docker-server=registry.redhat.io \
       --docker-username=<redhat_user_name> \
       --docker-password=<redhat_password> \
       --docker-email=<email>

3. 次のテンプレートを使用して、values.yaml という名前のファイルを作成します。

   global:
     host: <app_address>
   route:
     enabled: false
   upstream:
     ingress:
       enabled: true
       className: webapprouting.kubernetes.azure.com
       host:
     backstage:
       image:
         pullSecrets:
           - rhdh-pull-secret
       podSecurityContext:
         fsGroup: 3000
     postgresql:
       image:
         pullSecrets:
           - rhdh-pull-secret
       primary:
         podSecurityContext:
           enabled: true
           fsGroup: 3000
     volumePermissions:
       enabled: true

4. Helm Chart をインストールするには、次のコマンドを実行します。

   helm -n <your_namespace> install -f values.yaml <your_deploy_name> openshift-helm-charts/redhat-developer-hub --version 1.1.1

5. デプロイメントのステータスを確認します。

   kubectl get deploy <your_deploy_name>-developer-hub -n <your_namespace>

6. URL: https://<app_address> を使用して、デプロイした Developer Hub にアクセスします。ここで、<app_address> は、前に取得した Ingress アドレス (たとえば、https://108.141.70.228) です。

7. デプロイメントをアップグレードまたは削除するには、次のコマンドを実行します。

   アップグレードコマンド

   helm -n <your_namespace> upgrade -f values.yaml <your_deploy_name> openshift-helm-charts/redhat-developer-hub --version 1.1.1

   削除コマンド

   helm -n <your_namespace> delete <your_deploy_name>

手順

1. rhdh-operator-<VERSION>.yaml という名前の Red Hat Developer Hub Operator マニフェストファイルを取得し、次のフラグメントを追加して db-statefulset.yaml と deployment.yaml のデフォルト設定を変更します。

   securityContext:
     fsGroup: 300

   マニフェストで指定された場所は次のとおりです。

   db-statefulset.yaml: | spec.template.spec
   deployment.yaml: | spec.template.spec

2. 変更した Operator マニフェストを Kubernetes クラスターに適用します。

   kubectl apply -f rhdh-operator-<VERSION>.yaml

   注記

   前のコマンドの実行はクラスター範囲であり、適切なクラスター権限が必要です。

3. 次の例に示すように、Red Hat 認証情報を使用して rhdh-pull-secret という名前の ImagePull Secret を作成し、保護された registry.redhat.io からイメージにアクセスします。

   kubectl -n <your_namespace> create secret docker-registry rhdh-pull-secret \
       --docker-server=registry.redhat.io \
       --docker-username=<redhat_user_name> \
       --docker-password=<redhat_password> \
       --docker-email=<email>

4. rhdh-ingress.yaml という名前の Ingress マニフェストファイルを作成し、次のように Developer Hub サービス名を指定します。

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     name: rhdh-ingress
     namespace: <your_namespace>
   spec:
     ingressClassName: webapprouting.kubernetes.azure.com
     rules:
       - http:
           paths:
             - path: /
               pathType: Prefix
               backend:
                 service:
                   name: backstage-<your-CR-name>
                   port:
                     name: http-backend

5. 作成した Ingress をデプロイするには、次のコマンドを実行します。

   kubectl -n <your_namespace> apply -f rhdh-ingress.yaml

6. 次の例を使用して、Developer Hub 設定を含む app-config-rhdh という名前の ConfigMap を作成します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: app-config-rhdh
   data:
     "app-config-rhdh.yaml": |
       app:
         title: Red Hat Developer Hub
         baseUrl: https://<app_address>
       backend:
         auth:
           keys:
             - secret: "${BACKEND_SECRET}"
         baseUrl: https://<app_address>
         cors:
           origin: https://<app_address>

7. secrets-rhdh という名前のシークレットを作成し、次の例に示すように、Base64-encoded 文字列値の BACKEND_SECRET という名前のキーを追加します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: secrets-rhdh
   stringData:
     BACKEND_SECRET: "xxx"

8. rhdh.yaml という名前のカスタムリソース (CR) マニフェストファイルを作成し、次のように以前に作成した rhdh-pull-secret を追加します。

   apiVersion: rhdh.redhat.com/v1alpha1
   kind: Backstage
   metadata:
     name: <your-rhdh-cr>
   spec:
     application:
       imagePullSecrets:
         - rhdh-pull-secret
       appConfig:
         configMaps:
           - name: "app-config-rhdh"
       extraEnvs:
         secrets:
           - name: "secrets-rhdh"

9. CR マニフェストを namespace に適用します。

   kubectl -n <your_namespace> apply -f rhdh.yaml

10. URL: https://<app_address> を使用して、デプロイした Developer Hub にアクセスします。ここで、<app_address> は、前に取得した Ingress アドレス (たとえば、https://108.141.70.228) です。

11. オプション: CR を削除するには、次のコマンドを実行します。

    kubectl -n <your_namespace> delete -f rhdh.yaml

手順

1. アプリケーションが登録されたら、次の点を書き留めます。

   • clientId: アプリケーション (クライアント) ID。App Registration → Overview にあります。
   • clientSecret: シークレット。*App Registration → Certificates & secrets にあります (必要に応じて新規作成します)。
   • tenantId: ディレクトリー (テナント) ID。App Registration → Overview にあります。

2. 次のフラグメントが Developer Hub ConfigMap に含まれていることを確認します。

   auth:
     environment: production
     providers:
       microsoft:
         production:
           clientId: ${AZURE_CLIENT_ID}
           clientSecret: ${AZURE_CLIENT_SECRET}
           tenantId: ${AZURE_TENANT_ID}
           domainHint: ${AZURE_TENANT_ID}
           additionalScopes:
             - Mail.Send

   新しいファイルを作成することも、既存のファイルに追加することもできます。

3. ConfigMap を Kubernetes クラスターに適用します。

   kubectl -n <your_namespace> apply -f <app-config>.yaml

4. Azure 認証情報を含む既存の Secret を作成または再利用し、次のフラグメントを追加します。

   stringData:
     AZURE_CLIENT_ID: <value-of-clientId>
     AZURE_CLIENT_SECRET: <value-of-clientSecret>
     AZURE_TENANT_ID: <value-of-tenantId>

5. シークレットを Kubernetes クラスターに適用します。

   kubectl -n <your_namespace> apply -f <azure-secrets>.yaml

6. value.yaml ファイルが、以前に作成した ConfigMap と Secret を参照していることを確認します。

   upstream:
     backstage:
     ...
       extraAppConfig:
         - filename: ...
           configMapRef: <app-config-containing-azure>
       extraEnvVarsSecrets:
         - <secret-containing-azure>

7. オプション: Helm Chart がすでにインストールされている場合は、アップグレードします。

   helm -n <your_namespace> upgrade -f <your-values.yaml> <your_deploy_name> redhat-developer/backstage --version 1.1.4

8. オプション: rhdh.yaml ファイルが変更されていない場合 (たとえば、そこから参照される ConfigMap と Secret のみを更新した場合)、対応する Pod を削除して Developer Hub デプロイメントを更新します。

   kubectl -n <your_namespace> delete pods -l backstage.io/app=backstage-<your-rhdh-cr>

手順

1. アプリケーションが登録されたら、次の点を書き留めます。

   • clientId: アプリケーション (クライアント) ID。App Registration → Overview にあります。
   • clientSecret: シークレット。*App Registration → Certificates & secrets にあります (必要に応じて新規作成します)。
   • tenantId: ディレクトリー (テナント) ID。App Registration → Overview にあります。

2. 次のフラグメントが Developer Hub ConfigMap に含まれていることを確認します。

   auth:
     environment: production
     providers:
       microsoft:
         production:
           clientId: ${AZURE_CLIENT_ID}
           clientSecret: ${AZURE_CLIENT_SECRET}
           tenantId: ${AZURE_TENANT_ID}
           domainHint: ${AZURE_TENANT_ID}
           additionalScopes:
             - Mail.Send

   新しいファイルを作成することも、既存のファイルに追加することもできます。

3. ConfigMap を Kubernetes クラスターに適用します。

   kubectl -n <your_namespace> apply -f <app-config>.yaml

4. Azure 認証情報を含む既存の Secret を作成または再利用し、次のフラグメントを追加します。

   stringData:
     AZURE_CLIENT_ID: <value-of-clientId>
     AZURE_CLIENT_SECRET: <value-of-clientSecret>
     AZURE_TENANT_ID: <value-of-tenantId>

5. シークレットを Kubernetes クラスターに適用します。

   kubectl -n <your_namespace> apply -f <azure-secrets>.yaml

6. カスタムリソースマニフェストが、以前に作成した ConfigMap と Secret への参照を含むことを確認します。

   apiVersion: rhdh.redhat.com/v1alpha1
   kind: Backstage
   metadata:
     name: <your-rhdh-cr>
   spec:
     application:
       imagePullSecrets:
       - rhdh-pull-secret
       route:
         enabled: false
       appConfig:
         configMaps:
           - name: <app-config-containing-azure>
       extraEnvs:
         secrets:
           - name: <secret-containing-azure>

7. カスタムリソースマニフェストを適用します。

   kubectl -n <your_namespace> apply -f rhdh.yaml

8. オプション: rhdh.yaml ファイルが変更されていない場合 (たとえば、そこから参照される ConfigMap と Secret のみを更新した場合)、対応する Pod を削除して Developer Hub デプロイメントを更新します。

   kubectl -n <your_namespace> delete pods -l backstage.io/app=backstage-<your-rhdh-cr>

手順

1. Developer Hub のサイドバーの下部にある Administration に移動します。

   RBAC タブが表示され、 Developer Hub で作成されたすべてのロールが表示されます。

2. (オプション) 任意のロールをクリックすると、OVERVIEW ページにロール情報が表示されます。
3. CREATE をクリックしてロールを作成します。
4. 所定のフィールドにロールの名前と説明を入力し、NEXT をクリックします。
5. 検索フィールドを使用してユーザーとグループを追加し、NEXT をクリックします。
6. Add permission policies セクションのドロップダウンから Plugin と Permission を選択します。
7. Add permission policies セクションで、設定する Policy を選択または選択解除し、NEXT をクリックします。
8. Review and create セクションで追加された情報を確認します。
9. CREATE をクリックします。

手順

1. Developer Hub のサイドバーの下部にある Administration に移動します。

   RBAC タブが表示され、 Developer Hub で作成されたすべてのロールが表示されます。

2. (オプション) 任意のロールをクリックすると、OVERVIEW ページにロール情報が表示されます。
3. 編集するロールの編集アイコンを選択します。
4. 名前、説明、ユーザーとグループ、権限ポリシーなどのロールの詳細を編集し、NEXT をクリックします。
5. 編集したロールの詳細を確認し、SAVE をクリックします。

手順

1. Developer Hub のサイドバーの下部にある Administration に移動します。

   RBAC タブが表示され、 Developer Hub で作成されたすべてのロールが表示されます。

2. (オプション) 任意のロールをクリックすると、OVERVIEW ページにロール情報が表示されます。

3. 削除するロールの Actions 列から削除アイコンを選択します。

   Delete this role? というポップアップが画面に表示されます。

4. DELETE をクリックします。

手順

1. 要求の送信先となる API エンドポイント (例: POST/api/permission/policies) を特定します。ユースケースに合わせて、要求の詳細を調整します。

   REST クライアントの場合:

   • Authorization: Web コンソールから生成されたトークンを入力します。
   • HTTP method: POST に設定します。
   • URL: RBAC REST API のベース URL とエンドポイント (例: http://localhost:7007/api/permission/policies) を入力します。

   curl ユーティリティーの場合:

   • -X: POST に設定します。

   • -H: 以下のヘッダーを設定します。

     Content-type: application/json

     Authorization: Bearer $token

     $token は、ブラウザーの Web コンソールから要求されたトークンです。

   • URL: 次の RBAC REST API ベースの URL エンドポイント (例: http://localhost:7007/api/permission/policies) を入力します。
   • -d: 要求の JSON bodyを追加します。

   要求の例:

   curl -X POST "http://localhost:7007/api/permission/policies" -d '{"entityReference":"role:default/test", "permission": "catalog-entity", "policy": "read", "effect":"allow"}' -H "Content-Type: application/json" -H "Authorization: Bearer $token" -v

2. 要求を実行し、応答を確認します。