Returns the specified AWS cloud config
GET/v1/cloudconfigs/aws/:configUid
Returns the specified AWS cloud config
Request​
Path Parameters
Cluster's cloud config uid
Header Parameters
Scope the request to the specified project uid
Responses​
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
]
]
Array [
]
Array [
]
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
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 is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
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.
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
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
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.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
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.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
clusterConfig
object
Cluster level configuration for aws cloud and applicable for all the machine pools
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
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"
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[]
additionalLabels
object
additionalLabels
additionalSecurityGroups
object[]
Additional Security groups
ARN of resource
filters
object[]
Filters is a set of key/value pairs used to identify a resource
Name of the filter. Filter names are case-sensitive
Values includes one or more filter values. Filter values are case-sensitive
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
AZs is only used for dynamic placement
Possible values: [on-demand
, spot
]
Default value: on-demand
EC2 instance capacity type
instanceConfig
MemoryMiB is the size of a virtual machine's memory, in MiB
NumCPUs is the number of virtual processors in a virtual machine
instance type
whether this pool is for control plane
labels for this pool, example: control-plane/worker, gpu, windows
machinePoolProperties
object
Machine pool specific properties
Possible values: [amd64
, arm64
]
Default value: amd64
Architecture type of the pool. Default value is 'amd64'
max size of the pool, for scaling
min size of the pool, for scaling
Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster
rootDeviceSize in GBs
size of the pool, number of machines
spotMarketOptions
object
SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.
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
taints
object[]
control plane or worker taints
Possible values: [NoSchedule
, PreferNoSchedule
, NoExecute
]
The taint key to be applied to a node
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.
The taint value corresponding to the taint key.
updateStrategy
object
rolling update strategy for this machinepool if not specified, will use ScaleOut
Possible values: [RollingUpdateScaleOut
, RollingUpdateScaleIn
]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove control plane 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
For mold controller to identify if is there any changes in Pack
conditions
object[]
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.
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.
Human-readable message indicating details about last transition.
Unique, one-word, CamelCase reason for the condition's last transition.
images
object[]
Images array items should be 1-to-1 mapping to Spec.MachinePoolConfig
addon layers present in spc
roleDigest
object
this map will be for ansible roles present in eack pack
sourceImageId, it can be from packref's annotations or from pack.json
PackerVariableDigest string
json:"packerDigest,omitempty"
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-29T15:51:28.071Z",
"deletionTimestamp": "2024-07-29T15:51:28.071Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
"name": "string",
"uid": "string"
},
"spec": {
"cloudAccountRef": {
"kind": "string",
"name": "string",
"uid": "string"
},
"clusterConfig": {
"bastionDisabled": true,
"controlPlaneLoadBalancer": "string",
"region": "string",
"sshKeyName": "string",
"vpcId": "string"
},
"machinePoolConfig": [
{
"additionalLabels": {},
"additionalSecurityGroups": [
{
"arn": "string",
"filters": [
{
"name": "string",
"values": [
"string"
]
}
],
"id": "string"
}
],
"additionalTags": {},
"azs": [
"string"
],
"capacityType": "on-demand",
"instanceConfig": {
"category": "string",
"cpuSet": 0,
"diskGiB": 0,
"memoryMiB": 0,
"name": "string",
"numCPUs": 0
},
"instanceType": "string",
"isControlPlane": true,
"labels": [
"string"
],
"machinePoolProperties": {
"archType": "amd64"
},
"maxSize": 0,
"minSize": 0,
"name": "string",
"nodeRepaveInterval": 0,
"rootDeviceSize": 0,
"size": 0,
"spotMarketOptions": {
"maxPrice": "string"
},
"subnetIds": {},
"taints": [
{
"effect": "NoSchedule",
"key": "string",
"timeAdded": "2024-07-29T15:51:28.071Z",
"value": "string"
}
],
"updateStrategy": {
"type": "RollingUpdateScaleOut"
},
"useControlPlaneAsWorker": true
}
]
},
"status": {
"ansibleRoleDigest": "string",
"conditions": [
{
"lastProbeTime": "2024-07-29T15:51:28.071Z",
"lastTransitionTime": "2024-07-29T15:51:28.071Z",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"images": [
{
"id": "string",
"os": "string",
"region": "string",
"state": "string"
}
],
"isAddonLayer": true,
"roleDigest": {},
"sourceImageId": "string",
"useCapiImage": true
}
}