Skip to main content

Returns the specified vSphere cloud config

GET 
/v1/cloudconfigs/vsphere/:configUid

Returns the specified vSphere cloud config

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses​

OK

Schema

    apiVersionstring

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

    kindstring

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    property name*string
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    labels

    object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    property name*string
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

    spec

    object

    VsphereCloudConfigSpec defines the desired state of VsphereCloudConfig

    cloudAccountRef

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    uidstring

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    clusterConfig

    object

    required

    controlPlaneEndpoint

    object

    The optional control plane endpoint, which can be an IP or FQDN

    ddnsSearchDomainstring

    DDNSSearchDomain is the search domain used for resolving IP addresses when the EndpointType is DDNS. This search domain is appended to the generated Hostname to obtain the complete DNS name for the endpoint. If Host is already a DDNS FQDN, DDNSSearchDomain is not required

    hoststring

    IP or FQDN(External/DDNS)

    typestring

    Possible values: [VIP, External, DDNS]

    VIP or External

    ntpServersstring[]

    NTPServers is a list of NTP servers to use instead of the machine image's default NTP server list.

    placement

    object

    required

    Placement configuration Placement config in ClusterConfig serve as default values for each MachinePool

    clusterstring

    Cluster is the computecluster in vsphere

    datacenterstring

    Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.

    datastorestring

    Datastore is the datastore in which VMs are created/located.

    folderstring

    Folder is the folder in which VMs are created/located.

    imageTemplateFolderstring

    ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates

    network

    object

    network info

    ipPool

    object

    when staticIP=true, need to provide IPPool

    gatewaystring

    Gateway is the gateway ip address

    nameserver

    object

    Nameserver provide information for dns resolvation

    addressesstring[]
    searchstring[]

    pools

    object[]

    Pools contains the list of IP addresses pools

  • Array [

    • endstring

    End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.

    gatewaystring

    Gateway is the gateway ip address

    nameserver

    object

    Nameserver provide information for dns resolvation

    addressesstring[]
    searchstring[]
    prefixint32

    Prefix is the mask of the network as integer (max 128)

    startstring

    Start is the first ip address that can be rendered

    subnetstring

    Subnet is used to validate that the rendered IP is in bounds. eg: 192.168.0.0/24 If Start value is not given, start value is derived from the subnet ip incremented by 1 (start value is 192.168.0.1 for subnet 192.168.0.0/24)

  • ]

    • prefixint32

    Prefix is the mask of the network as integer (max 128)

    uidstring

    UID is the UID of this IPPool, used by Hubble

    networkNamestringrequired

    NetworkName is the name of the network in which VMs are created/located.

    parentPoolRef

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    uidstring

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    staticIpboolean

    support dhcp or static IP, if false, use DHCP

    resourcePoolstring

    ResourcePool is the resource pool within the above computecluster Cluster

    storagePolicyNamestring

    StoragePolicyName of the storage policy to use with this Virtual Machine

    uidstring

    UID for this placement

    sshKeysstring[]

    SSHKeys specifies a list of ssh authorized keys for the 'spectro' user

    staticIpboolean

    whether this cluster should use dhcp or static IP, if false, use DHCP if this is set, then all machinepools should have staticIP with provided IPPool adding this as an additional standalone flag without relating to placement.Nework main reason is to enable more validation for placement.Network.StaticIP which should come together with valid Network.IPPool and Network.Name

    edgeHostRef

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    uidstring

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    machinePoolConfig

    object[]

    required

  • Array [

    • additionalLabels

    object

    additionalLabels

    property name*string

    additionalTags

    object

    AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole

    property name*string

    instanceType

    object

    required

    InstanceType defines the required CPU, Memory, Storage

    diskGiBint32required

    DiskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned.

    memoryMiBint64required

    MemoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.

    numCPUsint32required

    NumCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.

    isControlPlanebooleanrequired

    whether this pool is for control plane

    labelsstring[]

    labels for this pool, example: control-plane/worker, gpu, windows

    machinePoolProperties

    object

    Machine pool specific properties

    archTypestring

    Possible values: [amd64, arm64]

    Default value: amd64

    Architecture type of the pool. Default value is 'amd64'

    maxSizeint32

    max size of the pool, for scaling

    minSizeint32

    min size of the pool, for scaling

    namestring
    nodeRepaveIntervalint32

    Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster

    placements

    object[]

    Placements configuration Placements If defined, will replace default values defined in VsphereClusterConfig Array means one MachinePool can span across multiple vsphere compute cluster

  • Array [

    • clusterstring

    Cluster is the computecluster in vsphere

    datacenterstring

    Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.

    datastorestring

    Datastore is the datastore in which VMs are created/located.

    folderstring

    Folder is the folder in which VMs are created/located.

    imageTemplateFolderstring

    ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates

    network

    object

    network info

    ipPool

    object

    when staticIP=true, need to provide IPPool

    gatewaystring

    Gateway is the gateway ip address

    nameserver

    object

    Nameserver provide information for dns resolvation

    addressesstring[]
    searchstring[]

    pools

    object[]

    Pools contains the list of IP addresses pools

  • Array [

    • endstring

    End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.

    gatewaystring

    Gateway is the gateway ip address

    nameserver

    object

    Nameserver provide information for dns resolvation

    addressesstring[]
    searchstring[]
    prefixint32

    Prefix is the mask of the network as integer (max 128)

    startstring

    Start is the first ip address that can be rendered

    subnetstring

    Subnet is used to validate that the rendered IP is in bounds. eg: 192.168.0.0/24 If Start value is not given, start value is derived from the subnet ip incremented by 1 (start value is 192.168.0.1 for subnet 192.168.0.0/24)

  • ]

    • prefixint32

    Prefix is the mask of the network as integer (max 128)

    uidstring

    UID is the UID of this IPPool, used by Hubble

    networkNamestringrequired

    NetworkName is the name of the network in which VMs are created/located.

    parentPoolRef

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    uidstring

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    staticIpboolean

    support dhcp or static IP, if false, use DHCP

    resourcePoolstring

    ResourcePool is the resource pool within the above computecluster Cluster

    storagePolicyNamestring

    StoragePolicyName of the storage policy to use with this Virtual Machine

    uidstring

    UID for this placement

  • ]

    • sizeint32

    size of the pool, number of machines

    taints

    object[]

    control plane or worker taints

  • Array [

    • effectstring

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    keystring

    The taint key to be applied to a node

    timeAddeddate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    valuestring

    The taint value corresponding to the taint key.

  • ]

    • updateStrategy

    object

    rolling update strategy for this machinepool if not specified, will use ScaleOut

    typestring

    Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]

    update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut

    useControlPlaneAsWorkerboolean

    if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove control plane taint this will not be used for worker pools

  • ]

    • status

    object

    VsphereCloudConfigStatus defines the observed state of VsphereCloudConfig

    ansibleDigeststring

    conditions

    object[]

  • Array [

    • lastProbeTimedate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    lastTransitionTimedate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    messagestring

    Human-readable message indicating details about last transition.

    reasonstring

    Unique, one-word, CamelCase reason for the condition's last transition.

    statusstringrequired
    typestringrequired

  • ]

    • isAddonLayerboolean

    addon layers present in spc

    lastOVACreatedstring
    lastVMExportedstring

    nodeImage

    object

    A generated Image should always be a template which resides inside vsphere Will not generate a OVA file out of the image OVA can be used as a base input of the os pack, that's internal to the pack

    fullPathstring

    full path of the image template location it contains datacenter/folder/templatename etc eg: /mydc/vm/template/spectro/workerpool-1-centos

    statestring

    roleDigest

    object

    this map will be for ansible roles present in eack pack

    property name*string
    sourceImageIdstring

    sourceImageId, it can be from packref's annotations or from pack.json

    uploadOvaS3string

    UploadOVAS3 will hold last image name which uploaded to S3

    useCapiImageboolean

    If no ansible roles found in Packs then Mold should tell Drive to use capi image and not create custom image, because there is nothing to add

Loading...