API Reference
Packages
infrastructure.cluster.x-k8s.io/v1alpha2
Package v1alpha2 contains API Schema definitions for the infrastructure v1alpha2 API group
Resource Types
- AddressSet
- AddressSetList
- FirewallRule
- FirewallRuleList
- LinodeCluster
- LinodeClusterList
- LinodeClusterTemplate
- LinodeClusterTemplateList
- LinodeFirewall
- LinodeFirewallList
- LinodeMachine
- LinodeMachineList
- LinodeMachineTemplate
- LinodeMachineTemplateList
- LinodeObjectStorageBucket
- LinodeObjectStorageBucketList
- LinodeObjectStorageKey
- LinodeObjectStorageKeyList
- LinodePlacementGroup
- LinodePlacementGroupList
- LinodeVPC
- LinodeVPCList
AddressSet
AddressSet is the Schema for the addresssets API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | AddressSet | ||
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 AddressSetSpec | |||
status AddressSetStatus |
AddressSetList
AddressSetList contains a list of AddressSet
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | AddressSetList | ||
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 AddressSet array |
AddressSetSpec
AddressSetSpec defines the desired state of AddressSet
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ipv4 string | |||
ipv6 string |
AddressSetStatus
AddressSetStatus defines the observed state of AddressSet
Appears in:
BucketAccessRef
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bucketName string | |||
permissions string | |||
region string |
FirewallRule
FirewallRule is the Schema for the firewallrules API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | FirewallRule | ||
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 FirewallRuleSpec | |||
status FirewallRuleStatus |
FirewallRuleList
FirewallRuleList contains a list of FirewallRule
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | FirewallRuleList | ||
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 FirewallRule array |
FirewallRuleSpec
FirewallRuleSpec defines the desired state of FirewallRule
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
action string | INSERT ADDITIONAL SPEC FIELDS - desired state of cluster Important: Run "make" to regenerate code after modifying this file | ||
label string | |||
description string | |||
ports string | |||
protocol NetworkProtocol | Enum: [TCP UDP ICMP IPENCAP] | ||
addresses NetworkAddresses | |||
addressSetRefs ObjectReference array | AddressSetRefs is a list of references to AddressSets as an alternative to using Addresses but can be used in conjunction with it |
FirewallRuleStatus
FirewallRuleStatus defines the observed state of FirewallRule
Appears in:
FirewallStatusError
Underlying type: string
FirewallStatusError defines errors states for Firewall objects.
Appears in:
| Field | Description |
|---|---|
CreateError | CreateFirewallError indicates that an error was encountered when trying to create the Firewall. |
UpdateError | UpdateFirewallError indicates that an error was encountered when trying to update the Firewall. |
DeleteError | DeleteFirewallError indicates that an error was encountered when trying to delete the Firewall. |
GeneratedSecret
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | The name of the generated Secret. If not set, the name is formatted as "{name-of-obj-key}-obj-key". | ||
namespace string | The namespace for the generated Secret. If not set, defaults to the namespace of the LinodeObjectStorageKey. | ||
type SecretType | The type of the generated Secret. | Opaque | Enum: [Opaque addons.cluster.x-k8s.io/resource-set] |
format object (keys:string, values:string) | How to format the data stored in the generated Secret. It supports Go template syntax and interpolating the following values: .AccessKey, .SecretKey .BucketName .BucketEndpoint .S3Endpoint If no format is supplied then a generic one is used containing the values specified. |
InstanceConfigInterfaceCreateOptions
InstanceConfigInterfaceCreateOptions defines network interface config
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ipamAddress string | |||
label string | MaxLength: 63 MinLength: 3 | ||
purpose ConfigInterfacePurpose | |||
primary boolean | |||
subnetId integer | |||
ipv4 VPCIPv4 | |||
ipRanges string array |
InstanceConfiguration
InstanceConfiguration defines the instance configuration
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
kernel string | Kernel is a Kernel ID to boot a Linode with. (e.g linode/latest-64bit) |
InstanceDisk
InstanceDisk defines a list of disks to use for an instance
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
diskID integer | DiskID is the linode assigned ID of the disk | ||
size Quantity | Size of the disk in resource.Quantity notation | Required: {} | |
label string | Label for the instance disk, if nothing is provided it will match the device name | ||
filesystem string | Filesystem of disk to provision, the default disk filesystem is "ext4" | Enum: [raw swap ext3 ext4 initrd] |
LinodeCluster
LinodeCluster is the Schema for the linodeclusters API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeCluster | ||
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 LinodeClusterSpec | |||
status LinodeClusterStatus |
LinodeClusterList
LinodeClusterList contains a list of LinodeCluster
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeClusterList | ||
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 LinodeCluster array |
LinodeClusterSpec
LinodeClusterSpec defines the desired state of LinodeCluster
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
region string | The Linode Region the LinodeCluster lives in. | ||
controlPlaneEndpoint APIEndpoint | ControlPlaneEndpoint represents the endpoint used to communicate with the LinodeCluster control plane. If ControlPlaneEndpoint is unset then the Nodebalancer ip will be used. | ||
network NetworkSpec | NetworkSpec encapsulates all things related to Linode network. | ||
vpcRef ObjectReference | |||
nodeBalancerFirewallRef ObjectReference | NodeBalancerFirewallRef is a reference to a NodeBalancer Firewall object. This makes the linode use the specified NodeBalancer Firewall. | ||
objectStore ObjectStore | ObjectStore defines a supporting Object Storage bucket for cluster operations. This is currently used for bootstrapping (e.g. Cloud-init). | ||
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for provisioning this cluster. If not supplied then the credentials of the controller will be used. |
LinodeClusterStatus
LinodeClusterStatus defines the observed state of LinodeCluster
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | Ready denotes that the cluster (infrastructure) is ready. | ||
failureReason string | FailureReason will be set in the event that there is a terminal problem reconciling the LinodeCluster and will contain a succinct value suitable for machine interpretation. | ||
failureMessage string | FailureMessage will be set in the event that there is a terminal problem reconciling the LinodeCluster and will contain a more verbose string suitable for logging and human consumption. | ||
conditions Condition array | Conditions defines current service state of the LinodeCluster. |
LinodeClusterTemplate
LinodeClusterTemplate is the Schema for the linodeclustertemplates API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeClusterTemplate | ||
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 LinodeClusterTemplateSpec |
LinodeClusterTemplateList
LinodeClusterTemplateList contains a list of LinodeClusterTemplate
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeClusterTemplateList | ||
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 LinodeClusterTemplate array |
LinodeClusterTemplateResource
LinodeClusterTemplateResource describes the data needed to create a LinodeCluster from a template.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
spec LinodeClusterSpec |
LinodeClusterTemplateSpec
LinodeClusterTemplateSpec defines the desired state of LinodeClusterTemplate
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
template LinodeClusterTemplateResource |
LinodeFirewall
LinodeFirewall is the Schema for the linodefirewalls API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeFirewall | ||
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 LinodeFirewallSpec | |||
status LinodeFirewallStatus |
LinodeFirewallList
LinodeFirewallList contains a list of LinodeFirewall
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeFirewallList | ||
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 LinodeFirewall array |
LinodeFirewallSpec
LinodeFirewallSpec defines the desired state of LinodeFirewall
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
firewallID integer | |||
enabled boolean | false | ||
inboundRules FirewallRuleSpec array | |||
inboundRuleRefs ObjectReference array | InboundRuleRefs is a list of references to FirewallRules as an alternative to using InboundRules but can be used in conjunction with it | ||
inboundPolicy string | InboundPolicy determines if traffic by default should be ACCEPTed or DROPped. Defaults to ACCEPT if not defined. | ACCEPT | Enum: [ACCEPT DROP] |
outboundRules FirewallRuleSpec array | |||
outboundRuleRefs ObjectReference array | OutboundRuleRefs is a list of references to FirewallRules as an alternative to using OutboundRules but can be used in conjunction with it | ||
outboundPolicy string | OutboundPolicy determines if traffic by default should be ACCEPTed or DROPped. Defaults to ACCEPT if not defined. | ACCEPT | Enum: [ACCEPT DROP] |
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for provisioning this Firewall. If not supplied then the credentials of the controller will be used. |
LinodeFirewallStatus
LinodeFirewallStatus defines the observed state of LinodeFirewall
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | Ready is true when the provider resource is ready. | false | |
failureReason FirewallStatusError | FailureReason will be set in the event that there is a terminal problem reconciling the Firewall and will contain a succinct value suitable for machine interpretation. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Firewall's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of Firewalls can be added as events to the Firewall object and/or logged in the controller's output. | ||
failureMessage string | FailureMessage will be set in the event that there is a terminal problem reconciling the Firewall and will contain a more verbose string suitable for logging and human consumption. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Firewall's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of Firewalls can be added as events to the Firewall object and/or logged in the controller's output. | ||
conditions Condition array | Conditions defines current service state of the LinodeFirewall. |
LinodeMachine
LinodeMachine is the Schema for the linodemachines API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeMachine | ||
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 LinodeMachineSpec | |||
status LinodeMachineStatus |
LinodeMachineList
LinodeMachineList contains a list of LinodeMachine
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeMachineList | ||
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 LinodeMachine array |
LinodeMachineSpec
LinodeMachineSpec defines the desired state of LinodeMachine
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
providerID string | ProviderID is the unique identifier as specified by the cloud provider. | ||
instanceID integer | InstanceID is the Linode instance ID for this machine. | ||
region string | Required: {} | ||
type string | Required: {} | ||
group string | |||
rootPass string | |||
authorizedKeys string array | |||
authorizedUsers string array | |||
backupID integer | |||
image string | |||
interfaces InstanceConfigInterfaceCreateOptions array | |||
backupsEnabled boolean | |||
privateIP boolean | |||
tags string array | |||
firewallID integer | |||
osDisk InstanceDisk | OSDisk is configuration for the root disk that includes the OS, if not specified this defaults to whatever space is not taken up by the DataDisks | ||
dataDisks object (keys:string, values:InstanceDisk) | DataDisks is a map of any additional disks to add to an instance, The sum of these disks + the OSDisk must not be more than allowed on a linodes plan | ||
diskEncryption string | DiskEncryption determines if the disks of the instance should be encrypted. | Enum: [enabled disabled] | |
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for provisioning this machine. If not supplied then these credentials will be used in-order: 1. LinodeMachine 2. Owner LinodeCluster 3. Controller | ||
configuration InstanceConfiguration | Configuration is the Akamai instance configuration OS, if not specified this defaults to the default configuration associated to the instance. | ||
placementGroupRef ObjectReference | PlacementGroupRef is a reference to a placement group object. This makes the linode to be launched in that specific group. | ||
firewallRef ObjectReference | FirewallRef is a reference to a firewall object. This makes the linode use the specified firewall. | ||
vpcRef ObjectReference | VPCRef is a reference to a LinodeVPC resource. If specified, this takes precedence over the cluster-level VPC configuration for multi-region support. |
LinodeMachineStatus
LinodeMachineStatus defines the observed state of LinodeMachine
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | Ready is true when the provider resource is ready. | false | |
addresses MachineAddress array | Addresses contains the Linode instance associated addresses. | ||
cloudinitMetadataSupport boolean | CloudinitMetadataSupport determines whether to use cloud-init or not. | true | |
instanceState InstanceStatus | InstanceState is the state of the Linode instance for this machine. | ||
failureReason string | FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output. | ||
failureMessage string | FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output. | ||
conditions Condition array | Conditions defines current service state of the LinodeMachine. |
LinodeMachineTemplate
LinodeMachineTemplate is the Schema for the linodemachinetemplates API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeMachineTemplate | ||
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 LinodeMachineTemplateSpec |
LinodeMachineTemplateList
LinodeMachineTemplateList contains a list of LinodeMachineTemplate
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeMachineTemplateList | ||
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 LinodeMachineTemplate array |
LinodeMachineTemplateResource
LinodeMachineTemplateResource describes the data needed to create a LinodeMachine from a template.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
spec LinodeMachineSpec |
LinodeMachineTemplateSpec
LinodeMachineTemplateSpec defines the desired state of LinodeMachineTemplate
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
template LinodeMachineTemplateResource |
LinodeNBPortConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
port integer | port configured on the NodeBalancer. It must be valid port range (1-65535). | Maximum: 65535 Minimum: 1 | |
nodeBalancerConfigID integer | nodeBalancerConfigID is the config ID of port's NodeBalancer config. |
LinodeObjectStorageBucket
LinodeObjectStorageBucket is the Schema for the linodeobjectstoragebuckets API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeObjectStorageBucket | ||
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 LinodeObjectStorageBucketSpec | |||
status LinodeObjectStorageBucketStatus |
LinodeObjectStorageBucketList
LinodeObjectStorageBucketList contains a list of LinodeObjectStorageBucket
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeObjectStorageBucketList | ||
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 LinodeObjectStorageBucket array |
LinodeObjectStorageBucketSpec
LinodeObjectStorageBucketSpec defines the desired state of LinodeObjectStorageBucket
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
region string | Region is the ID of the Object Storage region for the bucket. | ||
acl ObjectStorageACL | Acl sets the Access Control Level of the bucket using a canned ACL string | private | Enum: [private public-read authenticated-read public-read-write] |
corsEnabled boolean | corsEnabled enables for all origins in the bucket .If set to false, CORS is disabled for all origins in the bucket | true | |
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for provisioning the bucket. If not supplied then the credentials of the controller will be used. |
LinodeObjectStorageBucketStatus
LinodeObjectStorageBucketStatus defines the observed state of LinodeObjectStorageBucket
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | Ready denotes that the bucket has been provisioned along with access keys. | false | |
failureMessage string | FailureMessage will be set in the event that there is a terminal problem reconciling the Object Storage Bucket and will contain a verbose string suitable for logging and human consumption. | ||
conditions Condition array | Conditions specify the service state of the LinodeObjectStorageBucket. | ||
hostname string | Hostname is the address assigned to the bucket. | ||
creationTime Time | CreationTime specifies the creation timestamp for the bucket. |
LinodeObjectStorageKey
LinodeObjectStorageKey is the Schema for the linodeobjectstoragekeys API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeObjectStorageKey | ||
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 LinodeObjectStorageKeySpec | |||
status LinodeObjectStorageKeyStatus |
LinodeObjectStorageKeyList
LinodeObjectStorageKeyList contains a list of LinodeObjectStorageKey
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeObjectStorageKeyList | ||
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 LinodeObjectStorageKey array |
LinodeObjectStorageKeySpec
LinodeObjectStorageKeySpec defines the desired state of LinodeObjectStorageKey
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bucketAccess BucketAccessRef array | BucketAccess is the list of object storage bucket labels which can be accessed using the key | MinItems: 1 | |
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for generating access keys. If not supplied then the credentials of the controller will be used. | ||
keyGeneration integer | KeyGeneration may be modified to trigger a rotation of the access key. | 0 | |
generatedSecret GeneratedSecret | GeneratedSecret configures the Secret to generate containing access key details. | ||
secretType SecretType | SecretType instructs the controller what type of secret to generate containing access key details. Deprecated: Use generatedSecret.type. | Enum: [Opaque addons.cluster.x-k8s.io/resource-set] | |
secretDataFormat object (keys:string, values:string) | SecretDataFormat instructs the controller how to format the data stored in the secret containing access key details. Deprecated: Use generatedSecret.format. |
LinodeObjectStorageKeyStatus
LinodeObjectStorageKeyStatus defines the observed state of LinodeObjectStorageKey
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | Ready denotes that the key has been provisioned. | false | |
failureMessage string | FailureMessage will be set in the event that there is a terminal problem reconciling the Object Storage Key and will contain a verbose string suitable for logging and human consumption. | ||
conditions Condition array | Conditions specify the service state of the LinodeObjectStorageKey. | ||
creationTime Time | CreationTime specifies the creation timestamp for the secret. | ||
lastKeyGeneration integer | LastKeyGeneration tracks the last known value of .spec.keyGeneration. | ||
accessKeyRef integer | AccessKeyRef stores the ID for Object Storage key provisioned. |
LinodePlacementGroup
LinodePlacementGroup is the Schema for the linodeplacementgroups API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodePlacementGroup | ||
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 LinodePlacementGroupSpec | |||
status LinodePlacementGroupStatus |
LinodePlacementGroupList
LinodePlacementGroupList contains a list of LinodePlacementGroup
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodePlacementGroupList | ||
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 LinodePlacementGroup array |
LinodePlacementGroupSpec
LinodePlacementGroupSpec defines the desired state of LinodePlacementGroup
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
pgID integer | |||
region string | |||
placementGroupPolicy string | strict | Enum: [strict flexible] | |
placementGroupType string | anti_affinity:local | Enum: [anti_affinity:local] | |
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for provisioning this PlacementGroup. If not supplied then the credentials of the controller will be used. |
LinodePlacementGroupStatus
LinodePlacementGroupStatus defines the observed state of LinodePlacementGroup
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | Ready is true when the provider resource is ready. | false | |
failureReason LinodePlacementGroupStatusError | FailureReason will be set in the event that there is a terminal problem reconciling the PlacementGroup and will contain a succinct value suitable for machine interpretation. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the PlacementGroup's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of PlacementGroups can be added as events to the PlacementGroup object and/or logged in the controller's output. | ||
failureMessage string | FailureMessage will be set in the event that there is a terminal problem reconciling the PlacementGroup and will contain a more verbose string suitable for logging and human consumption. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the PlacementGroup's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of PlacementGroups can be added as events to the PlacementGroup object and/or logged in the controller's output. | ||
conditions Condition array | Conditions defines current service state of the LinodePlacementGroup. |
LinodePlacementGroupStatusError
Underlying type: string
LinodePlacementGroupStatusError defines errors states for PlacementGroup objects.
Appears in:
| Field | Description |
|---|---|
CreateError | CreatePlacementGroupError indicates that an error was encountered when trying to create the PlacementGroup. |
DeleteError | DeletePlacementGroupError indicates that an error was encountered when trying to delete the PlacementGroup. |
LinodeVPC
LinodeVPC is the Schema for the linodemachines API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeVPC | ||
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 LinodeVPCSpec | |||
status LinodeVPCStatus |
LinodeVPCList
LinodeVPCList contains a list of LinodeVPC
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind string | LinodeVPCList | ||
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 LinodeVPC array |
LinodeVPCSpec
LinodeVPCSpec defines the desired state of LinodeVPC
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vpcID integer | |||
description string | |||
region string | |||
subnets VPCSubnetCreateOptions array | |||
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for provisioning this VPC. If not supplied then the credentials of the controller will be used. |
LinodeVPCStatus
LinodeVPCStatus defines the observed state of LinodeVPC
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | Ready is true when the provider resource is ready. | false | |
failureReason VPCStatusError | FailureReason will be set in the event that there is a terminal problem reconciling the VPC and will contain a succinct value suitable for machine interpretation. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the VPC's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of VPCs can be added as events to the VPC object and/or logged in the controller's output. | ||
failureMessage string | FailureMessage will be set in the event that there is a terminal problem reconciling the VPC and will contain a more verbose string suitable for logging and human consumption. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the VPC's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of VPCs can be added as events to the VPC object and/or logged in the controller's output. | ||
conditions Condition array | Conditions defines current service state of the LinodeVPC. |
NetworkAddresses
NetworkAddresses holds a list of IPv4 and IPv6 addresses We don't use linodego here since kubebuilder can't generate DeepCopyInto for linodego.NetworkAddresses
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ipv4 string | |||
ipv6 string |
NetworkSpec
NetworkSpec encapsulates Linode networking resources.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
loadBalancerType string | LoadBalancerType is the type of load balancer to use, defaults to NodeBalancer if not otherwise set | NodeBalancer | Enum: [NodeBalancer dns external] |
dnsProvider string | DNSProvider is provider who manages the domain Ignored if the LoadBalancerType is set to anything other than dns If not set, defaults linode dns | Enum: [linode akamai] | |
dnsRootDomain string | DNSRootDomain is the root domain used to create a DNS entry for the control-plane endpoint Ignored if the LoadBalancerType is set to anything other than dns | ||
dnsUniqueIdentifier string | DNSUniqueIdentifier is the unique identifier for the DNS. This let clusters with the same name have unique DNS record Ignored if the LoadBalancerType is set to anything other than dns If not set, CAPL will create a unique identifier for you | ||
dnsTTLsec integer | DNSTTLSec is the TTL for the domain record Ignored if the LoadBalancerType is set to anything other than dns If not set, defaults to 30 | ||
dnsSubDomainOverride string | DNSSubDomainOverride is used to override CAPL's construction of the controlplane endpoint If set, this will override the DNS subdomain from | ||
apiserverLoadBalancerPort integer | apiserverLoadBalancerPort used by the api server. It must be valid ports range (1-65535). If omitted, default value is 6443. | Maximum: 65535 Minimum: 1 | |
nodeBalancerID integer | NodeBalancerID is the id of NodeBalancer. | ||
nodeBalancerFirewallID integer | NodeBalancerFirewallID is the id of NodeBalancer Firewall. | ||
apiserverNodeBalancerConfigID integer | apiserverNodeBalancerConfigID is the config ID of api server NodeBalancer config. | ||
additionalPorts LinodeNBPortConfig array | additionalPorts contains list of ports to be configured with NodeBalancer. | ||
useVlan boolean | UseVlan provisions a cluster that uses VLANs instead of VPCs. IPAM is managed internally. |
ObjectStorageACL
Underlying type: string
Appears in:
| Field | Description |
|---|---|
private | |
public-read | |
authenticated-read | |
public-read-write |
ObjectStore
ObjectStore defines a supporting Object Storage bucket for cluster operations. This is currently used for bootstrapping (e.g. Cloud-init).
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
presignedURLDuration Duration | PresignedURLDuration defines the duration for which presigned URLs are valid. This is used to generate presigned URLs for S3 Bucket objects, which are used by control-plane and worker nodes to fetch bootstrap data. | ||
credentialsRef SecretReference | CredentialsRef is a reference to a Secret that contains the credentials to use for accessing the Cluster Object Store. |
VPCIPv4
VPCIPv4 defines VPC IPV4 settings
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vpc string | |||
nat1to1 string |
VPCStatusError
Underlying type: string
VPCStatusError defines errors states for VPC objects.
Appears in:
| Field | Description |
|---|---|
CreateError | CreateVPCError indicates that an error was encountered when trying to create the VPC. |
UpdateError | UpdateVPCError indicates that an error was encountered when trying to update the VPC. |
DeleteError | DeleteVPCError indicates that an error was encountered when trying to delete the VPC. |
VPCSubnetCreateOptions
VPCSubnetCreateOptions defines subnet options
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
label string | MaxLength: 63 MinLength: 3 | ||
ipv4 string | |||
subnetID integer | SubnetID is subnet id for the subnet |