Skip to content

Commit

Permalink
fix: gropus and permissions docs
Browse files Browse the repository at this point in the history
  • Loading branch information
staceysalamon-aiven committed Nov 20, 2024
1 parent 2cf45ba commit dc8804d
Show file tree
Hide file tree
Showing 12 changed files with 60 additions and 69 deletions.
8 changes: 1 addition & 7 deletions docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,7 @@ Add users to groups to streamline access management to your Aiven projects and s
description="Create and add users to groups."
/>
<Card
to="/docs/platform/concepts/permissions"
iconName="book"
title="Project member roles"
description="View project permissions you can assign to users and groups."
/>
<Card
to="/docs/platform/howto/add-groups-projects"
to="/docs/platform/howto/manage-project-permissions"
iconName="clipboardCheck"
title="Add groups to projects"
description="Give a group of users access to a project."
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/application-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You must be a [super admin](/docs/platform/howto/make-super-admin) to access thi
You [create and manage application users](/docs/platform/howto/manage-application-users)
at the organization level. Application users are granted access to projects
and services in the same way as organization users by adding them to
[projects](/docs/platform/howto/add-project-members) and assigning them a role. You can
[projects](/docs/platform/howto/manage-project-permissions) and assigning them a role. You can
also make application users super admin, giving them full access to your organization,
its organizational units, projects, services, and billing and other settings.

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/orgs-units-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Organizations also let you centrally manage settings like:
the organization level, you can use billing groups across all projects in the
organization and its units. You can't share billing information between organizations.
- [Users](/docs/platform/concepts/user-access-management) and
[groups](/docs/platform/howto/list-groups): Managed at the organization level. You
[groups](/docs/platform/howto/manage-groups): Managed at the organization level. You
can grant users and groups access at the organization and project level with
[permissions and roles](/docs/platform/concepts/permissions).
- [Domains](/docs/platform/howto/manage-domains) and
Expand Down
11 changes: 6 additions & 5 deletions docs/platform/concepts/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ To give users access to projects and services in your organizations, you grant t
group of resources.
* **Roles**: Sets of permissions that you can assign to a principal.

Principals are
[organization users](/docs/platform/howto/manage-org-users),
[application users](/docs/platform/concepts/application-users),
and [groups](/docs/platform/howto/list-groups).
You can grant access to principals at the project level. You can
Principals can be:
* [Organization users](/docs/platform/howto/manage-org-users)
* [Application users](/docs/platform/concepts/application-users)
* [Groups](/docs/platform/howto/manage-groups)

You can [grant access to principals at the project level](/docs/platform/howto/manage-project-permissions). You can also
[add users to services](/docs/platform/howto/create_new_service_user).

To grant access to resources at the organization level, you can
Expand Down
23 changes: 0 additions & 23 deletions docs/platform/howto/add-groups-projects.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/platform/howto/add-project-members.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/platform/howto/list-groups.md

This file was deleted.

9 changes: 6 additions & 3 deletions docs/platform/howto/manage-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,22 @@ title: Manage groups of users

import ConsoleLabel from "@site/src/components/ConsoleIcons"

Create groups of users in your organization to make it easier to [give users with similar roles access to projects](/docs/platform/howto/add-groups-projects).
Create groups of users in your organization to make it easier to manage access to your organization's resources.

You can [grant permissions](/docs/platform/howto/manage-project-permissions) to groups for projects,
giving them the right level of access to the project and its services.

## Create a group

To create a group in an organization:
<!-- vale off -->

1. Click **Admin** > **Groups**.
1. Click **Create group**.
1. Enter a unique name for the group. You can also enter a description.
1. Optional: To assign users to the group, click the toggle and choose
the users to add.
1. Click **Create group**.
<!-- vale on -->

## Add users to a group

You can only add users that are
Expand Down
40 changes: 40 additions & 0 deletions docs/platform/howto/manage-project-permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Manage project permissions
---

import ConsoleLabel from "@site/src/components/ConsoleIcons"
import {ConsoleIcon} from "@site/src/components/ConsoleIcons"

You can give users and groups access to a project and the services in it by granting them roles and permissions for that project.

## Grant project permissions to a user or group

1. In the project, click <ConsoleLabel name="projectpermissions"/>.

1. Click **Grant permissions** and select **Grant to users** or **Grant to groups**.

1. Select the users or groups to add to the project.

1. Select the [roles and permissions](/docs/platform/concepts/permissions) to grant.

1. Click **Grant permissions**.

## Change permissions for a user or group

1. In the project, click <ConsoleLabel name="projectpermissions"/>.

1. For the user or group click <ConsoleLabel name="actions"/> >
<ConsoleIcon name="edit"/> **Edit permissions**.

1. Add or remove permissions and click **Save changes**.

## Remove access to a project

To remove all permissions to a project:

1. In the project, click <ConsoleLabel name="projectpermissions"/>.

1. For the user or group click <ConsoleLabel name="actions"/> >
<ConsoleIcon name="delete"/> **Remove**.

1. Click **Remove user** or **Remove group** to confirm.
2 changes: 1 addition & 1 deletion docs/tools/aiven-console/howto/create-manage-teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Account Owners team.
1. Enter the name of one of the teams and assign the same users to this group. Do this
for each team.

1. [Add each new group to the projects](/docs/platform/howto/add-groups-projects)
1. [Add each new group to the projects](/docs/platform/howto/manage-groups#add-groups-to-a-project)
that the teams are assigned to with the same role.

1. After confirming all users have the correct level of access to the projects,
Expand Down
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ const sidebars: SidebarsConfig = {
},
items: [
'platform/howto/manage-project',
'platform/howto/manage-project-permissions',
'platform/howto/technical-emails',
'platform/howto/manage-unassigned-projects',
'platform/howto/reactivate-suspended-project',
Expand Down
3 changes: 3 additions & 0 deletions static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
/platform/concepts/service-scaling https://aiven.io/docs/platform/howto/scale-services
/platform/howto/access-service-log https://aiven.io/docs/platform/howto/list-monitoring
/platform/howto/access-service-logs https://aiven.io/docs/platform/howto/list-monitoring
/platform/howto/add-project-members https://aiven.io/docs/platform/howto/manage-project-permissions.md
/platform/howto/add-groups-projects https://aiven.io/docs/platform/howto/manage-groups
/platform/howto/billing-aws-marketplace-subscription https://aiven.io/docs/marketplace-setup
/platform/howto/billing-azure-marketplace-subscription https://aiven.io/docs/marketplace-setup
/platform/howto/billing-google-cloud-platform-marketplace-subscription https://aiven.io/docs/marketplace-setup
Expand All @@ -50,6 +52,7 @@
/platform/howto/list-billing https://aiven.io/docs/platform/concepts/billing-and-payment
/platform/howto/list-billing-groups https://aiven.io/docs/platform/concepts/billing-groups
/platform/howto/list-byoc https://aiven.io/docs/platform/concepts/byoc
/platform/howto/list-groups https://aiven.io/docs/platform/howto/manage-groups
/platform/howto/list-identity-providers https://aiven.io/docs/platform/howto/saml/add-identity-providers
/platform/howto/list-network https://aiven.io/docs/platform/concepts/cloud-security
/platform/howto/list-user https://aiven.io/docs/platform/howto/manage-org-users
Expand Down

0 comments on commit dc8804d

Please sign in to comment.