Method: projects.locations.memberships.generateConnectManifest

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
  • JSON representation
• Authorization scopes
• ConnectAgent
  • JSON representation
• ConnectAgentResource
  • JSON representation
• TypeMeta
  • JSON representation
• Examples
• Try it!

Generates the manifest for deployment of the GKE connect agent.

This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The Membership resource name the Agent will associate with, in the format projects/*/locations/*/memberships/*. Authorization requires the following IAM permission on the specified resource name: gkehub.memberships.generateConnectManifest

Query parameters

Parameters
connectAgent	object (ConnectAgent) Optional. The connect agent to generate manifest for.
version	string Optional. The Connect agent version to use. Defaults to the most current version.
isUpgrade	boolean Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.
registry	string Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.
imagePullSecretContent	string (bytes format) Optional. The image pull secret content for the registry, if not public. A base64-encoded string.

Request body

The request body must be empty.

Response body

GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

If successful, the response body contains data with the following structure:

JSON representation
{ "manifest": [ { object (ConnectAgentResource) } ] }

Fields
manifest[]	object (ConnectAgentResource) The ordered list of Kubernetes resources that need to be applied to the cluster for GKE Connect agent installation/upgrade.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ConnectAgent

The information required from end users to use GKE Connect.

JSON representation
{ "name": string, "proxy": string, "namespace": string }

Fields
name (deprecated)	string This item is deprecated! Do not set.
proxy	string (bytes format) Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form http(s)://{proxy_address}, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy. A base64-encoded string.
namespace	string Optional. Namespace for GKE Connect agent resources. Defaults to gke-connect. The Connect Agent is authorized automatically when run in the default namespace. Otherwise, explicit authorization must be granted with an additional IAM binding.

ConnectAgentResource

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

JSON representation
{ "type": { object (TypeMeta) }, "manifest": string }

Fields
type	object (TypeMeta) Kubernetes type of the resource.
manifest	string YAML manifest of the resource.

TypeMeta

TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.

JSON representation
{ "kind": string, "apiVersion": string }

Fields
kind	string Kind of the resource (e.g. Deployment).
apiVersion	string APIVersion of the resource (e.g. v1).