コンテナランナーのインストール (Kubernetes)

2 months ago1 min read

クラウド

このページの内容

CircleCI のコンテナランナーをインストールする方法についてこのドキュメントでわかりやすく説明します。

前提条件

コンテナランナーをインストールしてジョブを実行するには、ルートアクセスおよび以下の設定とインストールが必要です。

Kubernetes 1.12+
Helm 3.x
他のワークロードがない状態の Kubernetes 名前空間
checkout ステップで、SSH でチェックアウトするように Git が設定されていること。使用する場合は、 port 22 からのアウトバウンド接続を許可するようにクラスタが設定されていることを確認してください。
コマンドラインからランナーをインストールする場合は、 CircleCI CLIを使用します。

セルフホストランナーの利用条件

1. ネームスペースとリソースクラスの作成

セルフホストランナーをインストールするには、名前空間とリソースクラストークンを作成する必要があります。リソースクラスとトークンを作成するには、VCS プロバイダーの組織管理者権限を持っている必要があります。名前空間やリソースクラスについては、コンセプトのページを参照してください。

お客様のランナーは、インベントリのページの左にあるナビゲーションバーで Self-Hosted Runners をクリックするとご覧いただけます。

CircleCI Web アプリで、Self-Hostd Runners に移動します。
組織でセルフホストランナーを初めて使用する場合、ファーストステップとしてまず名前空間を作成する必要があります。 作成できる名前空間は、各組織につき 1 つのみです。 必須ではありませんが、 CircleCI のアカウント名を小文字で使用することを推奨します。 CircleCI は UI でデフォルトで推奨される名前空間として組織名を入力します。

もし、お客様の組織が既に Orb を使用しているのであれば、新しい名前空間を作らないでください。その代わりに、お客様の組織が Orb に使用している名前空間を入力してください。
2つ目の入力フィールドには、セルフホスト・ランナー・リソース・クラスの名前を入力します。
リソースクラストークンをコピーし保存します。セルフホストランナーはこのトークンを使って関連するリソースクラスの作業を要求します。

トークンは再取得できないので、必ず安全な場所に保管してください。
Select the Container tab for installation instructions specific to container runner. These instructions are also included in the next section of this installation guide.

Figure 1. Web アプリによるコンテナランナーのインストール
新しいリソースクラスの設定コードが提供されます。既存の .circleci/config.yml がある場合は、既存の jobs セクションの下に新しいリソースクラスを追加してください。既存のファイルがない場合は、 jobs セクション全体を追加します。既存の .circleci/config.yml ファイルがない場合は、ファイルを作成し、すべてのコードをコピーします。

セルフホストランナーをインストールするには、下記手順を実行し、名前空間と認証トークンを作成する必要があります。リソースクラスとトークンを作成するには、VCS プロバイダーの組織管理者である必要があります。

お客様のランナーは、 Web アプリ内のインベントリのページの左にあるナビゲーションバーで Self-Hosted Runners をクリックするとご覧いただけます。

組織のセルフホストランナーの名前空間を作成します。 作成できる名前空間は、各組織につき 1 つのみです。 CircleCI の組織のアカウント名を小文字で使用することを推奨します。既に Orb を使用している場合は、Orb で使用しているのと同じ名前空間にします。

下記のコマンドを使って名前空間を作成します。
```
circleci namespace create <name> --org-id <your-organization-id>
```
TIP: 組織に既にネームスペースがある場合、上記のコマンドを実行して別のネームスペースを作成すると、エラーが表示されます。エラーメッセージは既存のネームスペースの名前を返します。この場合、既存のネームスペースを使用して、以下の手順 2 に進みます。
次のコマンドを実行して、セルフホストランナーの名前空間用のリソースクラスを作成します。
```
circleci runner resource-class create <namespace>/<resource-class> <description> --generate-token
```
<namespace> と <resource-class> は、それぞれお客様の orgネームスペースと希望するリソースクラス名に置き換えてください。オプションで説明を追加することもできます。

例: circleci runner resource-class create my-namespace/my-resource-class my-description --generate-token.

リソースクラストークンは、ランナーリソースクラスが正常に作成された後に返されます。

トークンは再取得できないので、必ず安全な場所に保管してください。

2. コンテナランナーインストール

以下のコマンドを実行して、コンテナランナー Helm のレポジトリを追加します：
```
helm repo add container-agent https://packagecloud.io/circleci/container-agent/helm
```
次に以下を実行します：
```
helm repo update
```
次に、以下のコマンドを実行し、circleci Kubernetes namespaceを作成します：
```
kubectl create namespace circleci
```

values.yaml ファイルという以下を含むファイルを作成します。

agent:
  resourceClasses:
    namespace/my-rc:
      token: <resource_class_token>

最後に、以下のコマンドを実行します：

helm install container-agent container-agent/container-agent -n circleci -f values.yaml

コンテナランナーの設定例

クラスタにコンテナランナーをインストールしたら、Docker Executor を使ってインストールを検証する CircleCI ジョブを作成し、トリガーします。コンテナランナーを使って実行する特定のジョブについて、以下のフィールドを設定する必要があります。

image:
resource_class: <namespace>/<resource-class>

以下は、ジョブ設定のシンプルなコード例です (cimg/base:2021.11 は、よく使用される CircleCI の Docker イメージです)。

version: 2.1

jobs:
  build:
    docker:
      - image: cimg/base:2021.11
    resource_class: <namespace>/<resource-class>
    steps:
      - checkout
      - run: echo "Hi I'm on Runners!"

workflows:
  build-workflow:
    jobs:
      - build

setup_remote_docker を使用する既存のジョブは 使用しないでください (詳細は以下のコンテナイメージのビルドのセクションを参照)。

トラブルシューティング

セルフホストランナーのトラブルシューティングガイドのコンテナランナーのトラブルシューティングのセクションを参照してください。

コンテナランナーのインストール (Kubernetes)

このページの内容

前提条件

セルフホストランナーの利用条件

1. ネームスペースとリソースクラスの作成

2. コンテナランナーインストール

コンテナランナーの設定例

トラブルシューティング

関連リソース

ドキュメントの改善にご協力ください

サポートが必要ですか

コンテナランナーのインストール (Kubernetes)

このページの内容

前提条件

セルフホストランナーの利用条件

1. ネームスペースとリソースクラスの作成

2. コンテナランナー インストール

コンテナランナーの設定例

トラブルシューティング

関連リソース

ドキュメントの改善にご協力ください

サポートが必要ですか

2. コンテナランナーインストール