Core Networking: NatGateway¶
Manage OCI core networking resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | core |
| Resource | NatGateway |
| API Version | core.oracle.com/v1beta1 |
| Package | Core Networking |
| Support Status | Preview |
| Latest Released Version | v2.0.0-alpha |
| Install Namespace | oci-service-operator-core-network-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/core_v1beta1_natgateway.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
blockTraffic |
Whether the NAT gateway blocks traffic through it. The default is false. Example: true |
boolean |
No |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the NAT gateway. | string |
Yes |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
publicIpId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway. | string |
No |
routeTableId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway. | string |
No |
vcnId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the gateway belongs to. | string |
Yes |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
blockTraffic |
Whether the NAT gateway blocks traffic through it. The default is false. Example: true |
boolean |
No |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the NAT gateway. | string |
No |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the NAT gateway. | string |
No |
lifecycleState |
The NAT gateway's current state. | string |
No |
natIp |
The IP address associated with the NAT gateway. | string |
No |
publicIpId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway. | string |
No |
publicIpIdCreateIntent |
Tracks whether spec.publicIpId was explicitly set or omitted when the current tracked NAT gateway first became managed by this controller. |
string |
No |
routeTableId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway. | string |
No |
status |
- | object |
Yes |
timeCreated |
The date and time the NAT gateway was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
vcnId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the NAT gateway belongs to. | string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/core_v1beta1_natgateway.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
#
# Replace the OCI identifiers below before running e2e.
# Update metadata.name and spec.displayName if you want to force a fresh create
# instead of reusing an existing NatGateway with the same display name in the same
# VCN.
#
apiVersion: core.oracle.com/v1beta1
kind: NatGateway
metadata:
name: natgateway-sample
spec:
compartmentId: ocid1.compartment.oc1..exampleuniqueID
vcnId: ocid1.vcn.oc1..exampleuniqueID
displayName: "natgateway-sample"