Monitor the Status of Instance Secret¶

In DataOS, the status of a Resource indicates its current life-cycle state, such as active, error, or deleted. Monitoring status allows teams to detect state transitions (e.g., from active to deleted or error) that may impact downstream dependencies, trigger configuration issues, or reflect access problems.

DataOS CLI¶

The status of an Instance Secret can be monitored using the DataOS CLI by executing the following command.

dataos-ctl get -t instance-secret

Example Usage:

dataos-ctl get -t instance-secret
INFO[0000] 🔍 get...                                     
INFO[0001] 🔍 get...complete                             

        NAME       | VERSION |      TYPE       | WORKSPACE | STATUS | RUNTIME |    OWNER     
-------------------|---------|-----------------|-----------|--------|---------|--------------
  bqdepot-r        | v1      | instance-secret |           | active |         | iamgroot  
  bqdepot-rw       | v1      | instance-secret |           | active |         | iamgroot

In the example above, the STATUS column indicates the current state of the Instance Secret active in this case, which confirms that the Instance Secret is available and usable.

Metis Catalog¶

To monitor the status of an Instance Secret on the Metis Catalog, follow the steps below:

Open the Metis Catalog.

Open the Metis Catalog
Search for the Instance Secret by name.

Search for the Instance Secret in Metis
Click on the Instance Secret that needs to be monitored and check the Status, which is represented as State.

Instance Secret details in Metis

The active state indicates that the secret is currently accessible and usable by other DataOS Resources. This is the expected state for any secret that is in use by other DataOS Resources.

Operations App¶

To monitor the status of an Instance Secret on the Operations app, follow the steps below:

Open the Operations app.

Open the Operations App

</div>

Under the User space → type → Instance Secret, search for the Instance Secret.

Operations > User Space > Instance Secret

The active state indicates that the secret is currently accessible and usable by other DataOS Resources. This is the expected state for any secret that is in use by other DataOS Resources.
On clicking the Instance Secret, its builder state can also be monitored.

🗣 The Builder Stage reflects the internal progress of a DataOS Resource as it is being reconciled and provisioned by the platform. This stage is managed by the Poros controller, which is responsible for ensuring the system’s actual state matches the desired state defined in the Resource manifest (YAML).

When a user applies a Resource YAML (dataos-ctl resource apply -f resource.yaml), the builder workflow begins. Poros orchestrates this by comparing the input state (what the user requested) with the current cluster state (what already exists), and attempts to reconcile the two.

If a Resource enters an error state during this stage, it means something failed while setting it up. A Resource in an error state at the Builder Stage is considered not fully created and should not be treated as active, even if it appears in the UI list.

Instance Secret details in Operations

Monitoring the Builder Stage is crucial, especially when status = error. If builder stage = building, the issue likely occurred after build, possibly runtime or external issues. But if builder stage = error, then the YAML itself needs fixing.

Status alerts¶

To automatically track critical state transitions, users can configure a Monitor and Pager to send alerts when the status of an Instance Secret changes to values like error or deleted. This enables teams to respond immediately to resource failures, misconfigurations, or unexpected deletions that may impact dependent components. Click here to view the steps to set up alerts for status changes.