ワークスペースの設定

ワークスペースを使用すると、GitLabプロジェクト用に分離された開発環境を作成および管理できます。各ワークスペースは、独自の依存関係、ライブラリ、ツールで構成され、各プロジェクトの特定のニーズに合わせてカスタマイズできます。

ワークスペースのインフラストラクチャをセットアップする

ワークスペースを作成する前に、インフラストラクチャを1回だけセットアップする必要があります。クラウドプロバイダーに関係なく、ワークスペースのインフラストラクチャをセットアップするには、次のことを行う必要があります:

1. Kubernetes向けGitLabエージェントがサポートするKubernetesクラスタを設定します。サポートされているKubernetesのバージョンを参照してください。
2. Kubernetesクラスターのオートスケールが有効になっていることを確認します。
3. Kubernetesクラスターで、次の手順を実行します:
   1. デフォルトのストレージクラスが定義されていて、各ワークスペースのボリュームを動的にプロビジョニングできることを確認します。
4. チュートリアル: Kubernetes向けGitLabエージェントをセットアップする。
5. オプション。ワークスペースでコンテナをビルドおよび実行します。
6. オプション。プライベートコンテナレジストリのサポートを設定します。
7. オプション。ワークスペースのsudoアクセスを設定します。

AWSを使用している場合は、OpenTofuチュートリアルを使用できます。詳細については、チュートリアル: AWSでワークスペースのインフラストラクチャをセットアップするを参照してください。

ワークスペースを作成する

前提要件:

• ワークスペースのインフラストラクチャをセットアップする必要があります。
• ワークスペースおよびエージェントプロジェクトに対してデベロッパーロール以上を持っている必要があります。

ワークスペースの起動には数分かかる場合があります。ワークスペースを開くには、プレビューでワークスペースを選択します。ターミナルにアクセスして、必要な依存関係をインストールすることもできます。

ワークスペース起動の進捗を監視する

ワークスペースを起動すると、初期化タスクとpostStartイベントの進捗をワークスペースログで確認できます。詳しくは、Workspace logs directoryを参照してください。

プラットフォームの互換性

ワークスペースのプラットフォーム要件は、開発ニーズによって異なります。

基本的なワークスペース機能では、基盤となるオペレーティングシステムに関係なく、Kubernetes向けGitLabエージェントをサポートする任意のlinux/amd64Kubernetesクラスタ上でワークスペースが実行されます。

プラットフォーム要件に合った方法を選択するには、ワークスペースのsudoアクセスの設定を参照してください。

ワークスペースでコンテナをビルドおよび実行する

開発環境では、ランタイム時に依存関係を管理および使用するために、コンテナのビルドと実行が必要になることがよくあります。ワークスペースでコンテナをビルドおよび実行するには、Sysboxを使用してワークスペースのsudoアクセスを設定する方法を参照してください。

プライベートコンテナレジストリのサポートを設定する

プライベートコンテナレジストリのイメージを使用するには:

1. Kubernetesにイメージプルシークレットを作成します。
2. このシークレットのnameとnamespaceをKubernetes向けGitLabエージェントの設定に追加します。

詳細については、image_pull_secretsを参照してください。

ワークスペースのsudoアクセスを設定する

開発環境では、ランタイムに依存関係をインストール、設定、および使用するために、sudo権限が必要になることがよくあります。プラットフォーム要件に合った方法を選択します:

前提要件:

• コンテナイメージは任意のユーザーIDをサポートする必要があります。sudoアクセスが設定されていても、devfileで使用されるコンテナイメージは、ユーザーID 0では実行できません。

Sysboxを使用する

Sysboxは、コンテナの分離を改善し、コンテナが仮想マシンと同じワークロードを実行できるようにするコンテナランタイムです。

Sysboxでsudoアクセスを設定するには:

1. Kubernetesクラスターで、Sysboxをインストールします。

2. Kubernetes向けGitLabエージェントを設定します:

   • デフォルトのランタイムクラスを設定します。default_runtime_classで、Sysboxのランタイムクラスを入力します。たとえば、sysbox-runcなどです。
   • 特権エスカレーションを有効にします。allow_privilege_escalationをtrueに設定します。
   • Sysboxに必要な注釈を設定します。annotationsを{"io.kubernetes.cri-o.userns-mode": "auto:size=65536"}に設定します。

Kata Containersを使用する

Kata Containersは、コンテナのように動作する軽量仮想マシンの標準実装ですが、仮想マシンのワークロード分離とセキュリティを提供します。

Kata Containersでsudoアクセスを設定するには:

1. Kubernetesクラスターで、Kata Containersをインストールします。

2. Kubernetes向けGitLabエージェントを設定します:

   • デフォルトのランタイムクラスを設定します。default_runtime_classで、Kata Containersのランタイムクラスを入力します。たとえば、kata-qemuなどです。
   • 特権エスカレーションを有効にします。allow_privilege_escalationをtrueに設定します。

ユーザーネームスペースを使用する

ユーザーネームスペースは、コンテナユーザーをホストユーザーから分離します。

ユーザーネームスペースでsudoアクセスを設定するには:

1. Kubernetesクラスターで、ユーザーネームスペースを設定します。

2. Kubernetes向けGitLabエージェントを設定します:

   • use_kubernetes_user_namespacesをtrueに設定します。
   • allow_privilege_escalationをtrueに設定します。

SSHでワークスペースに接続する

前提要件:

• devfileで指定されたイメージに対してSSHアクセスを有効にする必要があります。詳細については、ワークスペースコンテナイメージを更新するを参照してください。
• GitLabワークスペースプロキシを指すTCPロードバランサーを設定する必要があります。詳細については、DNSレコードを更新するを参照してください。

SSHクライアントを使用してワークスペースに接続するには:

1. gitlab-workspaces-proxy-sshサービスの外部IPアドレスを取得します:

   kubectl -n gitlab-workspaces get service gitlab-workspaces-proxy-ssh

2. ワークスペースの名前を取得します:

   1. 左側のサイドバーで、検索または移動先を選択します。
   2. あなたの作業を選択します。
   3. ワークスペースを選択します。
   4. 接続するワークスペースの名前をコピーします。

3. 次のコマンドを実行します:

   ssh <workspace_name>@<ssh_proxy_IP_address>

4. パスワードには、少なくともread_apiスコープを持つパーソナルアクセストークンを入力します。

TCPロードバランサーを介してgitlab-workspaces-proxyに接続すると、gitlab-workspaces-proxyはユーザー名（ワークスペース名）を調べ、GitLabとやり取りして、以下を確認します:

• パーソナルアクセストークン
• ワークスペースへのユーザーアクセス

ワークスペースコンテナイメージを更新する

カスタムワークスペースイメージは、2つの方法で更新できます。

ワークスペースイメージがワークスペースベースイメージに基づいている場合、SSHサポートはすでに設定されており、使用する準備ができています。この方法では、イメージにワークスペースに必要なすべての設定があることが保証されます。詳細な手順については、カスタムワークスペースイメージを作成するを参照してください。

ワークスペースベースイメージを使用しない場合は、独自のベースイメージからビルドできます。これを行う場合は、ランタイムイメージでSSHサポートを手動で設定します:

1. ランタイムイメージにsshdをインストールします。
2. gitlab-workspacesという名前のユーザーを作成し、パスワードなしでコンテナにアクセスできるようにします。

以下は、SSHの設定例です:

FROM golang:1.20.5-bullseye

# Install `openssh-server` and other dependencies
RUN apt update \
    && apt upgrade -y \
    && apt install openssh-server sudo curl git wget software-properties-common apt-transport-https --yes \
    && rm -rf /var/lib/apt/lists/*

# Permit empty passwords
RUN sed -i 's/nullok_secure/nullok/' /etc/pam.d/common-auth
RUN echo "PermitEmptyPasswords yes" >> /etc/ssh/sshd_config

# Generate a workspace host key
RUN ssh-keygen -A
RUN chmod 775 /etc/ssh/ssh_host_rsa_key && \
    chmod 775 /etc/ssh/ssh_host_ecdsa_key && \
    chmod 775 /etc/ssh/ssh_host_ed25519_key

# Create a `gitlab-workspaces` user
RUN useradd -l -u 5001 -G sudo -md /home/gitlab-workspaces -s /bin/bash gitlab-workspaces
RUN passwd -d gitlab-workspaces
ENV HOME=/home/gitlab-workspaces
WORKDIR $HOME
RUN mkdir -p /home/gitlab-workspaces && chgrp -R 0 /home && chmod -R g=u /etc/passwd /etc/group /home

# Allow sign-in access to `/etc/shadow`
RUN chmod 775 /etc/shadow

USER gitlab-workspaces

関連トピック

• チュートリアル: Kubernetes向けGitLabエージェントをセットアップする
• ワークスペースの設定
• ワークスペース設定
• ワークスペースのトラブルシューティング
• GitLabリモート開発ワークスペースのクイックスタートガイド
• GitLabでオンデマンドのクラウドベース開発環境用のインフラストラクチャをセットアップする