Skip to content

Key Management: EkmsPrivateEndpoint

Manage OCI Vault resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot

Field Value
Service keymanagement
Resource EkmsPrivateEndpoint
API Version keymanagement.oracle.com/v1beta1
Package Key Management
Support Status Preview
Latest Released Version v2.1.0-alpha
Install Namespace oci-service-operator-keymanagement-system

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
caBundle CABundle to validate TLS certificate of the external key manager system in PEM format string Yes
compartmentId Compartment identifier. string Yes
definedTags Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No
displayName Display name of the EKMS private endpoint resource being created. string Yes
externalKeyManagerIp External private IP to connect to from this EKMS private endpoint string Yes
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No
port The port of the external key manager system integer No
subnetId The OCID of subnet in which the EKMS private endpoint is to be created 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
caBundle CABundle to validate TLS certificate of the external key manager system in PEM format string No
compartmentId Compartment Identifier. string No
definedTags Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No
displayName EKMS Private Endpoint display name string No
externalKeyManagerIp Private IP of the external key manager system to connect to from the EKMS private endpoint string No
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No
id Unique identifier that is immutable 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 'Failed' state. string No
lifecycleState The current state of the EKMS private endpoint resource. string No
port The port of the external key manager system integer No
privateEndpointIp The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet string No
status - object Yes
subnetId Subnet Identifier string No
timeCreated The time the EKMS private endpoint was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string. string No
timeUpdated The time the EKMS private endpoint was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string. string No

Sample Manifest

This example is generated from the checked-in sample manifest at config/samples/keymanagement_v1beta1_ekmsprivateendpoint.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.
#

apiVersion: keymanagement.oracle.com/v1beta1
kind: EkmsPrivateEndpoint
metadata:
  name: ekmsprivateendpoint-sample
spec: {}