Skip to main content

Oracle Kubernetes Engine

Defines the settings for Oracle Kubernetes Engine, including cluster and gateway specifics

Type: oke

Properties

NameTypeDescriptionRequired
clusterobjectSettings specific to the OKE cluster
yes
gatewayobjectGateway-related settings for OKE
yes

Additional Properties: not allowed
Example

{
"cluster": {
"id": "my-oke-cluster",
"location": "us-phoenix-1",
"namespace": "my-namespace"
},
"gateway": {
"namespace": "istio-ingress-system",
"public_name": "public-gateway",
"private_name": "private-gateway"
}
}

cluster: Cluster

Settings specific to the OKE cluster

Properties

NameTypeDescriptionRequired
id
(Name)
stringThe name of the OKE cluster (e.g., 'my-oke-cluster'). Cluster names must be unique within your Oracle Cloud compartment and region
Minimal Length: 1
Maximal Length: 40
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
yes
locationstringThe Oracle Cloud region where the OKE cluster is deployed (e.g., 'us-phoenix-1', 'us-ashburn-1')
yes
namespace
(Applications Namespace)
stringThe Kubernetes namespace within the OKE 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

Example

{
"id": "my-oke-cluster",
"location": "us-phoenix-1",
"namespace": "my-namespace"
}

gateway: Gateway

Gateway-related settings for OKE

Properties

NameTypeDescriptionRequired
namespacestringThe namespace in which the gateway is deployed
Maximal Length: 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
no
public_name
(Public Gateway Name)
stringThe name of the public gateway (e.g., 'public-gateway')
Maximal Length: 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
yes
private_name
(Private Gateway Name)
stringThe name of the private gateway (e.g., 'private-gateway')
Maximal Length: 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
no

Example

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