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 | spec is the desired state of the AddressSet | MinProperties: 1 | |
status AddressSetStatus | status is the observed state of the AddressSet |
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 | items is a list of AddressSet |
AddressSetSpec
AddressSetSpec defines the desired state of AddressSet
Validation:
- MinProperties: 1
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ipv4 string | ipv4 defines a list of IPv4 address strings | ||
ipv6 string | ipv6 defines a list of IPv6 address strings |
AddressSetStatus
AddressSetStatus defines the observed state of AddressSet
Appears in:
BucketAccessRef
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bucketName string | bucketName is the name of the bucket to grant access to. | MaxLength: 63 MinLength: 3 | |
permissions string | permissions is the permissions to grant to the bucket. | Enum: [read_only read_write] | |
region string | region is the region of the bucket. | MinLength: 1 |
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 | spec is the desired state of the FirewallRule. | ||
status FirewallRuleStatus | status is the observed state of the FirewallRule. |
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 | items is a list of FirewallRule. |
FirewallRuleSpec
FirewallRuleSpec defines the desired state of FirewallRule.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
action string | action is the action to take when the rule matches. | Enum: [ACCEPT DROP] | |
label string | label is the label of the rule. | MinLength: 3 | |
description string | description is the description of the rule. | ||
ports string | ports is the ports to apply the rule to. | ||
protocol NetworkProtocol | protocol is the protocol to apply the rule to. | Enum: [TCP UDP ICMP IPENCAP] | |
addresses NetworkAddresses | addresses is a list of addresses to apply the rule to. | ||
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 | name of the generated Secret. If not set, the name is formatted as "{name-of-obj-key}-obj-key". | ||
namespace string | namespace for the generated Secret. If not set, defaults to the namespace of the LinodeObjectStorageKey. | ||
type SecretType | type of the generated Secret. | Opaque | Enum: [Opaque addons.cluster.x-k8s.io/resource-set] |
format object (keys:string, values:string) | format of 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. |
IPv6CreateOptions
IPv6CreateOptions defines the IPv6 options for the instance.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
enableSLAAC boolean | enableSLAAC is an option to enable SLAAC (Stateless Address Autoconfiguration) for the instance. This is useful for IPv6 addresses, allowing the instance to automatically configure its own IPv6 address. Defaults to false. | ||
enableRanges boolean | enableRanges is an option to enable IPv6 ranges for the instance. If set to true, the instance will have a range of IPv6 addresses. This is useful for instances that require multiple IPv6 addresses. Defaults to false. | ||
isPublicIPv6 boolean | isPublicIPv6 is an option to enable public IPv6 for the instance. If set to true, the instance will have a publicly routable IPv6 range. Defaults to false. |
InstanceConfigInterfaceCreateOptions
InstanceConfigInterfaceCreateOptions defines network interface config
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ipamAddress string | ipamAddress is the IP address to assign to the interface. | ||
label string | label is the label of the interface. | MaxLength: 63 MinLength: 3 | |
purpose ConfigInterfacePurpose | purpose is the purpose of the interface. | ||
primary boolean | primary is a boolean indicating whether the interface is primary. | ||
subnetId integer | subnetId is the ID of the subnet to use for the interface. | ||
ipv4 VPCIPv4 | ipv4 is the IPv4 configuration for the interface. | ||
ipRanges string array | ipRanges is a list of IPv4 ranges to assign to the interface. |
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. | ||
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] |
InstanceDisks
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
sdb InstanceDisk | sdb is a disk for the instance. | ||
sdc InstanceDisk | sdc is a disk for the instance. | ||
sdd InstanceDisk | sdd is a disk for the instance. | ||
sde InstanceDisk | sde is a disk for the instance. | ||
sdf InstanceDisk | sdf is a disk for the instance. | ||
sdg InstanceDisk | sdg is a disk for the instance. | ||
sdh InstanceDisk | sdh is a disk for the instance. |
InterfaceDefaultRoute
InterfaceDefaultRoute defines the default IPv4 and IPv6 routes for an interface
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ipv4 boolean | ipv4 is the IPv4 default route for the interface. | ||
ipv6 boolean | ipv6 is the IPv6 default route for the interface. |
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 | spec is the desired state of the LinodeCluster. | ||
status LinodeClusterStatus | status is the observed state of the LinodeCluster. |
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 | items is a list of LinodeCluster. |
LinodeClusterSpec
LinodeClusterSpec defines the desired state of LinodeCluster
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
region string | region the LinodeCluster lives in. | MinLength: 1 | |
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 | network encapsulates all things related to Linode network. | ||
vpcRef ObjectReference | vpcRef is a reference to a VPC object. This makes the Linodes use the specified VPC. | ||
vpcID integer | vpcID is the ID of an existing VPC in Linode. | ||
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 |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodeCluster. | ||
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. |
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 | spec is the desired state of the LinodeClusterTemplate. |
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 | items is a list of LinodeClusterTemplate. |
LinodeClusterTemplateResource
LinodeClusterTemplateResource describes the data needed to create a LinodeCluster from a template.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
spec LinodeClusterSpec | spec is the specification of the LinodeCluster. |
LinodeClusterTemplateSpec
LinodeClusterTemplateSpec defines the desired state of LinodeClusterTemplate
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
template LinodeClusterTemplateResource | template defines the specification for a LinodeCluster. |
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 | spec is the desired state of the LinodeFirewall. | MinProperties: 1 | |
status LinodeFirewallStatus | status is the observed state of the LinodeFirewall. |
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 | items is a list of LinodeFirewall. |
LinodeFirewallSpec
LinodeFirewallSpec defines the desired state of LinodeFirewall
Validation:
- MinProperties: 1
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
firewallID integer | firewallID is the ID of the Firewall. | ||
enabled boolean | enabled determines if the Firewall is enabled. Defaults to false if not defined. | false | |
inboundRules FirewallRuleSpec array | inboundRules is a list of FirewallRules that will be applied to the Firewall. | ||
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 | outboundRules is a list of FirewallRules that will be applied to the Firewall. | ||
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 |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodeFirewall. | ||
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. |
LinodeInterfaceCreateOptions
LinodeInterfaceCreateOptions defines the linode network interface config
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
firewall_id integer | firewall_id is the ID of the firewall to use for the interface. | ||
default_route InterfaceDefaultRoute | default_route is the default route for the interface. | ||
public PublicInterfaceCreateOptions | public is the public interface configuration for the interface. | ||
vpc VPCInterfaceCreateOptions | vpc is the VPC interface configuration for the interface. | ||
vlan VLANInterface | vlan is the VLAN interface configuration for the interface. |
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 | spec defines the specification of desired behavior for the LinodeMachine. | ||
status LinodeMachineStatus | status defines the observed state of LinodeMachine. |
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 | items is a list of LinodeMachine. |
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 | region is the Linode region to create the instance in. | MinLength: 1 | |
type string | type is the Linode instance type to create. | MinLength: 1 | |
group string | group is the Linode group to create the instance in. | ||
rootPass string | rootPass is the root password for the instance. | ||
authorizedKeys string array | authorizedKeys is a list of SSH public keys to add to the instance. | ||
authorizedUsers string array | authorizedUsers is a list of usernames to add to the instance. | ||
backupID integer | backupID is the ID of the backup to restore the instance from. | ||
image string | image is the Linode image to use for the instance. | ||
interfaces InstanceConfigInterfaceCreateOptions array | interfaces is a list of legacy network interfaces to use for the instance. | ||
linodeInterfaces LinodeInterfaceCreateOptions array | linodeInterfaces is a list of Linode network interfaces to use for the instance. Requires Linode Interfaces beta opt-in to use. | ||
backupsEnabled boolean | backupsEnabled is a boolean indicating whether backups should be enabled for the instance. | ||
privateIP boolean | privateIP is a boolean indicating whether the instance should have a private IP address. | ||
tags string array | tags is a list of tags to apply to the Linode instance. | ||
firewallID integer | firewallID is the id of the cloud firewall to apply to the Linode Instance | ||
osDisk InstanceDisk | osDisk is a 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 InstanceDisks | 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. The default is disabled. | 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. | ||
vpcID integer | vpcID is the ID of an existing VPC in Linode. This allows using a VPC that is not managed by CAPL. | ||
ipv6Options IPv6CreateOptions | ipv6Options defines the IPv6 options for the instance. If not specified, IPv6 ranges won't be allocated to instance. | ||
networkHelper boolean | networkHelper is an option usually enabled on account level. It helps configure networking automatically for instances. You can use this to enable/disable the network helper for a specific instance. For more information, see https://techdocs.akamai.com/cloud-computing/docs/automatically-configure-networking Defaults to true. | ||
interfaceGeneration InterfaceGeneration | interfaceGeneration is the generation of the interface to use for the cluster's nodes in interface / linodeInterface are not specified for a LinodeMachine. If not set, defaults to "legacy_config". | legacy_config | Enum: [legacy_config linode] |
LinodeMachineStatus
LinodeMachineStatus defines the observed state of LinodeMachine
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodeMachine. | ||
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. Deprecated: Stackscript no longer in use, so this field is not used. | 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. | ||
tags string array | tags are the tags applied to the Linode Machine. |
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 | spec is the desired state of the LinodeMachineTemplate. | ||
status LinodeMachineTemplateStatus | status is the observed state of the LinodeMachineTemplate. |
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 | items is a list of LinodeMachineTemplate. |
LinodeMachineTemplateResource
LinodeMachineTemplateResource describes the data needed to create a LinodeMachine from a template.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
spec LinodeMachineSpec | spec is the specification of the desired behavior of the machine. |
LinodeMachineTemplateSpec
LinodeMachineTemplateSpec defines the desired state of LinodeMachineTemplate
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
template LinodeMachineTemplateResource | template defines the specification for a LinodeMachine. |
LinodeMachineTemplateStatus
LinodeMachineTemplateStatus defines the observed state of LinodeMachineTemplate It is used to store the status of the LinodeMachineTemplate, such as tags.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodeMachineTemplate | ||
tags string array | tags that are currently applied to the LinodeMachineTemplate. | ||
firewallID integer | firewallID that is currently applied to the LinodeMachineTemplate. |
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 | spec is the desired state of the LinodeObjectStorageBucket. | ||
status LinodeObjectStorageBucketStatus | status is the observed state of the LinodeObjectStorageBucket. |
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 | items is a list of LinodeObjectStorageBucket. |
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. | MinLength: 1 | |
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. | ||
accessKeyRef ObjectReference | accessKeyRef is a reference to a LinodeObjectStorageBucketKey for the bucket. | ||
forceDeleteBucket boolean | forceDeleteBucket enables the object storage bucket used to be deleted even if it contains objects. |
LinodeObjectStorageBucketStatus
LinodeObjectStorageBucketStatus defines the observed state of LinodeObjectStorageBucket
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodeObjectStorageBucket. | ||
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. | ||
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 | spec is the desired state of the LinodeObjectStorageKey. | ||
status LinodeObjectStorageKeyStatus | status is the observed state of the LinodeObjectStorageKey. |
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 | Items represent the list of LinodeObjectStorageKey objects. |
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 |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodeObjectStorageKey. | ||
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. | ||
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 | spec is the desired state of the LinodePlacementGroup. | ||
status LinodePlacementGroupStatus | status is the observed state of the LinodePlacementGroup. |
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 | items is a list of LinodePlacementGroup. |
LinodePlacementGroupSpec
LinodePlacementGroupSpec defines the desired state of LinodePlacementGroup
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
pgID integer | pgID is the ID of the PlacementGroup. | ||
region string | region is the Linode region to create the PlacementGroup in. | MinLength: 1 | |
placementGroupPolicy string | placementGroupPolicy defines the policy for the PlacementGroup. | strict | Enum: [strict flexible] |
placementGroupType string | placementGroupType defines the type of the PlacementGroup. | 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 |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodePlacementGroup. | ||
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. |
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 | spec is the desired state of the LinodeVPC. | ||
status LinodeVPCStatus | status is the observed state of the LinodeVPC. |
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 | items is a list of LinodeVPC. |
LinodeVPCSpec
LinodeVPCSpec defines the desired state of LinodeVPC
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vpcID integer | vpcID is the ID of the VPC. | ||
description string | description is the description of the VPC. | ||
region string | region is the region to create the VPC in. | MinLength: 1 | |
ipv6 VPCIPv6Range array | ipv6 is a list of IPv6 ranges allocated to the VPC. Once ranges are allocated based on the IPv6Range field, they will be added to this field. | ||
ipv6Range VPCCreateOptionsIPv6 array | ipv6Range is a list of IPv6 ranges to allocate to the VPC. If not specified, the VPC will not have an IPv6 range allocated. Once ranges are allocated, they will be added to the IPv6 field. | ||
subnets VPCSubnetCreateOptions array | subnets is a list of subnets to create in the VPC. | ||
retain boolean | retain allows you to keep the VPC after the LinodeVPC object is deleted. This is useful if you want to use an existing VPC that was not created by this controller. If set to true, the controller will not delete the VPC resource in Linode. Defaults to false. | false | |
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 |
|---|---|---|---|
conditions Condition array | conditions define the current service state of the LinodeVPC. | ||
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. |
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 | ipv4 defines a list of IPv4 address strings. | ||
ipv6 string | ipv6 defines a list of IPv6 address strings. |
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 the 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. | ||
subnetName string | subnetName is the name/label of the VPC subnet to be used by the cluster | ||
useVlan boolean | useVlan provisions a cluster that uses VLANs instead of VPCs. IPAM is managed internally. | ||
nodeBalancerBackendIPv4Range string | nodeBalancerBackendIPv4Range is the subnet range we want to provide for creating nodebalancer in VPC. example: 10.10.10.0/30 | ||
enableVPCBackends boolean | enableVPCBackends toggles VPC-scoped NodeBalancer and VPC backend IP usage. If set to false (default), the NodeBalancer will not be created in a VPC and backends will use Linode private IPs. If true, the NodeBalancer will be created in the configured VPC (when VPCRef or VPCID is set) and backends will use VPC IPs. | false |
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. |
PublicInterfaceCreateOptions
PublicInterfaceCreateOptions defines the IPv4 and IPv6 public interface create options
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ipv4 PublicInterfaceIPv4CreateOptions | ipv4 is the IPv4 configuration for the public interface. | ||
ipv6 PublicInterfaceIPv6CreateOptions | ipv6 is the IPv6 configuration for the public interface. |
PublicInterfaceIPv4AddressCreateOptions
PublicInterfaceIPv4AddressCreateOptions defines the public IPv4 address and whether it is primary
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
address string | address is the IPv4 address for the public interface. | MinLength: 1 | |
primary boolean | primary is a boolean indicating whether the address is primary. |
PublicInterfaceIPv4CreateOptions
PublicInterfaceIPv4CreateOptions defines the PublicInterfaceIPv4AddressCreateOptions for addresses
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
addresses PublicInterfaceIPv4AddressCreateOptions array | addresses is the IPv4 addresses for the public interface. |
PublicInterfaceIPv6CreateOptions
PublicInterfaceIPv6CreateOptions defines the PublicInterfaceIPv6RangeCreateOptions
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ranges PublicInterfaceIPv6RangeCreateOptions array | ranges is the IPv6 ranges for the public interface. |
PublicInterfaceIPv6RangeCreateOptions
PublicInterfaceIPv6RangeCreateOptions defines the IPv6 range for a public interface
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
range string | range is the IPv6 range for the public interface. | MinLength: 1 |
VLANInterface
VLANInterface defines the VLAN interface configuration for an instance
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vlan_label string | vlan_label is the label of the VLAN. | MinLength: 1 | |
ipam_address string | ipam_address is the IP address to assign to the interface. |
VPCCreateOptionsIPv6
VPCCreateOptionsIPv6 defines the options for creating an IPv6 range in a VPC. It's copied from linodego.VPCCreateOptionsIPv6 and should be kept in sync. Values supported by the linode API should be used here. See https://techdocs.akamai.com/linode-api/reference/post-vpc for more details.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
range string | range is the IPv6 prefix for the VPC. | ||
allocation_class string | allocation_class is the IPv6 inventory from which the VPC prefix should be allocated. |
VPCIPv4
VPCIPv4 defines VPC IPV4 settings
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vpc string | vpc is the ID of the VPC to use for the interface. | ||
nat1to1 string | nat1to1 is the NAT 1:1 address for the interface. |
VPCInterfaceCreateOptions
VPCInterfaceCreateOptions defines the VPC interface configuration for an instance
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
subnet_id integer | subnet_id is the ID of the subnet to use for the interface. | Minimum: 1 | |
ipv4 VPCInterfaceIPv4CreateOptions | ipv4 is the IPv4 configuration for the interface. | ||
ipv6 VPCInterfaceIPv6CreateOptions | ipv6 is the IPv6 configuration for the interface. |
VPCInterfaceIPv4AddressCreateOptions
VPCInterfaceIPv4AddressCreateOptions defines the IPv4 configuration for a VPC interface
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
address string | address is the IPv4 address for the interface. | MinLength: 1 | |
primary boolean | primary is a boolean indicating whether the address is primary. | ||
nat_1_1_address string | nat_1_1_address is the NAT 1:1 address for the interface. |
VPCInterfaceIPv4CreateOptions
VPCInterfaceIPv4CreateOptions defines the IPv4 address and range configuration for a VPC interface
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
addresses VPCInterfaceIPv4AddressCreateOptions array | addresses is the IPv4 addresses for the interface. | ||
ranges VPCInterfaceIPv4RangeCreateOptions array | ranges is the IPv4 ranges for the interface. |
VPCInterfaceIPv4RangeCreateOptions
VPCInterfaceIPv4RangeCreateOptions defines the IPv4 range for a VPC interface
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
range string | range is the IPv4 range for the interface. | MinLength: 1 |
VPCInterfaceIPv6CreateOptions
VPCInterfaceIPv6CreateOptions defines the IPv6 configuration for a VPC interface
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
slaac VPCInterfaceIPv6SLAACCreateOptions array | slaac is the IPv6 SLAAC configuration for the interface. | ||
ranges VPCInterfaceIPv6RangeCreateOptions array | ranges is the IPv6 ranges for the interface. | ||
is_public boolean | is_public is a boolean indicating whether the interface is public. |
VPCInterfaceIPv6RangeCreateOptions
VPCInterfaceIPv6RangeCreateOptions defines the IPv6 range for a VPC interface
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
range string | range is the IPv6 range for the interface. | MinLength: 1 |
VPCInterfaceIPv6SLAACCreateOptions
VPCInterfaceIPv6SLAACCreateOptions defines the Range for IPv6 SLAAC
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
range string | range is the IPv6 range for the interface. | MinLength: 1 |
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 | label is the label of the subnet. | MaxLength: 63 MinLength: 3 | |
ipv4 string | ipv4 is the IPv4 address range of the subnet. | ||
ipv6 VPCIPv6Range array | ipv6 is a list of IPv6 ranges allocated to the subnet. Once ranges are allocated based on the IPv6Range field, they will be added to this field. | ||
ipv6Range VPCSubnetCreateOptionsIPv6 array | ipv6Range is a list of IPv6 ranges to allocate to the subnet. If not specified, the subnet will not have an IPv6 range allocated. Once ranges are allocated, they will be added to the IPv6 field. | ||
subnetID integer | subnetID is subnet id for the subnet | ||
retain boolean | retain allows you to keep the Subnet after the LinodeVPC object is deleted. This is only applicable when the parent VPC has retain set to true. | false |
VPCSubnetCreateOptionsIPv6
VPCSubnetCreateOptionsIPv6 defines the options for creating an IPv6 range in a VPC subnet. It's copied from linodego.VPCSubnetCreateOptionsIPv6 and should be kept in sync. Values supported by the linode API should be used here. See https://techdocs.akamai.com/linode-api/reference/post-vpc-subnet for more details.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
range string | range is the IPv6 prefix for the subnet. |