Skip to main content
Version: latest

Returns the specified AWS cloud config

GET 

/v1/cloudconfigs/aws/:configUid

Returns the specified AWS 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

    apiVersionstring

    Deprecated. Not used for the resource info. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

    kindstring

    Cloud type of the cloud config

    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

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

    uidstring

    UID of the referent.

    clusterConfig

    object

    Cluster level configuration for aws cloud and applicable for all the machine pools

    bastionDisabledboolean

    Create bastion node option we have earlier supported creation of bastion by default capa seems to favour session manager against bastion node https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/947

    controlPlaneLoadBalancerstring

    ControlPlaneLoadBalancer specifies how API server elb will be configured, this field is optional, not provided, "", default => "Internet-facing" "Internet-facing" => "Internet-facing" "internal" => "internal" For spectro saas setup we require to talk to the apiserver from our cluster so ControlPlaneLoadBalancer should be "", not provided or "Internet-facing"

    regionstringrequired
    sshKeyNamestring
    vpcIdstring

    VPC Id to deploy cluster into should have one public and one private subnet for the the cluster creation, this field is optional, If VPC Id is not provided a fully managed VPC will be created

    machinePoolConfig

    object[]

  • Array [

  • additionalLabels

    object

    additionalLabels

    property name*string

    additionalSecurityGroups

    object[]

    Additional Security groups

  • Array [

  • arnstring

    ARN of resource

    filters

    object[]

    Filters is a set of key/value pairs used to identify a resource

  • Array [

  • namestring

    Name of the filter. Filter names are case-sensitive

    valuesstring[]

    Values includes one or more filter values. Filter values are case-sensitive

  • ]

  • idstring

    ID of resource

  • ]

  • 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
    azsstring[]

    AZs is only used for dynamic placement

    capacityTypestring

    Possible values: [on-demand, spot]

    Default value: on-demand

    EC2 instance capacity type

    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

    instanceTypestring

    instance type

    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

    rootDeviceSizeint64

    rootDeviceSize in GBs

    sizeint32

    size of the pool, number of machines

    spotMarketOptions

    object

    SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

    maxPricestring

    MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

    subnetIds

    object

    AZ to subnet mapping filled by ally from hubble SubnetIDs ["us-west-2d"] = "subnet-079b6061" This field is optional If we don't provide a subnetId then by default the first private subnet from the AZ will be picked up for deployment

    property name*string

    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

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

    ansibleRoleDigeststring

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

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

  • images

    object[]

    Images array items should be 1-to-1 mapping to Spec.MachinePoolConfig

  • Array [

  • idstring
    osstring
    regionstring
    statestring
  • ]

  • isAddonLayerboolean

    addon layers present in spc

    roleDigest

    object

    this map will be for ansible roles present in eack pack

    property name*string
    sourceImageIdstring

    sourceImageId, it can be from packref's annotations or from pack.json

    useCapiImageboolean

    PackerVariableDigest string json:"packerDigest,omitempty" If no ansible roles found in Packs then Mold should tell Drive to use capi image and not create custom image, because there is nothing to add

Loading...