---
sidebar_label: Oracle Kubernetes Engine
---

# Oracle Kubernetes Engine

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

**Type**: `oke`

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|[**cluster**](#cluster)|`object`|Settings specific to the OKE cluster<br/>|yes|
|[**gateway**](#gateway)|`object`|Gateway-related settings for OKE<br/>|yes|

**Additional Properties:** not allowed  
**Example**

```json
{
    "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"
    }
}
```

<a name="cluster"></a>
## cluster: Cluster

Settings specific to the OKE cluster

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|**id**<br/>(Name)|`string`|The name of the OKE cluster (e.g., 'my-oke-cluster'). Cluster names must be unique within your Oracle Cloud compartment and region<br/>Minimal Length: `1`<br/>Maximal Length: `40`<br/>Pattern: `^[a-z]([-a-z0-9]*[a-z0-9])?$`<br/>|yes|
|**location**|`string`|The Oracle Cloud region where the OKE cluster is deployed (e.g., 'us-phoenix-1', 'us-ashburn-1')<br/>|yes|
|**namespace**<br/>(Applications Namespace)|`string`|The Kubernetes namespace within the OKE cluster where the application is deployed (e.g., 'my-namespace'). Namespace names must be valid DNS labels<br/>Maximal Length: `63`<br/>Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`<br/>|yes|

**Example**

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

<a name="gateway"></a>
## gateway: Gateway

Gateway-related settings for OKE

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|**namespace**|`string`|The namespace in which the gateway is deployed<br/>Maximal Length: `63`<br/>Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`<br/>|no|
|**public\_name**<br/>(Public Gateway Name)|`string`|The name of the public gateway (e.g., 'public-gateway')<br/>Maximal Length: `63`<br/>Pattern: `^[a-z]([-a-z0-9]*[a-z0-9])?$`<br/>|yes|
|**private\_name**<br/>(Private Gateway Name)|`string`|The name of the private gateway (e.g., 'private-gateway')<br/>Maximal Length: `63`<br/>Pattern: `^[a-z]([-a-z0-9]*[a-z0-9])?$`<br/>|no|

**Example**

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