az aks draft
Note
このリファレンスは、Azure CLI (バージョン 2.73.0 以降) の aks-preview 拡張機能の一部です。 az aks draft コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
プロジェクト ディレクトリに配置ファイルをビルドし、AKS クラスターにデプロイするためのコマンド。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az aks draft create |
Dockerfile と、プロジェクト ディレクトリに必要な最小限の Kubernetes デプロイ ファイル (helm、kustomize、マニフェスト) を生成します。 |
Extension | GA |
| az aks draft generate-workflow |
自動ビルド用の GitHub ワークフローを生成し、AKS にデプロイします。 |
Extension | GA |
| az aks draft setup-gh |
アプリケーションの GitHub OIDC を設定します。 |
Extension | GA |
| az aks draft up |
|
Extension | GA |
| az aks draft update |
インターネットにアクセスできるようにアプリケーションを更新します。 |
Extension | GA |
az aks draft create
Dockerfile と、プロジェクト ディレクトリに必要な最小限の Kubernetes デプロイ ファイル (helm、kustomize、マニフェスト) を生成します。
az aks draft create [--app]
[--create-config]
[--deployment-only]
[--destination]
[--dockerfile-only]
[--language]
[--path]
例
現在のディレクトリに Dockerfile ファイルとデプロイ ファイルを生成するように求めるメッセージが表示されます。
az aks draft create
現在のディレクトリに Dockerfile のみを生成します。
az aks draft create --dockerfile-only=true
現在のディレクトリ内のデプロイ ファイルのみを生成します。
az aks draft create --deployment-only=true
特定のプロジェクト ディレクトリにあるアプリ名を使用して、Java プロジェクトに Dockerfile とデプロイ ファイルを生成します。
az aks draft create --language=java --app=some_app --destination=/projects/some_project
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Helm リリースの名前を指定します。
構成ファイルへのパスを指定します。
Kubernetes デプロイの配置ファイル (helm、kustomize、マニフェスト) のみを生成します。
プロジェクト ディレクトリへのパスを指定します (既定値は .)。
| プロパティ | 値 |
|---|---|
| 規定値: | . |
Kubernetes デプロイに対してのみ Dockerfile を生成します。
Kubernetes デプロイの作成に使用する言語を指定します。
指定した場所にある Draft バイナリを自動的にダウンロードして使用します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aks draft generate-workflow
自動ビルド用の GitHub ワークフローを生成し、AKS にデプロイします。
このコマンドを実行する前に、アプリケーション用に GitHub OIDC を設定していることを確認してください。 また、Azure 上にリソース グループ、コンテナー レジストリ、Kubernetes クラスターを作成し、 az aks update -n <cluster-name> -g <resource-group-name> --attach-acr <acr-name>を使用して 3 つのリソースをリンクする必要があります。
az aks draft generate-workflow [--branch]
[--cluster-name]
[--container-name]
[--destination]
[--path]
[--registry-name]
[--resource-group]
例
現在のディレクトリに GitHub ワークフローを生成するように求めるメッセージが表示されます。
az aks draft generate-workflow
特定のプロジェクト ディレクトリに GitHub ワークフローを生成するように求めるメッセージが表示されます。
az aks draft generate-workflow --destination=/projects/some_project
リソース グループ、AKS クラスター名、特定のプロジェクト ディレクトリ内のコンテナー レジストリ名を含む GitHub ワークフローを生成します。
az aks draft generate-workflow --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --destination=/projects/some_project
リソース グループ、AKS クラスター名、コンテナー レジストリ名、および特定のプロジェクト ディレクトリ内のコンテナー イメージ名を使用してメイン ブランチからデプロイする GitHub ワークフローを生成します。
az aks draft generate-workflow --branch=main --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --container-name=some_image --destination=/projects/some_project
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
自動的にデプロイする GitHub ブランチを指定します。
AKS クラスター名を指定します。
コンテナー イメージの名前を指定します。
プロジェクト ディレクトリへのパスを指定します (既定値は .)。
指定した場所にある Draft バイナリを自動的にダウンロードして使用します。
プロジェクト ディレクトリへのパスを指定します。
Azure リソース グループの名前を指定します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aks draft setup-gh
アプリケーションの GitHub OIDC を設定します。
az aks draft setup-gh [--app]
[--gh-repo]
[--path]
[--provider]
[--resource-group]
[--subscription-id]
例
リポジトリの GitHub OIDC のセットアップを求めるメッセージが表示されます。
az aks draft setup-gh
特定のリポジトリ用に Azure に GitHub OIDC をセットアップします。
az aks draft setup-gh --provider=azure --gh-repo=some_organization/some_repo
サブスクリプション ID とリソース グループを使用して、Azure に GitHub OIDC をセットアップします。
az aks draft setup-gh --provider=azure --subscription-id=some_subscription --resource-group=some_rg
特定のリポジトリのサブスクリプション ID とリソース グループを使用して、Azure 上のアプリケーション名を使用して GitHub OIDC をセットアップします。
az aks draft setup-gh --app=some_app --provider=azure --subscription-id=some_subscription --resource-group=some_rg --gh-repo=some_organization/some_repo
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Azure Active Directory のアプリケーション名を指定します。
GitHub リポジトリ (組織/repo_name) を指定します。
指定した場所にある Draft バイナリを自動的にダウンロードして使用します。
クラウド プロバイダーを指定します (既定値は azure)。
| プロパティ | 値 |
|---|---|
| 規定値: | azure |
Azure リソース グループの名前を指定します。
Azure サブスクリプション ID を指定します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aks draft up
az aks draft setup-gh実行してからaz aks draft generate-workflowします。
このコマンドは、 az aks draft setup-gh と az aks draft generate-workflow を組み合わせて GitHub OIDC を設定し、自動ビルドと AKS へのデプロイのための GitHub ワークフローを生成します。 このコマンドを実行する前に、Azure 上にリソース グループ、コンテナー レジストリ、Kubernetes クラスターを作成し、 az aks update -n <cluster-name> -g <resource-group-name> --attach-acr <acr-name>を使用して 3 つのリソースをリンクします。
az aks draft up [--app]
[--branch]
[--cluster-name]
[--container-name]
[--destination]
[--gh-repo]
[--path]
[--provider]
[--registry-name]
[--resource-group]
[--subscription-id]
例
GitHub OIDC をセットアップするように求め、現在のディレクトリに GitHub ワークフローを生成します。
az aks draft up
GitHub OIDC をセットアップするように求め、特定のプロジェクト ディレクトリに GitHub ワークフローを生成します。
az aks draft up --destination=/projects/some_project
特定のリポジトリに対して GitHub OIDC をセットアップするように求め、特定のプロジェクト ディレクトリに GitHub ワークフローを生成します。
az aks draft up --gh-repo=some_organization/some_repo --destination=/projects/some_project
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
アプリケーションの名前を指定します。
自動的にデプロイする GitHub ブランチを指定します。
AKS クラスター名を指定します。
コンテナー イメージの名前を指定します。
プロジェクト ディレクトリへのパスを指定します (既定値は .)。
GitHub リポジトリ (組織/repo_name) を指定します。
指定した場所にある Draft バイナリを自動的にダウンロードして使用します。
クラウド プロバイダーを指定します (既定値は azure)。
| プロパティ | 値 |
|---|---|
| 規定値: | azure |
プロジェクト ディレクトリへのパスを指定します。
Azure リソース グループの名前を指定します。
Azure サブスクリプション ID を指定します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aks draft update
インターネットにアクセスできるようにアプリケーションを更新します。
このコマンドは、アプリケーションが外部要求を受信できるように、必要に応じて yaml ファイルを自動的に更新します。
az aks draft update [--certificate]
[--destination]
[--host]
[--path]
例
インターネットにアクセスできるようにアプリケーションを更新するように求めるメッセージが表示されます。
az aks draft update
特定のプロジェクト ディレクトリでインターネットにアクセスできるようにアプリケーションを更新するように求めるメッセージが表示されます。
az aks draft update --destination=/projects/some_project
イングレス リソースのホストと、特定のプロジェクト ディレクトリ内の Keyvault 証明書を使用して、インターネットにアクセスできるようにアプリケーションを更新します。
az aks draft update --host=some_host --certificate=some_certificate --destination=/projects/some_project
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
提示する Keyvault 証明書の URI を指定します。
プロジェクト ディレクトリへのパスを指定します (既定値は .)。
イングレス リソースのホストを指定します。
指定した場所にある Draft バイナリを自動的にダウンロードして使用します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |