You are viewing an outdated version of provider-gcp-compute.Go to Latest
upbound/provider-gcp-compute@v1.8.2
Instance
compute.gcp.upbound.io
Instance
upbound/provider-gcp-compute@v1.8.2compute.gcp.upbound.io

Instance is the Schema for the Instances API. Manages a VM instance resource within GCE.

Type

CRD

Group

compute.gcp.upbound.io

Version

apiVersion: compute.gcp.upbound.io/v1beta1

kind: Instance

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

InstanceSpec defines the desired state of Instance

forProvider
requiredobject
requiredobject

No description provided.

array

Configure Nested Virtualisation and Simultaneous Hyper Threading on this VM. Structure is documented below

array

Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is documented below.

object

A 256-bit [customer-supplied encryption key] (https://cloud.google.com/compute/docs/disks/customer-supplied-encryption), encoded in RFC 4648 base64 to encrypt this disk. Only one of kms_key_self_link and disk_encryption_key_raw may be set.

key
requiredstring
name
requiredstring
namespace
requiredstring
mode
string
source
string
array

The boot disk for the instance. Structure is documented below.

autoDelete
boolean
object

A 256-bit [customer-supplied encryption key] (https://cloud.google.com/compute/docs/disks/customer-supplied-encryption), encoded in RFC 4648 base64 to encrypt this disk. Only one of kms_key_self_link and disk_encryption_key_raw may be set.

key
requiredstring
name
requiredstring
namespace
requiredstring
array

Parameters for a new disk that will be created alongside the new instance. Either initialize_params or source must be set. Structure is documented below.

image
string
imageRef
object
object

Reference to a Image in compute to populate image.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Image in compute to populate image.

policy
object
object

Policies for selection.

resolve
string
labels
object
size
number
type
string
mode
string
source
string
array

Enable Confidential Mode on this VM. Structure is documented below

array

List of the type and count of accelerator cards attached to the instance. Structure documented below. Note: GPU accelerators can only be used with on_host_maintenance option set to TERMINATE. Note: This field uses attr-as-block mode to avoid breaking users during the 0.12 upgrade. To explicitly send a list of zero objects you must use the following syntax: example=[] For more details about this behavior, see this section.

count
number
type
string
hostname
string
labels
object
metadata
object
array

Networks to attach to the instance. This can be specified multiple times. Structure is documented below.

array

Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Omit to ensure that the instance is not accessible from the Internet.g. via tunnel or because it is running on another cloud instance on that network). This block can be repeated multiple times. Structure documented below.

array

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. Structure documented below.

array

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. Structure documented below.

network
string
networkIp
string
object

Reference to a Network in compute to populate network.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in compute to populate network.

policy
object
object

Policies for selection.

resolve
string
nicType
string
stackType
string
object

Reference to a Subnetwork in compute to populate subnetwork.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Subnetwork in compute to populate subnetwork.

policy
object
object

Policies for selection.

resolve
string
array

os-features, and network_interface.0.nic-type must be GVNIC in order for this setting to take effect.

params
array
array

Additional instance parameters. .

project
string
array

Specifies the reservations that this instance can consume from. Structure is documented below.

array

Specifies the label selector for the reservation to use.. Structure is documented below.

key
string
values
array
array

Corresponds to the label values of a reservation resource.

type
string
array
  • A list of self_links of resource policies to attach to the instance. Modifying this list will cause the instance to recreate. Currently a max of 1 resource policy is supported.
array

The scheduling strategy to use. More details about this configuration option are detailed below.

array

io/docs/providers/google/guides/provider_versions.html) Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. Structure is documented below. The local_ssd_recovery_timeout block supports:

nanos
number
seconds
number
array

The duration of the instance. Instance will run and be terminated after then, the termination action could be defined in instance_termination_action. Structure is documented below.

nanos
number
seconds
number
array

Specifies node affinities or anti-affinities to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation here. Structure documented below.

key
string
operator
string
values
array
array

Corresponds to the label values of a reservation resource.

array

Specifies the action to be performed when the instance is terminated using max_run_duration and STOP instance_termination_action. Only support true discard_local_ssd at this point. Structure is documented below.

array

Scratch disks to attach to the instance. This can be specified multiple times for multiple scratch disks. Structure is documented below.

interface
string
size
number
array

Service account to attach to the instance. Structure is documented below. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

email
string
emailRef
object
object

Reference to a ServiceAccount in cloudplatform to populate email.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a ServiceAccount in cloudplatform to populate email.

policy
object
object

Policies for selection.

resolve
string
scopes
array
array

A list of service scopes. Both OAuth2 URLs and gcloud short names are supported. To allow full access to all Cloud APIs, use the cloud-platform scope. See a complete list of scopes here. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

array

Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

tags
array
array

A list of network tags to attach to the instance.

zone
requiredstring
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

Configure Nested Virtualisation and Simultaneous Hyper Threading on this VM. Structure is documented below

array

Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is documented below.

mode
string
source
string
array

The boot disk for the instance. Structure is documented below.

autoDelete
boolean
object

A 256-bit [customer-supplied encryption key] (https://cloud.google.com/compute/docs/disks/customer-supplied-encryption), encoded in RFC 4648 base64 to encrypt this disk. Only one of kms_key_self_link and disk_encryption_key_raw may be set.

key
requiredstring
name
requiredstring
namespace
requiredstring
array

Parameters for a new disk that will be created alongside the new instance. Either initialize_params or source must be set. Structure is documented below.

image
string
imageRef
object
object

Reference to a Image in compute to populate image.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Image in compute to populate image.

policy
object
object

Policies for selection.

resolve
string
labels
object
size
number
type
string
mode
string
source
string
array

Enable Confidential Mode on this VM. Structure is documented below

array

List of the type and count of accelerator cards attached to the instance. Structure documented below. Note: GPU accelerators can only be used with on_host_maintenance option set to TERMINATE. Note: This field uses attr-as-block mode to avoid breaking users during the 0.12 upgrade. To explicitly send a list of zero objects you must use the following syntax: example=[] For more details about this behavior, see this section.

count
number
type
string
hostname
string
labels
object
metadata
object
array

Networks to attach to the instance. This can be specified multiple times. Structure is documented below.

array

Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Omit to ensure that the instance is not accessible from the Internet.g. via tunnel or because it is running on another cloud instance on that network). This block can be repeated multiple times. Structure documented below.

array

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. Structure documented below.

array

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. Structure documented below.

network
string
networkIp
string
object

Reference to a Network in compute to populate network.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in compute to populate network.

policy
object
object

Policies for selection.

resolve
string
nicType
string
stackType
string
object

Reference to a Subnetwork in compute to populate subnetwork.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Subnetwork in compute to populate subnetwork.

policy
object
object

Policies for selection.

resolve
string
array

os-features, and network_interface.0.nic-type must be GVNIC in order for this setting to take effect.

params
array
array

Additional instance parameters. .

project
string
array

Specifies the reservations that this instance can consume from. Structure is documented below.

array

Specifies the label selector for the reservation to use.. Structure is documented below.

key
string
values
array
array

Corresponds to the label values of a reservation resource.

type
string
array
  • A list of self_links of resource policies to attach to the instance. Modifying this list will cause the instance to recreate. Currently a max of 1 resource policy is supported.
array

The scheduling strategy to use. More details about this configuration option are detailed below.

array

io/docs/providers/google/guides/provider_versions.html) Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. Structure is documented below. The local_ssd_recovery_timeout block supports:

nanos
number
seconds
number
array

The duration of the instance. Instance will run and be terminated after then, the termination action could be defined in instance_termination_action. Structure is documented below.

nanos
number
seconds
number
array

Specifies node affinities or anti-affinities to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation here. Structure documented below.

key
string
operator
string
values
array
array

Corresponds to the label values of a reservation resource.

array

Specifies the action to be performed when the instance is terminated using max_run_duration and STOP instance_termination_action. Only support true discard_local_ssd at this point. Structure is documented below.

array

Scratch disks to attach to the instance. This can be specified multiple times for multiple scratch disks. Structure is documented below.

interface
string
size
number
array

Service account to attach to the instance. Structure is documented below. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

email
string
emailRef
object
object

Reference to a ServiceAccount in cloudplatform to populate email.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a ServiceAccount in cloudplatform to populate email.

policy
object
object

Policies for selection.

resolve
string
scopes
array
array

A list of service scopes. Both OAuth2 URLs and gcloud short names are supported. To allow full access to all Cloud APIs, use the cloud-platform scope. See a complete list of scopes here. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

array

Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

tags
array
array

A list of network tags to attach to the instance.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

InstanceStatus defines the observed state of Instance.

object

No description provided.

array

Configure Nested Virtualisation and Simultaneous Hyper Threading on this VM. Structure is documented below

array

Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is documented below.

array

The boot disk for the instance. Structure is documented below.

autoDelete
boolean
array

Parameters for a new disk that will be created alongside the new instance. Either initialize_params or source must be set. Structure is documented below.

mode
string
source
string
array

Enable Confidential Mode on this VM. Structure is documented below

array

List of the type and count of accelerator cards attached to the instance. Structure documented below. Note: GPU accelerators can only be used with on_host_maintenance option set to TERMINATE. Note: This field uses attr-as-block mode to avoid breaking users during the 0.12 upgrade. To explicitly send a list of zero objects you must use the following syntax: example=[] For more details about this behavior, see this section.

count
number
type
string
hostname
string
id
string
labels
object
metadata
object
array

Networks to attach to the instance. This can be specified multiple times. Structure is documented below.

array

Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Omit to ensure that the instance is not accessible from the Internet.g. via tunnel or because it is running on another cloud instance on that network). This block can be repeated multiple times. Structure documented below.

array

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. Structure documented below.

array

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. Structure documented below.

name
string
network
string
networkIp
string
nicType
string
stackType
string
array

os-features, and network_interface.0.nic-type must be GVNIC in order for this setting to take effect.

params
array
array

Additional instance parameters. .

project
string
array

Specifies the reservations that this instance can consume from. Structure is documented below.

array

Specifies the label selector for the reservation to use.. Structure is documented below.

key
string
values
array
array

Corresponds to the label values of a reservation resource.

type
string
array
  • A list of self_links of resource policies to attach to the instance. Modifying this list will cause the instance to recreate. Currently a max of 1 resource policy is supported.
array

The scheduling strategy to use. More details about this configuration option are detailed below.

array

io/docs/providers/google/guides/provider_versions.html) Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. Structure is documented below. The local_ssd_recovery_timeout block supports:

nanos
number
seconds
number
array

The duration of the instance. Instance will run and be terminated after then, the termination action could be defined in instance_termination_action. Structure is documented below.

nanos
number
seconds
number
array

Specifies node affinities or anti-affinities to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation here. Structure documented below.

key
string
operator
string
values
array
array

Corresponds to the label values of a reservation resource.

array

Specifies the action to be performed when the instance is terminated using max_run_duration and STOP instance_termination_action. Only support true discard_local_ssd at this point. Structure is documented below.

array

Scratch disks to attach to the instance. This can be specified multiple times for multiple scratch disks. Structure is documented below.

interface
string
size
number
selfLink
string
array

Service account to attach to the instance. Structure is documented below. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

email
string
scopes
array
array

A list of service scopes. Both OAuth2 URLs and gcloud short names are supported. To allow full access to all Cloud APIs, use the cloud-platform scope. See a complete list of scopes here. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

array

Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here. Note: allow_stopping_for_update must be set to true or your instance must have a desired_status of TERMINATED in order to update this field.

tags
array
array

A list of network tags to attach to the instance.

zone
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions