Skip to content
|
You are browsing the Kong Gateway documentation archive. This documentation is no longer actively maintained.
See the latest Kong Gateway documentation.
Kong Gateway Enterprise [ARCHIVE]
1.3-x

PermalinkWorkspaces in Kong Manager

Workspaces enable an organization to segment traffic so that teams of Admins sharing the same Kong cluster are only able to interact with entities from their groups. Within a Workspace, it is possible to invite Admins to a particular team and to enforce RBAC with Roles and Permissions that further delimit the types of actions and entities available to an Admin.

PermalinkDefault Workspace

When the first Super Admin logs in, they begin in the Workspace named default. From here, they may invite Admins who are intended to be able to manage all other Workspaces, as well as the Workspaces themselves.

To navigate between Workspaces from the Overview page, click on any Workspace displayed beneath the Vitals chart.

The list of Workspaces may be rendered as cards or a table, depending on preference.

Workspace List

PermalinkCreating New Workspaces

  1. Log in as the Super Admin. On the Workspaces page, click the New Workspace button at the top right to see the Create Workspace form. Name and choose a color / icon for the new Workspace.

    New Workspace Form

    ⚠️ WARNING: Do not name Workspaces the same as these major routes in Kong Manager:

     • Admins
 • Certificates
 • Consumers
 • Plugins
 • Portal
 • Routes
 • Services
 • SNIs
 • Upstreams
 • Vitals

  2. Click the “Create New Workspace” button. Upon creation, the application will navigate to the new Workspace’s dashboard.

    New Dashboard

PermalinkEdit a workspace

  1. In the workspace you want to edit, navigate to the Dashboard page.

  2. Near the top right, click the Settings button. This button takes you to the Edit Workspace page.

  3. Here, you can edit the workspace name, avatar, and avatar background color.

  4. Click Update Workspace to save.

PermalinkDelete a workspace

PermalinkWipe workspace data

To delete a workspace, all data must first be deleted from the workspace. Choose one of the following methods.

Using Kong Manager, complete the following:

  1. Manually delete all files via Dev Portal > Editor. You cannot delete folders at this time, but deleting all files from a folder will remove the folder.
  2. Turn off the Dev Portal. Go to Dev Portal Settings > Advanced > Turn Off.
  3. Remove all roles from the workspace:
    1. Go to Teams in the top navigation.
    2. Navigate to the Roles tab.
    3. Click View on the workspace you want to delete.
    4. Go to each role entry and click Edit.
    5. In the entry detail page, click Delete Role. A confirmation modal will appear. Click Delete Role again.

  1. Delete all Dev Portal files associated with the workspace:

     curl -i -X DELETE http://localhost:8001/{WORKSPACE_NAME}/files

  2. Turn off the Dev Portal for the workspace:

    curl -X PATCH http://localhost:8001/workspaces/{WORKSPACE_NAME}  \
 --data "config.portal=false"

  3. Delete each role from the workspace:

     curl -i -X DELETE http://localhost:8001/{WORKSPACE_NAME}/rbac/roles/{ROLE_NAME|ROLE_ID}

  1. Delete all Dev Portal files associated with the workspace:

     portal wipe WORKSPACE_NAME

  2. Turn off the Dev Portal for the workspace:

     portal disable WORKSPACE_NAME

  3. Delete each role from the workspace. You can’t complete this step using the Portal CLI, so switch to either the Kong Manager or Admin API tab and complete step 3.

PermalinkDelete a clean workspace

If your workspace is clean, you can delete it using the Kong Manager GUI or the Kong Admin API. If not, see the previous section to wipe workspace data.

  1. In the workspace you want to delete, navigate to the Dashboard page.

  2. Near the top right, click the Settings button. This button takes you to the Edit Workspace page.

  3. Click Delete in the bottom right corner.

    The deletion will fail if you have any data in your workspace.

Send a DELETE request to the Kong Admin API:

curl -i -X DELETE http://localhost/workspaces/{WORKSPACE_NAME|WORKSPACE_ID}

The deletion will fail if you have any data in your workspace.

If it is successful, you should see the following response:

HTTP 204 No Content

PermalinkWorkspace Access

If a Role does not have permission to access entire endpoints within a Workspace, the Admin assigned to that Role will not be able to see the related navigation links.

For more information about Admins and Roles, see RBAC in Kong Manager.