パラメーターとシークレット
devfile を使用すると、プロジェクトおよび個人のパラメーターとシークレットを開発環境に提供できます。開発環境内では、これらのパラメーターとシークレットを環境変数として参照できます。
プロジェクトのパラメーターとシークレットを開発環境に提供する
開発環境には、プロジェクト全体に共通のパラメーターとシークレット (URL、ファイルパス、共通認証トークンなど) を提供できます。
必要なプロジェクトパラメーターとシークレットを定義するには、プロジェクトの devfile を使用します。開発環境は、プロジェクトのシークレットとパラメーターのストレージから値を取得します。必要なパラメーターとシークレットは、ターゲット開発環境で環境変数として使用できます。
プロジェクトを開きます。
プロジェクトのサイドバーメニューで、設定を選択し、次にシークレットとパラメーターを選択します。
作成をクリックし、シークレットまたはパラメーターを選択します。
指定
キー : パラメーター名。この名前を使用して、devfile 内でこのパラメーターを参照します。
値 : パラメーター値。
制限:
シークレットとパラメーターは、特定のプロジェクトのスコープ内にのみ存在します。1 つのプロジェクトでシークレットまたはパラメーターを作成した場合、他のプロジェクトで使用することはできません。
シークレットとパラメーターのキーはプロジェクト内で一意である必要があります。同じキーを持つシークレットとパラメーターも許可されません。
キーは 128 文字以下である必要があり、英数字 (
[a-z]
、[A-Z]
、[0-9]
)、ダッシュ (-
)、またはアンダースコア (_
) のみを含めることができます。キーでは大文字と小文字が区別されません。
シークレットまたはパラメーターの値の最大サイズは 30KB です。
作成したプロジェクトのシークレットとパラメーターを devfile で参照するには、環境変数に割り当てます。パラメーターまたはシークレット名 (キー) の前に
project:
プレフィックスを付ける必要があります。例:# suppose we created a project parameter 'service-url' # and a project secret 'auth-token' schemaVersion: 2.2.0 attributes: space: instanceType: large editor: type: Idea components: - name: dev-container container: env: - name: URL value: '{{ project:service-url }}' - name: TOKEN value: '{{ project:auth-token }}'
個人パラメーターとシークレットを開発環境に提供する
特定の開発環境パラメーターおよびシークレットの個人値を提供するようユーザーに要求できます。例: これらは、プロジェクトのバイナリ依存関係をダウンロードするためのユーザー認証情報である可能性があります。必要なパラメーターとシークレットは、ターゲット開発環境で環境変数として使用できます。
必要な環境変数 (パラメーターとシークレット) を定義するには、プロジェクトの devfile を使用します。開発環境を作成するとき、ユーザーは変数値を指定するように求められます。値は、シークレットとパラメーターの個人ユーザーストレージから取得する必要があります。
必要な環境変数を定義するには
プロジェクトリポジトリで devfile を開きます。存在しない場合は、新しいもの (
.space/devfile.yaml
など) を作成します。必要な環境変数を指定します。例: 環境変数
DB_USERNAME
(値はプレーンパラメーターであることが期待されます) と変数DB_TOKEN
(値はシークレットであることが期待されます) が必要です。schemaVersion: 2.2.0 attributes: space: instanceType: large editor: type: Idea requiredParameters: - name: DB_USERNAME description: 'Database username' requiredSecrets: - name: DB_TOKEN description: 'Database access token'変更をコミットしてプッシュします。
この後、開発環境を作成するときに、プロジェクト開発者は、定義されたシークレットとパラメーターの値を指定する必要があります (これは、最初に作成された環境に対してのみ行う必要があります。後続のすべての環境には、これらの設定が事前定義されます)。
個人のシークレットとパラメーターを必要な環境変数に割り当てるには
パーソナルナビゲーションサイドバーで、開発環境をクリックし、次に環境変数をクリックします。
新規パラメーターまたは新しいシークレットをクリックして、パラメーターまたはシークレットを作成します。
指定
キー : パラメーター / シークレット名。
値 : パラメーター / シークレット値。
新しい開発環境を作成するときは、新規開発環境ウィンドウの環境変数で、環境変数を対応するパラメーターとシークレットに割り当てます。
指定した環境変数は、新しく作成された開発環境でのみ設定されることに注意してください。既存の開発環境にはそのような変数はありません。
関連ページ:
![](https://resources.jetbrains.com/help/img/space/devenvChooseDevfile.png)
開発ファイル
プロジェクトの開発環境を構成するには、devfile を使用する必要があります。開発ファイルは、ビルド環境の構成と実行に YAML 形式を使用するオープン仕様です。Space は、2.2.0 仕様の機能サブセットのみをサポートします (サポートされる機能は、現在の Space ドキュメントで完全にカバーされています。このドキュメントに機能が記載されていない場合、その機能はサポートされていません)。開発ファイルの場所:my-project // project root ├─── .space...
![](https://resources.jetbrains.com/help/img/space/projectMembers.png)
プロジェクトに参加する
あるプロジェクトに貢献を開始したい場合は、そのプロジェクトに参加する必要があります。つまり、そのプロジェクトのメンバーになる必要があります。貢献しようとしているプロジェクトに移動します。すでにメンバーである場合は、プロジェクトのページのプロジェクトメンバーにリストされます。そうでない場合は、プロジェクト管理者に連絡してメンバーシップを依頼してください。プロジェクト管理者を確認するには、プロジェクトページでメンバーウィジェットをクリックします。プロジェクトを探す:すべてのプロジェクトは名前で見つ
![](https://resources.jetbrains.com/help/img/space/devenvNew.png)
開発環境で開発する
前提条件:開発環境で開発を開始する前に、次の手順を実行します。JetBrains Toolbox アプリをローカルマシンにインストールします。IntelliJ ベースの IDE を使用する場合は、Toolbox アプリを利用して JetBrains Gateway をインストールします。(オプション) プロジェクトの開発環境を構成します。この手順をスキップすると、プロジェクトはデフォルトの Docker イメージに基づいて開発環境で開かれます。開発環境で開きたいプロジェクトに少なくともプロジェク...
![](https://resources.jetbrains.com/help/img/space/gitPush-warmup-branchFilter-runInBranch.png)
ウォームアップ
開発環境では、IDE ウォームアップフェーズ (IDE がインデックスを構築し、プロジェクトの依存関係の解決などのその他のバックグラウンドアクティビティを実行する期間) を削除することで、開発速度を大幅に向上させることができます。これらすべてのルーチンを開発環境のウォームアップに配置し、スケジュールまたはコミットプッシュで実行できます。ウォームアップの結果、ウォームアップスナップショット (Docker ボリューム) が作成され、開発環境にマウントされます。ウォームアップが定期的に実行されているこ...