Manage environments
Environments are the deployment targets for your teams, where they run their processes. Use the Environments page in Camunda Hub to view every environment in your organization, monitor its status, and open its applications.
Each environment runs on a cluster, which you administer on the cluster pages. To learn how environments and clusters relate, see environments.
- SaaS
- Self-Managed
Permissions
Your role determines which environments you can see and what you can do with them across Camunda Hub, for example on the organization's Environments page, in workspaces, and projects:
| Role | What you can do |
|---|---|
| Organization owner or admin | View all environments, assign environments to workspaces, and resume a paused environment. |
| DevOps | View all environments, open the cluster pages, and resume a paused environment. DevOps can't assign environments. |
| Editor or admin in a workspace | View the environments assigned to the workspaces where you are an editor or workspace admin. |
| Viewer or commenter in a workspace | No access to environments. |
Environment details
Camunda Hub provides details for each environment. Select an environment on the Environments page to open them.
| Detail | Description |
|---|---|
| Name | The name of the environment. |
| Status | The status of the environment. |
| Tag | The tag of the backing cluster, which represents the lifecycle phase of the environment: dev, test, stage, or prod. |
| Version | The Camunda version that the environment is running. |
| Region | The region of the backing cluster. |
| Cluster ID | The ID of the backing cluster. |
| REST API | The REST API address of the environment. |
| Swagger UI | The Swagger UI address of the environment, if Swagger UI is enabled for the backing cluster. |
| Workspaces | The workspaces the environment is assigned to. Organization owners and admins see Unassigned if the environment isn't assigned to any workspace. |
Environment statuses
The status of an environment reflects the state of its cluster. The status updates automatically while the cluster changes state, and settles on the health of the cluster when the change completes.
| Status | Description |
|---|---|
| Healthy | The environment is running. |
| Unhealthy | The environment reports a problem. |
| Unknown | Camunda Hub can't determine the status. |
| Creating | The cluster is being created. |
| Updating | The cluster is being updated. |
| Unavailable | The cluster is under maintenance or waiting for input. |
| Paused | The cluster is paused. You can resume the environment. |
| Resuming | The cluster is starting after being resumed. |
How environment statuses follow the cluster
The status of an environment comes from the state of the cluster behind it. This table shows the status that each cluster state produces, and whether you can deploy:
| Cluster state | Environment status | Deploying |
|---|---|---|
| Healthy | Healthy | Allowed. |
| Unhealthy | Unhealthy | Allowed, with a Deployment may fail warning. |
| Missing (its backing resources are gone) | Unhealthy | Allowed, with a Deployment may fail warning. |
| Paused | Paused | Blocked until you resume the environment. |
| Resuming | Resuming | Blocked until the environment is healthy. |
| Creating | Creating | Blocked, with Environment is being created. |
| Updating | Updating | Allowed, with a Deployment may fail warning. |
| Maintenance | Unavailable | Blocked, until the maintenance is finished. |
| Waiting for input | Unavailable | Blocked, until the cluster has the input it waits for. |
| No state, or a state Camunda Hub doesn't recognize | Unknown | Not blocked. |
A cluster in the Maintenance or Waiting for input state still exists, but its environment shows Unavailable. To see the state of the cluster, open it in Manage clusters.
The status of an environment reads the same wherever it appears: on the Environments page, in the environment details, in the environments of a workspace, on the cluster page, in the deploy dialog, and in the runtime connection of the modeler. For how deploying follows the status, see deploy a project.
If Console stops reporting a cluster, its environment stays listed from the last known snapshot, with the status Unknown and the mark Not reported. You can't deploy to it.
The Camunda Hub API reports only the health of an environment: HEALTHY, UNHEALTHY, PAUSED, RESUMING, and UNKNOWN. An environment that is being created, is being updated, is under maintenance, or is waiting for input reads UNKNOWN there. The Creating, Updating, and Unavailable statuses appear only in the Camunda Hub interface.
Resume a paused environment
Organization owners, admins, and DevOps users can resume a paused environment wherever Camunda Hub shows its status, for example on the Environments page, in the environment details, or when you select an environment to deploy to. The status changes to Resuming while the cluster starts, and then to Healthy.
Search and filter environments
To find relevant environments, go to the Environments page of your Hub organization. Use the toolbar to narrow down the list:
- Search environments: Search by the name of an environment or the name of its cluster.
- Status, Version, and Tag: Show only the environments that match the selected values. Each filter lists only the values that exist in your organization.
Environment applications
Each environment has its own instances of the Camunda applications. Open an application from the details of the environment.
| Application | Description |
|---|---|
| Operate | Monitor and troubleshoot the process instances of the environment. See Operate. |
| Tasklist | Work on the user tasks of the environment. See Tasklist. |
| Admin | Manage authentication, authorization, and administration for the environment. See Admin. |
| Optimize | Analyze and improve your processes. See Optimize. |
Jobs
The details of an environment summarize its jobs for the last 24 hours: the number of jobs that were created, completed, and not completed. For more information, see the job dashboard.
Workspaces assigned to an environment
The details of an environment list the workspaces that the environment is assigned to. Organization owners and admins can open a workspace from this list. An environment that isn't assigned to any workspace is shown as Unassigned.
To change the assignment, see assign environments to a workspace.
Add a new environment
In SaaS, you add an environment by creating a cluster. Every SaaS cluster has one environment, which Camunda Hub creates automatically when the cluster is created.
- Create a cluster. The environment of the cluster appears on the Environments page.
- Assign the environment to a workspace so that teams can deploy to it.
Permissions
Your role determines which environments you can see and what you can do with them across Camunda Hub, for example on the organization's Environments page, in workspaces, and projects:
| Role | What you can do |
|---|---|
| Organization admin | View all environments, and assign environments to workspaces. |
| DevOps | View all environments, and open the cluster pages. DevOps can't assign environments. |
| Editor or admin in a workspace | View the environments assigned to the workspaces where you are an editor or workspace admin. |
| Viewer or commenter in a workspace | No access to environments. |
Environment details
Camunda Hub provides details for each environment. Select an environment on the Environments page to open them.
| Detail | Description |
|---|---|
| Name | The name of the environment. |
| Status | The status of the environment. |
| Tags | The tags of the backing cluster, for example dev or prod. |
| Version | The Camunda version that the environment is running. |
| Cluster ID | The ID of the backing cluster. |
| Physical tenant ID | The ID of the Physical Tenant, if the environment is backed by one. |
| Workspaces | The workspaces the environment is assigned to. Organization owners and admins see Unassigned if the environment isn't assigned to any workspace. |
Environment statuses
The status of an environment reflects the state of its cluster. Camunda Hub monitors the health of the components of each environment to determine its status. For details on how the status is determined, see the Camunda Hub configuration.
| Status | Description |
|---|---|
| Healthy | The environment is running. |
| Unhealthy | The environment reports a problem. |
| Unknown | Camunda Hub can't determine the status, for example because a component doesn't respond. |
| Not reported | The environment is assigned to a workspace, but its cluster or Physical Tenant is no longer in the Camunda Hub configuration. It shows no live data, and you can't deploy to it. |
Search and filter environments
To find relevant environments, go to the Environments page of your Hub organization. Use the toolbar to narrow down the list:
- Search environments: Search by the name of an environment or the name of its cluster.
- Status, Version, and Tag: Show only the environments that match the selected values. Each filter lists only the values that exist in your organization.
Environment applications
An environment can have its own instances of the Camunda applications. Open an application from the details of the environment.
| Application | Description |
|---|---|
| Operate | Monitor and troubleshoot the process instances of the environment. See Operate. |
| Tasklist | Work on the user tasks of the environment. See Tasklist. |
| Admin | Manage authentication, authorization, and administration for the environment. See Admin. |
| Optimize | Analyze and improve your processes, if Optimize is configured. See Optimize. |
An application is unavailable for an environment if it isn't configured.
Jobs
The details of an environment summarize its jobs for the last 24 hours: the number of jobs that were created, completed, and not completed. Select View all job types to see the jobs by type. For more information, see the job dashboard.
Workspaces assigned to an environment
The details of an environment list the workspaces that the environment is assigned to. Organization owners and admins can open a workspace from this list. An environment that isn't assigned to any workspace is shown as Unassigned.
To change the assignment, see assign environments to a workspace.
Add a new environment
In Self-Managed, you add an environment by adding a cluster or a Physical Tenant to the Camunda Hub configuration. You provision clusters outside Camunda Hub. A cluster has an environment for its default Physical Tenant, and, on Camunda 8.10 and later, one for each additional Physical Tenant you declare.
- Provision the cluster with your platform tooling.
- Add the cluster to the Camunda Hub configuration, and declare any additional Physical Tenants. See physical tenants in the Camunda Hub configuration.
- Perform a rolling restart of Camunda Hub. Camunda Hub reads the configuration at startup. After the restart, the environments appear on the Environments page.
- Assign the environments to a workspace so that teams can deploy to them.
Next steps
- Assign environments to a workspace.
- Manage clusters.
- Learn how to deploy a project.