Skip to main content

Azure Kubernetes Service

Defines the settings for Azure Kubernetes Service , including cluster settings and gateway specifics

Type: aks-configuration

Properties

NameTypeDescriptionRequired
clusterobjectSettings specific to the AKS cluster
yes
gatewayobjectGateway-related settings
yes
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-aks-cluster",
"namespace": "nullplatform",
"resource_group": "my-aks-resource-group",
"authentication_mode": "localAccounts"
},
"gateway": {
"namespace": "istio-ingress",
"public_name": "istio-ingress",
"private_name": "istio-ingress-private"
},
"security": {
"image_pull_secrets": [
"image-pull-secret-nullplatform"
],
"service_account_name": "my-service-account"
},
"resource_management": {}
}

cluster: Cluster

Settings specific to the AKS cluster

Properties

NameTypeDescriptionRequired
id
(Name)
stringThe name of the AKS cluster (e.g., 'my-aks-cluster'). Cluster names must be unique within your Azure subscription and resource group
Minimal Length: 1
Maximal Length: 63
Pattern: ^[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$
yes
namespace
(Applications Namespace)
stringThe Kubernetes namespace within the AKS cluster where the application is deployed (e.g., 'my-namespace'). Namespace names must be valid DNS labels
Maximal Length: 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
yes
resource_group
(Resource Group Name)
stringName of the resource group containing the AKS cluster
yes
authentication_mode
(Cluster authentication mode)
stringThe type of authentication used to connect the cluster
no

Example

{
"id": "my-aks-cluster",
"namespace": "nullplatform",
"resource_group": "my-aks-resource-group",
"authentication_mode": "localAccounts"
}

gateway: Gateway

Gateway-related settings

Properties

NameTypeDescriptionRequired
namespacestringThe namespace in which the gateway is deployed
Maximal Length: 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
yes
public_name
(Public Gateway Name)
stringThe name of the public Application Gateway in AKS (e.g., 'public-gateway')
Minimal Length: 1
Maximal Length: 80
Pattern: ^[a-zA-Z][a-zA-Z0-9-]{0,78}[a-zA-Z0-9]$
yes
private_name
(Private Gateway Name)
stringThe name of the private Application Gateway in AKS (e.g., 'private-gateway')
Minimal Length: 1
Maximal Length: 80
Pattern: ^[a-zA-Z][a-zA-Z0-9-]{0,78}[a-zA-Z0-9]$
no

Example

{
"namespace": "istio-ingress",
"public_name": "istio-ingress",
"private_name": "istio-ingress-private"
}

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 AKS 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 AKS 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