-
Couldn't load subscription status.
- Fork 96
docs: HCP organization "owner" role changes #1150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,36 +6,26 @@ description: |- | |
|
|
||
| # Projects | ||
|
|
||
| Projects are lightweight containers for resources or use cases that require similar access. An organization contains one or more projects. HCP resources such as [HashiCorp Virtual Networks | ||
| (HVN)](/hcp/docs/hcp/network) and server clusters reside within Projects. | ||
| Projects are lightweight containers for resources or use cases that require similar access. An organization contains one or more projects. HCP resources such as [HashiCorp Virtual Networks (HVN)](/hcp/docs/hcp/network) and server clusters reside within projects. | ||
|
|
||
| Use projects to segment access within an organization. For example, projects can separate teams, use cases, or environments, such as development, staging, and production. The billing summary reports usage per project. | ||
| Use projects to segment access within an organization. For example, projects can separate teams, use cases, or environments, such as development, staging, and production. The billing summary reports usage per project. | ||
|
|
||
| Here are important characteristics about HCP projects: | ||
|
|
||
| - _Global_ [HCP service quotas](/hcp/docs/hcp/admin/support#service-quotas) remain at the | ||
| organization level and they are not enforced per project. | ||
| organization level and they are not enforced per project. Refer the [HCP Support](/hcp/docs/hcp/admin/support) page to learn more about the service quotas. | ||
|
|
||
| - An [organization](/hcp/docs/hcp/admin/orgs) can contain 1 or more projects. | ||
|
|
||
| <Note> | ||
| - HCP resource names, such as a cluster name, are unique to projects. | ||
|
|
||
| Refer the [HCP | ||
| Support](/hcp/docs/hcp/admin/support) page to learn more about the service | ||
| quotas. | ||
|
|
||
| </Note> | ||
|
|
||
| - HCP resource names (e.g. cluster name) are unique per project and not per | ||
| organization. | ||
|
|
||
| - You cannot deploy an HCP Vault Dedicated or HCP Consul Dedicated cluster if an | ||
| HVN belongs to a different project. | ||
| - You cannot deploy an HCP Vault Dedicated cluster if an HVN belongs to a different project. | ||
|
|
||
| - To delete a project, all resources under the project must be deleted or | ||
| deactivated first. See the [manage resources](#manage-resources) section. | ||
| deactivated first. Refer to [manage resources](#manage-resources) for more information. | ||
|
|
||
| ## Use Cases | ||
|
|
||
| ### Use Cases | ||
| Taking advantage of segregating access within your organization via projects is the best way to enforce least privileged access. Deploying all HCP services or resources within one project, can lead to several unintended consequences. | ||
|
|
||
| - Increased likelihood of over privileging identities within the project | ||
|
|
@@ -46,55 +36,42 @@ Taking advantage of segregating access within your organization via projects is | |
|
|
||
| Users with organization contributor, admin, or owner roles can create new | ||
| projects. If an organization contributor creates a new project, the user | ||
| automatically becomes the admin of that project. (Refer to the [User | ||
| Permissions](/hcp/docs/hcp/admin/users#user-permissions) for information about | ||
| the roles you can assign.) | ||
| automatically becomes the admin of that project. Refer to the [User Permissions](/hcp/docs/hcp/admin/users#user-permissions) for information about | ||
| the roles you can assign. | ||
|
|
||
| 1. Log into [HCP Portal](https://portal.cloud.hashicorp.com/) and choose your | ||
| organization. | ||
|
|
||
| <Note> | ||
|
|
||
| If you have logged in before, the portal opens the last project you were in. | ||
| Navigate back to the organization level from the breadcrumbs, or click on the | ||
| HashiCorp icon at the top-left to choose your organization. | ||
|
|
||
| </Note> | ||
| organization. If you have logged in before, the portal opens the last project you were in. | ||
| Navigate to the Organization to change projects | ||
|
|
||
| 1. Select **Projects** in the sidebar. | ||
|
|
||
| 1. Click **+ Create project**. | ||
| 1. Click **Create project**. | ||
|
|
||
| 1. Enter the **Project name** and **Project description**. | ||
|
|
||
| 1. Click **Create project** to complete. | ||
|
|
||
|
|
||
| ## Manage projects | ||
|
|
||
| Users with project admin role can edit the existing project name and | ||
| description, or delete the project. (Refer to the [User | ||
| Permissions](/hcp/docs/hcp/admin/users#user-permissions) for information about | ||
| the roles you can assign.) | ||
| Users with project owner and admin roles can edit the existing project name and | ||
| description, or delete the project. Refer to [User Permissions](/hcp/docs/hcp/admin/users#user-permissions) for information about | ||
| the roles you can assign. | ||
|
|
||
| 1. Log into [HCP Portal](https://portal.cloud.hashicorp.com/) and choose your | ||
| organization. | ||
|
|
||
| 1. Select **Projects** in the sidebar. | ||
|
|
||
| 1. Expand the menu next to the project you wish to modify, and select **Edit | ||
| project** to edit the project name or description, or select **Delete** to | ||
| 1. Expand the menu next to the project you wish to modify. | ||
| Select **Edit project** to edit the project name or description, or select **Delete** to | ||
| delete the project. | ||
|  | ||
|
|
||
| 1. Select **View project** will take you to the project setting page where you | ||
| can find the **project ID**. | ||
|
|
||
| 1. Select **View project** to find information about the project, such as the project ID. | ||
|
|
||
| ## Manage resources | ||
|
|
||
|  | ||
|
|
||
| A resource is any item that the access management system controls access to. Examples of resources are a HCP Vault Dedicated cluster, HCP Packer Bucket, HashiCorp Virtual Network (HVN) or a HCP Vault Secret App. The **Active Resources** page lists all resources created in the project. To delete a project, all resources must be deleted. If an resource exists, HCP will block users from deleting the project. This page helps you to identify what resources are still in the project. | ||
| A resource is any item that the access management system controls access to. Examples of resources are a HCP Vault Dedicated cluster, HCP Packer Bucket, HashiCorp Virtual Network (HVN) or a HCP Vault Secret App. The **Active Resources** page lists all resources created in the project. To delete a project, all resources must be deleted. If an resource exists, HCP will block users from deleting the project. This page helps you to identify what resources are still in the project. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How can HCP Vault Secrets is EOL. Let's remove "HCP Vault Secrets App" |
||
|
|
||
|  | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,16 +8,25 @@ description: |- | |
|
|
||
| This topic describes HCP's access management features. You can set roles and permissions at either the _organization level_ , _project level_ or _resource level_ to secure access to HCP resources. | ||
|
|
||
| ## Roles & Permissions | ||
| ## Roles and permissions | ||
|
|
||
| @include '/hcp-administration/permission-intro.mdx' | ||
|
|
||
| ### Organization | ||
| ## Add new role assignment | ||
|
|
||
| The following tables describe role permissions assigned at the organization level. | ||
| Users with the `owner` role in an organization can add and assign roles at a fine-grained level using the HCP platform. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This statement is true. But other roles have the manage IAM policy permission like |
||
|
|
||
| <Tabs> | ||
| <Tab heading="All Services" group="all-services"> | ||
| 1. At the top, click the dropdown to open the organization and project selector. Select **View all organizations**. | ||
| 1. Click the name of the organization. | ||
| 1. From the **Organization dashboard**, click **Access Control (IAM)**. | ||
| 1. Click **Add new assignment**. If you are not an organization's owner, this option does not appear. | ||
| 1. Enter the user's email address. | ||
|
|
||
| You can change the user's role assignment and the service associated with that role assignment using the drop-down menus. When you set a role assignment for all services, it sets the user's role in the organization. | ||
|
|
||
| ## Organization level roles and permissions | ||
|
|
||
| The following table describes the roles and permissions available at the organizational level: | ||
|
|
||
| | HCP Organization Permissions | Owner | Admin | Contributor | Viewer | Browser | No role | | ||
| | --------------------------------- | :-----: | :------: | :---------: | :------: | :------: | :------: | | ||
|
|
@@ -35,7 +44,9 @@ The following tables describe role permissions assigned at the organization leve | |
| | Manage SSO configuration | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | | ||
| | Manage billing resources | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | | ||
|
|
||
| </Tab> | ||
| The following tables provide additional ways to understand permissions, based on needs such as billing and SSO management. | ||
|
|
||
| <Tabs> | ||
|
|
||
| <Tab heading="Resource Manager" group="resource-manager"> | ||
|
|
||
|
|
@@ -75,7 +86,6 @@ The following tables describe role permissions assigned at the organization leve | |
| | Manage SSO and SCIM configuration | ❌ | | ||
| | Manage billing resources | ✅ | | ||
|
|
||
|
|
||
| </Tab> | ||
|
|
||
| <Tab heading="IAM" group="iam"> | ||
|
|
@@ -128,7 +138,17 @@ To learn more about each permission, refer to [HCP Terraform organization permis | |
|
|
||
| A user can be a part of an organization with no roles assigned directly to them through the [SSO default role settings](/hcp/docs/hcp/admin/iam/sso) or IAM settings. To enforce least-privileged access, new users will have a limited experience within the platform until an Admin assigns either an organization or project role to the user. | ||
|
|
||
| ### Project | ||
| ## View current role assignments | ||
|
|
||
| To view a list of current role assignments in an organization: | ||
|
|
||
| 1. At the top, click the dropdown to open the organization and project selector. Select **View all organizations**. | ||
| 1. Click the name of the organization. | ||
| 1. From the **Organization dashboard**, click **Access Control (IAM)**. | ||
|
|
||
| The **Role assignments** page lists the currently assigned roles, and provides an interface to search and filter the current assignments. | ||
|
|
||
| ## Project level roles and permissions | ||
|
|
||
| The following tables describe role permissions scope to the project level. | ||
|
|
||
|
|
@@ -227,19 +247,20 @@ To learn more about each permission, refer to [HCP Terraform project permissions | |
|
|
||
| </Tabs> | ||
|
|
||
| #### Assign a project role | ||
| ## Assign a project role | ||
|
|
||
| @include '/hcp-administration/assign-project-role.mdx' | ||
|
|
||
| # Role Names and Role IDs | ||
| ## Role Names and Role IDs | ||
|
|
||
| To interact with the HCP Access Management system using the [HCP Terraform provider](https://registry.terraform.io/providers/hashicorp/hcp/latest) or public APIs, you must properly format the role IDs you reference.The table lists role names and the formatting of their Role IDs. | ||
| To interact with the HCP Access Management system using the [HCP Terraform provider](https://registry.terraform.io/providers/hashicorp/hcp/latest) or public APIs, you must properly format the role IDs you reference. The following able lists role names and the formatting of their Role IDs. | ||
|
|
||
| <Tabs> | ||
| <Tab heading="All Services" group="all-services"> | ||
|
|
||
| | Role name | Role ID | | ||
| | ----------- | :------------------------------: | | ||
| | Owner | `roles/owner` | | ||
| | Admin | `roles/admin` | | ||
| | Contributor | `roles/contributor` | | ||
| | Viewer | `roles/viewer` | | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@boruszak , while we will allow multiple owners within an organization, we still will only allow someone to create an organization if they are NOT an owner of any other orgs. Should that idea be covered in this page or a different location?