HCSMachine [infrastructure.cluster.x-k8s.io/v1beta1]

infrastructure.cluster.x-k8s.io group

HCSMachine is the Schema for the hcsmachines API.

v1beta1 version
spec object required

spec defines the desired state of HCSMachine

adminPassword string

AdminPassword is the admin password for the instance.

availabilityZone string

AvailabilityZone is the availability zone for the instance.

configPoolRef object

ConfigPoolRef is a reference to the HCSMachineConfigPool resource that provides shared configuration for this machine.

apiVersion string

API version of the referent.

fieldPath string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kind string
name string
namespace string
resourceVersion string
uid string
dataVolumes []object

Volume defines the disk volume configuration for HCS instances.

format string

Format is the format of the volume.

mountPath string

Path is the path to the volume.

size integer required

Size is the volume size in GB.

type string required

Type is the volume type (e.g., SSD, SAS, SATA).

flavorName string

FlavorName is the name of the HCS instance flavor/type.

imageName string

ImageName is the name of the image to use for the instance.

jobId string
keyPairName string

KeyPairName is the name of the SSH key pair for instance access.

providerID string

ProviderID is the unique identifier as specified by the cloud provider.

rootVolume object

RootVolume is the root disk volume configuration.

format string

Format is the format of the volume.

mountPath string

Path is the path to the volume.

size integer required

Size is the volume size in GB.

type string required

Type is the volume type (e.g., SSD, SAS, SATA).

serverId string

ServerId is the HCS ECS server instance ID.

serverName string
status object

status defines the observed state of HCSMachine

addresses []object

NodeAddress contains information for the node's address.

address string required

The node address.

type string required

Node address type, one of Hostname, ExternalIP or InternalIP.

conditions []object

Condition defines an observation of a Cluster API resource operational state.

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message string

message is a human readable message indicating details about the transition. This field may be empty.

reason string

reason is the reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may be empty.

severity string

severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

status string required

status of the condition, one of True, False, Unknown.

type string required

type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

failureMessage string

FailureMessage will be set in case of a terminal error.

failureReason string

FailureReason will be set in case of a terminal error.

instanceState string

InstanceState is the current state of the HCS instance (e.g., ACTIVE, BUILD, ERROR).

ready boolean

Ready indicates whether the machine infrastructure is ready.