v1alpha1

package
v1.123.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the tpu v1alpha1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/tpu +k8s:defaulter-gen=TypeMeta +groupName=tpu.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source
var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "tpu.cnrm.cloud.google.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme

	TPUNodeGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(TPUNode{}).Name(),
	}
)

Functions

This section is empty.

Types

type NodeNetworkEndpointsStatus

type NodeNetworkEndpointsStatus struct {
	/* The IP address of this network endpoint. */
	// +optional
	IpAddress *string `json:"ipAddress,omitempty"`

	/* The port of this network endpoint. */
	// +optional
	Port *int64 `json:"port,omitempty"`
}

func (*NodeNetworkEndpointsStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeNetworkEndpointsStatus.

func (*NodeNetworkEndpointsStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NodeSchedulingConfig

type NodeSchedulingConfig struct {
	/* Immutable. Defines whether the TPU instance is preemptible. */
	Preemptible bool `json:"preemptible"`
}

func (*NodeSchedulingConfig) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeSchedulingConfig.

func (*NodeSchedulingConfig) DeepCopyInto

func (in *NodeSchedulingConfig) DeepCopyInto(out *NodeSchedulingConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TPUNode

type TPUNode struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TPUNodeSpec   `json:"spec,omitempty"`
	Status TPUNodeStatus `json:"status,omitempty"`
}

TPUNode is the Schema for the tpu API +k8s:openapi-gen=true

func (*TPUNode) DeepCopy

func (in *TPUNode) DeepCopy() *TPUNode

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TPUNode.

func (*TPUNode) DeepCopyInto

func (in *TPUNode) DeepCopyInto(out *TPUNode)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TPUNode) DeepCopyObject

func (in *TPUNode) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TPUNodeList

type TPUNodeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []TPUNode `json:"items"`
}

TPUNodeList contains a list of TPUNode

func (*TPUNodeList) DeepCopy

func (in *TPUNodeList) DeepCopy() *TPUNodeList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TPUNodeList.

func (*TPUNodeList) DeepCopyInto

func (in *TPUNodeList) DeepCopyInto(out *TPUNodeList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TPUNodeList) DeepCopyObject

func (in *TPUNodeList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TPUNodeSpec

type TPUNodeSpec struct {
	/* Immutable. The type of hardware accelerators associated with this node. */
	AcceleratorType string `json:"acceleratorType"`

	/* Immutable. The CIDR block that the TPU node will use when selecting an IP
	address. This CIDR block must be a /29 block; the Compute Engine
	networks API forbids a smaller block, and using a larger block would
	be wasteful (a node can only consume one IP address).

	Errors will occur if the CIDR block has already been used for a
	currently existing TPU node, the CIDR block conflicts with any
	subnetworks in the user's provided network, or the provided network
	is peered with another network that is using that CIDR block. */
	// +optional
	CidrBlock *string `json:"cidrBlock,omitempty"`

	/* Immutable. The user-supplied description of the TPU. Maximum of 512 characters. */
	// +optional
	Description *string `json:"description,omitempty"`

	/* Immutable. The name of a network to peer the TPU node to. It must be a
	preexisting Compute Engine network inside of the project on which
	this API has been activated. If none is provided, "default" will be
	used. */
	// +optional
	Network *string `json:"network,omitempty"`

	/* The project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Immutable. Sets the scheduling options for this TPU instance. */
	// +optional
	SchedulingConfig *NodeSchedulingConfig `json:"schedulingConfig,omitempty"`

	/* The version of Tensorflow running in the Node. */
	TensorflowVersion string `json:"tensorflowVersion"`

	/* Immutable. Whether the VPC peering for the node is set up through Service Networking API.
	The VPC Peering should be set up before provisioning the node. If this field is set,
	cidr_block field should not be specified. If the network that you want to peer the
	TPU Node to is a Shared VPC network, the node must be created with this this field enabled. */
	// +optional
	UseServiceNetworking *bool `json:"useServiceNetworking,omitempty"`

	/* Immutable. The GCP location for the TPU. If it is not provided, the provider zone is used. */
	Zone string `json:"zone"`
}

func (*TPUNodeSpec) DeepCopy

func (in *TPUNodeSpec) DeepCopy() *TPUNodeSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TPUNodeSpec.

func (*TPUNodeSpec) DeepCopyInto

func (in *TPUNodeSpec) DeepCopyInto(out *TPUNodeSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TPUNodeStatus

type TPUNodeStatus struct {
	/* Conditions represent the latest available observations of the
	   TPUNode's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* The network endpoints where TPU workers can be accessed and sent work.
	It is recommended that Tensorflow clients of the node first reach out
	to the first (index 0) entry. */
	// +optional
	NetworkEndpoints []NodeNetworkEndpointsStatus `json:"networkEndpoints,omitempty"`

	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	/* The service account used to run the tensor flow services within the
	node. To share resources, including Google Cloud Storage data, with
	the Tensorflow job running in the Node, this account must have
	permissions to that data. */
	// +optional
	ServiceAccount *string `json:"serviceAccount,omitempty"`
}

func (*TPUNodeStatus) DeepCopy

func (in *TPUNodeStatus) DeepCopy() *TPUNodeStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TPUNodeStatus.

func (*TPUNodeStatus) DeepCopyInto

func (in *TPUNodeStatus) DeepCopyInto(out *TPUNodeStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL