Skip to content

servicecatalog.oracle.com/v1beta1

Back to API Reference

APIVersion: servicecatalog.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes servicecatalog.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
PrivateApplication Namespaced Sample -
ServiceCatalog Namespaced Sample -

PrivateApplication

Manage OCI Service Catalog private applications.

  • Plural: privateapplications
  • Scope: Namespaced
  • APIVersion: servicecatalog.oracle.com/v1beta1
  • Sample: Sample (config/samples/servicecatalog_v1beta1_privateapplication.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

PrivateApplicationSpec defines the desired state of PrivateApplication.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the private application. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName The name of the private application. 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 - -
logoFileBase64Encoded Base64-encoded logo to use as the private application icon. Template icon file requirements: PNG format, 50 KB maximum, 130 x 130 pixels. string No - -
longDescription A long description of the private application. string No - -
packageDetails PrivateApplicationPackageDetails defines nested fields for PrivateApplication.PackageDetails. object Yes - -
shortDescription A short description of the private application. string Yes - -

Spec.packageDetails

Back to PrivateApplication spec

PrivateApplicationPackageDetails defines nested fields for PrivateApplication.PackageDetails.

Field Description Type Required Default Enum
jsonData - string No - -
packageType - string No - -
version The package version. string Yes - -
zipFileBase64Encoded Base-64 payload of the Terraform zip package. string No - -

Status

PrivateApplicationStatus defines the observed state of PrivateApplication.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the private application resides. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName The name of the private application. 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 The unique identifier for the private application in Marketplace. string No - -
lifecycleState The lifecycle state of the private application. string No - -
logo PrivateApplicationLogo defines nested fields for PrivateApplication.Logo. object No - -
longDescription A long description of the private application. string No - -
packageType Type of packages within this private application. string No - -
shortDescription A short description of the private application. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the private application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2021-05-26T21:10:29.600Z string No - -
timeUpdated The date and time the private application was last modified, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2021-12-10T05:10:29.721Z string No - -

Back to PrivateApplication status

PrivateApplicationLogo defines nested fields for PrivateApplication.Logo.

Field Description Type Required Default Enum
contentUrl The content URL of the uploaded data. string No - -
displayName The name used to refer to the uploaded data. string No - -
mimeType The MIME type of the uploaded data. string No - -

Status.status

Back to PrivateApplication status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to PrivateApplication status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to PrivateApplication status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to PrivateApplication status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ServiceCatalog

Manage OCI Service Catalog resources.

  • Plural: servicecatalogs
  • Scope: Namespaced
  • APIVersion: servicecatalog.oracle.com/v1beta1
  • Sample: Sample (config/samples/servicecatalog_v1beta1_servicecatalog.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ServiceCatalogSpec defines the desired state of ServiceCatalog.

Field Description Type Required Default Enum
compartmentId The unique identifier for the compartment where the service catalog will be created. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName The display name of the service catalog. 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 - -
status The status of a service catalog. string No - -

Status

ServiceCatalogStatus defines the observed state of ServiceCatalog.

Field Description Type Required Default Enum
compartmentId The Compartment id where the service catalog exists string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName The name of the service catalog. 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 The unique identifier for the Service catalog. string No - -
lifecycleState The lifecycle state of the service catalog. string No - -
sdkStatus The status of a service catalog. This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the service catalog was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2021-05-26T21:10:29.600Z string No - -
timeUpdated The date and time the service catalog was last modified, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2021-12-10T05:10:29.721Z string No - -

Status.status

Back to ServiceCatalog status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ServiceCatalog status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ServiceCatalog status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ServiceCatalog status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -