Validates EKS cluster create operation
POST/v1/spectroclusters/eks/validate
Validates EKS cluster create operation
Request
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
]
Array [
]
Array [
Array [
Array [
]
]
]
Array [
Array [
]
]
Array [
Array [
Array [
]
]
Array [
]
Array [
]
]
Array [
Array [
Array [
]
]
Array [
]
]
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
Cloud account uid to be used for cluster provisioning
cloudConfig
object
required
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 cluster
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
Endpoints specifies access to this cluster's control plane endpoints
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
clusterConfig
object
General cluster configuration like health, patching settings, namespace resource allocation, rbac
ClusterMetaAttribute can be used to set additional cluster metadata information.
hostClusterConfig
clusterEndpoint
host cluster configuration
config
ingressConfig
Ingress configuration for exposing the virtual cluster's kube-apiserver
loadBalancerConfig
Load balancer configuration for exposing the virtual cluster's kube-apiserver
Possible values: [Ingress, LoadBalancer]
is enabled as host cluster
clusterGroup
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
hostCluster
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
Default value: false
is enabled as host cluster
lifecycleConfig
Default value: false
enable pause life cycle config
location
object
Cluster location information
country code for cluster location
country name for cluster location
geoLoc
object
Geolocation Latlong entity
Latitude of a resource
Longitude of a resource
region code for cluster location
region name for cluster location
machineManagementConfig
object
osPatchConfig
object
OS patch config contains properties to patch node os with latest security packages. If OsPatchConfig is not provided then node os will not be patched with latest security updates. Note: For edge based cluster (like edge-native type) the osPatchConfig is NOT applicable, the values will be ignored.
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.
PatchOnBoot indicates need to do patch when node first boot up, only once
Reboot once the OS patch is applied
The schedule at which security patches will be applied to OS. Schedule should be in Cron format, see https://en.wikipedia.org/wiki/Cron for more help.
resources
object
namespaces
object[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
Cluster namespace spec
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
resourceAllocation
Cluster namespace resource allocation
rbacs
object[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
object
Cluster RBAC spec
bindings
object[]
role
object
Cluster role ref
Possible values: [Role, ClusterRole]
subjects
object[]
Possible values: [User, Group, ServiceAccount]
Possible values: [RoleBinding, ClusterRoleBinding]
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
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
undefined[]
cloudConfig
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...)
Possible values: [on-demand, spot]
Default value: on-demand
EC2 instance capacity type
flag to know if aws launch template is enabled
instance type
Possible values: >= 1 and <= 2000
rootDeviceSize in GBs
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
subnets
undefined[]
poolConfig
object
Machine pool configuration for the cluster
additionalLabels
object
Additional labels to be part of the machine pool
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
Whether this pool is for control plane
Labels for this machine 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
Size of the pool, number of nodes/machines
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 machine pool 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
policies
object
Cluster policies
backupPolicy
Cluster backup config
schedule
Cluster feature schedule
scanPolicy
Cluster compliance scan schedule configuration
kubeBench
Cluster compliance scan schedule config for kube bench driver
schedule
Cluster feature schedule
kubeHunter
Cluster compliance scan schedule config for kube hunter driver
schedule
Cluster feature schedule
sonobuoy
Cluster compliance scan schedule config for sonobuoy driver
schedule
Cluster feature schedule
profiles
object[]
packValues
object[]
Cluster profile packs array
manifests
undefined[]
Pack manifests are additional content as part of the profile
Manifest content in yaml
Manifest name
Manifest uid
Pack name
Pack version tag
Possible values: [spectro, helm, manifest, oci]
Default value: spectro
Pack values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
Cluster profile uid to be replaced with new profile
Cluster profile uid
variables
object[]
Variable name
Actual value of the variable to be used within the cluster
Responses
- 200
Eks Cluster validation response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Array [
Array [
Array [
]
]
]
machinePools
object
Constraint validator response
results
object[]
errors
object[]
profiles
object[]
packs
object
Constraint validator response
results
object[]
errors
object[]
Cluster profile uid
{
"machinePools": {
"results": [
{
"displayName": "string",
"errors": [
{
"code": "string",
"message": "string"
}
],
"name": "string"
}
]
},
"profiles": [
{
"packs": {
"results": [
{
"displayName": "string",
"errors": [
{
"code": "string",
"message": "string"
}
],
"name": "string"
}
]
},
"uid": "string"
}
]
}