API Reference
Packages
infrastructure.cluster.x-k8s.io/v1alpha1
Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group.
Resource Types
- KinkCluster
- KinkClusterList
- KinkClusterTemplate
- KinkClusterTemplateList
- KinkMachine
- KinkMachineList
- KinkMachineTemplate
- KinkMachineTemplateList
KinkCluster
KinkCluster is the Schema for the kinkclusters API.
Appears in: - KinkClusterList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkCluster |
||
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 |
||
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 |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec KinkClusterSpec |
|||
status KinkClusterStatus |
KinkClusterList
KinkClusterList contains a list of KinkCluster.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkClusterList |
||
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 |
||
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 |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items KinkCluster array |
KinkClusterSpec
KinkClusterSpec defines the desired state of KinkCluster.
Appears in: - KinkCluster - KinkClusterTemplateResource
KinkClusterStatus
KinkClusterStatus defines the observed state of KinkCluster.
Appears in: - KinkCluster
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean |
Ready denotes that the kink cluster infrastructure is fully provisioned. |
KinkClusterTemplate
KinkClusterTemplate is the Schema for the kinkclustertemplates API.
Appears in: - KinkClusterTemplateList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkClusterTemplate |
||
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 |
||
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 |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec KinkClusterTemplateSpec |
|||
status KinkClusterTemplateStatus |
KinkClusterTemplateList
KinkClusterTemplateList contains a list of KinkClusterTemplate.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkClusterTemplateList |
||
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 |
||
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 |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items KinkClusterTemplate array |
KinkClusterTemplateResource
Appears in: - KinkClusterTemplateSpec
| Field | Description | Default | Validation |
|---|---|---|---|
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec KinkClusterSpec |
KinkClusterTemplateSpec
KinkClusterTemplateSpec defines the desired state of KinkClusterTemplate.
Appears in: - KinkClusterTemplate
| Field | Description | Default | Validation |
|---|---|---|---|
template KinkClusterTemplateResource |
KinkClusterTemplateStatus
KinkClusterTemplateStatus defines the observed state of KinkClusterTemplate.
Appears in: - KinkClusterTemplate
KinkMachine
KinkMachine is the Schema for the kinkmachines API.
Appears in: - KinkMachineList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkMachine |
||
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 |
||
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 |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec KinkMachineSpec |
|||
status KinkMachineStatus |
KinkMachineList
KinkMachineList contains a list of KinkMachine.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkMachineList |
||
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 |
||
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 |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items KinkMachine array |
KinkMachineSpec
KinkMachineSpec defines the desired state of KinkMachine.
Appears in: - KinkMachine - KinkMachineTemplateResource
| Field | Description | Default | Validation |
|---|---|---|---|
providerID string |
providerID must match the provider ID as seen on the node object corresponding to this machine. |
KinkMachineStatus
KinkMachineStatus defines the observed state of KinkMachine.
Appears in: - KinkMachine
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean |
Ready denotes that the kink machine infrastructure is fully provisioned. |
KinkMachineTemplate
KinkMachineTemplate is the Schema for the kinkmachinetemplates API.
Appears in: - KinkMachineTemplateList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkMachineTemplate |
||
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 |
||
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 |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec KinkMachineTemplateSpec |
|||
status KinkMachineTemplateStatus |
KinkMachineTemplateList
KinkMachineTemplateList contains a list of KinkMachineTemplate.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
infrastructure.cluster.x-k8s.io/v1alpha1 |
||
kind string |
KinkMachineTemplateList |
||
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 |
||
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 |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items KinkMachineTemplate array |
KinkMachineTemplateResource
Appears in: - KinkMachineTemplateSpec
| Field | Description | Default | Validation |
|---|---|---|---|
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec KinkMachineSpec |
KinkMachineTemplateSpec
KinkMachineTemplateSpec defines the desired state of KinkMachineTemplate.
Appears in: - KinkMachineTemplate
| Field | Description | Default | Validation |
|---|---|---|---|
template KinkMachineTemplateResource |
KinkMachineTemplateStatus
KinkMachineTemplateStatus defines the observed state of KinkMachineTemplate.
Appears in: - KinkMachineTemplate