Skip to main content
Version: latest

Returns the specified edge-native cloud config

GET 
/v1/cloudconfigs/edge-native/:configUid

Returns the specified edge-native 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

    metadata

    object

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

    annotations

    object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

    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

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    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 of the resource.

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    spec

    object

    EdgeNativeCloudConfigSpec defines the desired state of EdgeNativeCloudConfig

    clusterConfig

    object

    required

    EdgeNativeClusterConfig definnes Edge Native Cluster specific Spec

    controlPlaneEndpoint

    object

    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

    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

    hostAddressstringrequired

    HostAddress is a FQDN or IP address of the Host

    hostNamestring

    Qualified name of host

    hostUidstringrequired

    HostUid is the ID of the EdgeHost

    nic

    object

    dnsstring[]
    gatewaystring
    ipstring
    isDefaultboolean
    macAddrstring
    nicNamestring
    subnetstring
    nicNamestring

    Deprecated. Edge host nic name

    staticIPstring

    Deprecated. Edge host static IP

    twoNodeCandidatePrioritystring

    Possible values: [primary, secondary]

    Set the edgehost candidate priority as primary or secondary, if the edgehost is nominated as two node candidate

  • ]

    • 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: [amd64, arm64]

    Default value: 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

    UpdatesStrategy will be used to translate to RollingUpdateStrategy of a MachineDeployment We'll start with default values for the translation, can expose more details later Following is details of parameters translated from the type ScaleOut => maxSurge=1, maxUnavailable=0 ScaleIn => maxSurge=0, maxUnavailable=1

    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

  • ]

    • status

    object

    EdgeNativeCloudConfigStatus defines the observed state of EdgeNativeCloudConfig

    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

  • ]

    • nodeImagestring
    sourceImageIdstring

    SourceImageId can be from packref's annotations or from pack.json

Loading...