Skip to main content

Updates a cluster with the provided cluster configuration

PATCH 
/v1/edge-mgmt/cluster

Updates a cluster with the provided cluster configuration

Request​

Body

required

    metadata

    object

    MetaData defines the metadata for the resource.

    creationTimestampdate-time

    CreationTimestamp is the timestamp when the resource was created.

    idstring

    ID is the unique identifier of the resource.

    labels

    object

    property name*string
    lastModifiedTimestampdate-time

    LastModifiedTimestamp is the timestamp when the resource was last modified.

    namestring

    Name is the name of the resource.

    tags

    object

    Tags is the list of tags associated with the resource.

    property name*object

    spec

    object

    archiveUploadPathstring

    cloudConfig

    object

    EdgeNativeCloudConfig is the Schema for the edgenativecloudconfigs API

    metadata

    object

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

    annotations

    object

    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

    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
    namespacestring
    resourceVersionstring
    selfLinkstring
    uidstring

    spec

    object

    EdgeNativeCloudConfigSpec defines the desired state of EdgeNativeCloudConfig

    clusterConfig

    object

    required

    EdgeNativeClusterConfig defines Edge Native Cluster specific Spec

    controlPlaneEndpoint

    object

    ControlPlaneEndpoint is the 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

    Host is FQDN(DDNS) or IP

    typestring

    Type indicates DDNS or VIP

    ntpServersstring[]

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

    overlayNetworkConfiguration

    object

    OverlayNetworkConfiguration is the configuration for the overlay network

    cidrstring

    CIDR is the CIDR of the overlay network

    enableboolean

    Enable is a flag to enable overlay network

    sshKeysstring[]

    SSHKeys specifies a list of ssh authorized keys to access the vms as a 'spectro' user

    staticIpboolean

    StaticIP indicates if IP allocation type is static IP. DHCP is the default allocation type

    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

    hosts

    object[]

    required

  • Array [

    • IsCandidateCaptionboolean

    Default value: false

    Is Edge host nominated as candidate

    caCertstring

    CACert for TLS connections

    hostAddressstring

    HostAddress is a FQDN or IP address of the Host

    hostNamestring

    Qualified name of host

    hostUidstring

    HostUid is the ID of the EdgeHost

    isTwoNodeCandidateboolean

    Default value: false

    Enable this flag to support 2-Node HA mode. True indicates this edgehost which act as the recovery node. It is a immutable field can be set only during cluster provisioning.

    nic

    object

    Edge native nic

    dnsstring[]
    gatewaystring
    ipstring
    isDefaultboolean
    macAddrstring
    nicNamestring
    subnetstring
    nicNamestring

    Deprecated. Edge host nic name

    staticIPstring

    Deprecated. Edge host static IP

  • ]

    • isControlPlaneboolean

    whether this pool is for control plane

    labelsstring[]

    labels for this pool, example: master/worker, gpu, windows

    machinePoolProperties

    object

    Machine pool specific properties

    archTypestring

    Possible values: [arm64, amd64]

    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

    osTypestring

    the os type for the pool, must be supported by the provider

    sizeint32

    size of the pool, number of machines

    taints

    object[]

    master 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 master taint this will not be used for worker pools

  • ]

    • profileVariables

    object[]

  • Array [

    • namestring
    profileUidstring
    valuestring

  • ]

    • scheduleAtstring

Responses​

(empty)

Schema

    messagestring
Loading...