ツイートシェアはてブ LINE Pocket

デプロイビルド構成

プロジェクトが構築されテストされたら、最終的なインフラストラクチャにデプロイする必要があることがよくあります。たとえば、NuGet ギャラリーにパッケージをアップロードしたり、DockerHub リポジトリにコンテナーを配信したり、ドキュメント Web サイトのソースを更新したりします。さまざまな CI/CD ソリューションでは、パイプラインのこの最後のステップに「デプロイ」ステージ、配信ターゲット、リリース、本番環境などのさまざまな用語を使用します。

TeamCity では、配信タスクは、通常のビルドルーチンを実行する同じ「ビルド構成」オブジェクトによって実行されます。ただし、ビルドと配信は異なるチームメンバーによってトリガーされる異なるタスクであるため、製品をデプロイする構成は、明示的に配備構成としてマークできます。

重要なポイント

デプロイ構成は、通常の構築ルーチンを実行する構成と、アプリを外部インフラストラクチャに配信する構成を区別するように設計されています。
デプロイ構成は、機能の点で通常の構成と変わりません。同じビルド機能を利用したり、同じビルドランナーを使用したりすることができます。
デプロイ構成が同じチェーン内の通常の構築 / テスト構成に従っている場合、十分な権限を持つ TeamCity ユーザーは通常の構成からデプロイを直接トリガーできます。
デプロイ構成では、個人用ビルドを実行できません。また、1 つのデプロイ構成に属する 2 つのビルドを同時に実行することはできません。
きめ細かいユーザー権限を設定するには、デプロイとビルド / テスト構成を異なるサブプロジェクトに分割することをお勧めします。
ビルド構成タイプを切り替えるには、「構成設定 | 一般」タブに移動します。

サンプル

このチュートリアルでは、コンポジットビルド構成記事で開発されたパイプラインを補足するデプロイ構成を作成します。

パイプラインの構築を作成する

コンポジットビルド構成の記事で説明されている手順に従って、複合「すべてビルド」構成で終わる 5 つの相互接続された構成のチェーンを作成します。

デプロイサブプロジェクトの作成

建物構成を編集して実行できる通常のプロジェクト開発者は、配信タスクを実行できないようにする必要があります。きめ細かいユーザー権限を設定し、配信関連のパラメーターと資格情報をメインの構築パイプラインから離れた場所に安全に保存するには、別のプロジェクトで配信構成を作成することをお勧めします。

管理 | <あなたのプロジェクト> に移動し、サブプロジェクトを作成するをクリックしてください。
手動タイルを選択して、特定の VCS リポジトリに関係のない空のプロジェクトを作成します。
サブプロジェクト名を「デプロイ構成」に設定します。
プロジェクトと配信ターゲットのタイプに応じて、デプロイ構成には異なる手順が含まれる場合があります。例: 構成では、nuget push コマンドを実行してパッケージを NuGet ギャラリーにアップロードする .NET ランナー、またはファイルを FTP サーバーまたは Windows 共有にアップロードするデプロイヤの 1 つを使用できます。
このサンプルでは、デプロイ構成は Docker イメージを DockerHub レジストリにアップロードします。このため、レジストリアドレスとログイン資格情報を指定する Docker 接続を作成する必要があります。この接続は、このサブプロジェクトのすべての構成で使用できます。接続を作成するには、サブプロジェクトの接続タブに移動します。

以下の Kotlin コードは、最終的なセットアップを示しています。

// Main Project
project {
    buildType(Building_1) // The "Build All" configuration
    subProject(BuildingConfigsProject) // The subproject with building configs
    subProject(DeploymentConfigsProject) // Our new subproject for deployment
    
}

// ...

object DeploymentConfigsProject : Project({
    name = "Deployment Configurations"
    description = "This subproject contains configurations that perform delivery tasks"

    features {
        dockerRegistry {
            id = "PROJECT_EXT_5"
            name = "Docker Registry"
            userName = "your_dockerhub_name"
            password = "credentialsJSON:0ff181ee-cc10-48ac-b5f4-ce50ca2013b4"
        }
    }
})

最初のデプロイ構成を追加する

新しいサブプロジェクトの一般設定タブで、ビルド構成を作成するをクリックします。
手動オプションを選択し、構成名として「Deploy Console (Windows)」と入力します。
ビルド構成タイプを「デプロイ」に設定します。
バージョン管理設定で、VCS ルートを接続をクリックし、すべての「ビルド ...」構成で使用される同じルートを選択します。
「コンソールのデプロイ (Windows)」は、 「コンソールと Web のビルド (win-x64)」ビルド構成に依存しており、そのアーティファクトにアクセスできる必要があります。
建物の構成 | 依存関係 " に移動し、対応するスナップショットとアーティファクト (bin => context) の依存関係を追加します。
生成されたコンテナーをアップロードする必要があるため、デプロイサブプロジェクトの作成セクションで作成した Docker 接続を使用する Docker サポートビルド機能を追加します。
構成に 3 つのビルドステップを追加します。
- ステップ #1 — 必要な .NET ランタイムコンテナー(英語)イメージをプル (すでにプルされている場合は更新) する Docker ランナー。
- ステップ #2 — context/console.windows.dockerfile の命令を使用してイメージを構築する Docker ランナー。
- ステップ #3 — 新しく構築されたイメージを公開する別の Docker ランナーステップ。

最終的な構成セットアップは次のようになります。

object DeploymentConfigsProject_DeployConsoleWindows : BuildType({
  name = "Deploy Console (Windows)"

  enablePersonalBuilds = false
  type = BuildTypeSettings.Type.DEPLOYMENT
  maxRunningBuilds = 1

  vcs {
    root(DslContext.settingsRoot)
  }

  steps {
    dockerCommand {
      name = "Pull container"
      commandType = other {
        subCommand = "pull"
        commandArgs = "mcr.microsoft.com/dotnet/runtime:7.0"
      }
    }
    dockerCommand {
      name = "Build container"
      commandType = build {
        source = file {
          path = "context/console.windows.dockerfile"
        }
        contextDir = "context"
        platform = DockerCommandStep.ImagePlatform.Windows
        namesAndTags = "username/clock-console:windows"
        commandArgs = "--build-arg baseImage=mcr.microsoft.com/dotnet/runtime:7.0"
      }
    }
    dockerCommand {
      name = "Push container"
      commandType = push {
        namesAndTags = "username/clock-console:windows"
      }
    }
  }

  features {
    dockerSupport {
      loginToRegistry = on {
        dockerRegistryId = "PROJECT_EXT_5"
      }
    }
  }

  dependencies {
    dependency(Building_BuildConsoleWebWinX64) {
      snapshot {
      }

      artifacts {
        artifactRules = "bin => context"
      }
    }
  }

  requirements {
    contains("teamcity.agent.os.name", "windows-server-2022")
  }
})

配信設定を実行する

上記のコードは、デプロイビルド構成の最初の固有の機能を強調しています。つまり、そのデフォルト設定が通常の構成の設定とは異なります。

個人用ビルドのトリガーを許可するオプションは無効になっています。
複数のビルドが同じ配信先に同時にアクセスしようとすることによって引き起こされる潜在的な問題を回避するために、構成内の合計最大ビルド数は 1 に制限されています。

デプロイビルド構成のその他の独自の機能は次のとおりです。

デプロイビルドを開始するボタンは、実行ではなく配置と呼ばれます。
アーティファクトを生成した構成から直接、アーティファクトをデプロイできます。完了した通常ビルドの詳細を開き、「デプロイ」セクションの配置をクリックします。
デプロイビルドが開始されると、「デプロイ」セクションから進行状況を追跡できます。ビルドが完了すると、再デプロイボタンが表示されます。このボタンを使用すると、配信ルーチンを再実行できます。
ビルド構成のアーティファクトがすでにデプロイされている場合、以前のビルドは、デプロイ構成をトリガーすると新しい配信がオーバーライドされることをユーザーに警告します。
TeamCity プロジェクト、構成、個々のビルドの変更タブと変更ログタブでは、リビジョン番号をクリックして各変更に関する詳細情報を表示できます。パイプラインに配信構成がある場合、この変更の詳細ページにはデプロイタブが表示され、この変更がいつ初めて配信されたかをすぐに識別できます。
通常のビルド構成では、最新の変更を含むビルドが最初に表示されます。デプロイ構成では、ビルドが時系列に並べられます。

配信構成をさらに追加する

「Deploy Console (Windows)」構成設定に移動し、アクション | 構成のコピーをクリックして配信構成のコピーを 3 つ作成します。
新しいコピーを次のように変更します。
- Web を導入する (Windows) — context/web.linux.dockerfile からの指示を使用してイメージを構築し、このイメージを別の「docker_username/clock-web」レジストリにプッシュします。
- コンソールのデプロイ (Linux) — ビルドコンソールと Web (linux-x64) 構成に対するスナップショットとアーティファクトの依存関係があります。ビルド手順で別の Linux ベースのイメージを使用します。
- Web を導入する (Linux) — 上記の両方。
親 (最上位) プロジェクトに移動し、既存の「すべてビルド」の横に新しいステップレス構成を作成します。この新しい構成を「すべてデプロイ」と呼び、そのタイプを「デプロイ」に設定します。
「すべてデプロイ」構成設定で、4 つの個別の「デプロイ ... 」構成すべてにスナップショットの依存関係を追加します。

最終的には、すべての構築タスクとデプロイタスクを便利に実行するメインプロジェクトレベルで 4 つの独立したデプロイ構成と 2 つの構成が得られます。

この設定では、個々の「ビルド ...」構成ビルドのビルド結果ページの「デプロイ」セクションに複数のオプションが表示されることに注意してください。ビルドが終了すると、関連するデプロイターゲットをトリガーできます。

すべての「デプロイ ...」構成の最終構成を以下に示します。

object DeployAll : BuildType({
    name = "Deploy All"

    enablePersonalBuilds = false
    type = BuildTypeSettings.Type.DEPLOYMENT
    maxRunningBuilds = 1

    dependencies {
        snapshot(DeploymentConfigsProject_DeployConsoleLinux) {
        }
        snapshot(DeploymentConfigsProject_DeployConsoleWindows) {
        }
        snapshot(DeploymentConfigsProject_DeployWebLinux) {
        }
        snapshot(DeploymentConfigsProject_DeployWebWindows) {
        }
    }
})

object DeploymentConfigsProject_DeployConsoleWindows : BuildType({
    name = "Deploy Console (Windows)"

    enablePersonalBuilds = false
    type = BuildTypeSettings.Type.DEPLOYMENT
    maxRunningBuilds = 1

    vcs {
        root(DslContext.settingsRoot)
    }

    steps {
        dockerCommand {
            name = "Pull container"
            commandType = other {
                subCommand = "pull"
                commandArgs = "mcr.microsoft.com/dotnet/runtime:7.0"
            }
        }
        dockerCommand {
            name = "Build container"
            commandType = build {
                source = file {
                    path = "context/console.windows.dockerfile"
                }
                contextDir = "context"
                platform = DockerCommandStep.ImagePlatform.Windows
                namesAndTags = "username/clock-console:windows"
                commandArgs = "--build-arg baseImage=mcr.microsoft.com/dotnet/runtime:7.0"
            }
        }
        dockerCommand {
            name = "Push container"
            commandType = push {
                namesAndTags = "username/clock-console:windows"
            }
        }
    }

    features {
        dockerSupport {
            loginToRegistry = on {
                dockerRegistryId = "PROJECT_EXT_5"
            }
        }
    }

    dependencies {
        dependency(Building_BuildConsoleWebWinX64) {
            snapshot {
            }

            artifacts {
                artifactRules = "bin => context"
            }
        }
    }

    requirements {
        contains("teamcity.agent.os.name", "windows-server-2022")
    }
})

object DeploymentConfigsProject_DeployConsoleLinux : BuildType({
    name = "Deploy Console (Linux)"

    enablePersonalBuilds = false
    type = BuildTypeSettings.Type.DEPLOYMENT
    maxRunningBuilds = 1

    vcs {
        root(DslContext.settingsRoot)
    }

    steps {
        dockerCommand {
            name = "Pull runtime dependencies"
            commandType = other {
                subCommand = "pull"
                commandArgs = "mcr.microsoft.com/dotnet/runtime-deps:7.0-alpine"
            }
        }
        dockerCommand {
            name = "Build container"
            commandType = build {
                source = file {
                    path = "context/console.linux.dockerfile"
                }
                contextDir = "context"
                platform = DockerCommandStep.ImagePlatform.Linux
                namesAndTags = "username/clock-console:ubuntu"
                commandArgs = "--build-arg baseImage=mcr.microsoft.com/dotnet/runtime-deps:7.0-alpine"
            }
        }
        dockerCommand {
            name = "Push container"
            commandType = push {
                namesAndTags = "username/clock-console:ubuntu"
            }
        }
    }

    features {
        dockerSupport {
            loginToRegistry = on {
                dockerRegistryId = "PROJECT_EXT_5"
            }
        }
    }

    dependencies {
        dependency(Building_BuildConsoleWebLinuxX64) {
            snapshot {
            }

            artifacts {
                artifactRules = "bin => context"
            }
        }
    }

    requirements {
        contains("teamcity.agent.os.name", "ubuntu-20.04")
    }
})

object DeploymentConfigsProject_DeployWebWindows : BuildType({
    name = "Deploy Web (Windows)"

    enablePersonalBuilds = false
    type = BuildTypeSettings.Type.DEPLOYMENT
    maxRunningBuilds = 1

    vcs {
        root(DslContext.settingsRoot)
    }

    steps {
        dockerCommand {
            name = "Pull container"
            commandType = other {
                subCommand = "pull"
                commandArgs = "mcr.microsoft.com/dotnet/runtime:7.0"
            }
        }
        dockerCommand {
            name = "Build container"
            commandType = build {
                source = file {
                    path = "context/web.windows.dockerfile"
                }
                contextDir = "context"
                platform = DockerCommandStep.ImagePlatform.Windows
                namesAndTags = "username/clock-web:windows"
                commandArgs = "--build-arg baseImage=mcr.microsoft.com/dotnet/runtime:7.0"
            }
        }
        dockerCommand {
            name = "Push container"
            commandType = push {
                namesAndTags = "username/clock-web:windows"
            }
        }
    }

    features {
        dockerSupport {
            loginToRegistry = on {
                dockerRegistryId = "PROJECT_EXT_5"
            }
        }
    }

    dependencies {
        dependency(Building_BuildConsoleWebWinX64) {
            snapshot {
            }

            artifacts {
                artifactRules = "bin => context"
            }
        }
    }

    requirements {
        contains("teamcity.agent.os.name", "windows-server-2022")
    }
})

object DeploymentConfigsProject_DeployWebLinux : BuildType({
    name = "Deploy Web (Linux)"

    enablePersonalBuilds = false
    type = BuildTypeSettings.Type.DEPLOYMENT
    maxRunningBuilds = 1

    vcs {
        root(DslContext.settingsRoot)
    }

    steps {
        dockerCommand {
            name = "Pull runtime dependencies"
            commandType = other {
                subCommand = "pull"
                commandArgs = "mcr.microsoft.com/dotnet/runtime-deps:7.0-alpine"
            }
        }
        dockerCommand {
            name = "Build container"
            commandType = build {
                source = file {
                    path = "context/web.linux.dockerfile"
                }
                contextDir = "context"
                platform = DockerCommandStep.ImagePlatform.Linux
                namesAndTags = "username/clock-web:ubuntu"
                commandArgs = "--build-arg baseImage=mcr.microsoft.com/dotnet/runtime-deps:7.0-alpine"
            }
        }
        dockerCommand {
            name = "Push container"
            commandType = push {
                namesAndTags = "username/clock-web:ubuntu"
            }
        }
    }

    features {
        dockerSupport {
            loginToRegistry = on {
                dockerRegistryId = "PROJECT_EXT_5"
            }
        }
    }

    dependencies {
        dependency(Building_BuildConsoleWebLinuxX64) {
            snapshot {
            }

            artifacts {
                artifactRules = "bin => context"
            }
        }
    }

    requirements {
        contains("teamcity.agent.os.name", "ubuntu-20.04")
    }
})

ユーザー権限の設定

管理 | ユーザー管理セクションでは、プロジェクトごとのユーザーロールと権限を設定できます。次の例を考えてみましょう。

ユーザー「Alice」は、親プロジェクト全体に対する「プロジェクト開発者」ロールを持ちます。このロールは、「Building Configurations」サブプロジェクトと「デプロイ Configurations」サブプロジェクトの両方で同じ権限を付与します。
ユーザー「Bob」は、「ビルド構成」では「プロジェクト開発者」であり、「デプロイ構成」では「プロジェクト閲覧者」です。

この設定では、Alice はビルドとデプロイタスクをトリガーできますが、Bob は配信を開始できません。Bob が「ビルド ...」構成のビルド結果を参照すると、TeamCity は「デプロイ」セクションを表示しません。

TeamCity では現在、ビルド構成スコープにロールと権限を設定することはできません。そのため、Bob が「すべてビルド」ビルドを実行できるようにしながら、「すべてデプロイ」ビルドをトリガーできないようにする権限を設定することはできません。この問題を回避するには、これらの集約構成を対応するサブプロジェクトに移動します。

最終更新日: 2023 年 6 月 08 日

TeamCity オンプレミス 2024.03 ヘルプ