Packages:

infrastructure.cluster.x-k8s.io/v1alpha1

infrastructure.cluster.x-k8s.io/v1alpha1

Resource Types:

AzureASOManagedCluster

AzureASOManagedCluster is the Schema for the azureasomanagedclusters API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureASOManagedClusterSpec

`AzureASOManagedClusterTemplateResourceSpec` AzureASOManagedClusterTemplateResourceSpec	(Members of `AzureASOManagedClusterTemplateResourceSpec` are embedded into this type.)
`controlPlaneEndpoint` sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint	(Optional) ControlPlaneEndpoint is the location of the API server within the control plane. CAPZ manages this field and it should not be set by the user. It fulfills Cluster API’s cluster infrastructure provider contract. Because this field is programmatically set by CAPZ after resource creation, we define it as +optional in the API schema to permit resource admission.

status
AzureASOManagedClusterStatus

AzureASOManagedClusterSpec

(Appears on:AzureASOManagedCluster)

AzureASOManagedClusterSpec defines the desired state of AzureASOManagedCluster.

Field	Description
`AzureASOManagedClusterTemplateResourceSpec` AzureASOManagedClusterTemplateResourceSpec	(Members of `AzureASOManagedClusterTemplateResourceSpec` are embedded into this type.)
`controlPlaneEndpoint` sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint	(Optional) ControlPlaneEndpoint is the location of the API server within the control plane. CAPZ manages this field and it should not be set by the user. It fulfills Cluster API’s cluster infrastructure provider contract. Because this field is programmatically set by CAPZ after resource creation, we define it as +optional in the API schema to permit resource admission.

AzureASOManagedClusterStatus

(Appears on:AzureASOManagedCluster)

AzureASOManagedClusterStatus defines the observed state of AzureASOManagedCluster.

Field	Description
`ready` bool	(Optional) Ready represents whether or not the cluster has been provisioned and is ready. It fulfills Cluster API’s cluster infrastructure provider contract.
`resources` []ResourceStatus	(Optional)

AzureASOManagedClusterTemplate

AzureASOManagedClusterTemplate is the Schema for the azureasomanagedclustertemplates API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureASOManagedClusterTemplateSpec

template
AzureASOManagedClusterTemplateResource

AzureASOManagedClusterTemplateResource

(Appears on:AzureASOManagedClusterTemplateSpec)

AzureASOManagedClusterTemplateResource defines the templated resource.

Field Description

spec
AzureASOManagedClusterTemplateResourceSpec

resources
[]k8s.io/apimachinery/pkg/runtime.RawExtension

(Optional)

Resources are embedded ASO resources to be managed by this resource.

AzureASOManagedClusterTemplateResourceSpec

(Appears on:AzureASOManagedClusterSpec, AzureASOManagedClusterTemplateResource)

AzureASOManagedClusterTemplateResourceSpec defines the desired state of the templated resource.

Field	Description
`resources` []k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Resources are embedded ASO resources to be managed by this resource.

AzureASOManagedClusterTemplateSpec

(Appears on:AzureASOManagedClusterTemplate)

AzureASOManagedClusterTemplateSpec defines the desired state of AzureASOManagedClusterTemplate.

Field	Description
`template` AzureASOManagedClusterTemplateResource

AzureASOManagedControlPlane

AzureASOManagedControlPlane is the Schema for the azureasomanagedcontrolplanes API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureASOManagedControlPlaneSpec

AzureASOManagedControlPlaneTemplateResourceSpec
AzureASOManagedControlPlaneTemplateResourceSpec

(Members of AzureASOManagedControlPlaneTemplateResourceSpec are embedded into this type.)

status
AzureASOManagedControlPlaneStatus

AzureASOManagedControlPlaneResource

(Appears on:AzureASOManagedControlPlaneTemplateSpec, AzureASOManagedMachinePoolTemplateSpec)

AzureASOManagedControlPlaneResource defines the templated resource.

Field Description

spec
AzureASOManagedControlPlaneTemplateResourceSpec

`version` string	(Optional) Version is the Kubernetes version of the control plane. It fulfills Cluster API’s control plane provider contract.
`resources` []k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Resources are embedded ASO resources to be managed by this resource.

AzureASOManagedControlPlaneSpec

(Appears on:AzureASOManagedControlPlane)

AzureASOManagedControlPlaneSpec defines the desired state of AzureASOManagedControlPlane.

Field	Description
`AzureASOManagedControlPlaneTemplateResourceSpec` AzureASOManagedControlPlaneTemplateResourceSpec	(Members of `AzureASOManagedControlPlaneTemplateResourceSpec` are embedded into this type.)

AzureASOManagedControlPlaneStatus

(Appears on:AzureASOManagedControlPlane)

AzureASOManagedControlPlaneStatus defines the observed state of AzureASOManagedControlPlane.

Field	Description
`initialized` bool	(Optional) Initialized represents whether or not the API server has been provisioned. It fulfills Cluster API’s control plane provider contract. For AKS, this is equivalent to `ready`.
`ready` bool	(Optional) Ready represents whether or not the API server is ready to receive requests. It fulfills Cluster API’s control plane provider contract. For AKS, this is equivalent to `initialized`.
`version` string	(Optional) Version is the observed Kubernetes version of the control plane. It fulfills Cluster API’s control plane provider contract.
`resources` []ResourceStatus	(Optional)
`controlPlaneEndpoint` sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint	(Optional) ControlPlaneEndpoint represents the endpoint for the cluster’s API server.

AzureASOManagedControlPlaneTemplate

AzureASOManagedControlPlaneTemplate is the Schema for the azureasomanagedcontrolplanetemplates API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureASOManagedControlPlaneTemplateSpec

template
AzureASOManagedControlPlaneResource

AzureASOManagedControlPlaneTemplateResourceSpec

(Appears on:AzureASOManagedControlPlaneResource, AzureASOManagedControlPlaneSpec)

AzureASOManagedControlPlaneTemplateResourceSpec defines the desired state of the templated resource.

Field	Description
`version` string	(Optional) Version is the Kubernetes version of the control plane. It fulfills Cluster API’s control plane provider contract.
`resources` []k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Resources are embedded ASO resources to be managed by this resource.

AzureASOManagedControlPlaneTemplateSpec

(Appears on:AzureASOManagedControlPlaneTemplate)

AzureASOManagedControlPlaneTemplateSpec defines the desired state of AzureASOManagedControlPlane.

Field	Description
`template` AzureASOManagedControlPlaneResource

AzureASOManagedMachinePool

AzureASOManagedMachinePool is the Schema for the azureasomanagedmachinepools API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureASOManagedMachinePoolSpec

AzureASOManagedMachinePoolTemplateResourceSpec
AzureASOManagedMachinePoolTemplateResourceSpec

(Members of AzureASOManagedMachinePoolTemplateResourceSpec are embedded into this type.)

status
AzureASOManagedMachinePoolStatus

AzureASOManagedMachinePoolResource

AzureASOManagedMachinePoolResource defines the templated resource.

Field Description

spec
AzureASOManagedMachinePoolTemplateResourceSpec

`providerIDList` []string	ProviderIDList is the list of cloud provider IDs for the instances. It fulfills Cluster API’s machine pool infrastructure provider contract.
`resources` []k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Resources are embedded ASO resources to be managed by this resource.

AzureASOManagedMachinePoolSpec

(Appears on:AzureASOManagedMachinePool)

AzureASOManagedMachinePoolSpec defines the desired state of AzureASOManagedMachinePool.

Field	Description
`AzureASOManagedMachinePoolTemplateResourceSpec` AzureASOManagedMachinePoolTemplateResourceSpec	(Members of `AzureASOManagedMachinePoolTemplateResourceSpec` are embedded into this type.)

AzureASOManagedMachinePoolStatus

(Appears on:AzureASOManagedMachinePool)

AzureASOManagedMachinePoolStatus defines the observed state of AzureASOManagedMachinePool.

Field	Description
`replicas` int32	(Optional) Replicas is the current number of provisioned replicas. It fulfills Cluster API’s machine pool infrastructure provider contract.
`ready` bool	(Optional) Ready represents whether or not the infrastructure is ready to be used. It fulfills Cluster API’s machine pool infrastructure provider contract.
`resources` []ResourceStatus	(Optional)

AzureASOManagedMachinePoolTemplate

AzureASOManagedMachinePoolTemplate is the Schema for the azureasomanagedmachinepooltemplates API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureASOManagedMachinePoolTemplateSpec

template
AzureASOManagedControlPlaneResource

AzureASOManagedMachinePoolTemplateResourceSpec

(Appears on:AzureASOManagedMachinePoolResource, AzureASOManagedMachinePoolSpec)

AzureASOManagedMachinePoolTemplateResourceSpec defines the desired state of the templated resource.

Field	Description
`providerIDList` []string	ProviderIDList is the list of cloud provider IDs for the instances. It fulfills Cluster API’s machine pool infrastructure provider contract.
`resources` []k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Resources are embedded ASO resources to be managed by this resource.

AzureASOManagedMachinePoolTemplateSpec

(Appears on:AzureASOManagedMachinePoolTemplate)

AzureASOManagedMachinePoolTemplateSpec defines the desired state of AzureASOManagedMachinePoolTemplate.

Field	Description
`template` AzureASOManagedControlPlaneResource

ResourceStatus

(Appears on:AzureASOManagedClusterStatus, AzureASOManagedControlPlaneStatus, AzureASOManagedMachinePoolStatus)

ResourceStatus represents the status of a resource.

Field	Description
`resource` StatusResource
`ready` bool

StatusResource

(Appears on:ResourceStatus)

StatusResource is a handle to a resource.

Field	Description
`group` string
`version` string
`kind` string
`name` string

Generated with gen-crd-api-reference-docs on git commit 30c0b162.