GKE Hub API (gkehub:v1alpha)

2024-09-12

2 new methods

Additions

    Methods
  • gkehub.projects.locations.memberships.validateExclusivity

      Path: v1alpha/{+parent}/memberships:validateExclusivity

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/memberships:validateExclusivity

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        crManifest

          Description: Optional. The YAML of the membership CR in the cluster. Empty if the membership CR does not exist.

          Location: query

          Type: string

        intendedMembership

          Description: Required. The intended membership name under the `parent`. This method only does validation in anticipation of a CreateMembership call with the same name.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

  • gkehub.projects.locations.memberships.generateExclusivityManifest

      Path: v1alpha/{+name}:generateExclusivityManifest

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateExclusivityManifest

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.

          Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$

          Location: path

          Required: Yes

          Type: string

        crdManifest

          Description: Optional. The YAML manifest of the membership CRD retrieved by `kubectl get customresourcedefinitions membership`. Leave empty if the resource does not exist.

          Location: query

          Type: string

        crManifest

          Description: Optional. The YAML manifest of the membership CR retrieved by `kubectl get memberships membership`. Leave empty if the resource does not exist.

          Location: query

          Type: string

      Parameter Order: name

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

      Description: GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed. Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub. The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.