API Gateway: ApiGatewayDeployment¶

Manage OCI API Gateway deployment routes and backend bindings. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot¶

Field	Value
Service	`apigateway`
Resource	`ApiGatewayDeployment`
API Version	`apigateway.oracle.com/v1beta1`
Package	API Gateway
Support Status	Preview
Latest Released Version	`v2.1.0-alpha`
Install Namespace	`oci-service-operator-apigateway-system`

Quick Links¶

Resource Guide Index
Setup Guide
Package Page
API Reference
Spec Reference
Status Reference
Rendered Sample (config/samples/apigateway_v1beta1_apigatewaydeployment.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
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created.	`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. Example: `My new resource`	`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
`gatewayId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.	`string`	Yes
`id`	The OCID of an existing API Gateway Deployment to bind to.	`string`	No
`locks`	Locks associated with this resource.	`list[object]`	No
`pathPrefix`	A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment (https://docs.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).	`string`	Yes
`routes`	Routes is the compatibility shorthand for specification.routes. Set either routes or specification.routes; the runtime rejects conflicting values.	`list[object]`	No
`specification`	ApiGatewayDeploymentSpecification defines nested fields for ApiGatewayDeployment.Specification.	`object`	No

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
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created.	`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. Example: `My new resource`	`string`	No
`endpoint`	The endpoint to access this deployment on the gateway.	`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
`gatewayId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.	`string`	No
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.	`string`	No
`lifecycleDetails`	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.	`string`	No
`lifecycleState`	The current state of the deployment.	`string`	No
`locks`	Locks associated with this resource.	`list[object]`	No
`pathPrefix`	A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment (https://docs.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).	`string`	No
`specification`	ApiGatewayDeploymentSpecification defines nested fields for ApiGatewayDeployment.Specification.	`object`	No
`status`	-	`object`	Yes
`systemTags`	System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No
`timeCreated`	The time this resource was created. An RFC3339 formatted datetime string.	`string`	No
`timeUpdated`	The time this resource was last updated. An RFC3339 formatted datetime string.	`string`	No

Sample Manifest¶

This example is generated from the checked-in sample manifest at config/samples/apigateway_v1beta1_apigatewaydeployment.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# 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 gateway and compartment OCIDs below before running e2e.
#
apiVersion: apigateway.oracle.com/v1beta1
kind: ApiGatewayDeployment
metadata:
  name: apigatewaydeployment-sample
spec:
  gatewayId: ocid1.apigateway.oc1..exampleuniqueID
  compartmentId: ocid1.compartment.oc1..exampleuniqueID
  displayName: apigatewaydeployment-sample
  pathPrefix: /sample
  routes:
    - path: /hello
      methods: [GET]
      backend:
        type: STOCK_RESPONSE_BACKEND
        status: 200
        body: hello