Skip to main content

Returns the specified CoxEdge cloud config

GET 
/v1/cloudconfigs/coxedge/:configUid

Returns the specified CoxEdge 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
    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 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.

    Populated by the system. Read-only.

    spec object

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

    coxEdgeLoadBalancerConfig objectrequired

    CoxEdge loadbalancer config

    popsstring[]

    CoxEdge PoPs - geographical location for the loadbalancer

    coxEdgeWorkerLoadBalancerConfig object

    CoxEdge loadbalancer config

    popsstring[]

    CoxEdge PoPs - geographical location for the loadbalancer

    environmentstring
    organizationIdstring
    sshAuthorizedKeysstring[]required

    CoxEdge ssh authorized keys

    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
    deployments undefined[]
  • Array [
    • cpuUtilizationint32
    enableAutoScalingboolean
    instancesPerPopint32
    maxInstancesPerPopint32
    minInstancesPerPopint32
    namestring
    popsstring[]
  • ]
    • instanceConfig
    categorystring
    cpuSetint64
    diskGiBint64
    memoryMiBint64

    MemoryMiB is the size of a virtual machine's memory, in MiB

    namestring
    numCPUsint32

    NumCPUs is the number of virtual processors in a virtual machine

    isControlPlanebooleanrequired

    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

    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

    persistentStorages object[]

    Array of coxedge load persistent storages

  • Array [
    • pathstring

    Coxedge load persistent storage path

    sizeint64

    Coxedge load persistent storage size

  • ]
    • securityGroupRules undefined[]
  • Array [
    • actionstring

    Possible values: [block, allow]

    descriptionstring
    portRangestring
    protocolstring

    Possible values: [TCP, UDP, TCP_UDP, ESP, AH, ICMP, GRE]

    sourcestring
    typestring
  • ]
    • sizeint32

    size of the pool, number of machines

    specstring
    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

  • ]
    • status object

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

    conditions object[]

    spectroAnsibleProvisioner: should be added only once, subsequent recocile will use the same provisioner SpectroAnsiblePacker bool json:"spectroAnsiblePacker,omitempty"

  • 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
  • ]
    • imageIDstring

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

Loading...