fleetappsmanagement.oracle.com/v1beta1¶
APIVersion: fleetappsmanagement.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 fleetappsmanagement.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| CatalogItem | Namespaced | Sample | - |
| CompliancePolicyRule | Namespaced | Sample | - |
| Fleet | Namespaced | Sample | - |
| FleetCredential | Namespaced | Sample | - |
| FleetProperty | Namespaced | Sample | - |
| FleetResource | Namespaced | Sample | - |
| MaintenanceWindow | Namespaced | Sample | - |
| Onboarding | Namespaced | Sample | - |
| Patch | Namespaced | Sample | - |
| PlatformConfiguration | Namespaced | Sample | - |
| Property | Namespaced | Sample | - |
| Provision | Namespaced | Sample | - |
| Runbook | Namespaced | Sample | - |
| RunbookVersion | Namespaced | Sample | - |
| SchedulerDefinition | Namespaced | Sample | - |
| TaskRecord | Namespaced | Sample | - |
CatalogItem¶
CatalogItem is the Schema for the catalogitems API.
Plural:catalogitemsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_catalogitem.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
CatalogItemSpec defines the desired state of CatalogItem.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogSourcePayload |
CatalogItemCatalogSourcePayload defines nested fields for CatalogItem.CatalogSourcePayload. | object |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. | string |
Yes | - | - |
configSourceType |
Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. | 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 | - | - |
description |
The description of the CatalogItem. | string |
Yes | - | - |
displayName |
The CatalogItem name. | 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 | - | - |
isItemLocked |
Indicates if the CatalogItem is immutable or not. | boolean |
No | - | - |
listingId |
The catalog listing Id. | string |
No | - | - |
listingVersion |
The catalog package version. | string |
No | - | - |
packageType |
Config package type Eg: TF_PACKAGE, NON_TF_PACKAGE, CONFIG_FILE. | string |
Yes | - | - |
shortDescription |
Short description about the catalog item. | string |
No | - | - |
timeReleased |
The date and time the CatalogItem was released, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
versionDescription |
Version description about the catalog item. | string |
No | - | - |
Spec.catalogSourcePayload¶
CatalogItemCatalogSourcePayload defines nested fields for CatalogItem.CatalogSourcePayload.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessUri |
access uri | string |
No | - | - |
branchName |
branch Name | string |
No | - | - |
bucketName |
bucket name | string |
No | - | - |
configSourceType |
- | string |
No | - | - |
configurationSourceProviderId |
configuration Source Provider OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) | string |
No | - | - |
description |
Template Description | string |
No | - | - |
jsonData |
- | string |
No | - | - |
listingId |
This listing Id parameter of Payload. | string |
No | - | - |
longDescription |
Template Long Description | string |
No | - | - |
namespaceName |
nameSpace | string |
No | - | - |
objectName |
object name | string |
No | - | - |
repositoryUrl |
repository Url | string |
No | - | - |
templateDisplayName |
Template Display Name | string |
No | - | - |
timeExpires |
The date and time expires, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
version |
This version parameter of Payload. | string |
No | - | - |
workingDirectory |
File path to the directory to use for running Terraform. If not specified, the root directory is used. | string |
No | - | - |
zipFileBase64Encoded |
The Base64 encoded template. This payload will trigger CreateTemplate API, where the parameter will be passed. | string |
No | - | - |
Status¶
CatalogItemStatus defines the observed state of CatalogItem.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogResultPayload |
CatalogItemCatalogResultPayload defines nested fields for CatalogItem.CatalogResultPayload. | object |
No | - | - |
catalogSourcePayload |
CatalogItemCatalogSourcePayload defines nested fields for CatalogItem.CatalogSourcePayload. | object |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. | string |
No | - | - |
configSourceType |
Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. | 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 | - | - |
description |
Description about the catalog item. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | 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 OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the catalog. | string |
No | - | - |
isItemLocked |
Indicates if the CatalogItem is immutable or not. | boolean |
No | - | - |
lifecycleDetails |
The details of lifecycle state CatalogItem. | string |
No | - | - |
lifecycleState |
The current state of the CatalogItem. | string |
No | - | - |
listingId |
The catalog listing Id. | string |
No | - | - |
listingVersion |
The catalog package version. | string |
No | - | - |
packageType |
Config package type Eg: TF_PACKAGE, NON_TF_PACKAGE, CONFIG_FILE. | string |
No | - | - |
shortDescription |
Short description about the catalog item. | string |
No | - | - |
shouldListPublicItems |
The indicator to append Public Items from the root compartment to any query, when set to TRUE. | boolean |
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 | - | - |
timeBackfillLastChecked |
The date and time the CatalogItem was last checked by backfill job, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeCreated |
The date and time the CatalogItem was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeLastChecked |
The date and time the CatalogItem was last checked, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeReleased |
The date and time the CatalogItem was released, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the CatalogItem was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
versionDescription |
Version description about the catalog item. | string |
No | - | - |
Status.catalogResultPayload¶
CatalogItemCatalogResultPayload defines nested fields for CatalogItem.CatalogResultPayload.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
branchName |
branch Name | string |
No | - | - |
configResultType |
- | string |
No | - | - |
configurationSourceProviderId |
configuration Source Provider OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) | string |
No | - | - |
jsonData |
- | string |
No | - | - |
packageUrl |
package url | string |
No | - | - |
repositoryUrl |
repository Url | string |
No | - | - |
templateId |
template id | string |
No | - | - |
timeExpires |
The date and time expires, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
workingDirectory |
working directory | string |
No | - | - |
Status.catalogSourcePayload¶
CatalogItemCatalogSourcePayload defines nested fields for CatalogItem.CatalogSourcePayload.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessUri |
access uri | string |
No | - | - |
branchName |
branch Name | string |
No | - | - |
bucketName |
bucket name | string |
No | - | - |
configSourceType |
- | string |
No | - | - |
configurationSourceProviderId |
configuration Source Provider OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) | string |
No | - | - |
description |
Template Description | string |
No | - | - |
jsonData |
- | string |
No | - | - |
listingId |
This listing Id parameter of Payload. | string |
No | - | - |
longDescription |
Template Long Description | string |
No | - | - |
namespaceName |
nameSpace | string |
No | - | - |
objectName |
object name | string |
No | - | - |
repositoryUrl |
repository Url | string |
No | - | - |
templateDisplayName |
Template Display Name | string |
No | - | - |
timeExpires |
The date and time expires, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
version |
This version parameter of Payload. | string |
No | - | - |
workingDirectory |
File path to the directory to use for running Terraform. If not specified, the root directory is used. | string |
No | - | - |
zipFileBase64Encoded |
The Base64 encoded template. This payload will trigger CreateTemplate API, where the parameter will be passed. | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
CompliancePolicyRule¶
CompliancePolicyRule is the Schema for the compliancepolicyrules API.
Plural:compliancepolicyrulesScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_compliancepolicyrule.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
CompliancePolicyRuleSpec defines the desired state of CompliancePolicyRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compliancePolicyId |
Unique OCID of the CompliancePolicy this CompliancePolicyRule belongs to. | 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 |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
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 | - | - |
gracePeriod |
Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn't report the product as noncompliant when patch is not applied. | string |
No | - | - |
patchSelection |
CompliancePolicyRulePatchSelection defines nested fields for CompliancePolicyRule.PatchSelection. | object |
Yes | - | - |
patchTypeId |
PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies. | list[string] |
Yes | - | - |
productVersion |
CompliancePolicyRuleProductVersion defines nested fields for CompliancePolicyRule.ProductVersion. | object |
Yes | - | - |
severity |
Severity to which this CompliancePolicyRule applies. | list[string] |
No | - | - |
Spec.patchSelection¶
Back to CompliancePolicyRule spec
CompliancePolicyRulePatchSelection defines nested fields for CompliancePolicyRule.PatchSelection.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
daysSinceRelease |
Days passed since patch release. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
patchLevel |
Patch Name. | string |
No | - | - |
patchName |
Patch Name. | string |
No | - | - |
selectionType |
- | string |
No | - | - |
Spec.productVersion¶
Back to CompliancePolicyRule spec
CompliancePolicyRuleProductVersion defines nested fields for CompliancePolicyRule.ProductVersion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isApplicableForAllHigherVersions |
Is rule applicable to all higher versions also | boolean |
No | - | - |
version |
Product version the rule is applicable. | string |
Yes | - | - |
Status¶
CompliancePolicyRuleStatus defines the observed state of CompliancePolicyRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID of the compartment the CompliancePolicyRule belongs to. | string |
No | - | - |
compliancePolicyId |
Unique OCID of the CompliancePolicy. | 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 |
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 |
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 | - | - |
gracePeriod |
Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn't report the product as noncompliant when patch is not applied. | string |
No | - | - |
id |
Unique OCID of the CompliancePolicyRule. | string |
No | - | - |
lifecycleDetails |
A message that describes the current state of the CompliancePolicyRule in more detail. For example, can be used to provide actionable information for a resource in the Failed state. | string |
No | - | - |
lifecycleState |
The current state of the CompliancePolicyRule. | string |
No | - | - |
patchSelection |
CompliancePolicyRulePatchSelection defines nested fields for CompliancePolicyRule.PatchSelection. | object |
No | - | - |
patchTypeId |
PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies. | list[string] |
No | - | - |
productVersion |
CompliancePolicyRuleProductVersion defines nested fields for CompliancePolicyRule.ProductVersion. | object |
No | - | - |
severity |
Severity to which this CompliancePolicyRule applies. | list[string] |
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 date and time the CompliancePolicyRule was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the CompliancePolicyRule was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.patchSelection¶
Back to CompliancePolicyRule status
CompliancePolicyRulePatchSelection defines nested fields for CompliancePolicyRule.PatchSelection.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
daysSinceRelease |
Days passed since patch release. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
patchLevel |
Patch Name. | string |
No | - | - |
patchName |
Patch Name. | string |
No | - | - |
selectionType |
- | string |
No | - | - |
Status.productVersion¶
Back to CompliancePolicyRule status
CompliancePolicyRuleProductVersion defines nested fields for CompliancePolicyRule.ProductVersion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isApplicableForAllHigherVersions |
Is rule applicable to all higher versions also | boolean |
No | - | - |
version |
Product version the rule is applicable. | string |
Yes | - | - |
Status.status¶
Back to CompliancePolicyRule 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 CompliancePolicyRule 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 CompliancePolicyRule 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 CompliancePolicyRule status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Fleet¶
Fleet is the Schema for the fleets API.
Plural:fleetsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_fleet.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
FleetSpec defines the desired state of Fleet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
compartment OCID | string |
Yes | - | - |
credentials |
Credentials associated with the Fleet. | list[object] |
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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | string |
No | - | - |
details |
FleetDetails defines nested fields for Fleet.Details. | object |
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 |
Yes | - | - |
environmentType |
Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types. | 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 | - | - |
isTargetAutoConfirm |
A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention. | boolean |
No | - | - |
notificationPreferences |
Notification Preferences associated with the Fleet. | list[object] |
No | - | - |
parentFleetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the fleet that would be the parent for this fleet. | string |
No | - | - |
products |
Products associated with the Fleet. Provide PlatformConfiguration Ids corresponding to all the Products that need to be managed. | list[string] |
No | - | - |
properties |
Properties associated with the Fleet. | list[object] |
No | - | - |
resourceSelection |
FleetResourceSelection defines nested fields for Fleet.ResourceSelection. | object |
Yes | - | - |
resources |
Resources associated with the Fleet if resourceSelectionType is MANUAL. | list[object] |
No | - | - |
Spec.credentials[]¶
FleetCredentialFields defines nested fields for Fleet.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | string |
Yes | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
Yes | - | - |
entitySpecifics |
FleetCredentialEntitySpecifics defines nested fields for Fleet.Credential.EntitySpecifics. | object |
Yes | - | - |
password |
FleetCredentialPassword defines nested fields for Fleet.Credential.Password. | object |
Yes | - | - |
user |
FleetCredentialUser defines nested fields for Fleet.Credential.User. | object |
Yes | - | - |
Spec.credentials[].entitySpecifics¶
FleetCredentialEntitySpecifics defines nested fields for Fleet.Credential.EntitySpecifics.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialLevel |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
resourceId |
OCID of the resource associated with the target for which the credential is created. | string |
No | - | - |
target |
Target name for which the credential is provided. | string |
No | - | - |
variables |
List of fleet credential variables. | list[object] |
No | - | - |
Spec.credentials[].entitySpecifics.variables[]¶
FleetCredentialEntitySpecificsVariable defines nested fields for Fleet.Credential.EntitySpecifics.Variable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the variable. | string |
No | - | - |
value |
The value corresponding to the variable name. | string |
No | - | - |
Spec.credentials[].password¶
FleetCredentialPassword defines nested fields for Fleet.Credential.Password.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
OCID for the Vault Key that will be used to encrypt/decrypt the value given. | string |
No | - | - |
keyVersion |
The Vault Key version. | string |
No | - | - |
secretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. | string |
No | - | - |
secretVersion |
The secret version. | string |
No | - | - |
value |
The value corresponding to the credential. | string |
No | - | - |
vaultId |
OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. | string |
No | - | - |
Spec.credentials[].user¶
FleetCredentialUser defines nested fields for Fleet.Credential.User.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
OCID for the Vault Key that will be used to encrypt/decrypt the value given. | string |
No | - | - |
keyVersion |
The Vault Key version. | string |
No | - | - |
secretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. | string |
No | - | - |
secretVersion |
The secret version. | string |
No | - | - |
value |
The value corresponding to the credential. | string |
No | - | - |
vaultId |
OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. | string |
No | - | - |
Spec.details¶
FleetDetails defines nested fields for Fleet.Details.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
fleetType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Spec.notificationPreferences[]¶
FleetNotificationPreference defines nested fields for Fleet.NotificationPreference.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment ID the topic belongs to. | string |
Yes | - | - |
preferences |
FleetNotificationPreferencePreferences defines nested fields for Fleet.NotificationPreference.Preferences. | object |
No | - | - |
topicId |
Topic Id where the notifications will be directed. A topic is a communication channel for sending messages on chosen events to subscriptions. | string |
Yes | - | - |
Spec.notificationPreferences[].preferences¶
FleetNotificationPreferencePreferences defines nested fields for Fleet.NotificationPreference.Preferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
onJobCanceled |
Enables or disables notification on job canceled. | boolean |
No | - | - |
onJobFailure |
Enables or disables notification on Job Failures. | boolean |
No | - | - |
onJobScheduleChange |
Enables or disables notification on job schedule change. | boolean |
No | - | - |
onJobStart |
Enables or disables notification on job start. | boolean |
No | - | - |
onJobSuccess |
Enables or disables notification on job success. | boolean |
No | - | - |
onResourceNonCompliance |
Enables or disables notification when fleet resource becomes non compliant. | boolean |
No | - | - |
onRunbookNewerVersion |
Enables or disables notification when a newer version of runbook associated with a fleet is available | boolean |
No | - | - |
onTaskFailure |
Enables or disables notification on task failure. | boolean |
No | - | - |
onTaskPause |
Enables or disables notification when a task is paused. | boolean |
No | - | - |
onTaskSuccess |
Enables or disables notification on task success. | boolean |
No | - | - |
onTopologyModification |
Enables or disables notification on Environment Fleet Topology Modification. | boolean |
No | - | - |
upcomingSchedule |
FleetNotificationPreferencePreferencesUpcomingSchedule defines nested fields for Fleet.NotificationPreference.Preferences.UpcomingSchedule. | object |
No | - | - |
Spec.notificationPreferences[].preferences.upcomingSchedule¶
FleetNotificationPreferencePreferencesUpcomingSchedule defines nested fields for Fleet.NotificationPreference.Preferences.UpcomingSchedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
notifyBefore |
Specify when the notification should be sent. | string |
No | - | - |
onUpcomingSchedule |
Enables notification on upcoming schedule. | boolean |
No | - | - |
Spec.properties[]¶
FleetPropertyFields defines nested fields for Fleet.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
compartment OCID | string |
Yes | - | - |
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 | - | - |
fleetPropertyType |
Type of the FleetProperty. | string |
Yes | - | - |
isRequired |
Property is required or not. | boolean |
No | - | - |
value |
Value of the Property. | string |
No | - | - |
Spec.resourceSelection¶
FleetResourceSelection defines nested fields for Fleet.ResourceSelection.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
resourceSelectionType |
- | string |
No | - | - |
ruleSelectionCriteria |
FleetResourceSelectionRuleSelectionCriteria defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria. | object |
No | - | - |
Spec.resourceSelection.ruleSelectionCriteria¶
FleetResourceSelectionRuleSelectionCriteria defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
matchCondition |
Match condition for the rule selection. Include resources that match all rules or any of the rules. | string |
Yes | - | - |
rules |
Rules. | list[object] |
Yes | - | - |
Spec.resourceSelection.ruleSelectionCriteria.rules[]¶
FleetResourceSelectionRuleSelectionCriteriaRule defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria.Rule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
basis |
Based on what the rule is created. It can be based on a resourceProperty or a tag. If based on a tag, basis will be 'definedTagEquals' If based on a resource property, basis will be 'inventoryProperties' | string |
No | - | - |
compartmentId |
Compartment Id for which the rule is created. | string |
Yes | - | - |
compartmentIdInSubtree |
If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. Default value for compartmentIdInSubtree is false |
boolean |
No | - | - |
conditions |
Rule Conditions | list[object] |
Yes | - | - |
matchCondition |
Match condition for the rule selection. Include resources that match all rules or any of the rules. Default value for matchCondition is ANY |
string |
No | - | - |
resourceCompartmentId |
The Compartment ID to dynamically search resources. Provide the compartment ID to which the rule is applicable. | string |
Yes | - | - |
Spec.resourceSelection.ruleSelectionCriteria.rules[].conditions[]¶
FleetResourceSelectionRuleSelectionCriteriaRuleCondition defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria.Rule.Condition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
attrGroup |
Attribute Group. Provide a Tag namespace if the rule is based on a tag. Provide resource type if the rule is based on a resource property. | string |
Yes | - | - |
attrKey |
Attribute Key.Provide Tag key if the rule is based on a tag. Provide resource property name if the rule is based on a resource property. | string |
Yes | - | - |
attrValue |
Attribute Value.Provide Tag value if the rule is based on a tag. Provide resource property value if the rule is based on a resource property. | string |
Yes | - | - |
Spec.resources[]¶
FleetResourceFields defines nested fields for Fleet.Resource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment Identifier[OCID]. | string |
Yes | - | - |
fleetResourceType |
Type of the FleetResource. | string |
No | - | - |
resourceId |
OCID of the resource. | string |
Yes | - | - |
tenancyId |
Tenancy Identifier[OCID]. | string |
Yes | - | - |
Status¶
FleetStatus defines the observed state of Fleet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | string |
No | - | - |
credentials |
Credentials associated with the Fleet. | list[object] |
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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | string |
No | - | - |
details |
FleetDetails defines nested fields for Fleet.Details. | object |
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 | - | - |
environmentType |
Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types. | 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 OCID of the resource. | string |
No | - | - |
isTargetAutoConfirm |
A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention. | boolean |
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 lifecycle state of the Fleet. | string |
No | - | - |
notificationPreferences |
Notification Preferences associated with the Fleet. | list[object] |
No | - | - |
parentFleetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the fleet that would be the parent for this fleet. | string |
No | - | - |
products |
Products associated with the Fleet. PlatformConfiguration Ids corresponding to the Products. | list[string] |
No | - | - |
properties |
Properties associated with the Fleet. | list[object] |
No | - | - |
resourceRegion |
Associated region | string |
No | - | - |
resourceSelection |
FleetResourceSelection defines nested fields for Fleet.ResourceSelection. | object |
No | - | - |
resources |
Resources associated with the Fleet if resourceSelectionType is MANUAL. | list[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 | - | - |
Status.credentials[]¶
FleetCredentialObservedState defines nested fields for Fleet.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | 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 | - | - |
entitySpecifics |
FleetCredentialEntitySpecifics defines nested fields for Fleet.Credential.EntitySpecifics. | object |
No | - | - |
user |
FleetCredentialUser defines nested fields for Fleet.Credential.User. | object |
No | - | - |
Status.credentials[].entitySpecifics¶
FleetCredentialEntitySpecifics defines nested fields for Fleet.Credential.EntitySpecifics.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialLevel |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
resourceId |
OCID of the resource associated with the target for which the credential is created. | string |
No | - | - |
target |
Target name for which the credential is provided. | string |
No | - | - |
variables |
List of fleet credential variables. | list[object] |
No | - | - |
Status.credentials[].entitySpecifics.variables[]¶
FleetCredentialEntitySpecificsVariable defines nested fields for Fleet.Credential.EntitySpecifics.Variable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the variable. | string |
No | - | - |
value |
The value corresponding to the variable name. | string |
No | - | - |
Status.credentials[].user¶
FleetCredentialUser defines nested fields for Fleet.Credential.User.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
OCID for the Vault Key that will be used to encrypt/decrypt the value given. | string |
No | - | - |
keyVersion |
The Vault Key version. | string |
No | - | - |
secretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. | string |
No | - | - |
secretVersion |
The secret version. | string |
No | - | - |
value |
The value corresponding to the credential. | string |
No | - | - |
vaultId |
OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. | string |
No | - | - |
Status.details¶
FleetDetails defines nested fields for Fleet.Details.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
fleetType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Status.notificationPreferences[]¶
FleetNotificationPreference defines nested fields for Fleet.NotificationPreference.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment ID the topic belongs to. | string |
Yes | - | - |
preferences |
FleetNotificationPreferencePreferences defines nested fields for Fleet.NotificationPreference.Preferences. | object |
No | - | - |
topicId |
Topic Id where the notifications will be directed. A topic is a communication channel for sending messages on chosen events to subscriptions. | string |
Yes | - | - |
Status.notificationPreferences[].preferences¶
FleetNotificationPreferencePreferences defines nested fields for Fleet.NotificationPreference.Preferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
onJobCanceled |
Enables or disables notification on job canceled. | boolean |
No | - | - |
onJobFailure |
Enables or disables notification on Job Failures. | boolean |
No | - | - |
onJobScheduleChange |
Enables or disables notification on job schedule change. | boolean |
No | - | - |
onJobStart |
Enables or disables notification on job start. | boolean |
No | - | - |
onJobSuccess |
Enables or disables notification on job success. | boolean |
No | - | - |
onResourceNonCompliance |
Enables or disables notification when fleet resource becomes non compliant. | boolean |
No | - | - |
onRunbookNewerVersion |
Enables or disables notification when a newer version of runbook associated with a fleet is available | boolean |
No | - | - |
onTaskFailure |
Enables or disables notification on task failure. | boolean |
No | - | - |
onTaskPause |
Enables or disables notification when a task is paused. | boolean |
No | - | - |
onTaskSuccess |
Enables or disables notification on task success. | boolean |
No | - | - |
onTopologyModification |
Enables or disables notification on Environment Fleet Topology Modification. | boolean |
No | - | - |
upcomingSchedule |
FleetNotificationPreferencePreferencesUpcomingSchedule defines nested fields for Fleet.NotificationPreference.Preferences.UpcomingSchedule. | object |
No | - | - |
Status.notificationPreferences[].preferences.upcomingSchedule¶
FleetNotificationPreferencePreferencesUpcomingSchedule defines nested fields for Fleet.NotificationPreference.Preferences.UpcomingSchedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
notifyBefore |
Specify when the notification should be sent. | string |
No | - | - |
onUpcomingSchedule |
Enables notification on upcoming schedule. | boolean |
No | - | - |
Status.properties[]¶
FleetPropertyFields defines nested fields for Fleet.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
compartment OCID | string |
Yes | - | - |
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 | - | - |
fleetPropertyType |
Type of the FleetProperty. | string |
Yes | - | - |
isRequired |
Property is required or not. | boolean |
No | - | - |
value |
Value of the Property. | string |
No | - | - |
Status.resourceSelection¶
FleetResourceSelection defines nested fields for Fleet.ResourceSelection.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
resourceSelectionType |
- | string |
No | - | - |
ruleSelectionCriteria |
FleetResourceSelectionRuleSelectionCriteria defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria. | object |
No | - | - |
Status.resourceSelection.ruleSelectionCriteria¶
FleetResourceSelectionRuleSelectionCriteria defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
matchCondition |
Match condition for the rule selection. Include resources that match all rules or any of the rules. | string |
Yes | - | - |
rules |
Rules. | list[object] |
Yes | - | - |
Status.resourceSelection.ruleSelectionCriteria.rules[]¶
FleetResourceSelectionRuleSelectionCriteriaRule defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria.Rule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
basis |
Based on what the rule is created. It can be based on a resourceProperty or a tag. If based on a tag, basis will be 'definedTagEquals' If based on a resource property, basis will be 'inventoryProperties' | string |
No | - | - |
compartmentId |
Compartment Id for which the rule is created. | string |
Yes | - | - |
compartmentIdInSubtree |
If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. Default value for compartmentIdInSubtree is false |
boolean |
No | - | - |
conditions |
Rule Conditions | list[object] |
Yes | - | - |
matchCondition |
Match condition for the rule selection. Include resources that match all rules or any of the rules. Default value for matchCondition is ANY |
string |
No | - | - |
resourceCompartmentId |
The Compartment ID to dynamically search resources. Provide the compartment ID to which the rule is applicable. | string |
Yes | - | - |
Status.resourceSelection.ruleSelectionCriteria.rules[].conditions[]¶
FleetResourceSelectionRuleSelectionCriteriaRuleCondition defines nested fields for Fleet.ResourceSelection.RuleSelectionCriteria.Rule.Condition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
attrGroup |
Attribute Group. Provide a Tag namespace if the rule is based on a tag. Provide resource type if the rule is based on a resource property. | string |
Yes | - | - |
attrKey |
Attribute Key.Provide Tag key if the rule is based on a tag. Provide resource property name if the rule is based on a resource property. | string |
Yes | - | - |
attrValue |
Attribute Value.Provide Tag value if the rule is based on a tag. Provide resource property value if the rule is based on a resource property. | string |
Yes | - | - |
Status.resources[]¶
FleetResourceFields defines nested fields for Fleet.Resource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment Identifier[OCID]. | string |
Yes | - | - |
fleetResourceType |
Type of the FleetResource. | string |
No | - | - |
resourceId |
OCID of the resource. | string |
Yes | - | - |
tenancyId |
Tenancy Identifier[OCID]. | string |
Yes | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
FleetCredential¶
FleetCredential is the Schema for the fleetcredentials API.
Plural:fleetcredentialsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_fleetcredential.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
FleetCredentialSpec defines the desired state of FleetCredential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
Yes | - | - |
entitySpecifics |
FleetCredentialEntitySpecificsFields defines nested fields for FleetCredential.EntitySpecifics. | object |
Yes | - | - |
password |
FleetCredentialPasswordFields defines nested fields for FleetCredential.Password. | object |
Yes | - | - |
user |
FleetCredentialUserFields defines nested fields for FleetCredential.User. | object |
Yes | - | - |
Spec.entitySpecifics¶
FleetCredentialEntitySpecificsFields defines nested fields for FleetCredential.EntitySpecifics.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialLevel |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
resourceId |
OCID of the resource associated with the target for which the credential is created. | string |
No | - | - |
target |
Target name for which the credential is provided. | string |
No | - | - |
variables |
List of fleet credential variables. | list[object] |
No | - | - |
Spec.entitySpecifics.variables[]¶
FleetCredentialEntitySpecificsVariableFields defines nested fields for FleetCredential.EntitySpecifics.Variable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the variable. | string |
No | - | - |
value |
The value corresponding to the variable name. | string |
No | - | - |
Spec.password¶
FleetCredentialPasswordFields defines nested fields for FleetCredential.Password.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
OCID for the Vault Key that will be used to encrypt/decrypt the value given. | string |
No | - | - |
keyVersion |
The Vault Key version. | string |
No | - | - |
secretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. | string |
No | - | - |
secretVersion |
The secret version. | string |
No | - | - |
value |
The value corresponding to the credential. | string |
No | - | - |
vaultId |
OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. | string |
No | - | - |
Spec.user¶
FleetCredentialUserFields defines nested fields for FleetCredential.User.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
OCID for the Vault Key that will be used to encrypt/decrypt the value given. | string |
No | - | - |
keyVersion |
The Vault Key version. | string |
No | - | - |
secretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. | string |
No | - | - |
secretVersion |
The secret version. | string |
No | - | - |
value |
The value corresponding to the credential. | string |
No | - | - |
vaultId |
OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. | string |
No | - | - |
Status¶
FleetCredentialStatus defines the observed state of FleetCredential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | 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 | - | - |
entitySpecifics |
FleetCredentialEntitySpecificsFields defines nested fields for FleetCredential.EntitySpecifics. | object |
No | - | - |
id |
The unique id 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 Failed state. | string |
No | - | - |
lifecycleState |
The current state of the FleetCredential. | string |
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 | - | - |
user |
FleetCredentialUserFields defines nested fields for FleetCredential.User. | object |
No | - | - |
Status.entitySpecifics¶
Back to FleetCredential status
FleetCredentialEntitySpecificsFields defines nested fields for FleetCredential.EntitySpecifics.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialLevel |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
resourceId |
OCID of the resource associated with the target for which the credential is created. | string |
No | - | - |
target |
Target name for which the credential is provided. | string |
No | - | - |
variables |
List of fleet credential variables. | list[object] |
No | - | - |
Status.entitySpecifics.variables[]¶
Back to FleetCredential status
FleetCredentialEntitySpecificsVariableFields defines nested fields for FleetCredential.EntitySpecifics.Variable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the variable. | string |
No | - | - |
value |
The value corresponding to the variable name. | string |
No | - | - |
Status.status¶
Back to FleetCredential 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 FleetCredential 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 FleetCredential 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 FleetCredential status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.user¶
Back to FleetCredential status
FleetCredentialUserFields defines nested fields for FleetCredential.User.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
OCID for the Vault Key that will be used to encrypt/decrypt the value given. | string |
No | - | - |
keyVersion |
The Vault Key version. | string |
No | - | - |
secretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. | string |
No | - | - |
secretVersion |
The secret version. | string |
No | - | - |
value |
The value corresponding to the credential. | string |
No | - | - |
vaultId |
OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. | string |
No | - | - |
FleetProperty¶
FleetProperty is the Schema for the fleetproperties API.
Plural:fleetpropertiesScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_fleetproperty.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
FleetPropertySpec defines the desired state of FleetProperty.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertyId |
OCID referring to global level metadata property. | string |
Yes | - | - |
value |
Value of the Property. | string |
Yes | - | - |
Status¶
FleetPropertyStatus defines the observed state of FleetProperty.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedValues |
Values of the property (must be a single value if selectionType = 'SINGLE_CHOICE'). | list[string] |
No | - | - |
compartmentId |
Compartment OCID | 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 | - | - |
id |
The unique id of the resource. | string |
No | - | - |
lifecycleState |
The current state of the FleetProperty. | string |
No | - | - |
propertyId |
OCID referring to global level metadata property. | string |
No | - | - |
selectionType |
Text selection of the property. | string |
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 | - | - |
value |
Value of the Property. | string |
No | - | - |
valueType |
Format of the value. | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
FleetResource¶
FleetResource is the Schema for the fleetresources API.
Plural:fleetresourcesScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_fleetresource.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
FleetResourceSpec defines the desired state of FleetResource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the compartment to which the resource belongs to. | string |
Yes | - | - |
resourceId |
The OCID of the resource. | string |
Yes | - | - |
resourceRegion |
Associated region | string |
No | - | - |
resourceType |
Type of the Resource. | string |
No | - | - |
tenancyId |
OCID of the tenancy to which the resource belongs to. | string |
Yes | - | - |
Status¶
FleetResourceStatus defines the observed state of FleetResource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartment |
Resource Compartment name. | string |
No | - | - |
compartmentId |
OCID of the compartment to which the resource belongs to. | string |
No | - | - |
complianceState |
Compliance State of the Resource. | 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 | - | - |
environmentType |
Environment Type associated with the Fleet when the resource type is fleet. Will only be returned for ENVIRONMENT fleets that are part of a GROUP Fleet. | string |
No | - | - |
id |
The unique id 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 Failed state. | string |
No | - | - |
lifecycleState |
The current state of the FleetResource. | string |
No | - | - |
percentCompliant |
The compliance percentage. | number |
No | - | - |
product |
Product associated with the resource when the resource type is fleet. Will only be returned for PRODUCT fleets that are part of a GROUP Fleet. | string |
No | - | - |
productCount |
Count of products within the resource. | integer |
No | - | - |
resourceId |
The OCID of the resource. | string |
No | - | - |
resourceRegion |
Associated region | string |
No | - | - |
resourceType |
Type of the Resource. | string |
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 | - | - |
targetCount |
Count of targets within the resource. | integer |
No | - | - |
tenancyId |
OCID of the tenancy to which the resource belongs to. | string |
No | - | - |
tenancyName |
Resource Tenancy Name. | 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 | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
MaintenanceWindow¶
MaintenanceWindow is the Schema for the maintenancewindows API.
Plural:maintenancewindowsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_maintenancewindow.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
MaintenanceWindowSpec defines the desired state of MaintenanceWindow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | 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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 | - | - |
duration |
Duration of the maintenance window. Specify how long the maintenance window remains open. | 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 | - | - |
isOutage |
Does the maintenenace window cause outage? An outage indicates whether a maintenance window can consider operations that require downtime. It means a period when the application is not accessible. | boolean |
No | - | - |
isRecurring |
Is this a recurring maintenance window? | boolean |
No | - | - |
recurrences |
Recurrence rule specification if maintenance window recurring. Specify the frequency of running the maintenance window. | string |
No | - | - |
timeScheduleStart |
Specify the date and time of the day that the maintenance window starts. | string |
Yes | - | - |
Status¶
MaintenanceWindowStatus defines the observed state of MaintenanceWindow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | 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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 | - | - |
duration |
Duration of the maintenance window. Specify how long the maintenance window remains open. | 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 OCID of the resource. | string |
No | - | - |
isOutage |
Does the maintenenace window cause outage? An outage indicates whether a maintenance window can consider operations that require downtime. It means a period when the application is not accessible. | boolean |
No | - | - |
isRecurring |
Is this a recurring maintenance window? | boolean |
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 MaintenanceWindow. | string |
No | - | - |
recurrences |
Recurrence rule specification if maintenance window recurring. Specify the frequency of running the maintenance window. | string |
No | - | - |
resourceRegion |
Associated region | string |
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 | - | - |
timeScheduleStart |
Specify the date and time of the day that the maintenance window starts. | string |
No | - | - |
timeUpdated |
The time this resource was last updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.status¶
Back to MaintenanceWindow 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 MaintenanceWindow 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 MaintenanceWindow 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 MaintenanceWindow status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Onboarding¶
Onboarding is the Schema for the onboardings API.
Plural:onboardingsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_onboarding.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
OnboardingSpec defines the desired state of Onboarding.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Tenancy OCID | 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 | - | - |
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 | - | - |
isCostTrackingTagEnabled |
A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag. | boolean |
No | - | - |
isFamsTagEnabled |
A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag. | boolean |
No | - | - |
Status¶
OnboardingStatus defines the observed state of Onboarding.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
appliedPolicies |
OnboardingAppliedPolicies defines nested fields for Onboarding.AppliedPolicies. | object |
No | - | - |
compartmentId |
Tenancy OCID | 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 | - | - |
discoveryFrequency |
Provide discovery frequency. | 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 id of the resource. | string |
No | - | - |
isCostTrackingTagEnabled |
A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag. | boolean |
No | - | - |
isFamsTagEnabled |
A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag. | boolean |
No | - | - |
lifecycleState |
The current state of the Onboarding. | string |
No | - | - |
resourceRegion |
Associated region | string |
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 | - | - |
version |
The version of Fleet Application Management that the tenant is onboarded to. | string |
No | - | - |
Status.appliedPolicies¶
OnboardingAppliedPolicies defines nested fields for Onboarding.AppliedPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
id |
The unique id of the resource. | string |
No | - | - |
statements |
Policy statements. | list[string] |
No | - | - |
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 | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Patch¶
Patch is the Schema for the patches API.
Plural:patchesScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_patch.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
PatchSpec defines the desired state of Patch.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
artifactDetails |
PatchArtifactDetails defines nested fields for Patch.ArtifactDetails. | object |
Yes | - | - |
compartmentId |
OCID of the compartment to which the resource belongs to. | 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 | - | - |
dependentPatches |
Dependent Patches for this patch. | list[object] |
No | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 | - | - |
name |
A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. Avoid entering confidential information. | string |
Yes | - | - |
patchType |
PatchType defines nested fields for Patch.PatchType. | object |
Yes | - | - |
product |
PatchProduct defines nested fields for Patch.Product. | object |
Yes | - | - |
severity |
Patch Severity. | string |
Yes | - | - |
timeReleased |
Date when the patch was released. | string |
Yes | - | - |
Spec.artifactDetails¶
PatchArtifactDetails defines nested fields for Patch.ArtifactDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
artifact |
PatchArtifactDetailsArtifact defines nested fields for Patch.ArtifactDetails.Artifact. | object |
No | - | - |
artifacts |
Artifacts. | list[object] |
No | - | - |
category |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Spec.artifactDetails.artifact¶
PatchArtifactDetailsArtifact defines nested fields for Patch.ArtifactDetails.Artifact.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
architecture |
System architecture. | string |
Yes | - | - |
content |
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content. | object |
Yes | - | - |
osType |
The OS type the patch is applicable for. | string |
Yes | - | - |
Spec.artifactDetails.artifact.content¶
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Spec.artifactDetails.artifacts[]¶
PatchArtifactDetailsArtifact defines nested fields for Patch.ArtifactDetails.Artifact.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
architecture |
System architecture. | string |
Yes | - | - |
content |
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content. | object |
Yes | - | - |
osType |
The OS type the patch is applicable for. | string |
Yes | - | - |
Spec.artifactDetails.artifacts[].content¶
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Spec.dependentPatches[]¶
PatchDependentPatch defines nested fields for Patch.DependentPatch.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.patchType¶
PatchType defines nested fields for Patch.PatchType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
platformConfigurationId |
PlatformConfiguration Id corresponding to the Patch Type | string |
Yes | - | - |
Spec.product¶
PatchProduct defines nested fields for Patch.Product.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
platformConfigurationId |
PlatformConfiguration Id corresponding to the Product | string |
Yes | - | - |
version |
product version. | string |
Yes | - | - |
Status¶
PatchStatus defines the observed state of Patch.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
artifactDetails |
PatchArtifactDetails defines nested fields for Patch.ArtifactDetails. | object |
No | - | - |
compartmentId |
OCID of the compartment to which the resource belongs to. | 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 | - | - |
dependentPatches |
Dependent Patches for this patch. | list[object] |
No | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 OCID 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 Failed state. | string |
No | - | - |
lifecycleState |
The current state of the Patch. | string |
No | - | - |
name |
A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. Avoid entering confidential information. | string |
No | - | - |
patchType |
PatchType defines nested fields for Patch.PatchType. | object |
No | - | - |
product |
PatchProduct defines nested fields for Patch.Product. | object |
No | - | - |
resourceRegion |
Associated region | string |
No | - | - |
severity |
Patch Severity. | string |
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 | - | - |
timeReleased |
Date when the patch was released. | string |
No | - | - |
timeUpdated |
The time this resource was last updated. An RFC3339 formatted datetime string. | string |
No | - | - |
type |
Provide information on who defined the patch. Example: For Custom Patches the value will be USER_DEFINED For Oracle Defined Patches the value will be ORACLE_DEFINED | string |
No | - | - |
Status.artifactDetails¶
PatchArtifactDetails defines nested fields for Patch.ArtifactDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
artifact |
PatchArtifactDetailsArtifact defines nested fields for Patch.ArtifactDetails.Artifact. | object |
No | - | - |
artifacts |
Artifacts. | list[object] |
No | - | - |
category |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Status.artifactDetails.artifact¶
PatchArtifactDetailsArtifact defines nested fields for Patch.ArtifactDetails.Artifact.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
architecture |
System architecture. | string |
Yes | - | - |
content |
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content. | object |
Yes | - | - |
osType |
The OS type the patch is applicable for. | string |
Yes | - | - |
Status.artifactDetails.artifact.content¶
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.artifactDetails.artifacts[]¶
PatchArtifactDetailsArtifact defines nested fields for Patch.ArtifactDetails.Artifact.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
architecture |
System architecture. | string |
Yes | - | - |
content |
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content. | object |
Yes | - | - |
osType |
The OS type the patch is applicable for. | string |
Yes | - | - |
Status.artifactDetails.artifacts[].content¶
PatchArtifactDetailsArtifactContent defines nested fields for Patch.ArtifactDetails.Artifact.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.dependentPatches[]¶
PatchDependentPatch defines nested fields for Patch.DependentPatch.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
id |
The OCID of the resource. | string |
Yes | - | - |
Status.patchType¶
PatchType defines nested fields for Patch.PatchType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
platformConfigurationId |
PlatformConfiguration Id corresponding to the Patch Type | string |
Yes | - | - |
Status.product¶
PatchProduct defines nested fields for Patch.Product.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
platformConfigurationId |
PlatformConfiguration Id corresponding to the Product | string |
Yes | - | - |
version |
product version. | string |
Yes | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
PlatformConfiguration¶
PlatformConfiguration is the Schema for the platformconfigurations API.
Plural:platformconfigurationsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_platformconfiguration.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
PlatformConfigurationSpec defines the desired state of PlatformConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | string |
Yes | - | - |
configCategoryDetails |
PlatformConfigurationConfigCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails. | object |
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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 |
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 | - | - |
Spec.configCategoryDetails¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compatibleProducts |
Products compatible with this Product. Provide products from the list of other products you have created that are compatible with the present one. This property is not applicable if isSoftlink is set to true. | list[object] |
No | - | - |
components |
Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. This property is not applicable if isSoftlink is set to true. | list[string] |
No | - | - |
configCategory |
- | string |
No | - | - |
credentials |
OCID for the Credential name to be associated with the Product. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. This property is not applicable if isSoftlink is set to true. | list[object] |
No | - | - |
instanceId |
The OCID of the resource. | string |
No | - | - |
instanceName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
No | - | - |
isCompliancePolicyRequiredForSoftlink |
If set true ,compliance policies will be created for softlink product. This property is applicable only if isSoftlink is set to true | boolean |
No | - | - |
isSoftlink |
Specify if the product is softlink product or not | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
linkProductId |
The OCID of the product that would be the target for the softlink. This property is applicable only if isSoftlink is set to true | string |
No | - | - |
patchTypes |
Patch Types associated with this Product. This property is not applicable if isSoftlink is set to true. | list[object] |
No | - | - |
products |
Products that belong to the stack. For example, Oracle WebLogic and Java for the Oracle Fusion Middleware product stack. | list[object] |
No | - | - |
subCategoryDetails |
PlatformConfigurationConfigCategoryDetailsSubCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails. | object |
No | - | - |
versions |
Versions associated with the PRODUCT. Mandatory if product is not softlink product. | list[string] |
No | - | - |
Spec.configCategoryDetails.compatibleProducts[]¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetailsCompatibleProduct defines nested fields for PlatformConfiguration.ConfigCategoryDetails.CompatibleProduct.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.configCategoryDetails.credentials[]¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetailsCredential defines nested fields for PlatformConfiguration.ConfigCategoryDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.configCategoryDetails.patchTypes[]¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetailsPatchType defines nested fields for PlatformConfiguration.ConfigCategoryDetails.PatchType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.configCategoryDetails.products[]¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetailsProduct defines nested fields for PlatformConfiguration.ConfigCategoryDetails.Product.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.configCategoryDetails.subCategoryDetails¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetailsSubCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
components |
Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. | list[string] |
No | - | - |
credentials |
OCID for the Credential name to be associated with the Product Stack. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. | list[object] |
No | - | - |
jsonData |
- | string |
No | - | - |
patchTypes |
Patch Types associated with this Product Stack which will be considered as Product. | list[object] |
No | - | - |
subCategory |
- | string |
No | - | - |
versions |
Versions associated with the PRODUCT . | list[string] |
No | - | - |
Spec.configCategoryDetails.subCategoryDetails.credentials[]¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsCredential defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.configCategoryDetails.subCategoryDetails.patchTypes[]¶
Back to PlatformConfiguration spec
PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsPatchType defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails.PatchType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status¶
PlatformConfigurationStatus defines the observed state of PlatformConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | string |
No | - | - |
configCategoryDetails |
PlatformConfigurationConfigCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails. | object |
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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 |
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 OCID 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 Failed state. | string |
No | - | - |
lifecycleState |
The current state of the PlatformConfiguration. | string |
No | - | - |
resourceRegion |
Associated region | string |
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 | - | - |
type |
The type of the configuration. | string |
No | - | - |
Status.configCategoryDetails¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compatibleProducts |
Products compatible with this Product. Provide products from the list of other products you have created that are compatible with the present one. This property is not applicable if isSoftlink is set to true. | list[object] |
No | - | - |
components |
Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. This property is not applicable if isSoftlink is set to true. | list[string] |
No | - | - |
configCategory |
- | string |
No | - | - |
credentials |
OCID for the Credential name to be associated with the Product. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. This property is not applicable if isSoftlink is set to true. | list[object] |
No | - | - |
instanceId |
The OCID of the resource. | string |
No | - | - |
instanceName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
No | - | - |
isCompliancePolicyRequiredForSoftlink |
If set true ,compliance policies will be created for softlink product. This property is applicable only if isSoftlink is set to true | boolean |
No | - | - |
isSoftlink |
Specify if the product is softlink product or not | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
linkProductId |
The OCID of the product that would be the target for the softlink. This property is applicable only if isSoftlink is set to true | string |
No | - | - |
patchTypes |
Patch Types associated with this Product. This property is not applicable if isSoftlink is set to true. | list[object] |
No | - | - |
products |
Products that belong to the stack. For example, Oracle WebLogic and Java for the Oracle Fusion Middleware product stack. | list[object] |
No | - | - |
subCategoryDetails |
PlatformConfigurationConfigCategoryDetailsSubCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails. | object |
No | - | - |
versions |
Versions associated with the PRODUCT. Mandatory if product is not softlink product. | list[string] |
No | - | - |
Status.configCategoryDetails.compatibleProducts[]¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetailsCompatibleProduct defines nested fields for PlatformConfiguration.ConfigCategoryDetails.CompatibleProduct.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.configCategoryDetails.credentials[]¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetailsCredential defines nested fields for PlatformConfiguration.ConfigCategoryDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.configCategoryDetails.patchTypes[]¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetailsPatchType defines nested fields for PlatformConfiguration.ConfigCategoryDetails.PatchType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.configCategoryDetails.products[]¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetailsProduct defines nested fields for PlatformConfiguration.ConfigCategoryDetails.Product.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.configCategoryDetails.subCategoryDetails¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetailsSubCategoryDetails defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
components |
Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. | list[string] |
No | - | - |
credentials |
OCID for the Credential name to be associated with the Product Stack. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. | list[object] |
No | - | - |
jsonData |
- | string |
No | - | - |
patchTypes |
Patch Types associated with this Product Stack which will be considered as Product. | list[object] |
No | - | - |
subCategory |
- | string |
No | - | - |
versions |
Versions associated with the PRODUCT . | list[string] |
No | - | - |
Status.configCategoryDetails.subCategoryDetails.credentials[]¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsCredential defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.configCategoryDetails.subCategoryDetails.patchTypes[]¶
Back to PlatformConfiguration status
PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsPatchType defines nested fields for PlatformConfiguration.ConfigCategoryDetails.SubCategoryDetails.PatchType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.status¶
Back to PlatformConfiguration 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 PlatformConfiguration 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 PlatformConfiguration 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 PlatformConfiguration status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Property¶
Property is the Schema for the properties API.
Plural:propertiesScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_property.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
PropertySpec defines the desired state of Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | 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 |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
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 | - | - |
selection |
Text selection of the property. | string |
Yes | - | - |
valueType |
Format of the value. | string |
Yes | - | - |
values |
Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). | list[string] |
No | - | - |
Status¶
PropertyStatus defines the observed state of Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment OCID | 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 |
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 |
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 OCID 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 Failed state. | string |
No | - | - |
lifecycleState |
The current state of the Property. | string |
No | - | - |
resourceRegion |
Associated region | string |
No | - | - |
scope |
The scope of the property. | string |
No | - | - |
selection |
Text selection of the property. | string |
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 | - | - |
type |
The type of the property. | string |
No | - | - |
valueType |
Format of the value. | string |
No | - | - |
values |
Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). | list[string] |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Provision¶
Provision is the Schema for the provisions API.
Plural:provisionsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_provision.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ProvisionSpec defines the desired state of Provision.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the FamProvision in. | string |
Yes | - | - |
configCatalogItemId |
A OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item to a file with key/value pairs to set up variables for createStack API. | 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 |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
fleetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. | 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 | - | - |
packageCatalogItemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item. | string |
Yes | - | - |
provisionDescription |
A description of the provision. | string |
No | - | - |
tfVariableCompartmentId |
An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
No | - | - |
tfVariableCurrentUserId |
An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
No | - | - |
tfVariableRegionId |
A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
Yes | - | - |
tfVariableTenancyId |
A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
Yes | - | - |
Status¶
ProvisionStatus defines the observed state of Provision.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. | string |
No | - | - |
configCatalogItemDisplayName |
A display Name of the Catalog Item in the Catalog. | string |
No | - | - |
configCatalogItemId |
A OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item to a file with key/value pairs to set up variables for createStack API. | string |
No | - | - |
configCatalogItemListingId |
A listing ID of the Catalog Item in the Catalog. | string |
No | - | - |
configCatalogItemListingVersion |
A listing version of the Catalog Item in the Catalog. | 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 | - | - |
deployedResources |
The deployed resources and their summary | list[object] |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. | string |
No | - | - |
fleetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. | 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 OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the FamProvision. | string |
No | - | - |
lifecycleDetails |
A message that describes the current state of the FamProvision in more detail. For example, can be used to provide actionable information for a resource in the Failed state. | string |
No | - | - |
lifecycleState |
The current state of the FamProvision. | string |
No | - | - |
packageCatalogItemDisplayName |
A display Name of the Catalog Item in the Catalog. | string |
No | - | - |
packageCatalogItemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item. | string |
No | - | - |
packageCatalogItemListingId |
A listing ID of the Catalog Item in the Catalog. | string |
No | - | - |
packageCatalogItemListingVersion |
A listing version of the Catalog Item in the Catalog. | string |
No | - | - |
provisionDescription |
A description of the provision. | string |
No | - | - |
rmsApplyJobId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the RMS APPLY Job. | string |
No | - | - |
stackId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the RMS Stack. | string |
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 | - | - |
tfOutputs |
Outputs from the Terraform Apply job | list[object] |
No | - | - |
tfVariableCompartmentId |
An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
No | - | - |
tfVariableCurrentUserId |
An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
No | - | - |
tfVariableRegionId |
A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
No | - | - |
tfVariableTenancyId |
A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. | string |
No | - | - |
timeCreated |
The date and time the FamProvision was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the FamProvision was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.deployedResources[]¶
ProvisionDeployedResource defines nested fields for Provision.DeployedResource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
mode |
The mode of the resource. Example: "managed" | string |
No | - | - |
resourceInstanceList |
Collection of InstanceSummary | list[object] |
No | - | - |
resourceName |
The name of the resource | string |
No | - | - |
resourceProvider |
The name of the Provider | string |
No | - | - |
resourceType |
The provider resource type. Must be supported by the Oracle Cloud Infrastructure provider (https://registry.terraform.io/providers/oracle/oci/latest/docs). Example: oci_core_instance | string |
No | - | - |
Status.deployedResources[].resourceInstanceList[]¶
ProvisionDeployedResourceResourceInstanceList defines nested fields for Provision.DeployedResource.ResourceInstanceList.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which instance is deployed. | string |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance. | string |
No | - | - |
state |
Instance lifecycle state | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.tfOutputs[]¶
ProvisionTfOutput defines nested fields for Provision.TfOutput.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isSensitive |
The indicator if the data for this parameter is sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.) | boolean |
No | - | - |
outputDescription |
The output description | string |
No | - | - |
outputName |
The output name | string |
No | - | - |
outputType |
The output type | string |
No | - | - |
outputValue |
The output value | string |
No | - | - |
Runbook¶
Runbook is the Schema for the runbooks API.
Plural:runbooksScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_runbook.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
RunbookSpec defines the desired state of Runbook.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the compartment to which the resource belongs to. | 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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 |
Yes | - | - |
estimatedTime |
Estimated time to successfully complete the runbook execution. | 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 | - | - |
isDefault |
Is the runbook default? | boolean |
No | - | - |
isSudoAccessNeeded |
Does this runbook need SUDO access to execute? | boolean |
No | - | - |
operation |
The lifecycle operation performed by the task. | string |
Yes | - | - |
osType |
The OS type for the runbook. | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
runbookVersion |
RunbookVersionFields defines nested fields for Runbook.RunbookVersion. | object |
Yes | - | - |
Spec.runbookVersion¶
RunbookVersionFields defines nested fields for Runbook.RunbookVersion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
executionWorkflowDetails |
RunbookVersionExecutionWorkflowDetails defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails. | object |
Yes | - | - |
groups |
The groups of the runbook. | list[object] |
Yes | - | - |
isLatest |
Is this version the latest? | boolean |
No | - | - |
rollbackWorkflowDetails |
RunbookVersionRollbackWorkflowDetails defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails. | object |
No | - | - |
tasks |
A set of tasks to execute in the runbook. | list[object] |
Yes | - | - |
version |
The version of the runbook. | string |
No | - | - |
Spec.runbookVersion.executionWorkflowDetails¶
RunbookVersionExecutionWorkflowDetails defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
workflow |
Execution Workflow for the runbook. | list[object] |
Yes | - | - |
Spec.runbookVersion.executionWorkflowDetails.workflow[]¶
RunbookVersionExecutionWorkflowDetailsWorkflow defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Spec.runbookVersion.executionWorkflowDetails.workflow[].steps[]¶
RunbookVersionExecutionWorkflowDetailsWorkflowStep defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Spec.runbookVersion.groups[]¶
RunbookVersionGroup defines nested fields for Runbook.RunbookVersion.Group.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the group. | string |
Yes | - | - |
properties |
RunbookVersionGroupProperties defines nested fields for Runbook.RunbookVersion.Group.Properties. | object |
No | - | - |
type |
The type of the group. PARALLEL_TASK_GROUP : Helps to execute tasks parallelly inside a resource. PARALLEL_RESOURCE_GROUP : Executes tasks across resources parallelly. ROLLING_RESOURCE_GROUP : Executes tasks across resources in a rolling order. | string |
Yes | - | - |
Spec.runbookVersion.groups[].properties¶
RunbookVersionGroupProperties defines nested fields for Runbook.RunbookVersion.Group.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionGroupPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Group.Properties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionGroupPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionGroupPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn. | object |
No | - | - |
Spec.runbookVersion.groups[].properties.notificationPreferences¶
RunbookVersionGroupPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Group.Properties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Spec.runbookVersion.groups[].properties.pauseDetails¶
RunbookVersionGroupPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Spec.runbookVersion.groups[].properties.runOn¶
RunbookVersionGroupPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Spec.runbookVersion.groups[].properties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetail defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Spec.runbookVersion.groups[].properties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Spec.runbookVersion.rollbackWorkflowDetails¶
RunbookVersionRollbackWorkflowDetails defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
scope |
rollback Scope | string |
Yes | - | - |
workflow |
Rollback Workflow for the runbook. | list[object] |
Yes | - | - |
Spec.runbookVersion.rollbackWorkflowDetails.workflow[]¶
RunbookVersionRollbackWorkflowDetailsWorkflow defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Spec.runbookVersion.rollbackWorkflowDetails.workflow[].steps[]¶
RunbookVersionRollbackWorkflowDetailsWorkflowStep defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Spec.runbookVersion.tasks[]¶
RunbookVersionTask defines nested fields for Runbook.RunbookVersion.Task.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableMappings |
Mapping output variables of previous tasks to the input variables of the current task. | list[object] |
No | - | - |
stepName |
The name of the task step. | string |
Yes | - | - |
stepProperties |
RunbookVersionTaskStepProperties defines nested fields for Runbook.RunbookVersion.Task.StepProperties. | object |
No | - | - |
taskRecordDetails |
RunbookVersionTaskTaskRecordDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails. | object |
Yes | - | - |
Spec.runbookVersion.tasks[].outputVariableMappings[]¶
RunbookVersionTaskOutputVariableMapping defines nested fields for Runbook.RunbookVersion.Task.OutputVariableMapping.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the input variable. | string |
Yes | - | - |
outputVariableDetails |
RunbookVersionTaskOutputVariableMappingOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails. | object |
Yes | - | - |
Spec.runbookVersion.tasks[].outputVariableMappings[].outputVariableDetails¶
RunbookVersionTaskOutputVariableMappingOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Spec.runbookVersion.tasks[].stepProperties¶
RunbookVersionTaskStepProperties defines nested fields for Runbook.RunbookVersion.Task.StepProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionTaskStepPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Task.StepProperties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionTaskStepPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionTaskStepPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn. | object |
No | - | - |
Spec.runbookVersion.tasks[].stepProperties.notificationPreferences¶
RunbookVersionTaskStepPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Task.StepProperties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Spec.runbookVersion.tasks[].stepProperties.pauseDetails¶
RunbookVersionTaskStepPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Spec.runbookVersion.tasks[].stepProperties.runOn¶
RunbookVersionTaskStepPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Spec.runbookVersion.tasks[].stepProperties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetail defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Spec.runbookVersion.tasks[].stepProperties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Spec.runbookVersion.tasks[].taskRecordDetails¶
RunbookVersionTaskTaskRecordDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the task. | string |
No | - | - |
executionDetails |
RunbookVersionTaskTaskRecordDetailsExecutionDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails. | object |
No | - | - |
isApplySubjectTask |
Is this an Apply Subject Task? Ex. Patch Execution Task | boolean |
No | - | - |
isCopyToLibraryEnabled |
Make a copy of this task in Library | boolean |
No | - | - |
isDiscoveryOutputTask |
Is this a discovery output task? | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the task | string |
No | - | - |
osType |
The OS for the task. | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
properties |
RunbookVersionTaskTaskRecordDetailsProperties defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.Properties. | object |
No | - | - |
scope |
- | string |
No | - | - |
taskRecordId |
The ID of taskRecord. | string |
No | - | - |
Spec.runbookVersion.tasks[].taskRecordDetails.executionDetails¶
RunbookVersionTaskTaskRecordDetailsExecutionDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
command |
Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. | string |
No | - | - |
configFile |
Catalog Id having config file. | string |
No | - | - |
content |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContent defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content. | object |
No | - | - |
credentials |
Credentials required for executing the task. | list[object] |
No | - | - |
endpoint |
Endpoint to be invoked. | string |
No | - | - |
executionType |
- | string |
No | - | - |
isExecutableContent |
Is the Content an executable file? | boolean |
No | - | - |
isLocked |
Is the script locked to prevent changes directly in Object Storage? | boolean |
No | - | - |
isReadOutputVariableEnabled |
Is read output variable enabled | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
systemVariables |
The list of system variables. | list[string] |
No | - | - |
targetCompartmentId |
OCID of the compartment to which the resource belongs to. | string |
No | - | - |
variables |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables. | object |
No | - | - |
Spec.runbookVersion.tasks[].taskRecordDetails.executionDetails.content¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContent defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Spec.runbookVersion.tasks[].taskRecordDetails.executionDetails.credentials[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsCredential defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.runbookVersion.tasks[].taskRecordDetails.executionDetails.variables¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputVariables |
The input variables for the task. | list[object] |
No | - | - |
outputVariables |
The list of output variables. | list[string] |
No | - | - |
Spec.runbookVersion.tasks[].taskRecordDetails.executionDetails.variables.inputVariables[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariable defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.InputVariable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the argument. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the argument. | string |
Yes | - | - |
type |
- | string |
No | - | - |
Spec.runbookVersion.tasks[].taskRecordDetails.properties¶
RunbookVersionTaskTaskRecordDetailsProperties defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
numRetries |
The number of retries allowed. | integer |
Yes | - | - |
timeoutInSeconds |
The timeout in seconds for the task. | integer |
Yes | - | - |
Status¶
RunbookStatus defines the observed state of Runbook.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the compartment to which the resource belongs to. | 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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 | - | - |
estimatedTime |
Estimated time to successfully complete the runbook execution. | 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 | - | - |
hasDraftVersion |
Does this runbook has draft versions? | boolean |
No | - | - |
id |
The OCID of the resource. | string |
No | - | - |
isDefault |
Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation. | boolean |
No | - | - |
isSudoAccessNeeded |
Does this runbook need SUDO access to execute? | boolean |
No | - | - |
latestVersion |
Latest runbook version. | 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 runbook. | string |
No | - | - |
operation |
The lifecycle operation performed by the runbook. | string |
No | - | - |
originalVersion |
Original runbook version. This version belongs to original runbook using which new runbook was exported. | string |
No | - | - |
osType |
The OS type for the runbook. | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
resourceRegion |
Associated region | string |
No | - | - |
runbookVersion |
RunbookVersionFields defines nested fields for Runbook.RunbookVersion. | 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 | - | - |
type |
The type of the runbook. | string |
No | - | - |
Status.runbookVersion¶
RunbookVersionFields defines nested fields for Runbook.RunbookVersion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
executionWorkflowDetails |
RunbookVersionExecutionWorkflowDetails defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails. | object |
Yes | - | - |
groups |
The groups of the runbook. | list[object] |
Yes | - | - |
isLatest |
Is this version the latest? | boolean |
No | - | - |
rollbackWorkflowDetails |
RunbookVersionRollbackWorkflowDetails defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails. | object |
No | - | - |
tasks |
A set of tasks to execute in the runbook. | list[object] |
Yes | - | - |
version |
The version of the runbook. | string |
No | - | - |
Status.runbookVersion.executionWorkflowDetails¶
RunbookVersionExecutionWorkflowDetails defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
workflow |
Execution Workflow for the runbook. | list[object] |
Yes | - | - |
Status.runbookVersion.executionWorkflowDetails.workflow[]¶
RunbookVersionExecutionWorkflowDetailsWorkflow defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Status.runbookVersion.executionWorkflowDetails.workflow[].steps[]¶
RunbookVersionExecutionWorkflowDetailsWorkflowStep defines nested fields for Runbook.RunbookVersion.ExecutionWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Status.runbookVersion.groups[]¶
RunbookVersionGroup defines nested fields for Runbook.RunbookVersion.Group.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the group. | string |
Yes | - | - |
properties |
RunbookVersionGroupProperties defines nested fields for Runbook.RunbookVersion.Group.Properties. | object |
No | - | - |
type |
The type of the group. PARALLEL_TASK_GROUP : Helps to execute tasks parallelly inside a resource. PARALLEL_RESOURCE_GROUP : Executes tasks across resources parallelly. ROLLING_RESOURCE_GROUP : Executes tasks across resources in a rolling order. | string |
Yes | - | - |
Status.runbookVersion.groups[].properties¶
RunbookVersionGroupProperties defines nested fields for Runbook.RunbookVersion.Group.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionGroupPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Group.Properties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionGroupPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionGroupPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn. | object |
No | - | - |
Status.runbookVersion.groups[].properties.notificationPreferences¶
RunbookVersionGroupPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Group.Properties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Status.runbookVersion.groups[].properties.pauseDetails¶
RunbookVersionGroupPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Status.runbookVersion.groups[].properties.runOn¶
RunbookVersionGroupPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Status.runbookVersion.groups[].properties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetail defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Status.runbookVersion.groups[].properties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Status.runbookVersion.rollbackWorkflowDetails¶
RunbookVersionRollbackWorkflowDetails defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
scope |
rollback Scope | string |
Yes | - | - |
workflow |
Rollback Workflow for the runbook. | list[object] |
Yes | - | - |
Status.runbookVersion.rollbackWorkflowDetails.workflow[]¶
RunbookVersionRollbackWorkflowDetailsWorkflow defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Status.runbookVersion.rollbackWorkflowDetails.workflow[].steps[]¶
RunbookVersionRollbackWorkflowDetailsWorkflowStep defines nested fields for Runbook.RunbookVersion.RollbackWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Status.runbookVersion.tasks[]¶
RunbookVersionTask defines nested fields for Runbook.RunbookVersion.Task.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableMappings |
Mapping output variables of previous tasks to the input variables of the current task. | list[object] |
No | - | - |
stepName |
The name of the task step. | string |
Yes | - | - |
stepProperties |
RunbookVersionTaskStepProperties defines nested fields for Runbook.RunbookVersion.Task.StepProperties. | object |
No | - | - |
taskRecordDetails |
RunbookVersionTaskTaskRecordDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails. | object |
Yes | - | - |
Status.runbookVersion.tasks[].outputVariableMappings[]¶
RunbookVersionTaskOutputVariableMapping defines nested fields for Runbook.RunbookVersion.Task.OutputVariableMapping.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the input variable. | string |
Yes | - | - |
outputVariableDetails |
RunbookVersionTaskOutputVariableMappingOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails. | object |
Yes | - | - |
Status.runbookVersion.tasks[].outputVariableMappings[].outputVariableDetails¶
RunbookVersionTaskOutputVariableMappingOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Status.runbookVersion.tasks[].stepProperties¶
RunbookVersionTaskStepProperties defines nested fields for Runbook.RunbookVersion.Task.StepProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionTaskStepPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Task.StepProperties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionTaskStepPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionTaskStepPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn. | object |
No | - | - |
Status.runbookVersion.tasks[].stepProperties.notificationPreferences¶
RunbookVersionTaskStepPropertiesNotificationPreferences defines nested fields for Runbook.RunbookVersion.Task.StepProperties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Status.runbookVersion.tasks[].stepProperties.pauseDetails¶
RunbookVersionTaskStepPropertiesPauseDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Status.runbookVersion.tasks[].stepProperties.runOn¶
RunbookVersionTaskStepPropertiesRunOn defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Status.runbookVersion.tasks[].stepProperties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetail defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Status.runbookVersion.tasks[].stepProperties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails defines nested fields for Runbook.RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Status.runbookVersion.tasks[].taskRecordDetails¶
RunbookVersionTaskTaskRecordDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the task. | string |
No | - | - |
executionDetails |
RunbookVersionTaskTaskRecordDetailsExecutionDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails. | object |
No | - | - |
isApplySubjectTask |
Is this an Apply Subject Task? Ex. Patch Execution Task | boolean |
No | - | - |
isCopyToLibraryEnabled |
Make a copy of this task in Library | boolean |
No | - | - |
isDiscoveryOutputTask |
Is this a discovery output task? | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the task | string |
No | - | - |
osType |
The OS for the task. | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
properties |
RunbookVersionTaskTaskRecordDetailsProperties defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.Properties. | object |
No | - | - |
scope |
- | string |
No | - | - |
taskRecordId |
The ID of taskRecord. | string |
No | - | - |
Status.runbookVersion.tasks[].taskRecordDetails.executionDetails¶
RunbookVersionTaskTaskRecordDetailsExecutionDetails defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
command |
Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. | string |
No | - | - |
configFile |
Catalog Id having config file. | string |
No | - | - |
content |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContent defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content. | object |
No | - | - |
credentials |
Credentials required for executing the task. | list[object] |
No | - | - |
endpoint |
Endpoint to be invoked. | string |
No | - | - |
executionType |
- | string |
No | - | - |
isExecutableContent |
Is the Content an executable file? | boolean |
No | - | - |
isLocked |
Is the script locked to prevent changes directly in Object Storage? | boolean |
No | - | - |
isReadOutputVariableEnabled |
Is read output variable enabled | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
systemVariables |
The list of system variables. | list[string] |
No | - | - |
targetCompartmentId |
OCID of the compartment to which the resource belongs to. | string |
No | - | - |
variables |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables. | object |
No | - | - |
Status.runbookVersion.tasks[].taskRecordDetails.executionDetails.content¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContent defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.runbookVersion.tasks[].taskRecordDetails.executionDetails.credentials[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsCredential defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.runbookVersion.tasks[].taskRecordDetails.executionDetails.variables¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputVariables |
The input variables for the task. | list[object] |
No | - | - |
outputVariables |
The list of output variables. | list[string] |
No | - | - |
Status.runbookVersion.tasks[].taskRecordDetails.executionDetails.variables.inputVariables[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariable defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.InputVariable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the argument. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the argument. | string |
Yes | - | - |
type |
- | string |
No | - | - |
Status.runbookVersion.tasks[].taskRecordDetails.properties¶
RunbookVersionTaskTaskRecordDetailsProperties defines nested fields for Runbook.RunbookVersion.Task.TaskRecordDetails.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
numRetries |
The number of retries allowed. | integer |
Yes | - | - |
timeoutInSeconds |
The timeout in seconds for the task. | integer |
Yes | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
RunbookVersion¶
RunbookVersion is the Schema for the runbookversions API.
Plural:runbookversionsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_runbookversion.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
RunbookVersionSpec defines the desired state of RunbookVersion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
executionWorkflowDetails |
RunbookVersionExecutionWorkflowDetailsFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails. | object |
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 | - | - |
groups |
The groups of the runbook version. | list[object] |
Yes | - | - |
rollbackWorkflowDetails |
RunbookVersionRollbackWorkflowDetailsFields defines nested fields for RunbookVersion.RollbackWorkflowDetails. | object |
No | - | - |
runbookId |
The OCID of the resource. | string |
Yes | - | - |
tasks |
A set of tasks to execute in the runbook. | list[object] |
Yes | - | - |
Spec.executionWorkflowDetails¶
RunbookVersionExecutionWorkflowDetailsFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
workflow |
Execution Workflow for the runbook. | list[object] |
Yes | - | - |
Spec.executionWorkflowDetails.workflow[]¶
RunbookVersionExecutionWorkflowDetailsWorkflowFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Spec.executionWorkflowDetails.workflow[].steps[]¶
RunbookVersionExecutionWorkflowDetailsWorkflowStepFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Spec.groups[]¶
RunbookVersionGroupFields defines nested fields for RunbookVersion.Group.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the group. | string |
Yes | - | - |
properties |
RunbookVersionGroupPropertiesFields defines nested fields for RunbookVersion.Group.Properties. | object |
No | - | - |
type |
The type of the group. PARALLEL_TASK_GROUP : Helps to execute tasks parallelly inside a resource. PARALLEL_RESOURCE_GROUP : Executes tasks across resources parallelly. ROLLING_RESOURCE_GROUP : Executes tasks across resources in a rolling order. | string |
Yes | - | - |
Spec.groups[].properties¶
RunbookVersionGroupPropertiesFields defines nested fields for RunbookVersion.Group.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionGroupPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Group.Properties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionGroupPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Group.Properties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionGroupPropertiesRunOnFields defines nested fields for RunbookVersion.Group.Properties.RunOn. | object |
No | - | - |
Spec.groups[].properties.notificationPreferences¶
RunbookVersionGroupPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Group.Properties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Spec.groups[].properties.pauseDetails¶
RunbookVersionGroupPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Group.Properties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Spec.groups[].properties.runOn¶
RunbookVersionGroupPropertiesRunOnFields defines nested fields for RunbookVersion.Group.Properties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Spec.groups[].properties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailFields defines nested fields for RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Spec.groups[].properties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Spec.rollbackWorkflowDetails¶
RunbookVersionRollbackWorkflowDetailsFields defines nested fields for RunbookVersion.RollbackWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
scope |
rollback Scope | string |
Yes | - | - |
workflow |
Rollback Workflow for the runbook. | list[object] |
Yes | - | - |
Spec.rollbackWorkflowDetails.workflow[]¶
RunbookVersionRollbackWorkflowDetailsWorkflowFields defines nested fields for RunbookVersion.RollbackWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Spec.rollbackWorkflowDetails.workflow[].steps[]¶
RunbookVersionRollbackWorkflowDetailsWorkflowStepFields defines nested fields for RunbookVersion.RollbackWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Spec.tasks[]¶
RunbookVersionTaskFields defines nested fields for RunbookVersion.Task.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableMappings |
Mapping output variables of previous tasks to the input variables of the current task. | list[object] |
No | - | - |
stepName |
The name of the task step. | string |
Yes | - | - |
stepProperties |
RunbookVersionTaskStepPropertiesFields defines nested fields for RunbookVersion.Task.StepProperties. | object |
No | - | - |
taskRecordDetails |
RunbookVersionTaskTaskRecordDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails. | object |
Yes | - | - |
Spec.tasks[].outputVariableMappings[]¶
RunbookVersionTaskOutputVariableMappingFields defines nested fields for RunbookVersion.Task.OutputVariableMapping.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the input variable. | string |
Yes | - | - |
outputVariableDetails |
RunbookVersionTaskOutputVariableMappingOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails. | object |
Yes | - | - |
Spec.tasks[].outputVariableMappings[].outputVariableDetails¶
RunbookVersionTaskOutputVariableMappingOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Spec.tasks[].stepProperties¶
RunbookVersionTaskStepPropertiesFields defines nested fields for RunbookVersion.Task.StepProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionTaskStepPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Task.StepProperties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionTaskStepPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionTaskStepPropertiesRunOnFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn. | object |
No | - | - |
Spec.tasks[].stepProperties.notificationPreferences¶
RunbookVersionTaskStepPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Task.StepProperties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Spec.tasks[].stepProperties.pauseDetails¶
RunbookVersionTaskStepPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Spec.tasks[].stepProperties.runOn¶
RunbookVersionTaskStepPropertiesRunOnFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Spec.tasks[].stepProperties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Spec.tasks[].stepProperties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Spec.tasks[].taskRecordDetails¶
RunbookVersionTaskTaskRecordDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the task. | string |
No | - | - |
executionDetails |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails. | object |
No | - | - |
isApplySubjectTask |
Is this an Apply Subject Task? Ex. Patch Execution Task | boolean |
No | - | - |
isCopyToLibraryEnabled |
Make a copy of this task in Library | boolean |
No | - | - |
isDiscoveryOutputTask |
Is this a discovery output task? | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the task | string |
No | - | - |
osType |
The OS for the task. | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
properties |
RunbookVersionTaskTaskRecordDetailsPropertiesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.Properties. | object |
No | - | - |
scope |
- | string |
No | - | - |
taskRecordId |
The ID of taskRecord. | string |
No | - | - |
Spec.tasks[].taskRecordDetails.executionDetails¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
command |
Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. | string |
No | - | - |
configFile |
Catalog Id having config file. | string |
No | - | - |
content |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContentFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content. | object |
No | - | - |
credentials |
Credentials required for executing the task. | list[object] |
No | - | - |
endpoint |
Endpoint to be invoked. | string |
No | - | - |
executionType |
- | string |
No | - | - |
isExecutableContent |
Is the Content an executable file? | boolean |
No | - | - |
isLocked |
Is the script locked to prevent changes directly in Object Storage? | boolean |
No | - | - |
isReadOutputVariableEnabled |
Is read output variable enabled | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
systemVariables |
The list of system variables. | list[string] |
No | - | - |
targetCompartmentId |
OCID of the compartment to which the resource belongs to. | string |
No | - | - |
variables |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables. | object |
No | - | - |
Spec.tasks[].taskRecordDetails.executionDetails.content¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContentFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Spec.tasks[].taskRecordDetails.executionDetails.credentials[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsCredentialFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.tasks[].taskRecordDetails.executionDetails.variables¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputVariables |
The input variables for the task. | list[object] |
No | - | - |
outputVariables |
The list of output variables. | list[string] |
No | - | - |
Spec.tasks[].taskRecordDetails.executionDetails.variables.inputVariables[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariableFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.InputVariable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the argument. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the argument. | string |
Yes | - | - |
type |
- | string |
No | - | - |
Spec.tasks[].taskRecordDetails.properties¶
RunbookVersionTaskTaskRecordDetailsPropertiesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
numRetries |
The number of retries allowed. | integer |
Yes | - | - |
timeoutInSeconds |
The timeout in seconds for the task. | integer |
Yes | - | - |
Status¶
RunbookVersionStatus defines the observed state of RunbookVersion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the compartment to which the resource belongs to. | 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 | - | - |
executionWorkflowDetails |
RunbookVersionExecutionWorkflowDetailsFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails. | object |
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 | - | - |
groups |
The groups of the runbook. | list[object] |
No | - | - |
id |
The OCID of the resource. | string |
No | - | - |
isLatest |
Is the latest version for the runbook? | boolean |
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 runbook version. | string |
No | - | - |
name |
The version of the runbook. | string |
No | - | - |
rollbackWorkflowDetails |
RunbookVersionRollbackWorkflowDetailsFields defines nested fields for RunbookVersion.RollbackWorkflowDetails. | object |
No | - | - |
runbookId |
The OCID of the resource. | string |
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 | - | - |
tasks |
A set of tasks to execute in the runbook. | list[object] |
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 | - | - |
Status.executionWorkflowDetails¶
RunbookVersionExecutionWorkflowDetailsFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
workflow |
Execution Workflow for the runbook. | list[object] |
Yes | - | - |
Status.executionWorkflowDetails.workflow[]¶
RunbookVersionExecutionWorkflowDetailsWorkflowFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Status.executionWorkflowDetails.workflow[].steps[]¶
RunbookVersionExecutionWorkflowDetailsWorkflowStepFields defines nested fields for RunbookVersion.ExecutionWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Status.groups[]¶
RunbookVersionGroupFields defines nested fields for RunbookVersion.Group.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the group. | string |
Yes | - | - |
properties |
RunbookVersionGroupPropertiesFields defines nested fields for RunbookVersion.Group.Properties. | object |
No | - | - |
type |
The type of the group. PARALLEL_TASK_GROUP : Helps to execute tasks parallelly inside a resource. PARALLEL_RESOURCE_GROUP : Executes tasks across resources parallelly. ROLLING_RESOURCE_GROUP : Executes tasks across resources in a rolling order. | string |
Yes | - | - |
Status.groups[].properties¶
RunbookVersionGroupPropertiesFields defines nested fields for RunbookVersion.Group.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionGroupPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Group.Properties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionGroupPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Group.Properties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionGroupPropertiesRunOnFields defines nested fields for RunbookVersion.Group.Properties.RunOn. | object |
No | - | - |
Status.groups[].properties.notificationPreferences¶
RunbookVersionGroupPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Group.Properties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Status.groups[].properties.pauseDetails¶
RunbookVersionGroupPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Group.Properties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Status.groups[].properties.runOn¶
RunbookVersionGroupPropertiesRunOnFields defines nested fields for RunbookVersion.Group.Properties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Status.groups[].properties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailFields defines nested fields for RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Status.groups[].properties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Group.Properties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Status.rollbackWorkflowDetails¶
RunbookVersionRollbackWorkflowDetailsFields defines nested fields for RunbookVersion.RollbackWorkflowDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
scope |
rollback Scope | string |
Yes | - | - |
workflow |
Rollback Workflow for the runbook. | list[object] |
Yes | - | - |
Status.rollbackWorkflowDetails.workflow[]¶
RunbookVersionRollbackWorkflowDetailsWorkflowFields defines nested fields for RunbookVersion.RollbackWorkflowDetails.Workflow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
Yes | - | - |
steps |
Steps within the Group. | list[object] |
Yes | - | - |
type |
Workflow Group Details. | string |
Yes | - | - |
Status.rollbackWorkflowDetails.workflow[].steps[]¶
RunbookVersionRollbackWorkflowDetailsWorkflowStepFields defines nested fields for RunbookVersion.RollbackWorkflowDetails.Workflow.Step.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
groupName |
Name of the group. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
stepName |
Provide StepName for the Task. | string |
No | - | - |
steps |
Tasks within the Group. Provide the stepName for all applicable tasks. | list[string] |
No | - | - |
type |
- | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.tasks[]¶
RunbookVersionTaskFields defines nested fields for RunbookVersion.Task.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableMappings |
Mapping output variables of previous tasks to the input variables of the current task. | list[object] |
No | - | - |
stepName |
The name of the task step. | string |
Yes | - | - |
stepProperties |
RunbookVersionTaskStepPropertiesFields defines nested fields for RunbookVersion.Task.StepProperties. | object |
No | - | - |
taskRecordDetails |
RunbookVersionTaskTaskRecordDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails. | object |
Yes | - | - |
Status.tasks[].outputVariableMappings[]¶
RunbookVersionTaskOutputVariableMappingFields defines nested fields for RunbookVersion.Task.OutputVariableMapping.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the input variable. | string |
Yes | - | - |
outputVariableDetails |
RunbookVersionTaskOutputVariableMappingOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails. | object |
Yes | - | - |
Status.tasks[].outputVariableMappings[].outputVariableDetails¶
RunbookVersionTaskOutputVariableMappingOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.OutputVariableMapping.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Status.tasks[].stepProperties¶
RunbookVersionTaskStepPropertiesFields defines nested fields for RunbookVersion.Task.StepProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionOnFailure |
The action to be taken in case of a failure. | string |
Yes | - | - |
notificationPreferences |
RunbookVersionTaskStepPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Task.StepProperties.NotificationPreferences. | object |
No | - | - |
pauseDetails |
RunbookVersionTaskStepPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.PauseDetails. | object |
No | - | - |
preCondition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
runOn |
RunbookVersionTaskStepPropertiesRunOnFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn. | object |
No | - | - |
Status.tasks[].stepProperties.notificationPreferences¶
RunbookVersionTaskStepPropertiesNotificationPreferencesFields defines nested fields for RunbookVersion.Task.StepProperties.NotificationPreferences.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
shouldNotifyOnPause |
Enables notification on pause. | boolean |
No | - | - |
shouldNotifyOnTaskFailure |
Enables or disables notification on Task Failures. | boolean |
No | - | - |
shouldNotifyOnTaskSuccess |
Enables or disables notification on Task Success. | boolean |
No | - | - |
Status.tasks[].stepProperties.pauseDetails¶
RunbookVersionTaskStepPropertiesPauseDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.PauseDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
durationInMinutes |
Time in minutes to apply Pause. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Status.tasks[].stepProperties.runOn¶
RunbookVersionTaskStepPropertiesRunOnFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
Build control flow conditions that determine the relevance of the task execution. | string |
No | - | - |
host |
OCID of the self hosted instance. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
previousTaskInstanceDetails |
Previous Task Instance Details | list[object] |
No | - | - |
Status.tasks[].stepProperties.runOn.previousTaskInstanceDetails[]¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableDetails |
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails. | object |
Yes | - | - |
resourceId |
Resource Ocid. | string |
Yes | - | - |
resourceType |
Resource Type. | string |
No | - | - |
Status.tasks[].stepProperties.runOn.previousTaskInstanceDetails[].outputVariableDetails¶
RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetailsFields defines nested fields for RunbookVersion.Task.StepProperties.RunOn.PreviousTaskInstanceDetail.OutputVariableDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outputVariableName |
The name of the output variable whose value has to be mapped. | string |
Yes | - | - |
stepName |
The name of the task step the output variable belongs to. | string |
Yes | - | - |
Status.tasks[].taskRecordDetails¶
RunbookVersionTaskTaskRecordDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the task. | string |
No | - | - |
executionDetails |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails. | object |
No | - | - |
isApplySubjectTask |
Is this an Apply Subject Task? Ex. Patch Execution Task | boolean |
No | - | - |
isCopyToLibraryEnabled |
Make a copy of this task in Library | boolean |
No | - | - |
isDiscoveryOutputTask |
Is this a discovery output task? | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the task | string |
No | - | - |
osType |
The OS for the task. | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
properties |
RunbookVersionTaskTaskRecordDetailsPropertiesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.Properties. | object |
No | - | - |
scope |
- | string |
No | - | - |
taskRecordId |
The ID of taskRecord. | string |
No | - | - |
Status.tasks[].taskRecordDetails.executionDetails¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
command |
Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. | string |
No | - | - |
configFile |
Catalog Id having config file. | string |
No | - | - |
content |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContentFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content. | object |
No | - | - |
credentials |
Credentials required for executing the task. | list[object] |
No | - | - |
endpoint |
Endpoint to be invoked. | string |
No | - | - |
executionType |
- | string |
No | - | - |
isExecutableContent |
Is the Content an executable file? | boolean |
No | - | - |
isLocked |
Is the script locked to prevent changes directly in Object Storage? | boolean |
No | - | - |
isReadOutputVariableEnabled |
Is read output variable enabled | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
systemVariables |
The list of system variables. | list[string] |
No | - | - |
targetCompartmentId |
OCID of the compartment to which the resource belongs to. | string |
No | - | - |
variables |
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables. | object |
No | - | - |
Status.tasks[].taskRecordDetails.executionDetails.content¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsContentFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.tasks[].taskRecordDetails.executionDetails.credentials[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsCredentialFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.tasks[].taskRecordDetails.executionDetails.variables¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputVariables |
The input variables for the task. | list[object] |
No | - | - |
outputVariables |
The list of output variables. | list[string] |
No | - | - |
Status.tasks[].taskRecordDetails.executionDetails.variables.inputVariables[]¶
RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariableFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.ExecutionDetails.Variables.InputVariable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the argument. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the argument. | string |
Yes | - | - |
type |
- | string |
No | - | - |
Status.tasks[].taskRecordDetails.properties¶
RunbookVersionTaskTaskRecordDetailsPropertiesFields defines nested fields for RunbookVersion.Task.TaskRecordDetails.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
numRetries |
The number of retries allowed. | integer |
Yes | - | - |
timeoutInSeconds |
The timeout in seconds for the task. | integer |
Yes | - | - |
SchedulerDefinition¶
SchedulerDefinition is the Schema for the schedulerdefinitions API.
Plural:schedulerdefinitionsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_schedulerdefinition.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
SchedulerDefinitionSpec defines the desired state of SchedulerDefinition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionGroups |
Action Groups associated with the Schedule. | list[object] |
Yes | - | - |
compartmentId |
Compartment OCID | 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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 |
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 | - | - |
runBooks |
Runbooks. | list[object] |
No | - | - |
schedule |
SchedulerDefinitionSchedule defines nested fields for SchedulerDefinition.Schedule. | object |
Yes | - | - |
Spec.actionGroups[]¶
Back to SchedulerDefinition spec
SchedulerDefinitionActionGroup defines nested fields for SchedulerDefinition.ActionGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
fleetId |
ID of the fleet | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
runbookId |
ID of the runbook | string |
No | - | - |
runbookVersionName |
Name of the runbook version | string |
No | - | - |
sequence |
Sequence of the Action Group. Action groups will be executed in a seuential order. All Action Groups having the same sequence will be executed parallely. If no value is provided a default value of 1 will be given. | integer |
No | - | - |
Spec.runBooks[]¶
Back to SchedulerDefinition spec
SchedulerDefinitionRunBook defines nested fields for SchedulerDefinition.RunBook.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputParameters |
Input Parameters for the Task | list[object] |
No | - | - |
runbookId |
The ID of the Runbook | string |
Yes | - | - |
runbookVersionName |
The runbook version name | string |
Yes | - | - |
Spec.runBooks[].inputParameters[]¶
Back to SchedulerDefinition spec
SchedulerDefinitionRunBookInputParameter defines nested fields for SchedulerDefinition.RunBook.InputParameter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
arguments |
Arguments for the Task | list[object] |
No | - | - |
stepName |
stepName for which the input parameters are provided | string |
Yes | - | - |
Spec.runBooks[].inputParameters[].arguments[]¶
Back to SchedulerDefinition spec
SchedulerDefinitionRunBookInputParameterArgument defines nested fields for SchedulerDefinition.RunBook.InputParameter.Argument.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
SchedulerDefinitionRunBookInputParameterArgumentContent defines nested fields for SchedulerDefinition.RunBook.InputParameter.Argument.Content. | object |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
name |
Name of the input variable | string |
Yes | - | - |
value |
The task input | string |
No | - | - |
Spec.runBooks[].inputParameters[].arguments[].content¶
Back to SchedulerDefinition spec
SchedulerDefinitionRunBookInputParameterArgumentContent defines nested fields for SchedulerDefinition.RunBook.InputParameter.Argument.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Spec.schedule¶
Back to SchedulerDefinition spec
SchedulerDefinitionSchedule defines nested fields for SchedulerDefinition.Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
duration |
Duration of the schedule. | string |
No | - | - |
executionStartdate |
Start Date for the schedule. An RFC3339 formatted datetime string | string |
Yes | - | - |
jsonData |
- | string |
No | - | - |
maintenanceWindowId |
Provide MaintenanceWindowId | string |
No | - | - |
recurrences |
Recurrence rule specification if recurring | string |
No | - | - |
type |
- | string |
No | - | - |
Status¶
SchedulerDefinitionStatus defines the observed state of SchedulerDefinition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionGroups |
Action Groups associated with the Schedule. | list[object] |
No | - | - |
compartmentId |
Compartment OCID | string |
No | - | - |
countOfAffectedActionGroups |
Count of Action Groups affected by the Schedule. | integer |
No | - | - |
countOfAffectedResources |
Count of Resources affected by the Schedule. | integer |
No | - | - |
countOfAffectedTargets |
Count of Targets affected by the Schedule. | integer |
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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | 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 |
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 OCID 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 Failed state. | string |
No | - | - |
lifecycleOperations |
All LifeCycle Operations that are part of the schedule. | list[string] |
No | - | - |
lifecycleState |
The current state of the SchedulerDefinition. | string |
No | - | - |
products |
All products that are part of the schedule for PRODUCT ActionGroup Type. | list[string] |
No | - | - |
resourceRegion |
Associated region | string |
No | - | - |
runBooks |
Runbooks. | list[object] |
No | - | - |
schedule |
SchedulerDefinitionSchedule defines nested fields for SchedulerDefinition.Schedule. | 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 | - | - |
timeOfNextRun |
The scheduled date for the next run of the Job. | string |
No | - | - |
timeUpdated |
The time this resource was last updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.actionGroups[]¶
Back to SchedulerDefinition status
SchedulerDefinitionActionGroup defines nested fields for SchedulerDefinition.ActionGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
fleetId |
ID of the fleet | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
runbookId |
ID of the runbook | string |
No | - | - |
runbookVersionName |
Name of the runbook version | string |
No | - | - |
sequence |
Sequence of the Action Group. Action groups will be executed in a seuential order. All Action Groups having the same sequence will be executed parallely. If no value is provided a default value of 1 will be given. | integer |
No | - | - |
Status.runBooks[]¶
Back to SchedulerDefinition status
SchedulerDefinitionRunBook defines nested fields for SchedulerDefinition.RunBook.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputParameters |
Input Parameters for the Task | list[object] |
No | - | - |
runbookId |
The ID of the Runbook | string |
Yes | - | - |
runbookVersionName |
The runbook version name | string |
Yes | - | - |
Status.runBooks[].inputParameters[]¶
Back to SchedulerDefinition status
SchedulerDefinitionRunBookInputParameter defines nested fields for SchedulerDefinition.RunBook.InputParameter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
arguments |
Arguments for the Task | list[object] |
No | - | - |
stepName |
stepName for which the input parameters are provided | string |
Yes | - | - |
Status.runBooks[].inputParameters[].arguments[]¶
Back to SchedulerDefinition status
SchedulerDefinitionRunBookInputParameterArgument defines nested fields for SchedulerDefinition.RunBook.InputParameter.Argument.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
SchedulerDefinitionRunBookInputParameterArgumentContent defines nested fields for SchedulerDefinition.RunBook.InputParameter.Argument.Content. | object |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
name |
Name of the input variable | string |
Yes | - | - |
value |
The task input | string |
No | - | - |
Status.runBooks[].inputParameters[].arguments[].content¶
Back to SchedulerDefinition status
SchedulerDefinitionRunBookInputParameterArgumentContent defines nested fields for SchedulerDefinition.RunBook.InputParameter.Argument.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.schedule¶
Back to SchedulerDefinition status
SchedulerDefinitionSchedule defines nested fields for SchedulerDefinition.Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
duration |
Duration of the schedule. | string |
No | - | - |
executionStartdate |
Start Date for the schedule. An RFC3339 formatted datetime string | string |
Yes | - | - |
jsonData |
- | string |
No | - | - |
maintenanceWindowId |
Provide MaintenanceWindowId | string |
No | - | - |
recurrences |
Recurrence rule specification if recurring | string |
No | - | - |
type |
- | string |
No | - | - |
Status.status¶
Back to SchedulerDefinition 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 SchedulerDefinition 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 SchedulerDefinition 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 SchedulerDefinition status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
TaskRecord¶
TaskRecord is the Schema for the taskrecords API.
Plural:taskrecordsScope:NamespacedAPIVersion:fleetappsmanagement.oracle.com/v1beta1Sample: Sample (config/samples/fleetappsmanagement_v1beta1_taskrecord.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
TaskRecordSpec defines the desired state of TaskRecord.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the compartment to which the resource belongs to. | 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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | string |
No | - | - |
details |
TaskRecordDetails defines nested fields for TaskRecord.Details. | object |
Yes | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
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 | - | - |
Spec.details¶
TaskRecordDetails defines nested fields for TaskRecord.Details.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
executionDetails |
TaskRecordDetailsExecutionDetails defines nested fields for TaskRecord.Details.ExecutionDetails. | object |
Yes | - | - |
isApplySubjectTask |
Is this an Apply Subject Task? Set this to true for a Patch Execution Task which applies patches(subjects) on a target. | boolean |
No | - | - |
isDiscoveryOutputTask |
Is this a discovery output task? | boolean |
No | - | - |
operation |
The lifecycle operation performed by the runbook. | string |
No | - | - |
osType |
The OS for the task | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
properties |
TaskRecordDetailsProperties defines nested fields for TaskRecord.Details.Properties. | object |
No | - | - |
scope |
The scope of the task | string |
Yes | - | - |
Spec.details.executionDetails¶
TaskRecordDetailsExecutionDetails defines nested fields for TaskRecord.Details.ExecutionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
command |
Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. | string |
No | - | - |
configFile |
Catalog Id having config file. | string |
No | - | - |
content |
TaskRecordDetailsExecutionDetailsContent defines nested fields for TaskRecord.Details.ExecutionDetails.Content. | object |
No | - | - |
credentials |
Credentials required for executing the task. | list[object] |
No | - | - |
endpoint |
Endpoint to be invoked. | string |
No | - | - |
executionType |
- | string |
No | - | - |
isExecutableContent |
Is the Content an executable file? | boolean |
No | - | - |
isLocked |
Is the script locked to prevent changes directly in Object Storage? | boolean |
No | - | - |
isReadOutputVariableEnabled |
Is read output variable enabled | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
systemVariables |
The list of system variables. | list[string] |
No | - | - |
targetCompartmentId |
OCID of the compartment to which the resource belongs to. | string |
No | - | - |
variables |
TaskRecordDetailsExecutionDetailsVariables defines nested fields for TaskRecord.Details.ExecutionDetails.Variables. | object |
No | - | - |
Spec.details.executionDetails.content¶
TaskRecordDetailsExecutionDetailsContent defines nested fields for TaskRecord.Details.ExecutionDetails.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Spec.details.executionDetails.credentials[]¶
TaskRecordDetailsExecutionDetailsCredential defines nested fields for TaskRecord.Details.ExecutionDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Spec.details.executionDetails.variables¶
TaskRecordDetailsExecutionDetailsVariables defines nested fields for TaskRecord.Details.ExecutionDetails.Variables.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputVariables |
The input variables for the task. | list[object] |
No | - | - |
outputVariables |
The list of output variables. | list[string] |
No | - | - |
Spec.details.executionDetails.variables.inputVariables[]¶
TaskRecordDetailsExecutionDetailsVariablesInputVariable defines nested fields for TaskRecord.Details.ExecutionDetails.Variables.InputVariable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the argument. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the argument. | string |
Yes | - | - |
type |
- | string |
No | - | - |
Spec.details.properties¶
TaskRecordDetailsProperties defines nested fields for TaskRecord.Details.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
numRetries |
The number of retries allowed. | integer |
Yes | - | - |
timeoutInSeconds |
The timeout in seconds for the task. | integer |
Yes | - | - |
Status¶
TaskRecordStatus defines the observed state of TaskRecord.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the compartment to which the resource belongs to. | 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 | - | - |
description |
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. | string |
No | - | - |
details |
TaskRecordDetails defines nested fields for TaskRecord.Details. | object |
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 |
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 OCID 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 Failed state. | string |
No | - | - |
lifecycleState |
The current state of the task record. | string |
No | - | - |
resourceRegion |
Associated region | string |
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 | - | - |
type |
Task type. | string |
No | - | - |
version |
The version of the task record. | string |
No | - | - |
Status.details¶
TaskRecordDetails defines nested fields for TaskRecord.Details.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
executionDetails |
TaskRecordDetailsExecutionDetails defines nested fields for TaskRecord.Details.ExecutionDetails. | object |
Yes | - | - |
isApplySubjectTask |
Is this an Apply Subject Task? Set this to true for a Patch Execution Task which applies patches(subjects) on a target. | boolean |
No | - | - |
isDiscoveryOutputTask |
Is this a discovery output task? | boolean |
No | - | - |
operation |
The lifecycle operation performed by the runbook. | string |
No | - | - |
osType |
The OS for the task | string |
No | - | - |
platform |
The platform of the runbook. | string |
No | - | - |
properties |
TaskRecordDetailsProperties defines nested fields for TaskRecord.Details.Properties. | object |
No | - | - |
scope |
The scope of the task | string |
Yes | - | - |
Status.details.executionDetails¶
TaskRecordDetailsExecutionDetails defines nested fields for TaskRecord.Details.ExecutionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
command |
Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. | string |
No | - | - |
configFile |
Catalog Id having config file. | string |
No | - | - |
content |
TaskRecordDetailsExecutionDetailsContent defines nested fields for TaskRecord.Details.ExecutionDetails.Content. | object |
No | - | - |
credentials |
Credentials required for executing the task. | list[object] |
No | - | - |
endpoint |
Endpoint to be invoked. | string |
No | - | - |
executionType |
- | string |
No | - | - |
isExecutableContent |
Is the Content an executable file? | boolean |
No | - | - |
isLocked |
Is the script locked to prevent changes directly in Object Storage? | boolean |
No | - | - |
isReadOutputVariableEnabled |
Is read output variable enabled | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
systemVariables |
The list of system variables. | list[string] |
No | - | - |
targetCompartmentId |
OCID of the compartment to which the resource belongs to. | string |
No | - | - |
variables |
TaskRecordDetailsExecutionDetailsVariables defines nested fields for TaskRecord.Details.ExecutionDetails.Variables. | object |
No | - | - |
Status.details.executionDetails.content¶
TaskRecordDetailsExecutionDetailsContent defines nested fields for TaskRecord.Details.ExecutionDetails.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket Name. | string |
No | - | - |
catalogId |
Catalog Id having terraform package. | string |
No | - | - |
checksum |
md5 checksum of the artifact. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespaceName |
Namespace. | string |
No | - | - |
objectName |
Object Name. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.details.executionDetails.credentials[]¶
TaskRecordDetailsExecutionDetailsCredential defines nested fields for TaskRecord.Details.ExecutionDetails.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
id |
The OCID of the resource. | string |
Yes | - | - |
Status.details.executionDetails.variables¶
TaskRecordDetailsExecutionDetailsVariables defines nested fields for TaskRecord.Details.ExecutionDetails.Variables.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inputVariables |
The input variables for the task. | list[object] |
No | - | - |
outputVariables |
The list of output variables. | list[string] |
No | - | - |
Status.details.executionDetails.variables.inputVariables[]¶
TaskRecordDetailsExecutionDetailsVariablesInputVariable defines nested fields for TaskRecord.Details.ExecutionDetails.Variables.InputVariable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description of the argument. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the argument. | string |
Yes | - | - |
type |
- | string |
No | - | - |
Status.details.properties¶
TaskRecordDetailsProperties defines nested fields for TaskRecord.Details.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
numRetries |
The number of retries allowed. | integer |
Yes | - | - |
timeoutInSeconds |
The timeout in seconds for the task. | integer |
Yes | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |