Manage Projects

    +
    Create and modify projects in order to allow access to Couchbase clusters.

    The purpose of a project is to contain, and manage access to, a particular set of clusters. For more information about projects, refer to Projects Overview.

    Accessing Projects in the Couchbase Cloud UI

    Projects can be viewed and managed from the Projects tab in the main navigation. A summary of all projects — of which you are a member — is displayed in table format.

    The 'Projects' tab showing a table of multiple projects, each with different Support Plans, with all of them showing a status of 'Healthy'.

    If you aren’t a member of any projects, and you have Organization Edit privileges, you will be presented with an option to create a project.

    Projects Summary

    The Projects tab shows a summary of all the projects in the organization that you are a member of. The summary is displayed in table format, with sortable columns and a row for each project. A search field is provided at the top of the summary, which you can use to search for any term or value that is listed in the summary table.

    The project summary displays the following information about each project:

    Name

    The name of the project.

    Status

    The status of the clusters in the project. If a cluster is failed over, then the status of the project will display as failed over, even if the rest of the clusters in the project are healthy.

    Clusters

    The number of clusters in the project.

    Support Plan

    The Support Plan(s) of the clusters in the project. Note that since Support Plans are assigned at the cluster level, you will see multiple Support Plans listed if the clusters in the project aren’t all on the same Support Plan.

    A Trash icon is displayed at the end of each row, which can be used to delete the project.

    Since Organization Admin users have implicit access to all projects in the organization, they will see all of the organization’s projects listed in the project summary — even the ones they aren’t explicitly a member of. All other users will see only the projects that they are a member of.

    Create a Project

    To create a project, you must have Organization Edit privileges.

    1. From the Projects tab, click Create Project.

      This opens the Create a Project fly-out menu.

    2. Provide a name for the project.

      In the Project Name field, enter a name for the project.

    3. (Optional) Add users to the project.

      Use the Add Users section to select the organization users that you wish to become members of the project. (If you don’t wish to add users to the project at this time, you always have the option to add them later.)

      1. Click the View field to select which users you wish to add to the project with the Project View role.

      2. Click the Edit field to select which users you wish to add to the project with the Project Edit role.

      Clicking on these fields will show a truncated drop-down list of all the users in your organization. If you don’t see the desired user at first, you can start typing the name of the user until they show up in the list. If the user is not yet a member of your organization, you will need to invite them to your organization before you can add them to a project.

    4. Once you’re satisfied with the configuration, click Create a Project.

      The fly-out will close and you will be brought to the project’s overview page. Since no clusters are in the project, you will be presented with options for creating a cluster and connecting a self-managed cluster.

    Add Users to an Existing Project

    You can add users to a project either during project creation, or after the project is created. This procedure describes how to add users to a project after the project is created.

    To add a user to an existing project, you must have Project Edit privileges within the project.

    1. From the Projects tab, find the project that you wish to add users to, and click on its row.

      This opens the project’s fly-out menu.

    2. In the Users section of the fly-out menu, click Add Users.

    3. Select users to add to the project.

      1. Click the View field to select which users you wish to add to the project with the Project View role.

      2. Click the Edit field to select which users you wish to add to the project with the Project Edit role.

      Clicking on these fields will show a truncated drop-down list of all the users in your organization. If you don’t see the desired user at first, you can start typing the name of the user until they show up in the list. If the user is not yet a member of your organization, you will need to invite them to your organization before you can add them to a project.

    4. Once you’ve selected all of the desired users, click Save Project to add them to the project.

    View Who Can Access a Project

    To view the members of a project, you must have Project View privileges within the project.

    The membership of a project can be viewed from the project’s fly-out menu. To access the project’s fly-out menu, go to the Projects tab in the main navigation, then find the desired project and click on its row.

    The Users section of the project’s fly-out menu displays all of the organization users that are members of the project.

    Change a User’s Role in a Project

    At this time, it is not currently possible to change a user’s role in a project. Instead, you can remove the user from the project, and then add them back with the desired role.

    Rename a Project

    To change the name of a project, you must have Project Edit privileges within the project.

    1. From the Projects tab, find the project that you wish rename, and click on its row.

      This opens the project’s fly-out menu.

    2. Click View Project.

      This opens the project’s overview screen.

    3. Click the vertical ellipsis to the right of the project’s name. In the drop-down menu that appears, click Edit Project Name.

    4. Enter a new name for the project.

    5. Once you’ve finished entering a new name for the project, click Save.

    Remove a User (or Yourself) from a Project

    Use this procedure to remove either yourself, or another user, from a project. To remove someone other than yourself from a project, you must have Project Edit privileges within the project.

    A project must have at least one member with the Project Edit role at all times. If the user that you are removing happens to be the only member of the project with the Project Edit role (even if that user is yourself), then you must first grant the Project Edit role to another member of the project before you can remove the desired user.

    1. Go to the Users tab in the main navigation.

    2. Find the user whom you wish to remove from a particular project, and click on their row.

      This opens the user’s fly-out menu.

    3. In the Projects section of the fly-out menu, click the Trash icon next to the project that you wish to remove the user from.

    Delete a Project

    To delete a project:

    • You must have Project Edit privileges within the project.

    • You must have deleted all clusters in the project. Couchbase Cloud does not allow a project to be deleted if it contains clusters. If clusters are present in the project, options for deleting the project will be disabled.

    Procedure

    1. From the Projects tab, find the project that you wish to delete.

    2. Click the Trash icon at the end of the row on the right side.

      Note that if there are any remaining clusters in the project, the Trash icon will be disabled. Once you have deleted all remaining clusters in the project, the Trash icon will be enabled.

    3. When prompted to confirm the deletion, type out the name of the project and click Confirm.