1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website/docs/reference/project-collaboration-mode.md
2024-10-17 11:52:02 +02:00

3.7 KiB
Raw Permalink Blame History

title
Project Collaboration Mode

:::note Availability

Plan: Enterprise | Version: 4.22+

:::

Overview

Project collaboration modes allow you to manage project visibility and interaction levels, ensuring better control and collaboration within your organization.

The collaboration mode of a project defines who within your Unleash instance can access the project. This setting also determines who can submit change requestsa feature that provides controlled and secure updates for feature flags.

Unleash supports three collaboration modes: open, protected, and private. A user's predefined root and project roles, as well as their custom root roles, determine what projects they can access.

Open collaboration mode

All users of your Unleash instance can view the project and submit change requests. This is the default collaboration mode.

Protected collaboration mode

All users of your Unleash instance can view the project but only project Members and Admins can submit change requests.

Private collaboration mode

Only project Members, Admins, Editors, and users with custom root roles can view the project. Viewers, who are not project Members, can't see the project in the project list. Only project Members and Admins can submit change requests.

View project Submit change requests
Open All users All users
Protected All users Project Members and Admins
Private Project Members, Admins, Editors, and users with custom root roles Project Members and Admins

Set project collaboration mode

To create a new project with a specific collaboration mode, do the following:

  1. In the Unleash Admin UI, go to Projects > New project.
  2. Enter Project name.
  3. Click Open to choose your collaboration mode.
  4. Click Create project.

Modify project collaboration mode

To modify the collaboration mode of an existing project, do the following:

  1. In the Unleash Admin UI, go to Projects and select the project you want to modify.
  2. Go to Project settings > Enterprise settings and use the Project collaboration mode list to update your collaboration mode.
  3. Click Save changes.

Change collaboration mode to protected

When you change the collaboration mode of an existing project to protected, all users who do not have sufficient permissions lose the ability to create new change requests. Existing change requests remain in place. Users with insufficient permissions can still cancel their change requests but can no longer update them.

Change collaboration mode to private

When you change the collaboration mode of an existing project to private, all users who do not have sufficient permissions lose access to the project, including their existing change requests.

Migrate existing projects

When upgrading Unleash to version 4.22.0 or later, all migrated projects get the open collaboration mode by default. See Modify project collaboration mode for instructions on changing the collaboration mode of an existing project.