REST Resource: projects.locations.clusters

Resource: Cluster

A Google Distributed Cloud Edge Kubernetes cluster.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "fleet": {
    object (Fleet)
  },
  "networking": {
    object (ClusterNetworking)
  },
  "authorization": {
    object (Authorization)
  },
  "defaultMaxPodsPerNode": integer,
  "endpoint": string,
  "clusterCaCertificate": string,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  }
}
Fields
name

string

Required. The resource name of the cluster.

createTime

string (Timestamp format)

Output only. The time when the cluster was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The time when the cluster was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels associated with this resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

fleet

object (Fleet)

Optional. Fleet configuration.

networking

object (ClusterNetworking)

Required. Cluster-wide networking configuration.

authorization

object (Authorization)

Required. Immutable. RBAC policy that will be applied and managed by GEC.

defaultMaxPodsPerNode

integer

Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used.

endpoint

string

Output only. The IP address of the Kubernetes API server.

clusterCaCertificate

string

Output only. The PEM-encoded public certificate of the cluster's CA.

maintenancePolicy

object (MaintenancePolicy)

Optional. Cluster-wide maintenance policy configuration.

Fleet

Fleet related configuration.

Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems.

JSON representation
{
  "project": string,
  "membership": string
}
Fields
project

string

Required. The name of the Fleet host project where this cluster will be registered.

Project names are formatted as projects/<project-number>.

membership

string

Output only. The name of the managed Hub Membership resource associated to this cluster.

Membership names are formatted as projects/<project-number>/locations/global/membership/<cluster-id>.

ClusterNetworking

Cluster-wide networking configuration.

JSON representation
{
  "clusterIpv4CidrBlocks": [
    string
  ],
  "servicesIpv4CidrBlocks": [
    string
  ]
}
Fields
clusterIpv4CidrBlocks[]

string

Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation.

servicesIpv4CidrBlocks[]

string

Required. All services in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation.

Authorization

RBAC policy that will be applied and managed by GEC.

JSON representation
{
  "adminUsers": {
    object (ClusterUser)
  }
}
Fields
adminUsers

object (ClusterUser)

Required. User that will be granted the cluster-admin role on the cluster, providing full access to the cluster. Currently, this is a singular field, but will be expanded to allow multiple admins in the future.

ClusterUser

A user principal for an RBAC policy.

JSON representation
{
  "username": string
}
Fields
username

string

Required. An active Google username.

MaintenancePolicy

Maintenance policy configuration.

JSON representation
{
  "window": {
    object (MaintenanceWindow)
  }
}
Fields
window

object (MaintenanceWindow)

Specifies the maintenance window in which maintenance may be performed.

MaintenanceWindow

Maintenance window configuration

JSON representation
{
  "recurringWindow": {
    object (RecurringTimeWindow)
  }
}
Fields
recurringWindow

object (RecurringTimeWindow)

Configuration of a recurring maintenance window.

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

JSON representation
{
  "window": {
    object (TimeWindow)
  },
  "recurrence": string
}
Fields
window

object (TimeWindow)

The window of the first recurrence.

recurrence

string

An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window recurs. They go on for the span of time between the start and end time.

TimeWindow

Represents an arbitrary window of time.

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

The time that the window first starts.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The time that the window ends. The end time must take place after the start time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

create

Creates a new Cluster in a given project and location.

delete

Deletes a single Cluster.

generateAccessToken

Generates an access token for a Cluster.

get

Gets details of a single Cluster.

list

Lists Clusters in a given project and location.

patch

Updates the parameters of a single Cluster.