Custom access items
Project Owner
A custom access item gives users one-click access to an application or service that runs inside a workspace. It appears next to the built-in ways in, such as the Cloud IDE and SSH, and opens the service through the platform.
Use one when the people using a workspace need something other than an IDE. A chat interface for an agent, a web application built for a business team, or an internal tool are typical examples. Knowledge Worker Agent reaches its users this way.
A custom access item does two things. SecurSpaces runs its command to start the service when the workspace starts, and makes the service's port available through the item. Without the item, the service is neither started nor reachable.
Add a custom access item
Add it to the workspace template, so every workspace created from the template has it. To add it to a single workspace, edit that workspace instead.
You need permission to edit the template or the workspace.
-
Open the workspace template, or the workspace, for editing.
-
In the Basic Info step, find Workspace Access, and select Add to add a custom access item.
-
Fill in the fields described in Fields.
-
Save the access item, and then save the template or workspace.
Expected result: Workspaces created from the template show the access item. A workspace you edited shows it after it restarts.
Custom access items can also be managed through the REST API, for both workspaces and workspace templates.
Fields
| Field | Required | What it holds |
|---|---|---|
| Name | Yes | The label shown on the access item |
| Icon | No | An image for the access item. Select Upload, and choose the file. |
| Command | Yes | The command that starts the service. Up to 300 characters. |
| Open Port | Yes | The port the service listens on inside the workspace, from 1 to 65534 |
| Health Probe | No | A command that checks whether the service is up. Up to 300 characters. |
| Health Timeout | No | How long, in seconds, to wait for the health probe. Values above 600 are capped at 600. |
Rules the platform enforces
-
Names are unique within a workspace.
-
Ports are unique, and can't collide with another port the workspace already uses.
-
Reserved ports are refused. The platform reserves some ports for its own services, such as
1111,2222,2376,11111, and11112. Choose another port for your service.
The platform rejects an item that breaks one of these rules when you save it, and names the item and the rule.
Check whether an item is online
When an item has a health probe, the platform runs the probe on a schedule and shows whether the service is online. If the probe fails, select the item's status to open the Error Trace, which shows the probe's error and the end of its output.
Without a health probe, the platform has no way to tell whether the service is up. Add one for any service users depend on.
Changes are audited
Creating, changing, and deleting a custom access item is recorded on the Audit page. The record includes the item's name and, truncated, its command and health probe, so reviewers can see what was configured.