You are looking at the documentation of a prior release. To read the documentation of the latest release, please visit here.

Instance

FieldTypeDescription
apiVersionstringlinode.kubeform.com/v1alpha1
kindstringInstance
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of the metadata field.
specInstanceSpec
statusInstanceStatus

InstanceSpec

Appears on:Instance, InstanceStatus

FieldTypeDescription
providerRefKubernetes core/v1.LocalObjectReference
idstring
secretRefKubernetes core/v1.LocalObjectReference
alerts[]InstanceSpecAlerts(Optional)
authorizedKeys[]string(Optional) A list of SSH public keys to deploy for the root user on the newly created Linode. Only accepted if ‘image’ is provided.
authorizedUsers[]string(Optional) A list of Linode usernames. If the usernames have associated SSH keys, the keys will be appended to the root user’s ~/.ssh/authorized_keys file automatically. Only accepted if ‘image’ is provided.
backupIDint64(Optional) A Backup ID from another Linode’s available backups. Your User must have read_write access to that Linode, the Backup must have a status of successful, and the Linode must be deployed to the same region as the Backup. See /linode/instances/{linodeId}/backups for a Linode’s available backups. This field and the image field are mutually exclusive.
backups[]InstanceSpecBackups(Optional) Information about this Linode’s backups status.
backupsEnabledbool(Optional) If this field is set to true, the created Linode will automatically be enrolled in the Linode Backup service. This will incur an additional charge. The cost for the Backup service is dependent on the Type of Linode deployed.
bootConfigLabelstring(Optional) The Label of the Instance Config that should be used to boot the Linode instance.
config[]InstanceSpecConfig(Optional) Configuration profiles define the VM settings and boot behavior of the Linode Instance.
disk[]InstanceSpecDisk(Optional)
groupstring(Optional) The display group of the Linode instance.
imagestring(Optional) An Image ID to deploy the Disk from. Official Linode Images start with linode/, while your Images start with private/. See /images for more information on the Images available for you to use.
ipAddressstring(Optional) This Linode’s Public IPv4 Address. If there are multiple public IPv4 addresses on this Instance, an arbitrary address will be used for this field.
ipv4[]string(Optional) This Linode’s IPv4 Addresses. Each Linode is assigned a single public IPv4 address upon creation, and may get a single private IPv4 address if needed. You may need to open a support ticket to get additional IPv4 addresses.
ipv6string(Optional) This Linode’s IPv6 SLAAC addresses. This address is specific to a Linode, and may not be shared.
labelstring(Optional) The Linode’s label is for display purposes only. If no label is provided for a Linode, a default will be assigned
privateIPbool(Optional) If true, the created Linode will have private networking enabled, allowing use of the 192.168.128.0/17 network within the Linode’s region.
privateIPAddressstring(Optional) This Linode’s Private IPv4 Address. The regional private IP address range is 192.168.128/17 address shared by all Linode Instances in a region.
regionstringThis is the location where the Linode was deployed. This cannot be changed without opening a support ticket.
specs[]InstanceSpecSpecs(Optional)
stackscriptIDint64(Optional) The StackScript to deploy to the newly created Linode. If provided, ‘image’ must also be provided, and must be an Image that is compatible with this StackScript.
statusstring(Optional) The status of the instance, indicating the current readiness state.
swapSizeint64(Optional) When deploying from an Image, this field is optional with a Linode API default of 512mb, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode.
tags[]string(Optional) An array of tags applied to this object. Tags are for organizational purposes only.
typestring(Optional) The type of instance to be deployed, determining the price and size.
watchdogEnabledbool(Optional) The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible. To prevent a loop, Lassie will give up if there have been more than 5 boot jobs issued within 15 minutes.

InstanceSpecAlerts

Appears on:InstanceSpec

FieldTypeDescription
cpuint64(Optional) The percentage of CPU usage required to trigger an alert. If the average CPU usage over two hours exceeds this value, we’ll send you an alert. If this is set to 0, the alert is disabled.
ioint64(Optional) The amount of disk IO operation per second required to trigger an alert. If the average disk IO over two hours exceeds this value, we’ll send you an alert. If set to 0, this alert is disabled.
networkInint64(Optional) The amount of incoming traffic, in Mbit/s, required to trigger an alert. If the average incoming traffic over two hours exceeds this value, we’ll send you an alert. If this is set to 0 (zero), the alert is disabled.
networkOutint64(Optional) The amount of outbound traffic, in Mbit/s, required to trigger an alert. If the average outbound traffic over two hours exceeds this value, we’ll send you an alert. If this is set to 0 (zero), the alert is disabled.
transferQuotaint64(Optional) The percentage of network transfer that may be used before an alert is triggered. When this value is exceeded, we’ll alert you. If this is set to 0 (zero), the alert is disabled.

InstanceSpecBackups

Appears on:InstanceSpec

FieldTypeDescription
enabledbool(Optional) If this Linode has the Backup service enabled.
schedule[]InstanceSpecBackupsSchedule(Optional)

InstanceSpecBackupsSchedule

Appears on:InstanceSpecBackups

FieldTypeDescription
daystring(Optional) The day (‘Sunday’-‘Saturday’) of the week that your Linode’s weekly Backup is taken. If not set manually, a day will be chosen for you. Backups are taken every day, but backups taken on this day are preferred when selecting backups to retain for a longer period. If not set manually, then when backups are initially enabled, this may come back as ‘Scheduling’ until the day is automatically selected.
windowstring(Optional) The window (‘W0’-‘W22’) in which your backups will be taken, in UTC. A backups window is a two-hour span of time in which the backup may occur. For example, ‘W10’ indicates that your backups should be taken between 10:00 and 12:00. If you do not choose a backup window, one will be selected for you automatically. If not set manually, when backups are initially enabled this may come back as Scheduling until the window is automatically selected.

InstanceSpecConfig

Appears on:InstanceSpec

FieldTypeDescription
commentsstring(Optional) Optional field for arbitrary User comments on this Config.
devices[]InstanceSpecConfigDevices(Optional) Device sda-sdh can be either a Disk or Volume identified by disk_label or volume_id. Only one type per slot allowed.
helpers[]InstanceSpecConfigHelpers(Optional) Helpers enabled when booting to this Linode Config.
kernelstring(Optional) A Kernel ID to boot a Linode with. Default is based on image choice. (examples: linode/latest-64bit, linode/grub2, linode/direct-disk)
labelstringThe Config’s label for display purposes. Also used by boot_config_label.
memoryLimitint64(Optional) Defaults to the total RAM of the Linode
rootDevicestring(Optional) The root device to boot. The corresponding disk must be attached.
runLevelstring(Optional) Defines the state of your Linode after booting. Defaults to default.
virtModestring(Optional) Controls the virtualization mode. Defaults to paravirt.

InstanceSpecConfigDevices

Appears on:InstanceSpecConfig

FieldTypeDescription
sda[]InstanceSpecConfigDevicesSda(Optional)
sdb[]InstanceSpecConfigDevicesSdb(Optional)
sdc[]InstanceSpecConfigDevicesSdc(Optional)
sdd[]InstanceSpecConfigDevicesSdd(Optional)
sde[]InstanceSpecConfigDevicesSde(Optional)
sdf[]InstanceSpecConfigDevicesSdf(Optional)
sdg[]InstanceSpecConfigDevicesSdg(Optional)
sdh[]InstanceSpecConfigDevicesSdh(Optional)

InstanceSpecConfigDevicesSda

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigDevicesSdb

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigDevicesSdc

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigDevicesSdd

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigDevicesSde

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigDevicesSdf

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigDevicesSdg

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigDevicesSdh

Appears on:InstanceSpecConfigDevices

FieldTypeDescription
diskIDint64(Optional) The Disk ID to map to this disk slot
diskLabelstring(Optional) The label of the disk to map to this device slot.
volumeIDint64(Optional) The Block Storage volume ID to map to this disk slot

InstanceSpecConfigHelpers

Appears on:InstanceSpecConfig

FieldTypeDescription
devtmpfsAutomountbool(Optional) Populates the /dev directory early during boot without udev. Defaults to false.
distrobool(Optional) Controls the behavior of the Linode Config’s Distribution Helper setting.
modulesDepbool(Optional) Creates a modules dependency file for the Kernel you run.
networkbool(Optional) Controls the behavior of the Linode Config’s Network Helper setting, used to automatically configure additional IP addresses assigned to this instance.
updatedbDisabledbool(Optional) Disables updatedb cron job to avoid disk thrashing.

InstanceSpecDisk

Appears on:InstanceSpec

FieldTypeDescription
authorizedKeys[]string(Optional) A list of SSH public keys to deploy for the root user on the newly created Linode. Only accepted if ‘image’ is provided.
authorizedUsers[]string(Optional) A list of Linode usernames. If the usernames have associated SSH keys, the keys will be appended to the root user’s ~/.ssh/authorized_keys file automatically. Only accepted if ‘image’ is provided.
filesystemstring(Optional) The Disk filesystem can be one of: raw, swap, ext3, ext4, initrd (max 32mb)
IDint64(Optional) The ID of the Disk (for use in Linode Image resources and Linode Instance Config Devices)
imagestring(Optional) An Image ID to deploy the Disk from. Official Linode Images start with linode/, while your Images start with private/.
labelstringThe disks label, which acts as an identifier in Terraform.
readOnlybool(Optional) If true, this Disk is read-only.
sizeint64The size of the Disk in MB.
stackscriptIDint64(Optional) The StackScript to deploy to the newly created Linode. If provided, ‘image’ must also be provided, and must be an Image that is compatible with this StackScript.

InstanceSpecSpecs

Appears on:InstanceSpec

FieldTypeDescription
diskint64(Optional) The amount of storage space, in GB. this Linode has access to. A typical Linode will divide this space between a primary disk with an image deployed to it, and a swap disk, usually 512 MB. This is the default configuration created when deploying a Linode with an image without specifying disks.
memoryint64(Optional) The amount of RAM, in MB, this Linode has access to. Typically a Linode will choose to boot with all of its available RAM, but this can be configured in a Config profile.
transferint64(Optional) The amount of network transfer this Linode is allotted each month.
vcpusint64(Optional) The number of vcpus this Linode has access to. Typically a Linode will choose to boot with all of its available vcpus, but this can be configured in a Config Profile.

InstanceStatus

Appears on:Instance

FieldTypeDescription
observedGenerationint64(Optional) Resource generation, which is updated on mutation by the API Server.
outputInstanceSpec(Optional)
statekubeform.dev/kubeform/apis/base/v1alpha1.State(Optional)
phasePhase(Optional)

Phase(string alias)

Appears on:InstanceStatus


Sensitive Values

NameTypeDescription
disk.<index>.root_passstringThe password that will be initialially assigned to the ‘root’ user account.
disk.<index>.stackscript_datamap[string]stringAn object containing responses to any User Defined Fields present in the StackScript being deployed to this Linode. Only accepted if ‘stackscript_id’ is given. The required values depend on the StackScript being deployed.
root_passstringThe password that will be initialially assigned to the ‘root’ user account.
stackscript_datamap[string]stringAn object containing responses to any User Defined Fields present in the StackScript being deployed to this Linode. Only accepted if ‘stackscript_id’ is given. The required values depend on the StackScript being deployed.