Verrazzano Managed Cluster

Packages:

clusters.verrazzano.io/v1alpha1

Resource Types:

OCNEOCIQuickCreate

OCNEOCIQuickCreate specifies the API for quick-create OCI OCNE clusters.

Field Description
apiVersion
string		 clusters.verrazzano.io/v1alpha1
kind
string 		OCNEOCIQuickCreate
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
OCIOCNEClusterSpec

The desired state of an OCNEOCIQuickCreate resource.



identityRef
NamespacedRef

(Inlined from CommonClusterSpec. Inlined comments are appended in the following.)

Reference for cloud authentication.
privateRegistry
PrivateRegistry

(Inlined from CommonClusterSpec. Inlined comments are appended in the following.)

Private Registry settings for the workload cluster.
proxy
Proxy

(Inlined from CommonClusterSpec. Inlined comments are appended in the following.)

HTTP Proxy settings.
kubernetes
KubernetesBase

Kubernetes settings.
ocne
OCNE

OCNE settings.
oci
OCI

OCI infrastructure settings.
status
OCNEOCIQuickCreateStatus

The observed state of an OCNEOCIQuickCreate resource.

OKEQuickCreate

OKEQuickCreate specifies the API for quick-create OKE clusters.

Field Description
apiVersion
string		 clusters.verrazzano.io/v1alpha1
kind
string 		OKEQuickCreate
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
OKEQuickCreateSpec

The desired state of an OCNEOCIQuickCreate resource.



identityRef
NamespacedRef

Reference for cloud authentication.
kubernetes
Kubernetes

Kubernetes settings.
oke
OKE

OKE cluster settings.
status
OKEQuickCreateStatus

The observed state of an OCNEOCIQuickCreate resource.

VerrazzanoManagedCluster

VerrazzanoManagedCluster specifies the Verrazzano Managed Cluster API.

Field Description
apiVersion
string		 clusters.verrazzano.io/v1alpha1
kind
string 		VerrazzanoManagedCluster
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
VerrazzanoManagedClusterSpec

The desired state of a Verrazzano Managed Cluster resource.



caSecret
string

The name of a Secret that contains the CA certificate of the managed cluster. This is used to configure the admin cluster to scrape metrics from the Prometheus endpoint on the managed cluster. If Rancher is enabled on the admin cluster, this will be automatically populated by Verrazzano. Otherwise, if you disabled Rancher, see the pre-registration instructions for how to create this Secret.
description
string 		(Optional)

The description of the managed cluster.
managedClusterManifestSecret
string 		(Optional)

The name of the Secret containing the generated YAML manifest file to be applied by the user to the managed cluster. This field is managed by a Verrazzano Kubernetes operator.
serviceAccount
string 		(Optional)

The name of the ServiceAccount that was generated for the managed cluster. This field is managed by a Verrazzano Kubernetes operator.
status
VerrazzanoManagedClusterStatus

The observed state of a Verrazzano Managed Cluster resource.

ArgoCDRegistration

(Appears on:VerrazzanoManagedClusterStatus)

ArgoCDRegistration defines the Argo CD registration state for a managed cluster.

Field Description
status
ArgoCDRegistrationStatus

The status of the ArgoCD registration.
lastSetTimestamp
Kubernetes meta/v1.Time 		(Optional)

The timestamp of last status set.
message
string 		(Optional)

Supporting message related to the Argo CD registration status.

ArgoCDRegistrationStatus (string alias)

(Appears on:ArgoCDRegistration)

ArgoCDRegistrationStatus identifies the status of an Argo CD registration.

Value Description

"Completed"

"Failed"

"PendingRancherClusterRegistration"

CNIType (string alias)

(Appears on:OKENetwork)

Value Description

"FLANNEL_OVERLAY"

"OCI_VCN_IP_NATIVE"

ClusterNetwork

(Appears on:Kubernetes, KubernetesBase)

Field Description
podCIDR
string

IP range for Kubernetes pods. The default is 10.244.0.0/16
serviceCIDR
string

IP range for Kubernetes service addresses. The default is 10.96.0.0/16.

ClusterReference

(Appears on:VerrazzanoManagedClusterStatus)

ClusterReference identifies the underlying ClusterAPI cluster for a managed cluster.

Field Description
apiVersion
string

The API version of the referenced ClusterAPI cluster object.
kind
string

The kind of the referenced ClusterAPI cluster object.
name
string

The name of the referenced ClusterAPI cluster object.
namespace
string

The namespace of the referenced ClusterAPI cluster object.

CommonClusterSpec

Field Description
identityRef
NamespacedRef

Reference for cloud authentication.
privateRegistry
PrivateRegistry

Private Registry settings for the workload cluster.
proxy
Proxy

HTTP Proxy settings.

CommonOCI

Field Description
region
string

OCI region where the cluster will be created.
compartment
string

OCI Compartment OCID where the cluster will be created
sshPublicKey
string

SSH public key for node ssh.
imageId
string

Node image OCID. The default is the latest OL8 image in the provided compartment.
cloudInitScript
[]string

Cloud-init script to run during node startup.

Condition

(Appears on:VerrazzanoManagedClusterStatus)

Condition describes a condition that occurred on the Verrazzano Managed Cluster.

Field Description
lastTransitionTime
Kubernetes meta/v1.Time 		(Optional)

Last time the condition transitioned from one status to another.
message
string 		(Optional)

A message with details about the last transition.
status
Kubernetes core/v1.ConditionStatus

Status of the condition: one of True, False, or Unknown.
type
ConditionType

The condition of the multicluster resource which can be checked with a kubectl wait command. Condition values are case-sensitive and formatted as follows: Ready: the VerrazzanoManagedCluster is ready to be used and all resources needed have been generated.

ConditionType (string alias)

(Appears on:Condition)

ConditionType identifies the condition of the Verrazzano Managed Cluster which can be checked with kubectl wait.

Value Description

"ManagedCARetrieved"

ManagedCARetrieved = true means that the managed cluster CA cert has been retrieved and populated. This is done by the VMC controller via the Rancher API proxy for the managed cluster.

"ManifestPushed"

ConditionManifestPushed = true means the the agent and registration secrets have been successfully transferred to the managed cluster on a multicluster install

"Ready"

Ready = true means the VMC is ready to be used and all resources needed have been generated

Kubernetes

(Appears on:OKEQuickCreateSpec)

Field Description
version
string

Kubernetes version.
clusterNetwork
ClusterNetwork

(Inlined from KubernetesBase. Inlined comments are appended in the following.)

Kubernetes network settings.

KubernetesBase

(Appears on:OCIOCNEClusterSpec)

Field Description
clusterNetwork
ClusterNetwork

Kubernetes network settings.

KubernetesInformation

(Appears on:VerrazzanoManagedClusterStatus)

KubernetesInformation defines the Kubernetes information for a managed cluster.

Field Description
version
string

The observed Kubernetes version installed on this cluster.

NamedOCINode

(Appears on:OCI, OKE)

Field Description
name
string
shape
string

(Inlined from OCINode. Inlined comments are appended in the following.)

Node pool Shape.
ocpus
int

(Inlined from OCINode. Inlined comments are appended in the following.)

Number of OCPUs per node, when using flex shapes.
memoryGbs
int

(Inlined from OCINode. Inlined comments are appended in the following.)

Amount of memory per node, in gigabytes, when using flex shapes.
bootVolumeGbs
int

(Inlined from OCINode. Inlined comments are appended in the following.)

Size of node boot volume, in gigabytes.
replicas
int

(Inlined from OCINode. Inlined comments are appended in the following.)

Number of nodes to create.

NamespacedRef

(Appears on:CommonClusterSpec, OCIOCNEClusterSpec, OKEQuickCreateSpec, PrivateRegistry)

Field Description
name
string

Name of the ref.
namespace
string

Namespace of the ref.

Network

(Appears on:OCI, OKENetwork)

Field Description
createVCN
bool

If true, a new VCN is created for the cluster. The default is false.
vcn
string

OCID of an existing VCN to create the cluster inside.
subnets
[]Subnet

List of existing subnets that will be used by the cluster.

OCI

(Appears on:OCIOCNEClusterSpec)

Field Description
region
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

OCI region where the cluster will be created.
compartment
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

OCI Compartment OCID where the cluster will be created
sshPublicKey
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

SSH public key for node ssh.
imageId
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

Node image OCID. The default is the latest OL8 image in the provided compartment.
cloudInitScript
[]string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

Cloud-init script to run during node startup.
controlPlane
OCINode

Control Plane node settings.
workers
[]NamedOCINode

List of worker nodes.
network
Network

OCI Network settings.

OCINode

(Appears on:OCI)

Field Description
shape
string

Node pool Shape.
ocpus
int

Number of OCPUs per node, when using flex shapes.
memoryGbs
int

Amount of memory per node, in gigabytes, when using flex shapes.
bootVolumeGbs
int

Size of node boot volume, in gigabytes.
replicas
int

Number of nodes to create.

OCIOCNEClusterSpec

(Appears on:OCNEOCIQuickCreate)

Field Description
identityRef
NamespacedRef

(Inlined from CommonClusterSpec. Inlined comments are appended in the following.)

Reference for cloud authentication.
privateRegistry
PrivateRegistry

(Inlined from CommonClusterSpec. Inlined comments are appended in the following.)

Private Registry settings for the workload cluster.
proxy
Proxy

(Inlined from CommonClusterSpec. Inlined comments are appended in the following.)

HTTP Proxy settings.
kubernetes
KubernetesBase

Kubernetes settings.
ocne
OCNE

OCNE settings.
oci
OCI

OCI infrastructure settings.

OCNE

(Appears on:OCIOCNEClusterSpec)

Field Description
version
string

OCNE Version.
dependencies
OCNEDependencies

OCNE dependency settings.

OCNEDependencies

(Appears on:OCNE)

Field Description
skipInstall
bool

Whether to skip OCNE dependency installation. The default is false.

OCNEOCIQuickCreateStatus

(Appears on:OCNEOCIQuickCreate)

Field Description
phase
QuickCreatePhase

OKE

(Appears on:OKEQuickCreateSpec)

Field Description
region
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

OCI region where the cluster will be created.
compartment
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

OCI Compartment OCID where the cluster will be created
sshPublicKey
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

SSH public key for node ssh.
imageId
string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

Node image OCID. The default is the latest OL8 image in the provided compartment.
cloudInitScript
[]string

(Inlined from CommonOCI. Inlined comments are appended in the following.)

Cloud-init script to run during node startup.
nodePools
[]NamedOCINode

List of Node pools.
virtualNodePools
[]VirtualNodePool

List of Virtual Node pools.
network
OKENetwork

Network settings for the OKE cluster.

OKENetwork

(Appears on:OKE)

Field Description
config
Network

VCN and subnet settings for existing networks.
cniType
CNIType

CNI Type for cluster networking. May be FLANNEL_OVERLAY or OCI_VCN_IP_NATIVE.

OKEQuickCreateSpec

(Appears on:OKEQuickCreate)

Field Description
identityRef
NamespacedRef

Reference for cloud authentication.
kubernetes
Kubernetes

Kubernetes settings.
oke
OKE

OKE cluster settings.

OKEQuickCreateStatus

(Appears on:OKEQuickCreate)

Field Description
phase
QuickCreatePhase

PrivateRegistry

(Appears on:CommonClusterSpec, OCIOCNEClusterSpec)

Field Description
url
string

Private registry URL.
credentialSecret
NamespacedRef

Reference to private registry credentials secret.

Proxy

(Appears on:CommonClusterSpec, OCIOCNEClusterSpec)

Field Description
httpProxy
string

HTTP Proxy string.
httpsProxy
string

HTTPS Proxy string.
noProxy
string

No Proxy string.

QuickCreatePhase (string alias)

(Appears on:OCNEOCIQuickCreateStatus, OKEQuickCreateStatus)

Value Description

"Complete"

QuickCreatePhaseComplete means the Quick Create has finished. Quick Create CR cleanup is started once this phase is reached.

"Provisioning"

QuickCreatePhaseProvisioning means the Quick Create is in progress.

RancherRegistration

(Appears on:VerrazzanoManagedClusterStatus)

RancherRegistration defines the Rancher registration state for a managed cluster.

Field Description
clusterID
string

The Rancher cluster ID for this cluster.
message
string 		(Optional)

A supporting message related to the Rancher registration status.
status
RancherRegistrationStatus

The status of the Rancher registration.

RancherRegistrationStatus (string alias)

(Appears on:RancherRegistration)

RancherRegistrationStatus identifies the status of a Rancher registration.

Value Description

"DeleteFailed"

"Completed"

"Failed"

StateType (string alias)

(Appears on:VerrazzanoManagedClusterStatus)

StateType identifies the state of the Verrazzano Managed Cluster.

Value Description

"Active"

"Deleting"

"Failed"

"Inactive"

"Pending"

"Provisioned"

"Provisioning"

"Unknown"

Subnet

(Appears on:Network)

Field Description
role
SubnetRole

Role of subnet within the cluster.
id
string

The ID of the subnet.

SubnetRole (string alias)

(Appears on:Subnet)

Value Description

"control-plane"

SubnetRoleControlPlane is the role of the Control Plane subnet.

"control-plane-endpoint"

SubnetRoleControlPlaneEndpoint is the role of the Control Plane endpoint subnet.

"service-lb"

SubnetRoleServiceLB is the role of the load balancer subnet.

"worker"

SubnetRoleWorker is the role of the worker subnet.

VerrazzanoInformation

(Appears on:VerrazzanoManagedClusterStatus)

VerrazzanoInformation defines the Verrazzano information for a managed cluster.

Field Description
version
string

The observed Verrazzano version installed on this cluster.

VerrazzanoManagedClusterSpec

(Appears on:VerrazzanoManagedCluster)

VerrazzanoManagedClusterSpec defines the desired state of a Verrazzano Managed Cluster.

Field Description
caSecret
string

The name of a Secret that contains the CA certificate of the managed cluster. This is used to configure the admin cluster to scrape metrics from the Prometheus endpoint on the managed cluster. If Rancher is enabled on the admin cluster, this will be automatically populated by Verrazzano. Otherwise, if you disabled Rancher, see the pre-registration instructions for how to create this Secret.
description
string 		(Optional)

The description of the managed cluster.
managedClusterManifestSecret
string 		(Optional)

The name of the Secret containing the generated YAML manifest file to be applied by the user to the managed cluster. This field is managed by a Verrazzano Kubernetes operator.
serviceAccount
string 		(Optional)

The name of the ServiceAccount that was generated for the managed cluster. This field is managed by a Verrazzano Kubernetes operator.

VerrazzanoManagedClusterStatus

(Appears on:VerrazzanoManagedCluster)

VerrazzanoManagedClusterStatus defines the observed state of a Verrazzano Managed Cluster.

Field Description
apiUrl
string

The Verrazzano API server URL for this managed cluster.
conditions
[]Condition

The current state of this managed cluster.
lastAgentConnectTime
Kubernetes meta/v1.Time

The last time the agent from this managed cluster connected to the admin cluster.
prometheusHost
string

The Prometheus host for this managed cluster.
thanosQueryStore
string

The Thanos Query Store API host name for this managed cluster.
rancherRegistration
RancherRegistration

The state of Rancher registration for this managed cluster.
argoCDRegistration
ArgoCDRegistration

The state of ArgoCD registration for this managed cluster.
state
StateType

The state of this managed cluster.
kubernetes
KubernetesInformation

The state of Kubernetes information of this managed cluster.
verrazzano
VerrazzanoInformation

The state of Verrazzano information of this managed cluster.
clusterRef
ClusterReference 		(Optional)

The reference to this managed cluster’s underlying ClusterAPI cluster.

VirtualNodePool

(Appears on:OKE)

Field Description
name
string
replicas
int

Generated with gen-crd-api-reference-docs on git commit 2f95b4017.