managementagent.oracle.com/v1beta1¶
APIVersion: managementagent.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 managementagent.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| DataSource | Namespaced | Sample | - |
| ManagementAgentInstallKey | Namespaced | Sample | - |
| NamedCredential | Namespaced | Sample | - |
DataSource¶
DataSource is the Schema for the datasources API.
Plural:datasourcesScope:NamespacedAPIVersion:managementagent.oracle.com/v1beta1Sample: Sample (config/samples/managementagent_v1beta1_datasource.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DataSourceSpec defines the desired state of DataSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowMetrics |
Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required. | string |
No | - | - |
compartmentId |
Compartment owning this DataSource. | string |
Yes | - | - |
connectionTimeout |
Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint. | integer |
No | - | - |
jsonData |
- | string |
No | - | - |
metricDimensions |
The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint. | list[object] |
No | - | - |
name |
Unique name of the DataSource. | string |
Yes | - | - |
namespace |
The OCI monitoring namespace to which scraped metrics should be uploaded. | string |
No | - | - |
proxyUrl |
The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property). | string |
No | - | - |
readDataLimitInKilobytes |
Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB). | integer |
No | - | - |
readTimeout |
Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint. | integer |
No | - | - |
resourceGroup |
OCI monitoring resource group to assign the metric to. | string |
No | - | - |
scheduleMins |
Number in minutes. The scraping occurs at the specified interval. | integer |
No | - | - |
type |
- | string |
No | - | - |
url |
The url through which the Prometheus Exporter publishes its metrics. (http only) | string |
No | - | - |
Spec.metricDimensions[]¶
DataSourceMetricDimension defines nested fields for DataSource.MetricDimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the metric dimension | string |
Yes | - | - |
value |
Value of the metric dimension | string |
Yes | - | - |
Status¶
DataSourceStatus defines the observed state of DataSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowMetrics |
Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required. | string |
No | - | - |
compartmentId |
Compartment owning this DataSource. | string |
No | - | - |
connectionTimeout |
Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint. | integer |
No | - | - |
isDaemonSet |
If the Kubernetes cluster type is Daemon set then this will be set to true. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. | string |
No | - | - |
metricDimensions |
The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint. | list[object] |
No | - | - |
name |
Unique name of the DataSource. | string |
No | - | - |
namespace |
The Kubernetes namespace | string |
No | - | - |
proxyUrl |
The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property). | string |
No | - | - |
readDataLimit |
Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB). | integer |
No | - | - |
readTimeout |
Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint. | integer |
No | - | - |
resourceGroup |
OCI monitoring resource group to assign the metric to. | string |
No | - | - |
scheduleMins |
Number in minutes. The scraping occurs at the specified interval. | integer |
No | - | - |
state |
State of the DataSource. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The time the DataSource was created. An RFC3339 formatted datetime string | string |
No | - | - |
timeUpdated |
The time the DataSource data was last received. An RFC3339 formatted datetime string | string |
No | - | - |
type |
- | string |
No | - | - |
url |
The url through which the Prometheus Exporter publishes its metrics. (http only) | string |
No | - | - |
Status.metricDimensions[]¶
DataSourceMetricDimension defines nested fields for DataSource.MetricDimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the metric dimension | string |
Yes | - | - |
value |
Value of the metric dimension | 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 | - | - |
ManagementAgentInstallKey¶
ManagementAgentInstallKey is the Schema for the managementagentinstallkeys API.
Plural:managementagentinstallkeysScope:NamespacedAPIVersion:managementagent.oracle.com/v1beta1Sample: Sample (config/samples/managementagent_v1beta1_managementagentinstallkey.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ManagementAgentInstallKeySpec defines the desired state of ManagementAgentInstallKey.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedKeyInstallCount |
Total number of install for this keys | integer |
No | - | - |
compartmentId |
Compartment Identifier | string |
Yes | - | - |
displayName |
Management Agent install Key Name | string |
Yes | - | - |
isKeyActive |
if set to true the install key state would be set to Active and if false to Inactive | boolean |
No | - | - |
isUnlimited |
If set to true, the install key has no expiration date or usage limit. Defaults to false | boolean |
No | - | - |
timeExpires |
date after which key would expire after creation | string |
No | - | - |
Status¶
ManagementAgentInstallKeyStatus defines the observed state of ManagementAgentInstallKey.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedKeyInstallCount |
Total number of install for this keys | integer |
No | - | - |
compartmentId |
Compartment Identifier | string |
No | - | - |
createdByPrincipalId |
Principal id of user who created the Agent Install key | string |
No | - | - |
currentKeyInstallCount |
Total number of install for this keys | integer |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
Management Agent Install Key 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 | - | - |
id |
Agent install Key identifier | string |
No | - | - |
isUnlimited |
If set to true, the install key has no expiration date or usage limit. Defaults to false | boolean |
No | - | - |
key |
Management Agent Install Key | string |
No | - | - |
lifecycleDetails |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. | string |
No | - | - |
lifecycleState |
Status of Key | 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 when Management Agent install Key was created. An RFC3339 formatted date time string | string |
No | - | - |
timeExpires |
date after which key would expire after creation | string |
No | - | - |
timeUpdated |
The time when Management Agent install Key was updated. An RFC3339 formatted date time string | string |
No | - | - |
Status.status¶
Back to ManagementAgentInstallKey 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 ManagementAgentInstallKey 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 ManagementAgentInstallKey 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 ManagementAgentInstallKey status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
NamedCredential¶
NamedCredential is the Schema for the namedcredentials API.
Plural:namedcredentialsScope:NamespacedAPIVersion:managementagent.oracle.com/v1beta1Sample: Sample (config/samples/managementagent_v1beta1_namedcredential.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
NamedCredentialSpec defines the desired state of NamedCredential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
Description of the Named Credential. | 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 | - | - |
managementAgentId |
The Management Agent parent resource to associate this named credential with. This is the ManagementAgent resource OCID. | string |
Yes | - | - |
name |
Identifier for Named Credential. This is unique for the Management Agent. | string |
Yes | - | - |
properties |
Properties for the named credential | list[object] |
Yes | - | - |
type |
The type of the Named Credential. | string |
Yes | - | - |
Spec.properties[]¶
NamedCredentialProperty defines nested fields for NamedCredential.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the property | string |
Yes | - | - |
value |
Value of the property | string |
Yes | - | - |
valueCategory |
The category of the Named credential property value. CLEAR_TEXT indicates the value field contains a clear text value. SECRET_IDENTIFIER indicates the value field contains a vault secret ocid identifier. ADB_IDENTIFIER indicates the value field contains an Autonomous database ocid identifier. ALLOWED_VALUE indicates the value should be selected from the options in the allowedValues field. | string |
Yes | - | - |
Status¶
NamedCredentialStatus defines the observed state of NamedCredential.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
Description of the Named Credential. | 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 |
Identifier for Named Credential. | string |
No | - | - |
lifecycleState |
The current state of the named credential | string |
No | - | - |
managementAgentId |
The Management Agent parent resource to associated with this named credential. This is the ManagementAgent resource OCID. | string |
No | - | - |
name |
Name for Named Credential. This is unique for the Management Agent. | string |
No | - | - |
properties |
Properties for the named credential | list[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 Named Credential was created. An RFC3339 formatted datetime string | string |
No | - | - |
timeUpdated |
The time the Named Credential data was last updated. An RFC3339 formatted datetime string | string |
No | - | - |
type |
The type of the Named Credential. | string |
No | - | - |
Status.properties[]¶
Back to NamedCredential status
NamedCredentialProperty defines nested fields for NamedCredential.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the property | string |
Yes | - | - |
value |
Value of the property | string |
Yes | - | - |
valueCategory |
The category of the Named credential property value. CLEAR_TEXT indicates the value field contains a clear text value. SECRET_IDENTIFIER indicates the value field contains a vault secret ocid identifier. ADB_IDENTIFIER indicates the value field contains an Autonomous database ocid identifier. ALLOWED_VALUE indicates the value should be selected from the options in the allowedValues field. | string |
Yes | - | - |
Status.status¶
Back to NamedCredential 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 NamedCredential 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 NamedCredential 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 NamedCredential status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |