第1章 サンプルソフトウェアテンプレートのカスタマイズ

手順

1. ローカルマシンのクローンされた tssc-sample-templates リポジトリーに移動します。

2. 希望するテキストエディターで プロパティー ファイルを開きます。たとえば、ターミナルで次のコマンドを実行して、Visual Studio Code で開きます。

   $ code properties

   Copy to Clipboard Toggle word wrap

   # PE can replace these values with on-prem host
   export GITHUB__DEFAULT__HOST=github.com
   export GITLAB__DEFAULT__HOST=gitlab.com
   export BITBUCKET__DEFAULT__HOST=bitbucket.org
   
   export QUAY__DEFAULT__HOST=quay.io
   
   # leave empty if you don't want to set defaults for your git or quay org
   export GITHUB__DEFAULT__ORG=""
   export GITLAB__DEFAULT__ORG=""
   export BITBUCKET__DEFAULT__ORG=""
   export QUAY__DEFAULT__ORG=""
   
   # PE can replace these values with own pipeline fork
   export PIPELINE__REPO__URL=https://github.com/redhat-appstudio/tssc-sample-pipelines
   export PIPELINE__REPO__BRANCH=main
   
   export DEFAULT__DEPLOYMENT__NAMESPACE__PREFIX=tssc-app
   
   export RHTAP__DEFAULT__NAMESPACE=tssc
   export ARGOCD__DEFAULT__NAMESPACE=tssc-gitops
   export ARGOCD__DEFAULT__INSTANCE=default
   export ARGOCD__DEFAULT__PROJECT=default
   
   
   # For secret reference in Repository CRs
   # Secret will be prefixed by CI name, gitops (for github), or gitlab, or bitbucket in template
   # export GIT__SECRET__DEFAULT__NAME=auth-secret
   export GIT__SECRET__DEFAULT__KEY=password
   export WEBHOOK__SECRET__DEFAULT__NAME=pipelines-secret
   export WEBHOOK__SECRET__DEFAULT__KEY=webhook.secret
   
   # compute the template tag to set defaults, leave empty if not set
   if [ ! -z "${GITHUB__DEFAULT__ORG}" ]; then
   export DEFAULT_ORG_FOR_GITHUB="default: $GITHUB__DEFAULT__ORG"
   fi
   if [ ! -z "${GITLAB__DEFAULT__ORG}" ]; then
   export DEFAULT_ORG_FOR_GITLAB="default: $GITLAB__DEFAULT__ORG"
   fi
   if [ ! -z "${BITBUCKET__DEFAULT__ORG}" ]; then
   export DEFAULT_ORG_FOR_BITBUCKET="default: $BITBUCKET__DEFAULT__ORG"
   fi
   if [ ! -z "${QUAY__DEFAULT__ORG}" ]; then
   export DEFAULT_ORG_FOR_QUAY="default: $QUAY__DEFAULT__ORG"
   fi

   Copy to Clipboard Toggle word wrap

3. お使いの環境に応じて以下のキーと値のペアを更新して、プロパティー ファイルをカスタマイズします。

   Expand

   キー	説明
   export GITHUB_DEFAULT_HOST	これをオンプレミスの GitHub ホストの完全修飾ドメイン名に設定します。つまり、HTTP プロトコルと .git 拡張子を除外した URL です。たとえば、github-github.apps.cluster-ljg9z.sandbox219.opentlc.com です。デフォルト値は github.com です。
   export GITLAB_DEFAULT_HOST	これをオンプレミスの GitLab ホストの完全修飾ドメイン名に設定します。つまり、HTTP プロトコルと .git 拡張子を除外した URL です。たとえば、gitlab-gitlab.apps.cluster-ljg9z.sandbox219.opentlc.com です。デフォルト値は gitlab.com です。
   export DEFAULT_DEPLOYMENT_NAMESPACE_PREFIX	RHADS - SSC 内のデプロイメントの namespace の接頭辞です。デフォルト値は tssc-app です。 注記 インストール中にデフォルトの developerHub: namespacePrefixes を変更した場合は、これを更新します。
   export PIPELINE_REPO_URL	フォークされたパイプラインリポジトリーの URL。例: https://github.com/redhat-appstudio/tssc-sample-pipelines
   export PIPELINE_REPO_BRANCH	フォークされたパイプラインリポジトリーのターゲットブランチ。例: main。
   export GITHUB_DEFAULT_ORG	デフォルトに設定する GitHub 組織の名前。
   export QUAY_DEFAULT_ORG	デフォルトとして設定する Quay 組織の名前。

   Show more

4. ソフトウェアテンプレートを調整し、リポジトリーのトップレベルディレクトリーから次のコマンドを実行して、デフォルトのホスト値を指定の入力に置き換えます。

   $ ./generate.sh

   Copy to Clipboard Toggle word wrap

5. Jenkins のみの場合：Jenkins ライブラリーをカスタマイズするには、skeleton > ci > gitops-template > jenkins に移動して、Jenkinsfile ファイルを開きます。remote URL をフォークしたリポジトリーの URL に置き換えます。たとえば、remote: https://github.com/<username>/tssc-sample-jenkins.git 等。

   さらに、Jenkins インスタンスがオンプレミスの OpenShift Container Platform (OCP)インスタンスにデプロイされておらず、Rekor および TUF サービスが異なるクラスター上にある場合は、REKOR_HOST および TUF_MIRROR 環境変数を更新します。これらの変数は、コンポーネントリポジトリーの env.sh ファイルで設定するか、Jenkins の環境変数またはシークレット として設定できます。この設定により、外部 Jenkins サーバーは、RHADS - SSC とともにインストールされた Rekor サービスおよび TUF サービスと通信できるようになります。このカスタマイズを行わないと、RHADS - SSC は Jenkins パイプラインでコンテナーイメージを正しく署名しない場合があります。

   REKOR_HOST 変数および TUF_MIRROR 変数を更新するには、以下を実行します。

   1. skeleton > ci > gitops-template > jenkins > tssc ディレクトリーに移動し て、env.sh ファイルを開きます。

      2 番目の env.sh ファイルは、skeleton > ci > source-repo > jenkins > tssc にあります。ニーズに合わせて設定を更新します。

      env.sh で、REKOR_HOST と TUF_MIRROR のデフォルト値を確認します。

      REKOR_HOST=http://rekor-server.tssc-tas.svc
      TUF_MIRROR=http://tuf.tssc-tas.svc

      Copy to Clipboard Toggle word wrap

   2. .svc を OCP クラスター URL に置き換えます。.svc ドメインはローカルクラスターを参照し、内部サービスはルートに .svc を含む他のサービスにアクセスできますが、外部 Jenkins はアクセスできません。

      Rekor および TUF サービスの正しいルートは、RHADS - SSC のインストールプロセスの一部として出力されます。これらのデータが利用できない場合は、CLI でこのコマンドを実行し、出力で Rekor ルートと TUF ルートを選択します。

      $ oc get routes -n tssc-tas

      Copy to Clipboard Toggle word wrap

      Rekor サーバーの URL の例: http://rekor-server.tssc-tas.apps.rosa.j6ufg-t3htv-ts6.z797.p3.openshiftapps.com

      注記
      • Jenkins で環境変数またはシークレットを設定するには、外部ツールとの安全な統合のために Jenkins へのシークレットの追加 を参照してください。
      • デフォルトでは、RHADS - SSC は動的に読み込まれた Jenkins ライブラリーを使用します。動的ロードではなく組み込みの Jenkins ライブラリーを使用するように RHADS - SSC を設定する必要がある場合は、Jenkins プロビジョニング設定を変更する必要があります。この変更により、トレーサビリティとコンテクス設定性が向上します。詳細な手順は、組み込みの Jenkins ライブラリーを使用するように RHADS - SSC を設定する を参照してください。
6. Red Hat Advanced Cluster Security (RHACS)のみの場合：RHACS スキャンを有効にするには、env.sh ファイルで エクスポート DISABLE_ACS を false に設定します。
7. オプション A: 変更をコミットし、リポジトリーにプッシュします。これにより、Red Hat Developer Hub (RHDH)のテンプレートが自動的に更新されます。

8. オプション B: 次の手順を使用して、テンプレートを手動でインポートおよび更新します。

   1. Git プロバイダーのフォークされたサンプルテンプレートリポジトリーに移動します。

   2. 適切な URL を取得します。

      • 単一のテンプレートの場合は、templates ディレクトリーから template.yaml を選択します。ブラウザーのアドレスバーから URL をコピーします。例： https://github.com/username/tssc-sample-templates/blob/main/templates/devfile-sample-code-with-quarkus-dance/template.yaml
      • すべてのテンプレートで、all.yaml を選択し、その URL をブラウザーのアドレスバーからコピーします。例： https://github.com/username/tssc-sample-templates/blob/main/all.yaml
   3. RHDH プラットフォームに戻ります。
   4. Create > Register Existing Component を選択します。
   5. Select URL フィールドに、前の手順でコピーした適切な URL を貼り付けます。
   6. Analyze を選択し、Import を選択して RHDH のテンプレートを更新します。