Examples
Enable control plane audit logs
Options
--control-plane-audit-logs (bool)
Specify configuration of the pushing k8s audit logs into service logs and show it in the UI.
By default cluster will be created without it.
--control-plane-authentication-oidc (json)
Configures OIDC providers for Kubernetes user authentication.
(structure)
claim_mappings -> (structure)[required]
Maps token claims to Kubernetes user attributes.
groups -> (structure)
Maps token claims to Kubernetes groups. Omission disables group mapping.
claim -> (string)
Names the token claim to map.
expression -> (string)
Maps token claims with a CEL expression.
prefix -> (string)[optional]
Omission and an empty value disable prefixing for claims. Expressions require omission, including for an empty value.
username -> (structure)[required]
Maps token claims to the Kubernetes username.
claim -> (string)
Names the token claim to map.
expression -> (string)
Maps token claims with a CEL expression.
prefix -> (string)[optional]
Omission and an empty value disable prefixing for claims. Expressions require omission, including for an empty value.
claim_validation_rules -> (structure)
Validates token claims before Kubernetes authenticates the user.
claim -> (string)
Names the token claim that must match required_value exactly.
expression -> (string)
Validates token claims with CEL. The expression must evaluate to true.
message -> (string)
Describes a failed CEL validation.
required_value -> (string)
An omitted value matches an empty string, following upstream behavior.
issuer -> (structure)[required]
Defines the issuer for accepted tokens.
audiences -> (string)
Lists the token audiences that this issuer accepts, for example, ["kubernetes", "dashboard"].
certificate_authority -> (string)
PEM CA bundle for discovery and JWKS. Omission uses system trust.
discovery_url -> (string)
Overrides the OpenID discovery URL. An empty value uses the issuer’s standard discovery URL.
url -> (string)
Identifies the issuer and must match the token iss claim.
name -> (string)
Identifies this provider within the cluster configuration.
user_validation_rules -> (structure)
Validates the mapped Kubernetes user information.
expression -> (string)
Validates the mapped Kubernetes user information with CEL.
message -> (string)
Describes a failed CEL validation.
JSON Schema:
--control-plane-endpoints-public-endpoint (bool)
Public endpoint specification. When set, a public endpoint is created.
--control-plane-endpoints-public-endpoint-allowed-cidrs (string array)
List of CIDR blocks from which access to public endpoint is allowed.
If field is not set, or list is empty, it means that access is not restricted at all.
You can specify a maximum of 100 CIDRs.
--control-plane-etcd-cluster-size (int64)
Number of instances in etcd cluster.
3 by default.
Control plane with etcd_cluster_size: 3 called “Highly Available” (“HA”), because it’s Kubernetes API
will be available despite a failure of one control plane instance.
--control-plane-karpenter (bool)
Enables installation of the Karpenter inside a cluster.
Karpenter will be installed as a helm chart inside cluster
so it requires creation of at least one CPU public node group.
Please note that there is no feature parity between Karpenter node pools and
public node groups.
By default cluster will be created without it.
--control-plane-version (string)
Desired Kubernetes version of the cluster. May be lower than the actual cluster version
if the desired version is no longer supported and the cluster has been automatically updated.
For now only acceptable format is <major>.<minor> like “1.31”.
Option for patch version update will be added later.
--id (string)
Identifier for the resource, unique for its resource type.
--labels (string->string)
Labels associated with the resource.
--labels-add (string->string)
Add values to Labels associated with the resource.
--labels-remove (string array)
Remove values from Labels associated with the resource.
--name (string)
Human-readable name for the resource.
--parent-id (string)
Identifier of the parent resource to which the resource belongs.
--resource-version (int64)
Version of the resource for safe concurrent modifications and consistent reads.
Positive and monotonically increases on each resource spec change (but not on each change of the
resource’s container(s) or status).
Service allows zero value or current.
--async (bool)
If set, returns operation id. Otherwise, waits for the operation to complete and returns its resource.
--clear-mask (string array)
Reset-mask field paths to clear in patch mode. Can be repeated.
--diff (bool)
Show diff of resource before committing update.
--full (bool)
Update full resource state. Automatically set to true if the —file or argument provided.
--patch (bool)
Update only specified fields.
Global Options
-h, --help (bool)
Show this message.
-p, --profile (string)
Set a profile for interacting with the cloud.
--format (string)
Output format. Supported values: yaml|json|jsonpath|table|text.
-f, --file (string)
Input file. For ‘update’ commands automatically set —full=true.
-c, --config (string)
Provide path to config file.
--debug (bool)
Write debug logs to stderr. Commands save debug logs in the config directory under logs/, except help and shell completion.
-I, --impersonate-service-account-id (string)
Impersonate into the service account and use its token for a command.
--color (bool)
Enable colored output.
--no-browser (bool)
Do not open browser automatically on auth.
--insecure (bool)
Disable transport security.
--auth-timeout (duration: 2h30m10s)
Set the timeout for the request including authentication process, default is 15m0s.
--per-retry-timeout (duration: 2h30m10s)
Set the timeout for each retry attempt, default is 20s.
--retries (uint)
Set the number of retry attempts, 1 is disable retries, default is 3.
--timeout (duration: 2h30m10s)
Set the timeout for the main request, default is 1m0s.
--no-check-update (bool)
Suppress check for updates.
--no-progress (bool)
Suppress progress indicators and spinners.