Packages:

infrastructure.cluster.x-k8s.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group

Resource Types:

    ControllerGeneratedStatus

    (Appears on:HivelocityMachineSpec)

    ControllerGeneratedStatus contains all status information which is important to persist.

    Field Description
    provisioningState
    ProvisioningState     		(Optional)

    Information tracked by the provisioner.
    lastUpdated
    Kubernetes meta/v1.Time     		(Optional)

    Time stamp of last update of status.

    HivelocityCluster

    HivelocityCluster is the Schema for the hivelocityclusters API.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityClusterSpec

    controlPlaneEndpoint
    Cluster API api/v1beta1.APIEndpoint     		(Optional)

    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
    controlPlaneRegion
    Region

    ControlPlaneRegion is a Hivelocity Region (LAX2, …).
    hivelocitySecretRef
    HivelocitySecretRef

    HivelocitySecret is a reference to a Kubernetes Secret.
    sshKey
    SSHKey     		(Optional)

    SSHKey is cluster wide. Valid value is a valid SSH key name.
    status
    HivelocityClusterStatus

    HivelocityClusterSpec

    (Appears on:HivelocityCluster, HivelocityClusterTemplateResource)

    HivelocityClusterSpec defines the desired state of HivelocityCluster.

    Field Description
    controlPlaneEndpoint
    Cluster API api/v1beta1.APIEndpoint     		(Optional)

    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
    controlPlaneRegion
    Region

    ControlPlaneRegion is a Hivelocity Region (LAX2, …).
    hivelocitySecretRef
    HivelocitySecretRef

    HivelocitySecret is a reference to a Kubernetes Secret.
    sshKey
    SSHKey     		(Optional)

    SSHKey is cluster wide. Valid value is a valid SSH key name.

    HivelocityClusterStatus

    (Appears on:HivelocityCluster)

    HivelocityClusterStatus defines the observed state of HivelocityCluster.

    Field Description
    ready
    bool
    failureDomains
    Cluster API api/v1beta1.FailureDomains
    conditions
    Cluster API api/v1beta1.Conditions

    HivelocityClusterTemplate

    HivelocityClusterTemplate is the Schema for the hivelocityclustertemplates API.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityClusterTemplateSpec

    template
    HivelocityClusterTemplateResource

    HivelocityClusterTemplateResource

    (Appears on:HivelocityClusterTemplateSpec)

    HivelocityClusterTemplateResource contains spec for HivelocityClusterSpec.

    Field Description
    metadata
    Cluster API api/v1beta1.ObjectMeta     		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityClusterSpec

    controlPlaneEndpoint
    Cluster API api/v1beta1.APIEndpoint     		(Optional)

    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
    controlPlaneRegion
    Region

    ControlPlaneRegion is a Hivelocity Region (LAX2, …).
    hivelocitySecretRef
    HivelocitySecretRef

    HivelocitySecret is a reference to a Kubernetes Secret.
    sshKey
    SSHKey     		(Optional)

    SSHKey is cluster wide. Valid value is a valid SSH key name.

    HivelocityClusterTemplateSpec

    (Appears on:HivelocityClusterTemplate)

    HivelocityClusterTemplateSpec defines the desired state of HivelocityClusterTemplate.

    Field Description
    template
    HivelocityClusterTemplateResource

    HivelocityDeviceType (string alias)

    (Appears on:HivelocityMachineSpec)

    HivelocityDeviceType defines the Hivelocity device type.

    HivelocityMachine

    HivelocityMachine is the Schema for the hivelocitymachines API.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityMachineSpec

    providerID
    string     		(Optional)

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

    Type is the Hivelocity Machine Type for this machine.
    imageName
    string

    ImageName is the reference to the Machine Image from which to create the device.
    status
    ControllerGeneratedStatus     		(Optional)

    Status contains all status information of the controller. Do not edit these values!
    status
    HivelocityMachineStatus

    HivelocityMachineSpec

    (Appears on:HivelocityMachine, HivelocityMachineTemplateResource)

    HivelocityMachineSpec defines the desired state of HivelocityMachine.

    Field Description
    providerID
    string     		(Optional)

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

    Type is the Hivelocity Machine Type for this machine.
    imageName
    string

    ImageName is the reference to the Machine Image from which to create the device.
    status
    ControllerGeneratedStatus     		(Optional)

    Status contains all status information of the controller. Do not edit these values!

    HivelocityMachineStatus

    (Appears on:HivelocityMachine)

    HivelocityMachineStatus defines the observed state of HivelocityMachine.

    Field Description
    ready
    bool     		(Optional)

    Ready is true when the provider resource is ready.
    addresses
    []Cluster API api/v1beta1.MachineAddress

    Addresses contains the machine’s associated addresses.
    region
    Region

    Region contains the name of the Hivelocity location the device is running.
    powerState
    string     		(Optional)

    PowerState is the state of the device for this machine.
    failureReason
    Cluster API errors.MachineStatusError     		(Optional)

    FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.
    failureMessage
    string     		(Optional)

    FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.
    conditions
    Cluster API api/v1beta1.Conditions     		(Optional)

    Conditions defines current service state of the HivelocityMachine.

    HivelocityMachineTemplate

    HivelocityMachineTemplate is the Schema for the hivelocitymachinetemplates API.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityMachineTemplateSpec

    template
    HivelocityMachineTemplateResource
    status
    HivelocityMachineTemplateStatus

    HivelocityMachineTemplateResource

    (Appears on:HivelocityMachineTemplateSpec)

    HivelocityMachineTemplateResource describes the data needed to create am HivelocityMachine from a template.

    Field Description
    metadata
    Cluster API api/v1beta1.ObjectMeta     		(Optional)

    Standard object’s metadata.

    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityMachineSpec

    Spec is the specification of the desired behavior of the machine.



    providerID
    string     		(Optional)

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

    Type is the Hivelocity Machine Type for this machine.
    imageName
    string

    ImageName is the reference to the Machine Image from which to create the device.
    status
    ControllerGeneratedStatus     		(Optional)

    Status contains all status information of the controller. Do not edit these values!

    HivelocityMachineTemplateSpec

    (Appears on:HivelocityMachineTemplate)

    HivelocityMachineTemplateSpec defines the desired state of HivelocityMachineTemplate.

    Field Description
    template
    HivelocityMachineTemplateResource

    HivelocityMachineTemplateStatus

    (Appears on:HivelocityMachineTemplate)

    HivelocityMachineTemplateStatus defines the observed state of HivelocityMachineTemplate.

    Field Description
    capacity
    Kubernetes core/v1.ResourceList     		(Optional)

    Capacity defines the resource capacity for this machine. This value is used for autoscaling from zero operations as defined in: https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20210310-opt-in-autoscaling-from-zero.md
    conditions
    Cluster API api/v1beta1.Conditions     		(Optional)

    Conditions defines current service state of the HivelocityMachineTemplate.

    HivelocityMachineTemplateWebhook

    HivelocityMachineTemplateWebhook implements a custom validation webhook for HivelocityMachineTemplate.

    HivelocityRemediation

    HivelocityRemediation is the Schema for the hivelocityremediations API.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityRemediationSpec     		(Optional)

    strategy
    RemediationStrategy

    Strategy field defines remediation strategy.
    status
    HivelocityRemediationStatus     		(Optional)

    HivelocityRemediationSpec

    (Appears on:HivelocityRemediation, HivelocityRemediationTemplateResource)

    HivelocityRemediationSpec defines the desired state of HivelocityRemediation.

    Field Description
    strategy
    RemediationStrategy

    Strategy field defines remediation strategy.

    HivelocityRemediationStatus

    (Appears on:HivelocityRemediation, HivelocityRemediationTemplateStatus)

    HivelocityRemediationStatus defines the observed state of HivelocityRemediation.

    Field Description
    phase
    string     		(Optional)

    Phase represents the current phase of machine remediation. E.g. Pending, Running, Done etc.
    retryCount
    int     		(Optional)

    RetryCount can be used as a counter during the remediation. Field can hold number of reboots etc.
    lastRemediated
    Kubernetes meta/v1.Time     		(Optional)

    LastRemediated identifies when the host was last remediated

    HivelocityRemediationTemplate

    HivelocityRemediationTemplate is the Schema for the hivelocityremediationtemplates API.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    HivelocityRemediationTemplateSpec     		(Optional)

    template
    HivelocityRemediationTemplateResource
    status
    HivelocityRemediationTemplateStatus     		(Optional)

    HivelocityRemediationTemplateResource

    (Appears on:HivelocityRemediationTemplateSpec)

    HivelocityRemediationTemplateResource describes the data needed to create a HivelocityRemediation from a template.

    Field Description
    spec
    HivelocityRemediationSpec

    Spec is the specification of the desired behavior of the HivelocityRemediation.



    strategy
    RemediationStrategy

    Strategy field defines remediation strategy.

    HivelocityRemediationTemplateSpec

    (Appears on:HivelocityRemediationTemplate)

    HivelocityRemediationTemplateSpec defines the desired state of HivelocityRemediationTemplate.

    Field Description
    template
    HivelocityRemediationTemplateResource

    HivelocityRemediationTemplateStatus

    (Appears on:HivelocityRemediationTemplate)

    HivelocityRemediationTemplateStatus defines the observed state of HivelocityRemediationTemplate.

    Field Description
    status
    HivelocityRemediationStatus

    HivelocityRemediationStatus defines the observed state of HivelocityRemediation

    HivelocitySecretRef

    (Appears on:HivelocityClusterSpec)

    HivelocitySecretRef defines the name of the Secret and the relevant key in the secret to access the Hivelocity API.

    Field Description
    name
    string     		(Optional)
    key
    string     		(Optional)

    ProvisioningState (string alias)

    (Appears on:ControllerGeneratedStatus)

    ProvisioningState defines the states the provisioner will report the host has having.

    Value Description

    "associate-device"

    StateAssociateDevice .

    "delete"

    StateDeleteDevice .

    "delete-deprovision"

    StateDeleteDeviceDeProvision .

    "delete-dissociate"

    StateDeleteDeviceDissociate .

    "provisioned"

    StateDeviceProvisioned .

    ""

    StateNone means the state is unknown.

    "provision-device"

    StateProvisionDevice .

    "verify-associate"

    StateVerifyAssociate .

    Region (string alias)

    (Appears on:HivelocityClusterSpec, HivelocityMachineStatus)

    Region is a Hivelocity Location

    RemediationStrategy

    (Appears on:HivelocityRemediationSpec)

    RemediationStrategy describes how to remediate machines.

    Field Description
    type
    RemediationType     		(Optional)

    Type of remediation.
    retryLimit
    int     		(Optional)

    Sets maximum number of remediation retries.
    timeout
    Kubernetes meta/v1.Duration

    Sets the timeout between remediation retries.

    RemediationType (string alias)

    (Appears on:RemediationStrategy)

    RemediationType defines the type of remediation.

    Value Description

    "Reboot"

    RemediationTypeReboot sets RemediationType to Reboot.

    ResourceLifecycle (string alias)

    ResourceLifecycle configures the lifecycle of a resource.

    Value Description

    "owned"

    ResourceLifecycleOwned is the value we use when tagging resources to indicate that the resource is considered owned and managed by the cluster, and in particular that the lifecycle is tied to the lifecycle of the cluster.

    "shared"

    ResourceLifecycleShared is the value we use when tagging resources to indicate that the resource is shared between multiple clusters, and should not be destroyed if the cluster is destroyed.

    SSHKey

    (Appears on:HivelocityClusterSpec)

    SSHKey defines the SSHKey for Hivelocity.

    Field Description
    name
    string

    Name of SSH key.