Returns the specified EKS cloud config
GET/v1/cloudconfigs/eks/:configUid
Returns the specified EKS 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 [
]
]
Array [
]
]
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
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.
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
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
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 of the resource.
UID is the unique identifier generated for the resource. This is not an input field for any request.
spec
object
EksCloudConfigSpec defines the cloud configuration input by user
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.
UID of the referent.
clusterConfig
object
EksClusterConfig defines EKS specific config
addons
object[]
Addons defines the EKS addons to enable with the EKS cluster. This may be required for brownfield clusters
ConflictResolution is used to declare what should happen if there are parameter conflicts.
Name is the name of the addon
ServiceAccountRoleArn is the ARN of an IAM role to bind to the addons service account
Version is the version of the addon to use
BastionDisabled is the option to disable bastion node
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"
encryptionConfig
object
EncryptionConfig specifies the encryption configuration for the EKS clsuter.
Is encryption configuration enabled for the cluster
Provider specifies the ARN or alias of the CMK (in AWS KMS)
Resources specifies the resources to be encrypted
endpointAccess
object
EndpointAccess specifies how control plane endpoints are accessible
Private points VPC-internal control plane access to the private endpoint
PrivateCIDRs specifies which blocks can access the private endpoint
Public controls whether control plane endpoints are publicly accessible
PublicCIDRs specifies which blocks can access the public endpoint
The AWS Region the cluster lives in.
SSHKeyName specifies which EC2 SSH key can be used to access machines.
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
fargateProfiles
object[]
additionalTags
object
AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.
name specifies the profile name.
selectors
object[]
Selectors specify fargate pod selectors.
labels
object
Labels specifies which pod labels this selector should match.
Namespace specifies which namespace this selector should match.
SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.
machinePoolConfig
object[]
additionalLabels
object
additionalLabels
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
awsLaunchTemplate
object
AWSLaunchTemplate specifies the launch template to use to create the managed node group
additionalSecurityGroups
object[]
AdditionalSecurityGroups is an array of references to security groups that should be applied to the instances
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
ami
object
AMI is the reference to the AMI from which to create the machine instance
Possible values: [AmazonLinux, AmazonLinuxGPU]
EKSOptimizedLookupType If specified, will look up an EKS Optimized image in SSM Parameter store
ID of resource
ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set
ImageLookupFormat is the AMI naming format to look up the image
ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set
rootVolume
object
Volume encapsulates the configuration options for the storage device.
Device name
EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN
EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN
IOPS is the number of IOPS requested for the disk. Not applicable to all types
Throughput to provision in MiB/s supported for the volume type. Not applicable to all types.
Type is the type of the volume (e.g. gp2, io1, etc...)
AZs is only used for dynamic placement
Possible values: [on-demand, spot]
Default value: on-demand
EC2 instance capacity type
flag to know if aws launch template is enabled
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: master/worker, gpu, windows
machinePoolProperties
object
Machine pool specific properties
Possible values: [amd64, arm64]
Default value: 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 defines the options available to a user when configuring Machines to run on Spot instances. Most users should provide an empty struct.
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[]
master 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
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
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2024-05-11T05:09:06.204Z",
"deletionTimestamp": "2024-05-11T05:09:06.204Z",
"labels": {},
"lastModifiedTimestamp": "2024-05-11T05:09:06.204Z",
"name": "string",
"uid": "string"
},
"spec": {
"cloudAccountRef": {
"kind": "string",
"name": "string",
"uid": "string"
},
"clusterConfig": {
"addons": [
{
"conflictResolution": "string",
"name": "string",
"serviceAccountRoleARN": "string",
"version": "string"
}
],
"bastionDisabled": true,
"controlPlaneLoadBalancer": "string",
"encryptionConfig": {
"isEnabled": true,
"provider": "string",
"resources": [
"string"
]
},
"endpointAccess": {
"private": true,
"privateCIDRs": [
"string"
],
"public": true,
"publicCIDRs": [
"string"
]
},
"region": "string",
"sshKeyName": "string",
"vpcId": "string"
},
"fargateProfiles": [
{
"additionalTags": {},
"name": "string",
"selectors": [
{
"labels": {},
"namespace": "string"
}
],
"subnetIds": [
"string"
]
}
],
"machinePoolConfig": [
{
"additionalLabels": {},
"additionalTags": {},
"awsLaunchTemplate": {
"additionalSecurityGroups": [
{
"arn": "string",
"filters": [
{
"name": "string",
"values": [
"string"
]
}
],
"id": "string"
}
],
"ami": {
"eksOptimizedLookupType": "AmazonLinux",
"id": "string"
},
"imageLookupBaseOS": "string",
"imageLookupFormat": "string",
"imageLookupOrg": "string",
"rootVolume": {
"deviceName": "string",
"encrypted": true,
"encryptionKey": "string",
"iops": 0,
"throughput": 0,
"type": "string"
}
},
"azs": [
"string"
],
"capacityType": "on-demand",
"enableAwsLaunchTemplate": true,
"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-05-11T05:09:06.205Z",
"value": "string"
}
],
"updateStrategy": {
"type": "RollingUpdateScaleOut"
},
"useControlPlaneAsWorker": true
}
]
}
}