Last generated March 23, 2022

G8sControlPlane

Deprecation: This CRD will be removed once Cluster API resources are used for all AWS workload clusters.

The G8sControlPlane resource defines the Control Plane nodes (Kubernetes master nodes) of a Giant Swarm workload cluster. It is reconciled by cluster-operator.

Full name:: g8scontrolplanes.infrastructure.giantswarm.io
Group:: infrastructure.giantswarm.io
Singular name:: g8scontrolplane
Plural name:: g8scontrolplanes
Scope:: Namespaced
Versions:: v1alpha2 v1alpha3

Version v1alpha2

Example CR

apiVersion: infrastructure.giantswarm.io/v1alpha2
kind: G8sControlPlane
metadata:
  annotations:
    giantswarm.io/docs: https://docs.giantswarm.io/ui-api/management-api/crd/g8scontrolplanes.infrastructure.giantswarm.io/
  creationTimestamp: null
  name: 0p8h5
spec:
  infrastructureRef:
    apiVersion: infrastructure.giantswarm.io/v1alpha2
    kind: AWSControlPlane
    name: 0p8h5
    namespace: default
  replicas: 1

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object Required

Specification part.

.spec.infrastructureRef

object Required

Reference to a provider-specific resource. On AWS, this would be of kind AWSControlPlane.

.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.infrastructureRef.fieldPath

string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

.spec.infrastructureRef.kind

string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.spec.infrastructureRef.name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.spec.infrastructureRef.namespace

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

.spec.infrastructureRef.resourceVersion

string

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

.spec.infrastructureRef.uid

string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.replicas

integer

Number of master nodes.

.status

object

Status information.

.status.readyReplicas

integer

Total number of fully running and ready control plane machines.

.status.replicas

integer

Total number of non-terminated machines targeted by this control plane (their labels match the selector).

Version v1alpha3

Example CR

apiVersion: infrastructure.giantswarm.io/v1alpha3
kind: G8sControlPlane
metadata:
  annotations:
    giantswarm.io/docs: https://docs.giantswarm.io/ui-api/management-api/crd/g8scontrolplanes.infrastructure.giantswarm.io/
  creationTimestamp: null
  name: 0p8h5
spec:
  infrastructureRef:
    apiVersion: infrastructure.giantswarm.io/v1alpha3
    kind: AWSControlPlane
    name: 0p8h5
    namespace: default
  replicas: 1

Properties

.apiVersion

string

.kind

string

.metadata

object

.spec

object Required

Specification part.

.spec.infrastructureRef

object Required

Reference to a provider-specific resource. On AWS, this would be of kind AWSControlPlane.

.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.infrastructureRef.fieldPath

string

.spec.infrastructureRef.kind

string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.spec.infrastructureRef.name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.spec.infrastructureRef.namespace

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

.spec.infrastructureRef.resourceVersion

string

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

.spec.infrastructureRef.uid

string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.replicas

integer

Number of master nodes.

.status

object

Status information.

.status.readyReplicas

integer

Total number of fully running and ready control plane machines.

.status.replicas

integer

Total number of non-terminated machines targeted by this control plane (their labels match the selector).

This documentation page shows information based on apiextensions v5.0.0.

Need help with the Management API?

We listen in your Slack support channel. And of course, we welcome your pull requests to improve these docs!