stackmonitoring.oracle.com/v1beta1¶
APIVersion: stackmonitoring.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 stackmonitoring.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| AlarmCondition | Namespaced | Sample | - |
| BaselineableMetric | Namespaced | Sample | - |
| Config | Namespaced | Sample | - |
| DiscoveryJob | Namespaced | Sample | - |
| MaintenanceWindow | Namespaced | Sample | - |
| MetricExtension | Namespaced | Sample | - |
| MonitoredResource | Namespaced | Sample | - |
| MonitoredResourceType | Namespaced | Sample | - |
| MonitoringTemplate | Namespaced | Sample | - |
| ProcessSet | Namespaced | Sample | - |
AlarmCondition¶
AlarmCondition is the Schema for the alarmconditions API.
Plural:alarmconditionsScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_alarmcondition.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
AlarmConditionSpec defines the desired state of AlarmCondition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compositeType |
The OCID of the composite resource type like EBS/PEOPLE_SOFT. | string |
No | - | - |
conditionType |
Type of defined monitoring template. | string |
Yes | - | - |
conditions |
Monitoring template conditions. | list[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 | - | - |
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 | - | - |
metricName |
The metric name. | string |
Yes | - | - |
namespace |
The stack monitoring service or application emitting the metric that is evaluated by the alarm. | string |
Yes | - | - |
resourceType |
The resource group OCID. | string |
Yes | - | - |
Spec.conditions[]¶
AlarmConditionCondition defines nested fields for AlarmCondition.Condition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
body |
The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. | string |
No | - | - |
query |
The Monitoring Query Language (MQL) expression to evaluate for the alarm. | string |
Yes | - | - |
severity |
Severity - Critical/Warning | string |
Yes | - | - |
shouldAppendNote |
Whether the note need to add into bottom of the body for mapping the alarms information with template or not. | boolean |
No | - | - |
shouldAppendUrl |
Whether the URL need to add into bottom of the body for mapping the alarms information with template or not. | boolean |
No | - | - |
triggerDelay |
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". | string |
No | - | - |
Status¶
AlarmConditionStatus defines the observed state of AlarmCondition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compositeType |
The OCID of the composite resource type like EBS/PEOPLE_SOFT. | string |
No | - | - |
conditionType |
Type of defined monitoring template. | string |
No | - | - |
conditions |
Monitoring template conditions | 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 | - | - |
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 Alarm Condition. | string |
No | - | - |
lifecycleState |
The current lifecycle state of the monitoring template | string |
No | - | - |
metricName |
The metric name. | string |
No | - | - |
monitoringTemplateId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitoring template. | string |
No | - | - |
namespace |
The stack monitoring service or application emitting the metric that is evaluated by the alarm. | string |
No | - | - |
resourceType |
The resource type OCID. | string |
No | - | - |
sdkStatus |
The current status of the monitoring template i.e. whether it is Published or Unpublished This uses a distinct JSON name so it can coexist with the OSOK status envelope. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time the alarm condition was created. Format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the alarm condition was updated. Format defined by RFC3339. | string |
No | - | - |
Status.conditions[]¶
AlarmConditionCondition defines nested fields for AlarmCondition.Condition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
body |
The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. | string |
No | - | - |
query |
The Monitoring Query Language (MQL) expression to evaluate for the alarm. | string |
Yes | - | - |
severity |
Severity - Critical/Warning | string |
Yes | - | - |
shouldAppendNote |
Whether the note need to add into bottom of the body for mapping the alarms information with template or not. | boolean |
No | - | - |
shouldAppendUrl |
Whether the URL need to add into bottom of the body for mapping the alarms information with template or not. | boolean |
No | - | - |
triggerDelay |
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". | 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 | - | - |
BaselineableMetric¶
BaselineableMetric is the Schema for the baselineablemetrics API.
Plural:baselineablemetricsScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_baselineablemetric.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
BaselineableMetricSpec defines the desired state of BaselineableMetric.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
column |
metric column name | string |
Yes | - | - |
compartmentId |
OCID of the compartment | 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 | - | - |
id |
OCID of the metric | string |
Yes | - | - |
isOutOfBox |
Is the metric created out of box, default false | boolean |
Yes | - | - |
lifecycleState |
The current lifecycle state of the metric extension | string |
No | - | - |
name |
name of the metric | string |
No | - | - |
namespace |
namespace of the metric | string |
Yes | - | - |
resourceGroup |
Resource group of the metric | string |
No | - | - |
resourceType |
Resource type of the metric | string |
No | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
tenancyId |
OCID of the tenancy | string |
No | - | - |
Status¶
BaselineableMetricStatus defines the observed state of BaselineableMetric.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
column |
metric column name | string |
No | - | - |
compartmentId |
OCID of the compartment | string |
No | - | - |
createdBy |
Created user id | 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 | - | - |
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 |
OCID of the metric | string |
No | - | - |
isOutOfBox |
Is the metric created out of box, default false | boolean |
No | - | - |
lastUpdatedBy |
last Updated user id | string |
No | - | - |
lifecycleState |
The current lifecycle state of the metric extension | string |
No | - | - |
name |
name of the metric | string |
No | - | - |
namespace |
namespace of the metric | string |
No | - | - |
resourceGroup |
Resource group of the metric | string |
No | - | - |
resourceType |
Resource type of the metric | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
tenancyId |
OCID of the tenancy | string |
No | - | - |
timeCreated |
creation date | string |
No | - | - |
timeLastUpdated |
last updated time | string |
No | - | - |
Status.status¶
Back to BaselineableMetric 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 BaselineableMetric 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 BaselineableMetric 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 BaselineableMetric status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Config¶
Config is the Schema for the configs API.
Plural:configsScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_config.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ConfigSpec defines the desired state of Config.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalConfigurations |
ConfigAdditionalConfigurations defines nested fields for Config.AdditionalConfigurations. | object |
No | - | - |
compartmentId |
Compartment in which the configuration is created. | string |
Yes | - | - |
configType |
- | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
The display name of the configuration. | string |
No | - | - |
dynamicGroups |
List of dynamic groups dedicated for Stack Monitoring. | list[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 | - | - |
isEnabled |
True if automatic promotion is enabled, false if it is not enabled. | boolean |
No | - | - |
isManuallyOnboarded |
True if customer decides marks configuration as manually configured. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
license |
License edition. | string |
No | - | - |
policyNames |
List of policy names assigned for onboarding | list[string] |
No | - | - |
resourceType |
The type of resource to configure for automatic promotion. | string |
No | - | - |
userGroups |
List of user groups dedicated for Stack Monitoring. | list[object] |
No | - | - |
version |
Assigned version to given onboard configuration. | string |
No | - | - |
Spec.additionalConfigurations¶
ConfigAdditionalConfigurations defines nested fields for Config.AdditionalConfigurations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[string, string] |
No | - | - |
Spec.dynamicGroups[]¶
ConfigDynamicGroup defines nested fields for Config.DynamicGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domain |
Identity domain name | string |
No | - | - |
name |
Name of dynamic Group | string |
Yes | - | - |
stackMonitoringAssignment |
Assignment of dynamic group in context of Stack Monitoring service. It describes the purpose of dynamic groups in Stack Monitoring. | string |
Yes | - | - |
Spec.userGroups[]¶
ConfigUserGroup defines nested fields for Config.UserGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domain |
Identity domain name | string |
No | - | - |
name |
Name of user Group | string |
Yes | - | - |
stackMonitoringRole |
Role assigned to user group in context of Stack Monitoring service. Access role can be for example: ADMINISTRATOR, OPERATOR, VIEWER, any other access role | string |
Yes | - | - |
Status¶
ConfigStatus defines the observed state of Config.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalConfigurations |
ConfigAdditionalConfigurations defines nested fields for Config.AdditionalConfigurations. | object |
No | - | - |
compartmentId |
The OCID of the compartment containing the configuration. | string |
No | - | - |
configType |
- | 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. | string |
No | - | - |
dynamicGroups |
List of dynamic groups dedicated for Stack Monitoring. | list[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 | - | - |
id |
The Unique Oracle ID (OCID) that is immutable on creation. | string |
No | - | - |
isEnabled |
True if enterprise extensibility is enabled, false if it is not enabled. | boolean |
No | - | - |
isManuallyOnboarded |
True if customer decides marks configuration as manually configured. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
license |
License edition. | string |
No | - | - |
lifecycleState |
The current state of the configuration. | string |
No | - | - |
policyNames |
List of policy names assigned for onboarding | list[string] |
No | - | - |
resourceType |
The type of resource to configure for automatic promotion. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The time the configuration was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
The time the Config was updated. | string |
No | - | - |
userGroups |
List of user groups dedicated for Stack Monitoring. | list[object] |
No | - | - |
version |
Assigned version to given onboard configuration. | string |
No | - | - |
Status.additionalConfigurations¶
ConfigAdditionalConfigurations defines nested fields for Config.AdditionalConfigurations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[string, string] |
No | - | - |
Status.dynamicGroups[]¶
ConfigDynamicGroup defines nested fields for Config.DynamicGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domain |
Identity domain name | string |
No | - | - |
name |
Name of dynamic Group | string |
Yes | - | - |
stackMonitoringAssignment |
Assignment of dynamic group in context of Stack Monitoring service. It describes the purpose of dynamic groups in Stack Monitoring. | 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 | - | - |
Status.userGroups[]¶
ConfigUserGroup defines nested fields for Config.UserGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
domain |
Identity domain name | string |
No | - | - |
name |
Name of user Group | string |
Yes | - | - |
stackMonitoringRole |
Role assigned to user group in context of Stack Monitoring service. Access role can be for example: ADMINISTRATOR, OPERATOR, VIEWER, any other access role | string |
Yes | - | - |
DiscoveryJob¶
DiscoveryJob is the Schema for the discoveryjobs API.
Plural:discoveryjobsScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_discoveryjob.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DiscoveryJobSpec defines the desired state of DiscoveryJob.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID of Compartment | 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 | - | - |
discoveryClient |
Client who submits discovery job. | string |
No | - | - |
discoveryDetails |
DiscoveryJobDiscoveryDetails defines nested fields for DiscoveryJob.DiscoveryDetails. | object |
Yes | - | - |
discoveryType |
Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources. | 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 | - | - |
shouldPropagateTagsToDiscoveredResources |
If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true. | boolean |
No | - | - |
Spec.discoveryDetails¶
DiscoveryJobDiscoveryDetails defines nested fields for DiscoveryJob.DiscoveryDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentId |
The OCID of Management Agent | string |
Yes | - | - |
credentials |
DiscoveryJobDiscoveryDetailsCredentials defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials. | object |
No | - | - |
license |
License edition of the monitored resource. | string |
No | - | - |
properties |
DiscoveryJobDiscoveryDetailsProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Properties. | object |
Yes | - | - |
resourceName |
The Name of resource type | string |
Yes | - | - |
resourceType |
Resource Type. | string |
Yes | - | - |
tags |
DiscoveryJobDiscoveryDetailsTags defines nested fields for DiscoveryJob.DiscoveryDetails.Tags. | object |
No | - | - |
Spec.discoveryDetails.credentials¶
DiscoveryJobDiscoveryDetailsCredentials defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
List of DiscoveryJob credentials. | list[object] |
Yes | - | - |
Spec.discoveryDetails.credentials.items[]¶
DiscoveryJobDiscoveryDetailsCredentialsItem defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialName |
Name of Credential | string |
Yes | - | - |
credentialType |
Name of Credential Type | string |
Yes | - | - |
properties |
DiscoveryJobDiscoveryDetailsCredentialsItemProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.Item.Properties. | object |
Yes | - | - |
Spec.discoveryDetails.credentials.items[].properties¶
DiscoveryJobDiscoveryDetailsCredentialsItemProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.Item.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[string, string] |
No | - | - |
Spec.discoveryDetails.properties¶
DiscoveryJobDiscoveryDetailsProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[string, string] |
No | - | - |
Spec.discoveryDetails.tags¶
DiscoveryJobDiscoveryDetailsTags defines nested fields for DiscoveryJob.DiscoveryDetails.Tags.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[string, string] |
No | - | - |
Status¶
DiscoveryJobStatus defines the observed state of DiscoveryJob.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID of the Compartment | 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 | - | - |
discoveryClient |
Client who submits discovery job. | string |
No | - | - |
discoveryDetails |
DiscoveryJobDiscoveryDetails defines nested fields for DiscoveryJob.DiscoveryDetails. | object |
No | - | - |
discoveryType |
Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources. | 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 Discovery job | string |
No | - | - |
license |
License edition of the monitored resource. | string |
No | - | - |
lifecycleState |
The current state of the DiscoveryJob Resource. | string |
No | - | - |
resourceName |
The name of resource type | string |
No | - | - |
resourceType |
Resource Type | string |
No | - | - |
sdkStatus |
Specifies the status of the discovery job This uses a distinct JSON name so it can coexist with the OSOK status envelope. | string |
No | - | - |
status |
- | object |
Yes | - | - |
statusMessage |
The short summary of the status of the discovery job | string |
No | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
tenantId |
The OCID of Tenant | string |
No | - | - |
timeUpdated |
The time the discovery Job was updated. | string |
No | - | - |
userId |
The OCID of user in which the job is submitted | string |
No | - | - |
Status.discoveryDetails¶
DiscoveryJobDiscoveryDetails defines nested fields for DiscoveryJob.DiscoveryDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentId |
The OCID of Management Agent | string |
Yes | - | - |
credentials |
DiscoveryJobDiscoveryDetailsCredentials defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials. | object |
No | - | - |
license |
License edition of the monitored resource. | string |
No | - | - |
properties |
DiscoveryJobDiscoveryDetailsProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Properties. | object |
Yes | - | - |
resourceName |
The Name of resource type | string |
Yes | - | - |
resourceType |
Resource Type. | string |
Yes | - | - |
tags |
DiscoveryJobDiscoveryDetailsTags defines nested fields for DiscoveryJob.DiscoveryDetails.Tags. | object |
No | - | - |
Status.discoveryDetails.credentials¶
DiscoveryJobDiscoveryDetailsCredentials defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
List of DiscoveryJob credentials. | list[object] |
Yes | - | - |
Status.discoveryDetails.credentials.items[]¶
DiscoveryJobDiscoveryDetailsCredentialsItem defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialName |
Name of Credential | string |
Yes | - | - |
credentialType |
Name of Credential Type | string |
Yes | - | - |
properties |
DiscoveryJobDiscoveryDetailsCredentialsItemProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.Item.Properties. | object |
Yes | - | - |
Status.discoveryDetails.credentials.items[].properties¶
DiscoveryJobDiscoveryDetailsCredentialsItemProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Credentials.Item.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[string, string] |
No | - | - |
Status.discoveryDetails.properties¶
DiscoveryJobDiscoveryDetailsProperties defines nested fields for DiscoveryJob.DiscoveryDetails.Properties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[string, string] |
No | - | - |
Status.discoveryDetails.tags¶
DiscoveryJobDiscoveryDetailsTags defines nested fields for DiscoveryJob.DiscoveryDetails.Tags.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
propertiesMap |
Key/Value pair of Property | map[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:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_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 Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 |
Maintenance Window description. | 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 |
Maintenance Window name. | string |
Yes | - | - |
resources |
List of resource Ids which are part of the Maintenance Window | list[object] |
Yes | - | - |
schedule |
MaintenanceWindowSchedule defines nested fields for MaintenanceWindow.Schedule. | object |
Yes | - | - |
Spec.resources[]¶
Back to MaintenanceWindow spec
MaintenanceWindowResource defines nested fields for MaintenanceWindow.Resource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areMembersIncluded |
Flag to indicate if the members of the resource has to be include in the Maintenance Window. | boolean |
No | - | - |
resourceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored resource part of the Maintenance window. | string |
Yes | - | - |
Spec.schedule¶
Back to MaintenanceWindow spec
MaintenanceWindowSchedule defines nested fields for MaintenanceWindow.Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
maintenanceWindowDuration |
Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format. | string |
No | - | - |
maintenanceWindowRecurrences |
A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStart value. BYMINUTE: Specifies the start minute of each reccurrence after timeMaintenanceWindowStart value. The default value is 00 BYSECOND: Specifies the start second of each reccurrence after timeMaintenanceWindowStart value. The default value is 00 Other Rules are not supported. |
string |
No | - | - |
scheduleType |
- | string |
No | - | - |
timeMaintenanceWindowEnd |
Start time of Maintenance window. A RFC3339 formatted datetime string | string |
No | - | - |
timeMaintenanceWindowStart |
Start time of Maintenance window. A RFC3339 formatted datetime string | string |
No | - | - |
Status¶
MaintenanceWindowStatus defines the observed state of MaintenanceWindow.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 |
Maintenance Window description. | 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 maintenance window. | string |
No | - | - |
lifecycleDetails |
Lifecycle Details of the Maintenance Window. | string |
No | - | - |
lifecycleState |
Lifecycle state of the monitored resource. | string |
No | - | - |
name |
Maintenance Window name. | string |
No | - | - |
numberOfResources |
Number of resources of the Maintenance window. | integer |
No | - | - |
operationStatus |
Status of the most recent operation of the Maintenance Window. | string |
No | - | - |
operationType |
The name of the most recent operation of the Maintenance window. | string |
No | - | - |
resources |
List of resource Ids which are part of the Maintenance Window | list[object] |
No | - | - |
resourcesDetails |
List of resource details that are part of the Maintenance Window. | list[object] |
No | - | - |
schedule |
MaintenanceWindowSchedule defines nested fields for MaintenanceWindow.Schedule. | object |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The time the the maintenance window was created. An RFC3339 formatted datetime string | string |
No | - | - |
timeUpdated |
The time the the mainteance window was updated. An RFC3339 formatted datetime string | string |
No | - | - |
Status.resources[]¶
Back to MaintenanceWindow status
MaintenanceWindowResource defines nested fields for MaintenanceWindow.Resource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areMembersIncluded |
Flag to indicate if the members of the resource has to be include in the Maintenance Window. | boolean |
No | - | - |
resourceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored resource part of the Maintenance window. | string |
Yes | - | - |
Status.resourcesDetails[]¶
Back to MaintenanceWindow status
MaintenanceWindowResourcesDetail defines nested fields for MaintenanceWindow.ResourcesDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the monitored resource | string |
No | - | - |
numberOfMembers |
Number of members of the resource | integer |
No | - | - |
resourceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored resource part of the Maintenance window. | string |
No | - | - |
type |
Type of the monitored resource | string |
No | - | - |
Status.schedule¶
Back to MaintenanceWindow status
MaintenanceWindowSchedule defines nested fields for MaintenanceWindow.Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
maintenanceWindowDuration |
Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format. | string |
No | - | - |
maintenanceWindowRecurrences |
A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStart value. BYMINUTE: Specifies the start minute of each reccurrence after timeMaintenanceWindowStart value. The default value is 00 BYSECOND: Specifies the start second of each reccurrence after timeMaintenanceWindowStart value. The default value is 00 Other Rules are not supported. |
string |
No | - | - |
scheduleType |
- | string |
No | - | - |
timeMaintenanceWindowEnd |
Start time of Maintenance window. A RFC3339 formatted datetime string | string |
No | - | - |
timeMaintenanceWindowStart |
Start time of Maintenance window. A 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 | - | - |
MetricExtension¶
MetricExtension is the Schema for the metricextensions API.
Plural:metricextensionsScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_metricextension.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
MetricExtensionSpec defines the desired state of MetricExtension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
collectionRecurrences |
Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1 | string |
Yes | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) | string |
Yes | - | - |
description |
Description of the metric extension. | string |
No | - | - |
displayName |
Metric Extension display name. | string |
Yes | - | - |
metricList |
List of metrics which are part of this metric extension | list[object] |
Yes | - | - |
name |
Metric Extension Resource name. | string |
Yes | - | - |
queryProperties |
MetricExtensionQueryProperties defines nested fields for MetricExtension.QueryProperties. | object |
Yes | - | - |
resourceType |
Resource type to which Metric Extension applies | string |
Yes | - | - |
Spec.metricList[]¶
MetricExtensionMetricList defines nested fields for MetricExtension.MetricList.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
computeExpression |
Compute Expression to calculate the value of this metric | string |
No | - | - |
dataType |
Data type of value of this metric | string |
Yes | - | - |
displayName |
Display name of the metric. | string |
No | - | - |
isDimension |
Current metric need to be included as dimension or not | boolean |
No | - | - |
isHidden |
Flag to marks whether a metric has to be uploaded or not. When isHidden = false -> Metric is uploaded, isHidden = true -> Metric is NOT uploaded | boolean |
No | - | - |
metricCategory |
Metric category | string |
No | - | - |
name |
Name of the metric. | string |
Yes | - | - |
unit |
Unit of metric value | string |
No | - | - |
Spec.queryProperties¶
MetricExtensionQueryProperties defines nested fields for MetricExtension.QueryProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
arguments |
Arguments required by either command or script | string |
No | - | - |
autoRowPrefix |
Prefix for an auto generated metric, in case multiple rows with non unique key values are returned | string |
No | - | - |
collectionMethod |
- | string |
No | - | - |
command |
OS command to execute without arguments | string |
No | - | - |
delimiter |
Character used to delimit multiple metric values in single line of output | string |
No | - | - |
identityMetric |
Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics | string |
No | - | - |
inParamDetails |
List of values and position of PL/SQL procedure IN parameters | list[object] |
No | - | - |
isMetricServiceEnabled |
Indicates if Metric Service is enabled on server domain | boolean |
No | - | - |
jmxAttributes |
List of JMX attributes or Metric Service Table columns separated by semi-colon | string |
No | - | - |
jsonData |
- | string |
No | - | - |
managedBeanQuery |
JMX Managed Bean Query or Metric Service Table name | string |
No | - | - |
outParamDetails |
MetricExtensionQueryPropertiesOutParamDetails defines nested fields for MetricExtension.QueryProperties.OutParamDetails. | object |
No | - | - |
protocolType |
Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL | string |
No | - | - |
responseContentType |
Type of content response given by the http(s) URL | string |
No | - | - |
scriptDetails |
MetricExtensionQueryPropertiesScriptDetails defines nested fields for MetricExtension.QueryProperties.ScriptDetails. | object |
No | - | - |
sqlDetails |
MetricExtensionQueryPropertiesSqlDetails defines nested fields for MetricExtension.QueryProperties.SqlDetails. | object |
No | - | - |
sqlType |
Type of SQL data collection method i.e. either a Statement or SQL Script File | string |
No | - | - |
startsWith |
String prefix used to identify metric output of the OS Command | string |
No | - | - |
url |
Http(s) end point URL | string |
No | - | - |
Spec.queryProperties.inParamDetails[]¶
MetricExtensionQueryPropertiesInParamDetail defines nested fields for MetricExtension.QueryProperties.InParamDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inParamPosition |
Position of IN parameter | integer |
Yes | - | - |
inParamValue |
Value of IN parameter | string |
Yes | - | - |
Spec.queryProperties.outParamDetails¶
MetricExtensionQueryPropertiesOutParamDetails defines nested fields for MetricExtension.QueryProperties.OutParamDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outParamName |
Name of the Out Parameter | string |
No | - | - |
outParamPosition |
Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value. | integer |
Yes | - | - |
outParamType |
SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored. | string |
Yes | - | - |
Spec.queryProperties.scriptDetails¶
MetricExtensionQueryPropertiesScriptDetails defines nested fields for MetricExtension.QueryProperties.ScriptDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
Content of the script file as base64 encoded string | string |
Yes | - | - |
name |
Name of the script file | string |
Yes | - | - |
Spec.queryProperties.sqlDetails¶
MetricExtensionQueryPropertiesSqlDetails defines nested fields for MetricExtension.QueryProperties.SqlDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
Sql statement or script file content as base64 encoded string | string |
Yes | - | - |
scriptFileName |
If a script needs to be executed, then provide file name of the script | string |
No | - | - |
Status¶
MetricExtensionStatus defines the observed state of MetricExtension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
collectionMethod |
Collection Method Metric Extension applies | string |
No | - | - |
collectionRecurrences |
Schedule of metric extension should use RFC 5545 format -> recur-rule-part = "FREQ";"INTERVAL" where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1 | string |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) | string |
No | - | - |
createdBy |
Created by user | string |
No | - | - |
description |
Description of the metric extension. | string |
No | - | - |
displayName |
Metric Extension resource display name | string |
No | - | - |
enabledOnResources |
List of resource details objects having resourceIds on which this metric extension is enabled. | list[object] |
No | - | - |
enabledOnResourcesCount |
Count of resources on which this metric extension is enabled. | integer |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Metric Extension resource | string |
No | - | - |
lastUpdatedBy |
Last updated by user | string |
No | - | - |
lifecycleState |
The current lifecycle state of the metric extension | string |
No | - | - |
metricList |
List of metrics which are part of this metric extension | list[object] |
No | - | - |
name |
Metric Extension resource name | string |
No | - | - |
queryProperties |
MetricExtensionQueryProperties defines nested fields for MetricExtension.QueryProperties. | object |
No | - | - |
resourceType |
Resource type to which Metric Extension applies | string |
No | - | - |
resourceUri |
The URI path that the user can do a GET on to access the metric extension metadata | string |
No | - | - |
sdkStatus |
The current status of the metric extension i.e. whether it is Draft or Published This uses a distinct JSON name so it can coexist with the OSOK status envelope. | string |
No | - | - |
status |
- | object |
Yes | - | - |
tenantId |
Tenant Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) | string |
No | - | - |
timeCreated |
Metric Extension creation time. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
Metric Extension update time. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.enabledOnResources[]¶
Back to MetricExtension status
MetricExtensionEnabledOnResource defines nested fields for MetricExtension.EnabledOnResource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
resourceId |
The OCID of the resource on which Metric Extension is enabled | string |
No | - | - |
Status.metricList[]¶
Back to MetricExtension status
MetricExtensionMetricList defines nested fields for MetricExtension.MetricList.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
computeExpression |
Compute Expression to calculate the value of this metric | string |
No | - | - |
dataType |
Data type of value of this metric | string |
Yes | - | - |
displayName |
Display name of the metric. | string |
No | - | - |
isDimension |
Current metric need to be included as dimension or not | boolean |
No | - | - |
isHidden |
Flag to marks whether a metric has to be uploaded or not. When isHidden = false -> Metric is uploaded, isHidden = true -> Metric is NOT uploaded | boolean |
No | - | - |
metricCategory |
Metric category | string |
No | - | - |
name |
Name of the metric. | string |
Yes | - | - |
unit |
Unit of metric value | string |
No | - | - |
Status.queryProperties¶
Back to MetricExtension status
MetricExtensionQueryProperties defines nested fields for MetricExtension.QueryProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
arguments |
Arguments required by either command or script | string |
No | - | - |
autoRowPrefix |
Prefix for an auto generated metric, in case multiple rows with non unique key values are returned | string |
No | - | - |
collectionMethod |
- | string |
No | - | - |
command |
OS command to execute without arguments | string |
No | - | - |
delimiter |
Character used to delimit multiple metric values in single line of output | string |
No | - | - |
identityMetric |
Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics | string |
No | - | - |
inParamDetails |
List of values and position of PL/SQL procedure IN parameters | list[object] |
No | - | - |
isMetricServiceEnabled |
Indicates if Metric Service is enabled on server domain | boolean |
No | - | - |
jmxAttributes |
List of JMX attributes or Metric Service Table columns separated by semi-colon | string |
No | - | - |
jsonData |
- | string |
No | - | - |
managedBeanQuery |
JMX Managed Bean Query or Metric Service Table name | string |
No | - | - |
outParamDetails |
MetricExtensionQueryPropertiesOutParamDetails defines nested fields for MetricExtension.QueryProperties.OutParamDetails. | object |
No | - | - |
protocolType |
Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL | string |
No | - | - |
responseContentType |
Type of content response given by the http(s) URL | string |
No | - | - |
scriptDetails |
MetricExtensionQueryPropertiesScriptDetails defines nested fields for MetricExtension.QueryProperties.ScriptDetails. | object |
No | - | - |
sqlDetails |
MetricExtensionQueryPropertiesSqlDetails defines nested fields for MetricExtension.QueryProperties.SqlDetails. | object |
No | - | - |
sqlType |
Type of SQL data collection method i.e. either a Statement or SQL Script File | string |
No | - | - |
startsWith |
String prefix used to identify metric output of the OS Command | string |
No | - | - |
url |
Http(s) end point URL | string |
No | - | - |
Status.queryProperties.inParamDetails[]¶
Back to MetricExtension status
MetricExtensionQueryPropertiesInParamDetail defines nested fields for MetricExtension.QueryProperties.InParamDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
inParamPosition |
Position of IN parameter | integer |
Yes | - | - |
inParamValue |
Value of IN parameter | string |
Yes | - | - |
Status.queryProperties.outParamDetails¶
Back to MetricExtension status
MetricExtensionQueryPropertiesOutParamDetails defines nested fields for MetricExtension.QueryProperties.OutParamDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
outParamName |
Name of the Out Parameter | string |
No | - | - |
outParamPosition |
Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value. | integer |
Yes | - | - |
outParamType |
SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored. | string |
Yes | - | - |
Status.queryProperties.scriptDetails¶
Back to MetricExtension status
MetricExtensionQueryPropertiesScriptDetails defines nested fields for MetricExtension.QueryProperties.ScriptDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
Content of the script file as base64 encoded string | string |
Yes | - | - |
name |
Name of the script file | string |
Yes | - | - |
Status.queryProperties.sqlDetails¶
Back to MetricExtension status
MetricExtensionQueryPropertiesSqlDetails defines nested fields for MetricExtension.QueryProperties.SqlDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
Sql statement or script file content as base64 encoded string | string |
Yes | - | - |
scriptFileName |
If a script needs to be executed, then provide file name of the script | string |
No | - | - |
Status.status¶
Back to MetricExtension 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 MetricExtension 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 MetricExtension 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 MetricExtension status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
MonitoredResource¶
MonitoredResource is the Schema for the monitoredresources API.
Plural:monitoredresourcesScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_monitoredresource.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
MonitoredResourceSpec defines the desired state of MonitoredResource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalAliases |
List of MonitoredResourceAliasCredentials. This property complements the existing "aliases" property by allowing user to specify more than one credential alias. If both "aliases" and "additionalAliases" are specified, union of the values is used as list of aliases applicable for this resource. If any duplicate found in the combined list of "alias" and "additionalAliases", an error will be thrown. | list[object] |
No | - | - |
additionalCredentials |
List of MonitoredResourceCredentials. This property complements the existing "credentials" property by allowing user to specify more than one credential. If both "credential" and "additionalCredentials" are specified, union of the values is used as list of credentials applicable for this resource. If any duplicate found in the combined list of "credentials" and "additionalCredentials", an error will be thrown. | list[object] |
No | - | - |
aliases |
MonitoredResourceAliases defines nested fields for MonitoredResource.Aliases. | object |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
Yes | - | - |
credentials |
MonitoredResourceCredentials defines nested fields for MonitoredResource.Credentials. | object |
No | - | - |
databaseConnectionDetails |
MonitoredResourceDatabaseConnectionDetails defines nested fields for MonitoredResource.DatabaseConnectionDetails. | 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 | - | - |
displayName |
Monitored resource display name. | string |
No | - | - |
externalId |
External resource is any OCI resource identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) which is not a Stack Monitoring service resource. Currently supports only OCI compute instance. | 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 | - | - |
hostName |
Host name of the monitored resource. | string |
No | - | - |
license |
License edition of the monitored resource. If not provided the default license type for the compartment will be used. | string |
No | - | - |
managementAgentId |
Management Agent Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
name |
Monitored Resource Name. | string |
Yes | - | - |
properties |
List of monitored resource properties. | list[object] |
No | - | - |
resourceTimeZone |
Time zone in the form of tz database canonical zone ID. Specifies the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles | string |
No | - | - |
type |
Monitored Resource Type. | string |
Yes | - | - |
Spec.additionalAliases[]¶
Back to MonitoredResource spec
MonitoredResourceAdditionalAliase defines nested fields for MonitoredResource.AdditionalAliase.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credential |
MonitoredResourceAdditionalAliaseCredential defines nested fields for MonitoredResource.AdditionalAliase.Credential. | object |
Yes | - | - |
name |
The name of the alias, within the context of the source. | string |
Yes | - | - |
source |
The source type and source name combination,delimited with (.) separator. Example: {source type}.{source name} and source type max char limit is 63. | string |
Yes | - | - |
Spec.additionalAliases[].credential¶
Back to MonitoredResource spec
MonitoredResourceAdditionalAliaseCredential defines nested fields for MonitoredResource.AdditionalAliase.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the pre-existing source credential which alias cred should point to. This should refer to the pre-existing source attribute which is bound to credential name. | string |
Yes | - | - |
service |
The name of the service owning the credential. Example: stack-monitoring or dbmgmt | string |
Yes | - | - |
source |
The source type and source name combination,delimited with (.) separator. This refers to the pre-existing source which alias cred should point to. Ex. {source type}.{source name} and source type max char limit is 63. | string |
Yes | - | - |
Spec.additionalCredentials[]¶
Back to MonitoredResource spec
MonitoredResourceAdditionalCredential defines nested fields for MonitoredResource.AdditionalCredential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
description |
The user-specified textual description of the credential. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
The master key should be created in OCI Vault owned by the client of this API. The user should have permission to access the vault key. | string |
No | - | - |
name |
The name of the credential, within the context of the source. | string |
No | - | - |
properties |
The credential properties list. Credential property values will be encrypted format. | list[object] |
No | - | - |
source |
The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. | string |
No | - | - |
type |
The type of the credential ( ex. JMXCreds,DBCreds). | string |
No | - | - |
Spec.additionalCredentials[].properties[]¶
Back to MonitoredResource spec
MonitoredResourceAdditionalCredentialProperty defines nested fields for MonitoredResource.AdditionalCredential.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the credential property, should confirm with names of properties of this credential's type. Example: For JMXCreds type, credential property name for weblogic user is 'Username'. | string |
Yes | - | - |
value |
The value of the credential property name. Example: For JMXCreds type, credential property value for 'Username' property is 'weblogic'. | string |
Yes | - | - |
Spec.aliases¶
Back to MonitoredResource spec
MonitoredResourceAliases defines nested fields for MonitoredResource.Aliases.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credential |
MonitoredResourceAliasesCredential defines nested fields for MonitoredResource.Aliases.Credential. | object |
Yes | - | - |
name |
The name of the alias, within the context of the source. | string |
Yes | - | - |
source |
The source type and source name combination,delimited with (.) separator. Example: {source type}.{source name} and source type max char limit is 63. | string |
Yes | - | - |
Spec.aliases.credential¶
Back to MonitoredResource spec
MonitoredResourceAliasesCredential defines nested fields for MonitoredResource.Aliases.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the pre-existing source credential which alias cred should point to. This should refer to the pre-existing source attribute which is bound to credential name. | string |
Yes | - | - |
service |
The name of the service owning the credential. Example: stack-monitoring or dbmgmt | string |
Yes | - | - |
source |
The source type and source name combination,delimited with (.) separator. This refers to the pre-existing source which alias cred should point to. Ex. {source type}.{source name} and source type max char limit is 63. | string |
Yes | - | - |
Spec.credentials¶
Back to MonitoredResource spec
MonitoredResourceCredentials defines nested fields for MonitoredResource.Credentials.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
description |
The user-specified textual description of the credential. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
The master key should be created in OCI Vault owned by the client of this API. The user should have permission to access the vault key. | string |
No | - | - |
name |
The name of the credential, within the context of the source. | string |
No | - | - |
properties |
The credential properties list. Credential property values will be encrypted format. | list[object] |
No | - | - |
source |
The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. | string |
No | - | - |
type |
The type of the credential ( ex. JMXCreds,DBCreds). | string |
No | - | - |
Spec.credentials.properties[]¶
Back to MonitoredResource spec
MonitoredResourceCredentialsProperty defines nested fields for MonitoredResource.Credentials.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the credential property, should confirm with names of properties of this credential's type. Example: For JMXCreds type, credential property name for weblogic user is 'Username'. | string |
Yes | - | - |
value |
The value of the credential property name. Example: For JMXCreds type, credential property value for 'Username' property is 'weblogic'. | string |
Yes | - | - |
Spec.databaseConnectionDetails¶
Back to MonitoredResource spec
MonitoredResourceDatabaseConnectionDetails defines nested fields for MonitoredResource.DatabaseConnectionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
connectorId |
Database connector Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
dbId |
dbId of the database. | string |
No | - | - |
dbUniqueName |
UniqueName used for database connection requests. | string |
No | - | - |
port |
Listener Port number used for connection requests. | integer |
Yes | - | - |
protocol |
Protocol used in DB connection string when connecting to external database service. | string |
Yes | - | - |
serviceName |
Service name used for connection requests. | string |
Yes | - | - |
sslSecretId |
SSL Secret Identifier for TCPS connector in OCI VaultOCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
Spec.properties[]¶
Back to MonitoredResource spec
MonitoredResourceProperty defines nested fields for MonitoredResource.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Property Name. | string |
No | - | - |
value |
Property Value. | string |
No | - | - |
Status¶
MonitoredResourceStatus defines the observed state of MonitoredResource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
aliases |
MonitoredResourceAliases defines nested fields for MonitoredResource.Aliases. | object |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
credentials |
MonitoredResourceCredentials defines nested fields for MonitoredResource.Credentials. | object |
No | - | - |
databaseConnectionDetails |
MonitoredResourceDatabaseConnectionDetails defines nested fields for MonitoredResource.DatabaseConnectionDetails. | 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 | - | - |
displayName |
Monitored resource display name. | string |
No | - | - |
externalId |
The external resource identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). External resource is any OCI resource which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance. | 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 | - | - |
hostName |
Monitored resource host name. | string |
No | - | - |
id |
Monitored resource identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
license |
License edition of the monitored resource. | string |
No | - | - |
lifecycleState |
Lifecycle state of the monitored resource. | string |
No | - | - |
managementAgentId |
Management Agent Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
name |
Monitored resource name. | string |
No | - | - |
properties |
List of monitored resource properties. | list[object] |
No | - | - |
resourceCategory |
Resource Category to indicate the kind of resource type. | string |
No | - | - |
resourceTimeZone |
Time zone in the form of tz database canonical zone ID. | string |
No | - | - |
sourceType |
Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
tenantId |
Tenancy Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
timeCreated |
The date and time when the monitored resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. | string |
No | - | - |
timeUpdated |
The date and time when the monitored resource was last updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. | string |
No | - | - |
type |
Monitored Resource Type. | string |
No | - | - |
Status.aliases¶
Back to MonitoredResource status
MonitoredResourceAliases defines nested fields for MonitoredResource.Aliases.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credential |
MonitoredResourceAliasesCredential defines nested fields for MonitoredResource.Aliases.Credential. | object |
Yes | - | - |
name |
The name of the alias, within the context of the source. | string |
Yes | - | - |
source |
The source type and source name combination,delimited with (.) separator. Example: {source type}.{source name} and source type max char limit is 63. | string |
Yes | - | - |
Status.aliases.credential¶
Back to MonitoredResource status
MonitoredResourceAliasesCredential defines nested fields for MonitoredResource.Aliases.Credential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the pre-existing source credential which alias cred should point to. This should refer to the pre-existing source attribute which is bound to credential name. | string |
Yes | - | - |
service |
The name of the service owning the credential. Example: stack-monitoring or dbmgmt | string |
Yes | - | - |
source |
The source type and source name combination,delimited with (.) separator. This refers to the pre-existing source which alias cred should point to. Ex. {source type}.{source name} and source type max char limit is 63. | string |
Yes | - | - |
Status.credentials¶
Back to MonitoredResource status
MonitoredResourceCredentials defines nested fields for MonitoredResource.Credentials.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
credentialType |
- | string |
No | - | - |
description |
The user-specified textual description of the credential. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
keyId |
The master key should be created in OCI Vault owned by the client of this API. The user should have permission to access the vault key. | string |
No | - | - |
name |
The name of the credential, within the context of the source. | string |
No | - | - |
properties |
The credential properties list. Credential property values will be encrypted format. | list[object] |
No | - | - |
source |
The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. | string |
No | - | - |
type |
The type of the credential ( ex. JMXCreds,DBCreds). | string |
No | - | - |
Status.credentials.properties[]¶
Back to MonitoredResource status
MonitoredResourceCredentialsProperty defines nested fields for MonitoredResource.Credentials.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the credential property, should confirm with names of properties of this credential's type. Example: For JMXCreds type, credential property name for weblogic user is 'Username'. | string |
Yes | - | - |
value |
The value of the credential property name. Example: For JMXCreds type, credential property value for 'Username' property is 'weblogic'. | string |
Yes | - | - |
Status.databaseConnectionDetails¶
Back to MonitoredResource status
MonitoredResourceDatabaseConnectionDetails defines nested fields for MonitoredResource.DatabaseConnectionDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
connectorId |
Database connector Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
dbId |
dbId of the database. | string |
No | - | - |
dbUniqueName |
UniqueName used for database connection requests. | string |
No | - | - |
port |
Listener Port number used for connection requests. | integer |
Yes | - | - |
protocol |
Protocol used in DB connection string when connecting to external database service. | string |
Yes | - | - |
serviceName |
Service name used for connection requests. | string |
Yes | - | - |
sslSecretId |
SSL Secret Identifier for TCPS connector in OCI VaultOCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
Status.properties[]¶
Back to MonitoredResource status
MonitoredResourceProperty defines nested fields for MonitoredResource.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Property Name. | string |
No | - | - |
value |
Property Value. | string |
No | - | - |
Status.status¶
Back to MonitoredResource 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 MonitoredResource 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 MonitoredResource 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 MonitoredResource status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
MonitoredResourceType¶
MonitoredResourceType is the Schema for the monitoredresourcetypes API.
Plural:monitoredresourcetypesScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_monitoredresourcetype.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
MonitoredResourceTypeSpec defines the desired state of MonitoredResourceType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 friendly description. | string |
No | - | - |
displayName |
Monitored resource type display name. | 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 | - | - |
metadata |
MonitoredResourceTypeMetadata defines nested fields for MonitoredResourceType.Metadata. | object |
No | - | - |
metricNamespace |
Metric namespace for resource type. | string |
No | - | - |
name |
A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed. | string |
Yes | - | - |
resourceCategory |
Resource Category to indicate the kind of resource type. | string |
No | - | - |
sourceType |
Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc. | string |
No | - | - |
Spec.metadata¶
Back to MonitoredResourceType spec
MonitoredResourceTypeMetadata defines nested fields for MonitoredResourceType.Metadata.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentProperties |
List of properties needed by the agent for monitoring the resource. Valid only if resource type is OCI management agent based. When specified, these properties are passed to the management agent during resource create or update. | list[string] |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
requiredProperties |
List of required properties for resource type. | list[string] |
No | - | - |
uniquePropertySets |
List of property sets used to uniquely identify the resources. This check is made during create or update of stack monitoring resource. The resource has to pass unique check for each set in the list. For example, database can have user, password and SID as one unique set. Another unique set would be user, password and service name. | list[object] |
No | - | - |
validPropertiesForCreate |
List of valid properties for resource type while creating the monitored resource. If resources of this type specifies any other properties during create operation, the operation will fail. | list[string] |
No | - | - |
validPropertiesForUpdate |
List of valid properties for resource type while updating the monitored resource. If resources of this type specifies any other properties during update operation, the operation will fail. | list[string] |
No | - | - |
validPropertyValues |
List of valid values for the properties. This is useful when resource type wants to restrict only certain values for some properties. For instance for 'osType' property, supported values can be restricted to be either Linux or Windows. Example: { "osType": ["Linux","Windows","Solaris"]} |
map[string, list[string]] |
No | - | - |
validSubResourceTypes |
List of valid sub-resource types for a composite resource type. The sub-resource types will be obtained from the valid association pairs corresponding to the composite resource types. It will be empty for non composite resource types | list[string] |
No | - | - |
Spec.metadata.uniquePropertySets[]¶
Back to MonitoredResourceType spec
MonitoredResourceTypeMetadataUniquePropertySet defines nested fields for MonitoredResourceType.Metadata.UniquePropertySet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
properties |
List of properties. | list[string] |
Yes | - | - |
Status¶
MonitoredResourceTypeStatus defines the observed state of MonitoredResourceType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalNamespaceMap |
Key/Value pair for additional namespaces used by stack monitoring services for SYSTEM (SMB) resource types. | map[string, string] |
No | - | - |
availabilityMetricsConfig |
MonitoredResourceTypeAvailabilityMetricsConfig defines nested fields for MonitoredResourceType.AvailabilityMetricsConfig. | object |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 friendly description. | string |
No | - | - |
displayName |
Monitored resource type display name. | 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 | - | - |
handlerConfig |
MonitoredResourceTypeHandlerConfig defines nested fields for MonitoredResourceType.HandlerConfig. | object |
No | - | - |
id |
Monitored resource type identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
isSystemDefined |
If boolean flag is true, then the resource type cannot be modified or deleted. | boolean |
No | - | - |
lifecycleState |
Lifecycle state of the monitored resource type. | string |
No | - | - |
metadata |
MonitoredResourceTypeMetadata defines nested fields for MonitoredResourceType.Metadata. | object |
No | - | - |
metricNamespace |
Metric namespace for resource type. | string |
No | - | - |
name |
A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed. | string |
No | - | - |
resourceCategory |
Resource Category to indicate the kind of resource type. | string |
No | - | - |
sourceType |
Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
tenancyId |
Tenancy Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
timeCreated |
The date and time when the monitored resource type was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. | string |
No | - | - |
timeUpdated |
The date and time when the monitored resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. | string |
No | - | - |
Status.availabilityMetricsConfig¶
Back to MonitoredResourceType status
MonitoredResourceTypeAvailabilityMetricsConfig defines nested fields for MonitoredResourceType.AvailabilityMetricsConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
collectionIntervalInSeconds |
Availability metric collection internal in seconds. | integer |
No | - | - |
metrics |
List of metrics used for availability calculation for the resource. | list[string] |
No | - | - |
Status.handlerConfig¶
Back to MonitoredResourceType status
MonitoredResourceTypeHandlerConfig defines nested fields for MonitoredResourceType.HandlerConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
collectdResourceNameConfig |
MonitoredResourceTypeHandlerConfigCollectdResourceNameConfig defines nested fields for MonitoredResourceType.HandlerConfig.CollectdResourceNameConfig. | object |
No | - | - |
collectorTypes |
List of collector/plugin names. | list[string] |
No | - | - |
handlerProperties |
List of handler configuration properties | list[object] |
No | - | - |
metricMappings |
List of AgentExtensionHandlerMetricMappingDetails. | list[object] |
No | - | - |
metricNameConfig |
MonitoredResourceTypeHandlerConfigMetricNameConfig defines nested fields for MonitoredResourceType.HandlerConfig.MetricNameConfig. | object |
No | - | - |
metricUploadIntervalInSeconds |
Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. | integer |
No | - | - |
telegrafResourceNameConfig |
MonitoredResourceTypeHandlerConfigTelegrafResourceNameConfig defines nested fields for MonitoredResourceType.HandlerConfig.TelegrafResourceNameConfig. | object |
No | - | - |
telemetryResourceGroup |
Resource group string; if not specified, the resource group string will be generated by the handler. | string |
No | - | - |
Status.handlerConfig.collectdResourceNameConfig¶
Back to MonitoredResourceType status
MonitoredResourceTypeHandlerConfigCollectdResourceNameConfig defines nested fields for MonitoredResourceType.HandlerConfig.CollectdResourceNameConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
excludeProperties |
List of property names to be excluded. | list[string] |
No | - | - |
includeProperties |
List of property names to be included. | list[string] |
No | - | - |
suffix |
String to be suffixed to the resource name. | string |
No | - | - |
Status.handlerConfig.handlerProperties[]¶
Back to MonitoredResourceType status
MonitoredResourceTypeHandlerConfigHandlerProperty defines nested fields for MonitoredResourceType.HandlerConfig.HandlerProperty.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Property name. | string |
No | - | - |
value |
Property value. | string |
No | - | - |
Status.handlerConfig.metricMappings[]¶
Back to MonitoredResourceType status
MonitoredResourceTypeHandlerConfigMetricMapping defines nested fields for MonitoredResourceType.HandlerConfig.MetricMapping.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
collectorMetricName |
Metric name as defined by the collector. | string |
No | - | - |
isSkipUpload |
Is ignoring this metric. | boolean |
No | - | - |
metricUploadIntervalInSeconds |
Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. | integer |
No | - | - |
telemetryMetricName |
Metric name to be upload to telemetry. | string |
No | - | - |
Status.handlerConfig.metricNameConfig¶
Back to MonitoredResourceType status
MonitoredResourceTypeHandlerConfigMetricNameConfig defines nested fields for MonitoredResourceType.HandlerConfig.MetricNameConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
excludePatternOnPrefix |
String pattern to be removed from the prefix of the metric name. | string |
No | - | - |
isPrefixWithCollectorType |
is prefixing the metric with collector type. | boolean |
No | - | - |
Status.handlerConfig.telegrafResourceNameConfig¶
Back to MonitoredResourceType status
MonitoredResourceTypeHandlerConfigTelegrafResourceNameConfig defines nested fields for MonitoredResourceType.HandlerConfig.TelegrafResourceNameConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
excludeTags |
List of tag names to be excluded. | list[string] |
No | - | - |
includeTags |
List of tag names to be included. | list[string] |
No | - | - |
isUseTagsOnly |
Flag to indicate if only tags will be used for resource name generation. | boolean |
No | - | - |
Status.metadata¶
Back to MonitoredResourceType status
MonitoredResourceTypeMetadata defines nested fields for MonitoredResourceType.Metadata.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentProperties |
List of properties needed by the agent for monitoring the resource. Valid only if resource type is OCI management agent based. When specified, these properties are passed to the management agent during resource create or update. | list[string] |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
requiredProperties |
List of required properties for resource type. | list[string] |
No | - | - |
uniquePropertySets |
List of property sets used to uniquely identify the resources. This check is made during create or update of stack monitoring resource. The resource has to pass unique check for each set in the list. For example, database can have user, password and SID as one unique set. Another unique set would be user, password and service name. | list[object] |
No | - | - |
validPropertiesForCreate |
List of valid properties for resource type while creating the monitored resource. If resources of this type specifies any other properties during create operation, the operation will fail. | list[string] |
No | - | - |
validPropertiesForUpdate |
List of valid properties for resource type while updating the monitored resource. If resources of this type specifies any other properties during update operation, the operation will fail. | list[string] |
No | - | - |
validPropertyValues |
List of valid values for the properties. This is useful when resource type wants to restrict only certain values for some properties. For instance for 'osType' property, supported values can be restricted to be either Linux or Windows. Example: { "osType": ["Linux","Windows","Solaris"]} |
map[string, list[string]] |
No | - | - |
validSubResourceTypes |
List of valid sub-resource types for a composite resource type. The sub-resource types will be obtained from the valid association pairs corresponding to the composite resource types. It will be empty for non composite resource types | list[string] |
No | - | - |
Status.metadata.uniquePropertySets[]¶
Back to MonitoredResourceType status
MonitoredResourceTypeMetadataUniquePropertySet defines nested fields for MonitoredResourceType.Metadata.UniquePropertySet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
properties |
List of properties. | list[string] |
Yes | - | - |
Status.status¶
Back to MonitoredResourceType 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 MonitoredResourceType 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 MonitoredResourceType 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 MonitoredResourceType status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
MonitoringTemplate¶
MonitoringTemplate is the Schema for the monitoringtemplates API.
Plural:monitoringtemplatesScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_monitoringtemplate.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
MonitoringTemplateSpec defines the desired state of MonitoringTemplate.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID of the compartment containing the monitoringTemplate. | 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 for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
destinations |
A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. | list[string] |
Yes | - | - |
displayName |
A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information. | 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 | - | - |
isAlarmsEnabled |
Whether the alarm is enabled or disabled, it will be Enabled by default. | boolean |
No | - | - |
isSplitNotificationEnabled |
Whether the alarm notification is enabled or disabled, it will be Enabled by default. | boolean |
No | - | - |
members |
List of members of this monitoring template | list[object] |
Yes | - | - |
messageFormat |
The format to use for alarm notifications. | string |
No | - | - |
repeatNotificationDuration |
The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D. | string |
No | - | - |
Spec.members[]¶
Back to MonitoringTemplate spec
MonitoringTemplateMember defines nested fields for MonitoringTemplate.Member.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compositeType |
The OCID of the composite resource type like EBS or Peoplesoft. | string |
No | - | - |
id |
The OCID of the resourceInstance/resourceType/resourceGroup | string |
Yes | - | - |
type |
Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP | string |
Yes | - | - |
Status¶
MonitoringTemplateStatus defines the observed state of MonitoringTemplate.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID of the compartment containing the monitoringTemplate. | 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 for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
destinations |
A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource. | list[string] |
No | - | - |
displayName |
A user-friendly name for the monitoring template. It should be unique, and it's mutable in nature. 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 monitoringTemplate | string |
No | - | - |
isAlarmsEnabled |
Whether the alarm is enabled or disabled. Default value is enabled. | boolean |
No | - | - |
isSplitNotificationEnabled |
Whether the alarm notification is enabled or disabled, it will be Enabled by default. | boolean |
No | - | - |
lifecycleState |
The current lifecycle state of the monitoring template. | string |
No | - | - |
members |
List of members of this monitoring template. | list[object] |
No | - | - |
messageFormat |
The format to use for alarm notifications. | string |
No | - | - |
repeatNotificationDuration |
The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D. | string |
No | - | - |
sdkStatus |
The current status of the monitoring template i.e. whether it is Applied or NotApplied. This uses a distinct JSON name so it can coexist with the OSOK status envelope. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
tenantId |
Tenant Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) | string |
No | - | - |
timeCreated |
The date and time the monitoringTemplate was created. Format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the monitoringTemplate was last updated. Format defined by RFC3339. | string |
No | - | - |
totalAlarmConditions |
Total Alarm Conditions | number |
No | - | - |
totalAppliedAlarmConditions |
Total Applied Alarm Conditions | number |
No | - | - |
Status.members[]¶
Back to MonitoringTemplate status
MonitoringTemplateMember defines nested fields for MonitoringTemplate.Member.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compositeType |
The OCID of the composite resource type like EBS or Peoplesoft. | string |
No | - | - |
id |
The OCID of the resourceInstance/resourceType/resourceGroup | string |
Yes | - | - |
type |
Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP | string |
Yes | - | - |
Status.status¶
Back to MonitoringTemplate 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 MonitoringTemplate 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 MonitoringTemplate 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 MonitoringTemplate status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
ProcessSet¶
ProcessSet is the Schema for the processsets API.
Plural:processsetsScope:NamespacedAPIVersion:stackmonitoring.oracle.com/v1beta1Sample: Sample (config/samples/stackmonitoring_v1beta1_processset.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ProcessSetSpec defines the desired state of ProcessSet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. | 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 |
Name of the Process Set. | 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 | - | - |
specification |
ProcessSetSpecification defines nested fields for ProcessSet.Specification. | object |
Yes | - | - |
Spec.specification¶
ProcessSetSpecification defines nested fields for ProcessSet.Specification.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
List of Process Set specification details. | list[object] |
Yes | - | - |
Spec.specification.items[]¶
ProcessSetSpecificationItem defines nested fields for ProcessSet.Specification.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
label |
Optional label used to identify a single filter. | string |
No | - | - |
processCommand |
String literal used for exact matching on process name. | string |
No | - | - |
processLineRegexPattern |
Regex pattern matching on process arguments. | string |
No | - | - |
processUser |
String literal used for exact matching on process user. | string |
No | - | - |
Status¶
ProcessSetStatus defines the observed state of ProcessSet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. | 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 |
Name of the Process Set. | 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 Process Set. | string |
No | - | - |
lifecycleState |
The current state of the Resource. | string |
No | - | - |
revision |
The current revision of the Process Set. | string |
No | - | - |
specification |
ProcessSetSpecification defines nested fields for ProcessSet.Specification. | object |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The time the process set was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
The time the process set was last updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.specification¶
ProcessSetSpecification defines nested fields for ProcessSet.Specification.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
List of Process Set specification details. | list[object] |
Yes | - | - |
Status.specification.items[]¶
ProcessSetSpecificationItem defines nested fields for ProcessSet.Specification.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
label |
Optional label used to identify a single filter. | string |
No | - | - |
processCommand |
String literal used for exact matching on process name. | string |
No | - | - |
processLineRegexPattern |
Regex pattern matching on process arguments. | string |
No | - | - |
processUser |
String literal used for exact matching on process user. | 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 | - | - |