デプロイ

デプロイをスケジュールするには

1. Space コマンドラインツールを使用して https://public.registry.jetbrains.space/p/space/containers/space-cli:latest から Docker イメージを取得します。

2. コマンドラインツールを Space に接続します。

   ./space configure https://mycompany.jetbrains.space space_auth_token

   ここで、https://mycompany.jetbrains.space は Space インスタンスの URL で、space_auth_token は Space 認証トークンです。これを行う必要があるのは 1 回だけです。ツールは、提供された設定をローカルの ~/.space/client-config ファイルに保存します。

3. schedule コマンドを使用して、デプロイをスケジュールします。通常、このコマンドはデプロイビルドの一部として CI/CD ツールによって実行する必要があります。例:

   ./space deployments schedule MY-WEB-APPLICATION production-server --version $DEPLOYMENT_VERSION --commit $DEPLOYMENT_COMMIT --ext-label 'My CI/CD service' --ext-url https://mycicdservice.url

   ここに:

   • MY-WEB-APPLICATION : プロジェクト識別子 (Space でプロジェクトを作成するときにプロジェクトに割り当てられます)。

   • production-server : デプロイターゲットの名前。

   • $DEPLOYMENT_VERSION および $DEPLOYMENT_COMMIT : ターゲットにデプロイするバージョンとコミット。

     特定のコミットを指定するには、次の形式 <repo>:<branch>:<commitID> を使用します。ここで、<repo> と <branch> は必須であり、<commitID> はオプションです。例: mywebapp:main:538dc16b 最新のコミットを使用するには、HEAD を指定します。

     スケジュールされた状態にあるこのブランチに既存のデプロイがある場合、./space deployments schedule コマンドはこのデプロイを更新します。そのようなデプロイが存在しない場合は、新しいデプロイが作成されます。

   • --ext-label および --ext-url では、デプロイを実行する CI/CD ツールの名前と URL を指定できます。例: これは、対応する CI/CD ビルド、デプロイターゲット、またはその他のものへのリンクである可能性があります。このリンクは、デプロイの隣の Space に表示されます。

   space コマンドの詳細については、次を実行してください。

   ./space deployments --help

デプロイをスケジュールするには

• オートメーションジョブで Space SDK クライアントを使用します。例:

  job("Deploy") { container("Run deploy script", image = "gradle:7.1-jre11") { kotlinScript { api -> // ... api.space().projects.automation.deployments.schedule( // get id of the current project project = api.projectIdentifier(), // deployment target name targetIdentifier = TargetIdentifier.Key("production-server"), version = "1.0.0", externalLinkLabel = "My CI/CD service", externalLinkUrl = "https://mycicdservice.url" // commitRefs is not required // the deployment will get the ID of the current commit - // the one that contains the currently running .space.kts ) } } }

デプロイをスケジュールするには

• POST リクエストを deployments/schedule エンドポイントに送信します。例:

  POST https://mycompany.jetbrains.space/api/http/projects/id:project-id/automation/deployments/start Authorization: Bearer [[[space_auth_token|https://www.jetbrains.com/help/space/deployments.html#obtaining-a-space-access-token]]] Accept: application/json Content-Type: application/json { "targetIdentifier": "key:production-server", "version": "1.0.0", "commitRefs": [ { "repositoryName": "my-web-app", "branch": "release", "commit": "abc1234" } ] }

デプロイをスケジュールするには

1. プロジェクトのデプロイページを開いてから、デプロイターゲットを開きます。

2. 新しいデプロイを作成するデプロイターゲットを開きます。

3. 新規をクリックし、デプロイを選択します。

4. 新規デプロイメントページで:

   • ターゲットにデプロイされるバージョンを指定します。

   • リポジトリ名で、ブランチを選択し、必要に応じて、デプロイするコミットを選択します。このブランチにまだ変更がある可能性がある場合は、特定のコミットの代わりに最新を選択できます。

   • 状況では、予定通りに出発します。

   • スケジュールには、デプロイの日付と時刻を指定します。

   • 表示オプションで、デプロイの説明を入力し、デプロイに関連付ける外部リンクを指定できます。例: これは、対応する CI/CD ビルド、デプロイターゲット、またはその他のものへのリンクである可能性があります。このリンクは、デプロイの隣の Space に表示されます。

5. 作成をクリックします。

デプロイを開始するには

1. Space コマンドラインツールを使用して https://public.registry.jetbrains.space/p/space/containers/space-cli:latest から Docker イメージを取得します。

2. コマンドラインツールを Space に接続します。

   ./space configure https://mycompany.jetbrains.space space_auth_token

   ここで、https://mycompany.jetbrains.space は Space インスタンスの URL で、space_auth_token は Space 認証トークンです。これを行う必要があるのは 1 回だけです。ツールは、提供された設定をローカルの ~/.space/client-config ファイルに保存します。

3. start コマンドを使用して、デプロイステータスをデプロイ中に変更します。例:

   ./space deployments start MY-WEB-APPLICATION production-server --version $DEPLOYMENT_VERSION --commit $DEPLOYMENT_COMMIT

   ここに:

   • MY-WEB-APPLICATION : プロジェクト識別子 (Space でプロジェクトを作成するときにプロジェクトに割り当てられます)。

   • production-server : デプロイターゲットの名前。

   • $DEPLOYMENT_VERSION および $DEPLOYMENT_COMMIT : ターゲットにデプロイするバージョンとコミット。

     特定のコミットを指定するには、次の形式 <repo>:<branch>:<commitID> を使用します。例: mywebapp:main:538dc16b

     スケジュールされたデプロイに他のコミット ID またはバージョンが指定されている場合、リクエストによってそれらが更新されます。例: コミット mywebapp:main:abc1234 に基づいて、バージョン 1.0.0 のデプロイをスケジュールしました。./space deployments start ... 1.0.1 mywebapp:main:def5678 を実行すると、Space のデプロイはコミット ID を def5678 に、バージョンを 1.0.1 に変更します。

   space コマンドの詳細については、次を実行してください。

   ./space deployments --help

デプロイを開始するには

• オートメーションジョブで Space SDK クライアントを使用します。例:

  job("Deploy") { container("Run deploy script", image = "gradle:7.1-jre11") { kotlinScript { api -> // ... api.space().projects.automation.deployments.start( // get id of the current project project = api.projectIdentifier(), // deployment target name targetIdentifier = TargetIdentifier.Id("production-server"), version = "1.0.0", // With syncWithAutomationJob = true, // Space will automatically change deployment status // based on the job execution result. // If the job fails, the deployment fails as well. // If the job is successful, the deployment becomes 'current'. syncWithAutomationJob = true // commitRefs is not required // the deployment will get the ID of the current commit - // the one that contains the currently running .space.kts ) } } }

デプロイを開始するには

• POST リクエストを deployments/start エンドポイントに送信します。例:

  POST https://mycompany.jetbrains.space/api/http/projects/id:project-id/automation/deployments/start Authorization: Bearer [[[space_auth_token|https://www.jetbrains.com/help/space/deployments.html#obtaining-a-space-access-token]]] Accept: application/json Content-Type: application/json { "targetIdentifier": "id:production-server", "version": "1.0.0", "commitRefs": [ { "repositoryName": "my-web-app", "branch": "release", "commit": "abc1234" } ] }

デプロイを開始するには

1. プロジェクトのデプロイページを開いてから、デプロイターゲットを開きます。

2. デプロイターゲットを開きます。

3. スケジュールされたデプロイを見つけて、ドロップダウンリストからデプロイステータスを選択します。

   

デプロイを終了するには

1. Space コマンドラインツールを使用して https://public.registry.jetbrains.space/p/space/containers/space-cli:latest から Docker イメージを取得します。

2. コマンドラインツールを Space に接続します。

   ./space configure https://mycompany.jetbrains.space space_auth_token

   ここで、https://mycompany.jetbrains.space は Space インスタンスの URL で、space_auth_token は Space 認証トークンです。これを行う必要があるのは 1 回だけです。ツールは、提供された設定をローカルの ~/.space/client-config ファイルに保存します。

3. finish コマンドを使用して、デプロイステータスをデプロイ中に変更します。例:

   ./space deployments finish MY-WEB-APPLICATION production-server --version $DEPLOYMENT_VERSION --commit $DEPLOYMENT_COMMIT

   ここに:

   • MY-WEB-APPLICATION : プロジェクト識別子 (Space でプロジェクトを作成するときにプロジェクトに割り当てられます)。

   • production-server : デプロイターゲットの名前。

   • $DEPLOYMENT_VERSION および $DEPLOYMENT_COMMIT : ターゲットにデプロイするバージョンとコミット。

     特定のコミットを指定するには、次の形式 <repo>:<branch>:<commitID> を使用します。例: mywebapp:main:538dc16b

   デプロイを失敗させるには、fail コマンドを使用します。例:

   ./space deployments fail MY-WEB-APPLICATION production-server --version $DEPLOYMENT_VERSION --commit $DEPLOYMENT_COMMIT

   space コマンドの詳細については、次を実行してください。

   ./space deployments --help

デプロイを終了するには

• オートメーションジョブで Space SDK クライアントを使用します。例:

  job("Deploy") { container("Run deploy script", image = "gradle:7.1-jre11") { kotlinScript { api -> // ... api.space().projects.automation.deployments.finish( // get id of the current project project = api.projectIdentifier(), targetIdentifier = TargetIdentifier.Key("production-server"), version = "1.0.0" // commitRefs is not required // the deployment will get the ID of the current commit - // the one that contains the currently running .space.kts ) // to fail the deployment, use ...deployments.fail() } } }

デプロイを終了するには

• POST リクエストを deployments/finish または deployments/fail エンドポイントに送信します。例:

  POST https://mycompany.jetbrains.space/api/http/projects/id:project-id/automation/deployments/finish Authorization: Bearer [[[space_auth_token|https://www.jetbrains.com/help/space/deployments.html#obtaining-a-space-access-token]]] Accept: application/json Content-Type: application/json { "targetIdentifier": "key:production-server", "version": "1.0.0", "commitRefs": [ { "repositoryName": "my-web-app", "branch": "release" } ] }

デプロイを終了するには

1. プロジェクトのデプロイページを開いてから、デプロイターゲットを開きます。

2. デプロイターゲットを開きます。

3. デプロイがすでに存在する場合は、それを見つけて、ドロップダウンリストから現在のステータスまたは失敗したステータスを選択します。

   

   既存のデプロイがない場合は、現在のステータスで新しいデプロイを作成します。