Skip to main content

Returns the specified Maas cloud config

GET 
https://api.spectrocloud.com/v1/cloudconfigs/maas/:configUid

Returns the specified Maas 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

    MaasCloudConfigSpec defines the cloud configuration input by user This will translate to clusterspec/machinespec for cluster-api

    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

    Cluster level configuration for MAAS cloud and applicable for all the machine pools

    domainstringrequired

    Domain name of the cluster to be provisioned

    sshKeysstring[]

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

    machinePoolConfig

    object[]

  • 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
    azsstring[]

    instanceType

    object

    required

    InstanceType defines the required CPU, Memory

    minCPUint32

    Minimum CPU cores

    minMemInMBint32

    Minimum memory in MiB

    isControlPlaneboolean

    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

    resourcePoolstring
    sizeint32

    size of the pool, number of machines

    tagsstring[]

    Tags in maas environment

    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

    MaasCloudConfigStatus defines the observed state of MaasCloudConfig The cloudimage info built by Mold is stored here image should be mapped to a specific machinepool

    ansibleRoleDigeststring

    For mold controller to identify if is there any changes in Pack

    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

    nodeImage

    object

    Name of the image

    namestring

    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

    useCapiImageboolean

    PackerVariableDigest string json:"packerDigest,omitempty" 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

curl -L -X GET 'https://api.spectrocloud.com/v1/cloudconfigs/maas/:configUid' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'
Request Collapse all
Base URL
https://api.spectrocloud.com
Auth
Parameters
— pathrequired
— header