Skip to main content
Version: latest

update the maas cloud config for the private gateway

PUT 

/v1/overlords/maas/:uid/cloudconfig

update the maas cloud config for the private gateway

Request

Path Parameters

    uid stringrequired

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    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

    clusterProfiles

    object[]

    Cluster profiles pack configuration for private gateway cluster

  • Array [

  • packValues

    object[]

    Cluster profile packs array

  • Array [

  • manifests

    undefined[]

    Pack manifests are additional content as part of the profile

  • Array [

  • contentstring

    Manifest content in yaml

    namestringrequired

    Manifest name

    uidstring

    Manifest uid

  • ]

  • namestringrequired

    Pack name

    tagstring

    Pack version tag

    typestring

    Possible values: [spectro, helm, manifest, oci]

    Default value: spectro

    valuesstring

    Pack values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values

  • ]

  • replaceWithProfilestring

    Cluster profile uid to be replaced with new profile

    uidstring

    Cluster profile uid

  • ]

  • clusterSettings

    object

    clusterSettings is the generic configuration related to a cluster like OS patch, Rbac, Namespace allocation

    clusterMetaAttributestring

    ClusterMetaAttribute can be used to set additional cluster metadata information.

    controlPlaneHealthCheckTimeoutstring

    hostClusterConfig

    clusterEndpoint

    host cluster configuration

    config

    ingressConfig

    Ingress configuration for exposing the virtual cluster's kube-apiserver

    hoststring
    portint64

    loadBalancerConfig

    Load balancer configuration for exposing the virtual cluster's kube-apiserver

    externalIPsstring[]
    externalTrafficPolicystring
    loadBalancerSourceRangesstring[]
    typestring

    Possible values: [Ingress, LoadBalancer]

    is enabled as host cluster

    clusterGroup

    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.

    uidstring

    UID of the referent.

    hostCluster

    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.

    uidstring

    UID of the referent.

    isHostClusterboolean

    Default value: false

    is enabled as host cluster

    lifecycleConfig

    pauseboolean

    Default value: false

    enable pause life cycle config

    location

    object

    Cluster location information

    countryCodestring

    country code for cluster location

    countryNamestring

    country name for cluster location

    geoLoc

    object

    Geolocation Latlong entity

    latitudefloat64

    Latitude of a resource

    longitudefloat64

    Longitude of a resource

    regionCodestring

    region code for cluster location

    regionNamestring

    region name for cluster location

    machineManagementConfig

    object

    osPatchConfig

    object

    Os patch config contains properties to patch node os with latest security packages. If OsPatchConfig is not provided then node os will not be patched with latest security updates.

    onDemandPatchAfterdate-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.

    patchOnBootboolean

    PatchOnBoot indicates need to do patch when node first boot up, only once

    rebootIfRequiredboolean

    Reboot once the OS patch is applied

    schedulestring

    The schedule at which security patches will be applied to OS. Schedule should be in Cron format, see https://en.wikipedia.org/wiki/Cron for more help.

    resources

    object

    namespaces

    object[]

  • Array [

  • metadata

    object

    ObjectMeta update entity with uid as input

    annotations

    object

    property name*string

    labels

    object

    property name*string
    namestring
    uidstring

    spec

    Cluster namespace spec

    isRegexboolean

    relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring

    resourceAllocation

    Cluster namespace resource allocation

    cpuCoresnumber
    memoryMiBnumber
  • ]

  • rbacs

    object[]

  • Array [

  • metadata

    object

    ObjectMeta update entity with uid as input

    annotations

    object

    property name*string

    labels

    object

    property name*string
    namestring
    uidstring

    spec

    object

    Cluster RBAC spec

    bindings

    object[]

  • Array [

  • namespacestring

    role

    object

    Cluster role ref

    kindstring

    Possible values: [Role, ClusterRole]

    namestring

    subjects

    object[]

  • Array [

  • namestring
    namespacestring
    typestring

    Possible values: [User, Group, ServiceAccount]

  • ]

  • typestring

    Possible values: [RoleBinding, ClusterRoleBinding]

  • ]

  • relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring
  • ]

  • updateWorkerPoolsInParallelboolean

    machineConfig

    object

    azsstring[]

    for master pool, this will be the failure domains for kcp

    instanceType

    object

    minCPUint32

    Minimum CPU cores

    minMemInMBint32

    Minimum memory in MiB

    resourcePoolstring
    sizeint32

    size of the pool, number of machines

Responses

The resource was updated successfully

Loading...