Method: projects.locations.memberships.generateConnectManifest

GKE Connect エージェントのデプロイ用のマニフェストを生成します。

このメソッドは、Google 提供のライブラリで内部的に使用されます。ほとんどのクライアントは、このメソッドを直接呼び出す必要はありません。

HTTP リクエスト

GET https://gkehub.googleapis.com/v1beta1/{name=projects/*/locations/*/memberships/*}:generateConnectManifest

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。エージェントに関連付ける Membership リソースの名前(projects/*/locations/*/memberships/* 形式)。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.memberships.generateConnectManifest

クエリ パラメータ

パラメータ
connectAgent

object (ConnectAgent)

省略可。マニフェストを生成する Connect エージェント。

version

string

省略可。使用する Connect エージェントのバージョン。デフォルトでは、最新バージョンになります。

isUpgrade

boolean

省略可。true の場合、アップグレード専用のリソースを生成します。インストール専用に生成された一部のリソース(シークレットなど)は除外されます。

registry

string

省略可。Connect エージェント イメージを取得するレジストリ。デフォルトは gcr.io/gkeconnect です。

imagePullSecretContent

string (bytes format)

省略可。レジストリのイメージ pull シークレット コンテンツ(公開されていない場合)。

Base64 でエンコードされた文字列。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

GenerateConnectManifestResponse には、Connect エージェントのインストール / アップグレードに関するマニフェスト情報が含まれています。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "manifest": [
    {
      object (ConnectAgentResource)
    }
  ]
}
フィールド
manifest[]

object (ConnectAgentResource)

GKE Connect エージェントのインストールまたはアップグレードのためにクラスタに適用する必要がある Kubernetes リソースの順序付きリスト。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ConnectAgent

GKE Connect を使用するためにエンドユーザーに必要な情報。

JSON 表現
{
  "name": string,
  "proxy": string,
  "namespace": string
}
フィールド
name
(deprecated)

string

設定しないでください。

proxy

string (bytes format)

省略可。エージェントから gkeconnect.googleapis.com への接続にプロキシの使用が必要な場合のプロキシの URI。プロキシでサポートされている HTTP / HTTPS プロトコルに応じて、http(s)://{proxy_address} 形式にする必要があります。これにより、Connect エージェントのアウトバウンド トラフィックが HTTP(S) プロキシを経由するようになります。

Base64 でエンコードされた文字列。

namespace

string

省略可。GKE Connect エージェント リソースの Namespace。デフォルトは gke-connect です。

Connect Agent は、デフォルトの Namespace で実行されると自動的に承認されます。それ以外の場合は、追加の IAM バインディングで明示的に認可する必要があります。

ConnectAgentResource

ConnectAgentResource は、Connect Agent デプロイの Kubernetes リソース マニフェストを表します。

JSON 表現
{
  "type": {
    object (TypeMeta)
  },
  "manifest": string
}
フィールド
type

object (TypeMeta)

リソースの Kubernetes タイプ。

manifest

string

リソースの YAML マニフェスト。

TypeMeta

TypeMeta は、マニフェスト内の Kubernetes リソースのコンテンツのマーシャリング解除に必要な型情報です。

JSON 表現
{
  "kind": string,
  "apiVersion": string
}
フィールド
kind

string

リソースの種類(Deployment など)。

apiVersion

string

リソースの APIVersion(v1 など)。