Verrazzano Managed Cluster

Packages:

clusters.verrazzano.io/v1alpha1

Resource Types:

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"

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

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"

"Inactive"

"Pending"

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.

Generated with gen-crd-api-reference-docs on git commit 1027f9a33.