Skip to main content
Version: latest

Validates EKS cluster create operation

POST 

/v1/spectroclusters/eks/validate

Validates EKS cluster create operation

Request

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    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, other than that any input on annotations will be ignored

    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 or Tags (UI) 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

    cloudAccountUidstringrequired

    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

  • Array [

  • conflictResolutionstring

    ConflictResolution is used to declare what should happen if there are parameter conflicts.

    namestringrequired

    Name is the name of the addon

    serviceAccountRoleARNstring

    ServiceAccountRoleArn is the ARN of an IAM role to bind to the addons service account

    versionstringrequired

    Version is the version of the addon to use

  • ]

  • bastionDisabledboolean

    BastionDisabled is the option to disable bastion node

    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"

    encryptionConfig

    object

    EncryptionConfig specifies the encryption configuration for the cluster

    isEnabledboolean

    Is encryption configuration enabled for the cluster

    providerstring

    Provider specifies the ARN or alias of the CMK (in AWS KMS)

    resourcesstring[]

    Resources specifies the resources to be encrypted

    endpointAccess

    object

    Endpoints specifies access to this cluster's control plane endpoints

    privateboolean

    Private points VPC-internal control plane access to the private endpoint

    privateCIDRsstring[]

    PrivateCIDRs specifies which blocks can access the private endpoint

    publicboolean

    Public controls whether control plane endpoints are publicly accessible

    publicCIDRsstring[]

    PublicCIDRs specifies which blocks can access the public endpoint

    regionstringrequired

    The AWS Region the cluster lives in.

    sshKeyNamestring

    SSHKeyName specifies which EC2 SSH key can be used to access machines.

    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

    clusterConfig

    object

    General cluster configuration like health, patching settings, namespace resource allocation, rbac

    clusterMetaAttributestring

    ClusterMetaAttribute can be used to set additional cluster metadata information.

    controlPlaneHealthCheckTimeoutstring

    hostClusterConfig

    clusterEndpoint

    host cluster configuration

    config

    ingressConfig

    Ingress configuration for exposing the virtual cluster's kube-apiserver

    hoststring
    portint64

    loadBalancerConfig

    Load balancer configuration for exposing the virtual cluster's kube-apiserver

    externalIPsstring[]
    externalTrafficPolicystring
    loadBalancerSourceRangesstring[]
    typestring

    Possible values: [Ingress, LoadBalancer]

    is enabled as host cluster

    clusterGroup

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

    hostCluster

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

    isHostClusterboolean

    Default value: false

    is enabled as host cluster

    lifecycleConfig

    pauseboolean

    Default value: false

    enable pause life cycle config

    location

    object

    Cluster location information

    countryCodestring

    country code for cluster location

    countryNamestring

    country name for cluster location

    geoLoc

    object

    Geolocation Latlong entity

    latitudefloat64

    Latitude of a resource

    longitudefloat64

    Longitude of a resource

    regionCodestring

    region code for cluster location

    regionNamestring

    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.

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

    patchOnBootboolean

    PatchOnBoot indicates need to do patch when node first boot up, only once

    rebootIfRequiredboolean

    Reboot once the OS patch is applied

    schedulestring

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

  • Array [

  • metadata

    object

    ObjectMeta update entity with uid as input

    annotations

    object

    property name*string

    labels

    object

    property name*string
    namestring

    Name of the resource

    uidstring

    Populated by the system. Read-only.

    spec

    Cluster namespace spec

    isRegexboolean

    relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring

    resourceAllocation

    Cluster namespace resource allocation

    cpuCoresnumber
    memoryMiBnumber
  • ]

  • rbacs

    object[]

  • Array [

  • metadata

    object

    ObjectMeta update entity with uid as input

    annotations

    object

    property name*string

    labels

    object

    property name*string
    namestring

    Name of the resource

    uidstring

    Populated by the system. Read-only.

    spec

    object

    Cluster RBAC spec

    bindings

    object[]

  • Array [

  • namespacestring

    role

    object

    Cluster role ref

    kindstring

    Possible values: [Role, ClusterRole]

    namestring

    subjects

    object[]

  • Array [

  • namestring
    namespacestring
    typestring

    Possible values: [User, Group, ServiceAccount]

  • ]

  • typestring

    Possible values: [RoleBinding, ClusterRoleBinding]

  • ]

  • relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring
  • ]

  • updateWorkerPoolsInParallelboolean

    fargateProfiles

    object[]

  • Array [

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

    property name*string
    namestringrequired

    name specifies the profile name.

    selectors

    object[]

    Selectors specify fargate pod selectors.

  • Array [

  • labels

    object

    Labels specifies which pod labels this selector should match.

    property name*string
    namespacestringrequired

    Namespace specifies which namespace this selector should match.

  • ]

  • subnetIdsstring[]

    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.

  • ]

  • machinepoolconfig

    undefined[]

  • Array [

  • 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

  • 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

  • ]

  • ami

    object

    AMI is the reference to the AMI from which to create the machine instance

    eksOptimizedLookupTypestring

    Possible values: [AmazonLinux, AmazonLinuxGPU]

    EKSOptimizedLookupType If specified, will look up an EKS Optimized image in SSM Parameter store

    idstring

    ID of resource

    imageLookupBaseOSstring

    ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set

    imageLookupFormatstring

    ImageLookupFormat is the AMI naming format to look up the image

    imageLookupOrgstring

    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.

    deviceNamestring

    Device name

    encryptedboolean

    EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN

    encryptionKeystring

    EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN

    iopsint64

    IOPS is the number of IOPS requested for the disk. Not applicable to all types

    throughputint64

    Throughput to provision in MiB/s supported for the volume type. Not applicable to all types.

    typestring

    Type is the type of the volume (e.g. gp2, io1, etc...)

    azsstring[]
    capacityTypestring

    Possible values: [on-demand, spot]

    Default value: on-demand

    EC2 instance capacity type

    enableAwsLaunchTemplateboolean

    flag to know if aws launch template is enabled

    instanceTypestring

    instance type

    rootDeviceSizeint64

    Possible values: >= 1 and <= 2000

    rootDeviceSize in GBs

    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

    subnets

    undefined[]

  • Array [

  • azstring
    idstring
  • ]

  • poolConfig

    object

    Machine pool configuration for the cluster

    additionalLabels

    object

    Additional labels to be part of the machine pool

    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
    isControlPlaneboolean

    Whether this pool is for control plane

    labelsstring[]required

    Labels for this machine 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

    namestringrequired
    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

    sizeint32required

    Size of the pool, number of nodes/machines

    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 machine pool 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

  • ]

  • policies

    object

    Cluster policies

    backupPolicy

    Cluster backup config

    backupLocationNamestring
    backupLocationUidstring
    backupNamestring
    backupPrefixstring
    durationInHoursint64
    includeAllDisksboolean
    includeClusterResourcesboolean
    locationTypestring
    namespacesstring[]

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    scanPolicy

    Cluster compliance scan schedule configuration

    kubeBench

    Cluster compliance scan schedule config for kube bench driver

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    kubeHunter

    Cluster compliance scan schedule config for kube hunter driver

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    sonobuoy

    Cluster compliance scan schedule config for sonobuoy driver

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    profiles

    object[]

  • Array [

  • packValues

    object[]

    Cluster profile packs array

  • Array [

  • manifests

    undefined[]

    Pack manifests are additional content as part of the profile

  • Array [

  • contentstring

    Manifest content in yaml

    namestringrequired

    Manifest name

    uidstring

    Manifest uid

  • ]

  • namestringrequired

    Pack name

    tagstring

    Pack version tag

    typestring

    Possible values: [spectro, helm, manifest, oci]

    Default value: spectro

    valuesstring

    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

  • ]

  • replaceWithProfilestring

    Cluster profile uid to be replaced with new profile

    uidstring

    Cluster profile uid

  • ]

Responses

Eks Cluster validation response

Schema

    machinePools

    object

    Constraint validator response

    results

    object[]

  • Array [

  • displayNamestring

    errors

    object[]

  • Array [

  • codestring
    messagestring
  • ]

  • namestring
  • ]

  • profiles

    object[]

  • Array [

  • packs

    object

    Constraint validator response

    results

    object[]

  • Array [

  • displayNamestring

    errors

    object[]

  • Array [

  • codestring
    messagestring
  • ]

  • namestring
  • ]

  • uidstring

    Cluster profile uid

  • ]

Loading...