Returns the specified Custom cloud config

GET 
/v1/cloudconfigs/cloudTypes/:cloudType/:configUid

Returns the specified Custom cloud config

Request

Path Parameters

cloudType stringrequired

Cluster's cloud type

configUid stringrequired

Cluster's cloud config uid

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

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

CustomCloudConfigSpec 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 Custom cloud and applicable for all the machine pools

valuesstringrequired

YAML string for Cluster and CloudCluster

machinePoolConfig

object[]

Array [

additionalLabels

object

additionalLabels

property name*string

isControlPlanebooleanrequired

whether this pool is for control plane

namestring

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.

]

useControlPlaneAsWorkerboolean

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

valuesstring

YAML string for machine

]

Example (from schema)

{
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T18:20:57.283Z",
    "deletionTimestamp": "2024-07-02T18:20:57.283Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T18:20:57.283Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountRef": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    },
    "clusterConfig": {
      "values": "string"
    },
    "machinePoolConfig": [
      {
        "additionalLabels": {},
        "isControlPlane": true,
        "name": "string",
        "size": 0,
        "taints": [
          {
            "effect": "NoSchedule",
            "key": "string",
            "timeAdded": "2024-07-02T18:20:57.284Z",
            "value": "string"
          }
        ],
        "useControlPlaneAsWorker": true,
        "values": "string"
      }
    ]
  }
}

Loading...