zz_runtime_types.go

/*
Copyright 2021 The Crossplane Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Code generated by upjet. DO NOT EDIT.

package v1beta1

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/runtime/schema"

	v1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
)

type AccessConfigObservation struct {

	// The proxy endpoint that is used to access the runtime.
	ProxyURI *string `json:"proxyUri,omitempty" tf:"proxy_uri,omitempty"`
}

type AccessConfigParameters struct {

	// The type of access mode this instance. For valid values, see
	// https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#RuntimeAccessType.
	// +kubebuilder:validation:Optional
	AccessType *string `json:"accessType,omitempty" tf:"access_type,omitempty"`

	// The owner of this runtime after creation. Format: alias@example.com.
	// Currently supports one owner only.
	// +kubebuilder:validation:Optional
	RuntimeOwner *string `json:"runtimeOwner,omitempty" tf:"runtime_owner,omitempty"`
}

type ContainerImagesObservation struct {
}

type ContainerImagesParameters struct {

	// The path to the container image repository.
	// For example: gcr.io/{project_id}/{imageName}
	// +kubebuilder:validation:Required
	Repository *string `json:"repository" tf:"repository,omitempty"`

	// The tag of the container image. If not specified, this defaults to the latest tag.
	// +kubebuilder:validation:Optional
	Tag *string `json:"tag,omitempty" tf:"tag,omitempty"`
}

type DataDiskObservation struct {

	// Optional. Specifies whether the disk will be auto-deleted
	// when the instance is deleted (but not when the disk is
	// detached from the instance).
	AutoDelete *bool `json:"autoDelete,omitempty" tf:"auto_delete,omitempty"`

	// Optional. Indicates that this is a boot disk. The virtual
	// machine will use the first partition of the disk for its
	// root filesystem.
	Boot *bool `json:"boot,omitempty" tf:"boot,omitempty"`

	// Optional. Specifies a unique device name of your choice
	// that is reflected into the /dev/disk/by-id/google-* tree
	// of a Linux operating system running within the instance.
	// This name can be used to reference the device for mounting,
	// resizing, and so on, from within the instance.
	// If not specified, the server chooses a default device name
	// to apply to this disk, in the form persistent-disk-x, where
	// x is a number assigned by Google Compute Engine. This field
	// is only applicable for persistent disks.
	DeviceName *string `json:"deviceName,omitempty" tf:"device_name,omitempty"`

	// Indicates a list of features to enable on the guest operating
	// system. Applicable only for bootable images. To see a list of
	// available features, read https://cloud.google.com/compute/docs/ images/create-delete-deprecate-private-images#guest-os-features
	// options.
	GuestOsFeatures []*string `json:"guestOsFeatures,omitempty" tf:"guest_os_features,omitempty"`

	// Output only. A zero-based index to this disk, where 0 is
	// reserved for the boot disk. If you have many disks attached
	// to an instance, each disk would have a unique index number.
	Index *float64 `json:"index,omitempty" tf:"index,omitempty"`

	// Type of the resource. Always compute#attachedDisk for attached
	// disks.
	Kind *string `json:"kind,omitempty" tf:"kind,omitempty"`

	// Output only. Any valid publicly visible licenses.
	Licenses []*string `json:"licenses,omitempty" tf:"licenses,omitempty"`
}

type DataDiskParameters struct {

	// Input only. Specifies the parameters for a new disk that will
	// be created alongside the new instance. Use initialization
	// parameters to create boot disks or local SSDs attached to the
	// new instance. This property is mutually exclusive with the
	// source property; you can only define one or the other, but not
	// both.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	InitializeParams []InitializeParamsParameters `json:"initializeParams,omitempty" tf:"initialize_params,omitempty"`

	// "Specifies the disk interface to use for attaching this disk,
	// which is either SCSI or NVME. The default is SCSI. Persistent
	// disks must always use SCSI and the request will fail if you attempt
	// to attach a persistent disk in any other format than SCSI. Local SSDs
	// can use either NVME or SCSI. For performance characteristics of SCSI
	// over NVMe, see Local SSD performance. Valid values: * NVME * SCSI".
	// +kubebuilder:validation:Optional
	Interface *string `json:"interface,omitempty" tf:"interface,omitempty"`

	// The mode in which to attach this disk, either READ_WRITE
	// or READ_ONLY. If not specified, the default is to attach
	// the disk in READ_WRITE mode.
	// +kubebuilder:validation:Optional
	Mode *string `json:"mode,omitempty" tf:"mode,omitempty"`

	// Specifies a valid partial or full URL to an existing
	// Persistent Disk resource.
	// +kubebuilder:validation:Optional
	Source *string `json:"source,omitempty" tf:"source,omitempty"`

	// Specifies the type of the disk, either SCRATCH or PERSISTENT.
	// If not specified, the default is PERSISTENT.
	// +kubebuilder:validation:Optional
	Type *string `json:"type,omitempty" tf:"type,omitempty"`
}

type EncryptionConfigObservation struct {
}

type EncryptionConfigParameters struct {

	// The Cloud KMS resource identifier of the customer-managed
	// encryption key used to protect a resource, such as a disks.
	// It has the following format:
	// projects/{PROJECT_ID}/locations/{REGION}/keyRings/ {KEY_RING_NAME}/cryptoKeys/{KEY_NAME}
	// +kubebuilder:validation:Optional
	KMSKey *string `json:"kmsKey,omitempty" tf:"kms_key,omitempty"`
}

type InitializeParamsObservation struct {
}

type InitializeParamsParameters struct {

	// Provide this property when creating the disk.
	// +kubebuilder:validation:Optional
	Description *string `json:"description,omitempty" tf:"description,omitempty"`

	// Specifies the disk name. If not specified, the default is
	// to use the name of the instance. If the disk with the
	// instance name exists already in the given zone/region, a
	// new name will be automatically generated.
	// +kubebuilder:validation:Optional
	DiskName *string `json:"diskName,omitempty" tf:"disk_name,omitempty"`

	// Specifies the size of the disk in base-2 GB. If not
	// specified, the disk will be the same size as the image
	// (usually 10GB). If specified, the size must be equal to
	// or larger than 10GB. Default 100 GB.
	// +kubebuilder:validation:Optional
	DiskSizeGb *float64 `json:"diskSizeGb,omitempty" tf:"disk_size_gb,omitempty"`

	// The type of the boot disk attached to this runtime,
	// defaults to standard persistent disk. For valid values,
	// see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#disktype
	// +kubebuilder:validation:Optional
	DiskType *string `json:"diskType,omitempty" tf:"disk_type,omitempty"`

	// The labels to associate with this runtime. Label keys must
	// contain 1 to 63 characters, and must conform to [RFC 1035]
	// (https://www.ietf.org/rfc/rfc1035.txt). Label values may be
	// empty, but, if present, must contain 1 to 63 characters, and must
	// conform to RFC 1035. No
	// more than 32 labels can be associated with a cluster.
	// +kubebuilder:validation:Optional
	Labels map[string]*string `json:"labels,omitempty" tf:"labels,omitempty"`
}

type KernelsObservation struct {
}

type KernelsParameters struct {

	// The path to the container image repository.
	// For example: gcr.io/{project_id}/{imageName}
	// +kubebuilder:validation:Required
	Repository *string `json:"repository" tf:"repository,omitempty"`

	// The tag of the container image. If not specified, this defaults to the latest tag.
	// +kubebuilder:validation:Optional
	Tag *string `json:"tag,omitempty" tf:"tag,omitempty"`
}

type MetricsObservation struct {

	// Contains runtime daemon metrics, such as OS and kernels and
	// sessions stats.
	SystemMetrics map[string]*string `json:"systemMetrics,omitempty" tf:"system_metrics,omitempty"`
}

type MetricsParameters struct {
}

type RuntimeObservation struct {

	// The config settings for accessing runtime.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	AccessConfig []AccessConfigObservation `json:"accessConfig,omitempty" tf:"access_config,omitempty"`

	// The health state of this runtime. For a list of possible output
	// values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
	HealthState *string `json:"healthState,omitempty" tf:"health_state,omitempty"`

	// an identifier for the resource with format projects/{{project}}/locations/{{location}}/runtimes/{{name}}
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// Contains Runtime daemon metrics such as Service status and JupyterLab
	// status
	// Structure is documented below.
	Metrics []MetricsObservation `json:"metrics,omitempty" tf:"metrics,omitempty"`

	// The config settings for software inside the runtime.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	SoftwareConfig []SoftwareConfigObservation `json:"softwareConfig,omitempty" tf:"software_config,omitempty"`

	// The state of this runtime.
	State *string `json:"state,omitempty" tf:"state,omitempty"`

	// Use a Compute Engine VM image to start the managed notebook instance.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	VirtualMachine []VirtualMachineObservation `json:"virtualMachine,omitempty" tf:"virtual_machine,omitempty"`
}

type RuntimeParameters struct {

	// The config settings for accessing runtime.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	AccessConfig []AccessConfigParameters `json:"accessConfig,omitempty" tf:"access_config,omitempty"`

	// A reference to the zone where the machine resides.
	// +kubebuilder:validation:Required
	Location *string `json:"location" tf:"location,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	// +kubebuilder:validation:Optional
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// The config settings for software inside the runtime.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	SoftwareConfig []SoftwareConfigParameters `json:"softwareConfig,omitempty" tf:"software_config,omitempty"`

	// Use a Compute Engine VM image to start the managed notebook instance.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	VirtualMachine []VirtualMachineParameters `json:"virtualMachine,omitempty" tf:"virtual_machine,omitempty"`
}

type SoftwareConfigObservation struct {

	// Bool indicating whether an newer image is available in an image family.
	Upgradeable *bool `json:"upgradeable,omitempty" tf:"upgradeable,omitempty"`
}

type SoftwareConfigParameters struct {

	// Specify a custom Cloud Storage path where the GPU driver is stored.
	// If not specified, we'll automatically choose from official GPU drivers.
	// +kubebuilder:validation:Optional
	CustomGpuDriverPath *string `json:"customGpuDriverPath,omitempty" tf:"custom_gpu_driver_path,omitempty"`

	// Verifies core internal services are running. Default: True.
	// +kubebuilder:validation:Optional
	EnableHealthMonitoring *bool `json:"enableHealthMonitoring,omitempty" tf:"enable_health_monitoring,omitempty"`

	// Runtime will automatically shutdown after idle_shutdown_time.
	// Default: True
	// +kubebuilder:validation:Optional
	IdleShutdown *bool `json:"idleShutdown,omitempty" tf:"idle_shutdown,omitempty"`

	// Time in minutes to wait before shuting down runtime.
	// Default: 180 minutes
	// +kubebuilder:validation:Optional
	IdleShutdownTimeout *float64 `json:"idleShutdownTimeout,omitempty" tf:"idle_shutdown_timeout,omitempty"`

	// Install Nvidia Driver automatically.
	// +kubebuilder:validation:Optional
	InstallGpuDriver *bool `json:"installGpuDriver,omitempty" tf:"install_gpu_driver,omitempty"`

	// Use a list of container images to use as Kernels in the notebook instance.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	Kernels []KernelsParameters `json:"kernels,omitempty" tf:"kernels,omitempty"`

	// Cron expression in UTC timezone for schedule instance auto upgrade.
	// Please follow the cron format.
	// +kubebuilder:validation:Optional
	NotebookUpgradeSchedule *string `json:"notebookUpgradeSchedule,omitempty" tf:"notebook_upgrade_schedule,omitempty"`

	// Path to a Bash script that automatically runs after a notebook instance
	// fully boots up. The path must be a URL or
	// Cloud Storage path (gs://path-to-file/file-name).
	// +kubebuilder:validation:Optional
	PostStartupScript *string `json:"postStartupScript,omitempty" tf:"post_startup_script,omitempty"`

	// Behavior for the post startup script.
	// Possible values are POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RUN_EVERY_START, and DOWNLOAD_AND_RUN_EVERY_START.
	// +kubebuilder:validation:Optional
	PostStartupScriptBehavior *string `json:"postStartupScriptBehavior,omitempty" tf:"post_startup_script_behavior,omitempty"`
}

type VirtualMachineConfigAcceleratorConfigObservation struct {
}

type VirtualMachineConfigAcceleratorConfigParameters struct {

	// Count of cores of this accelerator.
	// +kubebuilder:validation:Optional
	CoreCount *float64 `json:"coreCount,omitempty" tf:"core_count,omitempty"`

	// Specifies the type of the disk, either SCRATCH or PERSISTENT.
	// If not specified, the default is PERSISTENT.
	// +kubebuilder:validation:Optional
	Type *string `json:"type,omitempty" tf:"type,omitempty"`
}

type VirtualMachineConfigObservation struct {

	// Data disk option configuration settings.
	// Structure is documented below.
	// +kubebuilder:validation:Required
	DataDisk []DataDiskObservation `json:"dataDisk,omitempty" tf:"data_disk,omitempty"`

	// The Compute Engine guest attributes. (see [Project and instance
	// guest attributes](https://cloud.google.com/compute/docs/
	// storing-retrieving-metadata#guest_attributes)).
	GuestAttributes map[string]*string `json:"guestAttributes,omitempty" tf:"guest_attributes,omitempty"`

	// The zone where the virtual machine is located.
	Zone *string `json:"zone,omitempty" tf:"zone,omitempty"`
}

type VirtualMachineConfigParameters struct {

	// The Compute Engine accelerator configuration for this runtime.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	AcceleratorConfig []VirtualMachineConfigAcceleratorConfigParameters `json:"acceleratorConfig,omitempty" tf:"accelerator_config,omitempty"`

	// Use a list of container images to start the notebook instance.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	ContainerImages []ContainerImagesParameters `json:"containerImages,omitempty" tf:"container_images,omitempty"`

	// Data disk option configuration settings.
	// Structure is documented below.
	// +kubebuilder:validation:Required
	DataDisk []DataDiskParameters `json:"dataDisk" tf:"data_disk,omitempty"`

	// Encryption settings for virtual machine data disk.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	EncryptionConfig []EncryptionConfigParameters `json:"encryptionConfig,omitempty" tf:"encryption_config,omitempty"`

	// If true, runtime will only have internal IP addresses. By default,
	// runtimes are not restricted to internal IP addresses, and will
	// have ephemeral external IP addresses assigned to each vm. This
	// internal_ip_only restriction can only be enabled for subnetwork
	// enabled networks, and all dependencies must be configured to be
	// accessible without external IP addresses.
	// +kubebuilder:validation:Optional
	InternalIPOnly *bool `json:"internalIpOnly,omitempty" tf:"internal_ip_only,omitempty"`

	// The labels to associate with this runtime. Label keys must
	// contain 1 to 63 characters, and must conform to [RFC 1035]
	// (https://www.ietf.org/rfc/rfc1035.txt). Label values may be
	// empty, but, if present, must contain 1 to 63 characters, and must
	// conform to RFC 1035. No
	// more than 32 labels can be associated with a cluster.
	// +kubebuilder:validation:Optional
	Labels map[string]*string `json:"labels,omitempty" tf:"labels,omitempty"`

	// The Compute Engine machine type used for runtimes.
	// +kubebuilder:validation:Required
	MachineType *string `json:"machineType" tf:"machine_type,omitempty"`

	// The Compute Engine metadata entries to add to virtual machine.
	// (see [Project and instance metadata](https://cloud.google.com
	// /compute/docs/storing-retrieving-metadata#project_and_instance
	// _metadata)).
	// +kubebuilder:validation:Optional
	Metadata map[string]*string `json:"metadata,omitempty" tf:"metadata,omitempty"`

	// The Compute Engine network to be used for machine communications.
	// Cannot be specified with subnetwork. If neither network nor
	// subnet is specified, the "default" network of the project is
	// used, if it exists. A full URL or partial URI. Examples:
	// +kubebuilder:validation:Optional
	Network *string `json:"network,omitempty" tf:"network,omitempty"`

	// The type of vNIC to be used on this interface. This may be gVNIC
	// or VirtioNet.
	// Possible values are UNSPECIFIED_NIC_TYPE, VIRTIO_NET, and GVNIC.
	// +kubebuilder:validation:Optional
	NicType *string `json:"nicType,omitempty" tf:"nic_type,omitempty"`

	// Reserved IP Range name is used for VPC Peering. The
	// subnetwork allocation will use the range name if it's assigned.
	// +kubebuilder:validation:Optional
	ReservedIPRange *string `json:"reservedIpRange,omitempty" tf:"reserved_ip_range,omitempty"`

	// Shielded VM Instance configuration settings.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	ShieldedInstanceConfig []VirtualMachineConfigShieldedInstanceConfigParameters `json:"shieldedInstanceConfig,omitempty" tf:"shielded_instance_config,omitempty"`

	// The Compute Engine subnetwork to be used for machine
	// communications. Cannot be specified with network. A full URL or
	// partial URI are valid. Examples:
	// +kubebuilder:validation:Optional
	Subnet *string `json:"subnet,omitempty" tf:"subnet,omitempty"`

	// The Compute Engine tags to add to runtime (see [Tagging instances]
	// (https://cloud.google.com/compute/docs/
	// label-or-tag-resources#tags)).
	// +kubebuilder:validation:Optional
	Tags []*string `json:"tags,omitempty" tf:"tags,omitempty"`
}

type VirtualMachineConfigShieldedInstanceConfigObservation struct {
}

type VirtualMachineConfigShieldedInstanceConfigParameters struct {

	// Defines whether the instance has integrity monitoring enabled.
	// Enables monitoring and attestation of the boot integrity of
	// the instance. The attestation is performed against the
	// integrity policy baseline. This baseline is initially derived
	// from the implicitly trusted boot image when the instance is
	// created. Enabled by default.
	// +kubebuilder:validation:Optional
	EnableIntegrityMonitoring *bool `json:"enableIntegrityMonitoring,omitempty" tf:"enable_integrity_monitoring,omitempty"`

	// Defines whether the instance has Secure Boot enabled.Secure
	// Boot helps ensure that the system only runs authentic software
	// by verifying the digital signature of all boot components, and
	// halting the boot process if signature verification fails.
	// Disabled by default.
	// +kubebuilder:validation:Optional
	EnableSecureBoot *bool `json:"enableSecureBoot,omitempty" tf:"enable_secure_boot,omitempty"`

	// Defines whether the instance has the vTPM enabled. Enabled by
	// default.
	// +kubebuilder:validation:Optional
	EnableVtpm *bool `json:"enableVtpm,omitempty" tf:"enable_vtpm,omitempty"`
}

type VirtualMachineObservation struct {

	// The unique identifier of the Managed Compute Engine instance.
	InstanceID *string `json:"instanceId,omitempty" tf:"instance_id,omitempty"`

	// The user-friendly name of the Managed Compute Engine instance.
	InstanceName *string `json:"instanceName,omitempty" tf:"instance_name,omitempty"`

	// Virtual Machine configuration settings.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	VirtualMachineConfig []VirtualMachineConfigObservation `json:"virtualMachineConfig,omitempty" tf:"virtual_machine_config,omitempty"`
}

type VirtualMachineParameters struct {

	// Virtual Machine configuration settings.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	VirtualMachineConfig []VirtualMachineConfigParameters `json:"virtualMachineConfig,omitempty" tf:"virtual_machine_config,omitempty"`
}

// RuntimeSpec defines the desired state of Runtime
type RuntimeSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     RuntimeParameters `json:"forProvider"`
}

// RuntimeStatus defines the observed state of Runtime.
type RuntimeStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        RuntimeObservation `json:"atProvider,omitempty"`
}

// +kubebuilder:object:root=true

// Runtime is the Schema for the Runtimes API. A Cloud AI Platform Notebook runtime.
// +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
// +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"
// +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name"
// +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
// +kubebuilder:subresource:status
// +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,gcp}
type Runtime struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              RuntimeSpec   `json:"spec"`
	Status            RuntimeStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true

// RuntimeList contains a list of Runtimes
type RuntimeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Runtime `json:"items"`
}

// Repository type metadata.
var (
	Runtime_Kind             = "Runtime"
	Runtime_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Runtime_Kind}.String()
	Runtime_KindAPIVersion   = Runtime_Kind + "." + CRDGroupVersion.String()
	Runtime_GroupVersionKind = CRDGroupVersion.WithKind(Runtime_Kind)
)

func init() {
	SchemeBuilder.Register(&Runtime{}, &RuntimeList{})
}