Skip to main content
Version: 0.5.0
OSSEnterprise

Managing Instances

Once an instance is deployed, you can monitor its status, inspect its details, deploy add-ons, and delete it when it is no longer needed.

Instances page showing deployed instances with health status

Viewing Instance Status

Accessing Instances

Navigate to Instances in the sidebar to see all deployed instances across your projects. The list shows each instance with its name, kind, namespace, project, and current status.

You can filter instances by project, namespace, status, or search by name.

Status Indicators

Each instance displays a status that reflects the health of its underlying Kubernetes resources:

StatusDescription
HealthyAll resources are created and healthy. The instance is fully operational.
ProgressingResources are being created or updated. The instance is not yet fully ready.
DegradedSome resources are unhealthy but the instance is partially operational.
UnhealthyOne or more resources could not be created or have entered a failed state.

Instance Details

Click on an instance to open its detail page. The detail view provides:

  • Status summary -- Current status with conditions and events from the underlying resources
  • Parameters -- The configuration values used to deploy this instance
  • Resources -- List of Kubernetes resources created by this instance with their individual statuses
  • Events -- Recent Kubernetes events related to the instance and its resources

Deploy Add-ons

The Add-ons section on the instance detail page lists RGDs that can extend this instance. Add-on RGDs use an externalRef field to reference the parent instance.

To deploy an add-on:

  1. Click Deploy Add-on on the instance detail page.
  2. Select the add-on RGD from the list.
  3. The deployment form opens with the externalRef pre-populated with the parent instance reference.
  4. Fill in the remaining parameters and deploy.

Add-ons are tracked as separate instances but are logically linked to the parent.

Deleting Instances

Permanent Action

Deleting an instance removes all of its underlying Kubernetes resources. This action cannot be undone. Make sure you have backups of any data stored by the instance before proceeding.

To delete an instance:

  1. Navigate to the instance detail page.
  2. Click Delete in the header.
  3. Confirm the deletion by typing the instance name.
  4. The instance and all its managed resources are removed.

Deletion requires the developer role or higher in the instance's project.

Coming Soon

The following features are planned for upcoming releases:

  • View deployment logs -- Stream container logs directly from the Knodex UI for troubleshooting.