Skip to main content

Amazon Elastic Kubernetes Service (EKS) configuration

Defines the configuration for Amazon Elastic Kubernetes Service (EKS) settings in the application, including cluster settings and Kubernetes specifics

Type: eks-configuration

Properties

NameTypeDescriptionRequired
cluster
(EKS cluster settings)
objectSettings specific to the EKS cluster.
yes
networkobjectNetwork-related configurations, including load balancer configurations
no
securityobjectSecurity-related configurations, including service accounts and other Kubernetes security elements
no
resource_managementobjectKubernetes resource allocation and limit settings for containerized applications
no

Additional Properties: not allowed
Example

{
"cluster": {
"id": "my-cluster",
"namespace": "my-namespace"
},
"network": {
"balancer_group_suffix": "my-suffix"
},
"security": {
"image_pull_secrets": [
"image-pull-secret-nullplatform"
],
"service_account_name": "my-service-account"
},
"resource_management": {}
}

cluster: EKS cluster settings

Settings specific to the EKS cluster.

Properties

NameTypeDescriptionRequired
id
(Cluster Name)
stringThe name of the Amazon EKS cluster (e.g., "my-cluster"). Cluster names must be unique within your AWS account and region
Maximal Length: 100
Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9-]{0,98}[a-zA-Z0-9])?$
yes
namespace
(Kubernetes Namespace)
stringThe Kubernetes namespace within the EKS cluster where the application is deployed (e.g., 'my-namespace'). Namespace names must be DNS labels
Maximal Length: 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
no
use_nullplatform_namespacebooleanWhen enabled, uses the nullplatform system namespace instead of a custom namespace
no

Example

{
"id": "my-cluster",
"namespace": "my-namespace"
}

network: Network

Network-related configurations, including load balancer configurations

Properties

NameTypeDescriptionRequired
balancer_group_suffix
(ALB Name Suffix)
stringWhen set, this suffix is added to the Application Load Balancer name, enabling management across multiple clusters in the same account or exceeding AWS ALB limit.
Maximal Length: 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Example

{
"balancer_group_suffix": "my-suffix"
}

security: Security

Security-related configurations, including service accounts and other Kubernetes security elements

Properties

NameTypeDescriptionRequired
image_pull_secrets
(List of secret names to use image pull secrets)
string[]Image pull secrets store Docker credentials in EKS clusters, enabling secure access to private container images for seamless Kubernetes application deployment.
service_account_namestringThe name of the Kubernetes service account used for deployments.

Example

{
"image_pull_secrets": [
"image-pull-secret-nullplatform"
],
"service_account_name": "my-service-account"
}

security.image_pull_secrets[]: List of secret names to use image pull secrets

Image pull secrets store Docker credentials in EKS clusters, enabling secure access to private container images for seamless Kubernetes application deployment.

Items

Item Type: string
Item Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Example

[
"image-pull-secret-nullplatform"
]

resource_management: Resource Management

Kubernetes resource allocation and limit settings for containerized applications

Properties

NameTypeDescriptionRequired
max_milicores
(Max Mili-Cores)
stringSets the maximum amount of CPU mili cores a pod can use. It caps the maxCoreMultiplier value when it is set
memory_cpu_ratiostringAmount of MiB of ram per CPU. Default value is 2048, it means 1 core for every 2 GiB of RAM
max_cores_multiplierstringSets the ratio between requested and limit CPU. Default value is 3, must be a number greater than or equal to 1
memory_request_to_limit_ratiostringSets the ratio between requested and limit memory. Default value is 1, must be a number greater than or equal to 1