Oracle Digital Assistant: OdaInstance¶
Manage OCI Digital Assistant resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | oda |
| Resource | OdaInstance |
| API Version | oda.oracle.com/v1beta1 |
| Package | Oracle Digital Assistant |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-oda-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/oda_v1beta1_odainstance.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 |
Identifier of the compartment. | 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 |
description |
Description of the Digital Assistant instance. | string |
No |
displayName |
User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. | string |
No |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} |
map[string, string] |
No |
identityDomain |
If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. | string |
No |
isRoleBasedAccess |
Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) | boolean |
No |
shapeName |
Shape or size of the instance. | 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 |
|---|---|---|---|
attachmentIds |
A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. | list[string] |
No |
attachmentTypes |
A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments. | list[string] |
No |
compartmentId |
Identifier of the compartment that the instance belongs to. | string |
No |
connectorUrl |
URL for the connector's endpoint. | 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 |
description |
Description of the Digital Assistant instance. | string |
No |
displayName |
User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value. | string |
No |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} |
map[string, string] |
No |
id |
Unique immutable identifier that was assigned when the instance was created. | string |
No |
identityAppConsoleUrl |
If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain. | string |
No |
identityAppGuid |
If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain. | string |
No |
identityDomain |
If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. | string |
No |
importedPackageIds |
A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages. | list[string] |
No |
importedPackageNames |
A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages. | list[string] |
No |
isRoleBasedAccess |
Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) | boolean |
No |
lifecycleState |
The current state of the Digital Assistant instance. | string |
No |
lifecycleSubState |
The current sub-state of the Digital Assistant instance. | string |
No |
restrictedOperations |
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. | list[object] |
No |
shapeName |
Shape or size of the instance. | string |
No |
stateMessage |
A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state. |
string |
No |
status |
- | object |
Yes |
timeCreated |
When the Digital Assistant instance was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. | string |
No |
timeUpdated |
When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. | string |
No |
webAppUrl |
URL for the Digital Assistant web application that's associated with the instance. | string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/oda_v1beta1_odainstance.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.
#
apiVersion: oda.oracle.com/v1beta1
kind: OdaInstance
metadata:
name: odainstance-sample
spec: {}