Docs: organization docs refactor (#46812)

* Docs: organization docs refactor

* fixes misspelling

* Apply suggestions from code review

Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com>

* incorporates feedback

* adds resource table

* revamped resource table

Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com>
This commit is contained in:
Christopher Moyer 2022-03-29 08:56:01 -05:00 committed by GitHub
parent bf977ac245
commit 3bcee53478
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 117 additions and 118 deletions

View File

@ -0,0 +1,116 @@
---
title: 'Manage organizations'
menuTitle: 'Manage organizations'
description: 'Describes how to use organizations to isolate dashboard to users and teams.'
weight: 300
aliases: [docs/sources/administration/manage-organizations/_index.md]
keywords:
- organizations
- dashboards
---
# Manage organizations
This topic describes what organizations are, and how to create, edit, and delete them.
## About organizations
An organization is an entity that helps you isolate users and resources such as dashboards, annotations, and data sources from each other. Their purpose is to provide completely separate experiences, which look like multiple instances of Grafana, within a single instance. Multiple organizations are easier and cheaper to manage than multiple instances of Grafana.
Users, configuration settings, and Grafana Enterprise licenses are shared between organizations. Other resources, like dashboards, data sources, annotations, folders, Teams, and Alerts, are isolated within each organization and cannot be easily shared with another organization.
The following table summarizes the resources you can share and/or isolate using organizations.
| Resource | Mode |
| ------------------------ | ---------------- |
| Users | Share or isolate |
| Folders | Isolate only |
| Dashboards | Isolate only |
| Data sources | Isolate only |
| Alerts | Isolate only |
| Notification channels | Isolate only |
| Annotations | Isolate only |
| Reports | Isolate only |
| API keys | Isolate only |
| Authentication providers | Share only |
| Configuration settings | Share only |
| Licenses | Share |
The member of one organization cannot view dashboards assigned to another organization. However, a user can belong to multiple organizations.
Grafana Server Administrators are responsible for creating organizations. For more information about the Grafana Server Administrator role, refer to [Grafana server administrators]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#Grafana server administrators" >}}).
## View a list of organizations
Complete this task when you want to view a list of existing organizations.
### Before you begin
- Ensure that you have Grafana Server Administrator permissions
**To view a list of organizations:**
1. Sign in to Grafana as a server administrator.
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Orgs**.
A list of organizations appears.
![Server Admin organization list](/static/img/docs/manage-users/server-org-list-7-3.png)
## Create an organization
Create an organization when you want to isolate dashboards and other resources from each other.
### Before you begin
- Ensure that you have Grafana Server Administrator permissions
**To create an organization:**
1. Sign in to Grafana as a server administrator.
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Orgs**.
1. Click **+ New org**.
1. Enter the name of the new organization and click **Create**.
Grafana creates the organization and adds you as the organization administrator.
1. On the **Preferences** tab, select a home dashboard, time zone, and week start.
For more information about preferences, refer to [Preferences]({{< relref "../preferences/_index.md" >}}).
For more information about adding users to an organization, refer to [Add a user to an organization]({{< relref "../manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md" >}}).
## Delete an organization
This action permanently removes an organization from your Grafana server.
> **Warning:** Deleting the organization also deletes all teams and dashboards associated the organization.
### Before you begin
- Ensure that you have Grafana Server Administrator permissions
- Because the delete action removes all teams and dashboards associated with the organization, ensure that the users who rely on the organization dashboards are aware of the change
**To delete an organization:**
1. Sign in to Grafana as a server administrator.
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Orgs**.
1. Click the red **X** next to the organization that you want to delete.
1. Click **Delete**.
## Edit an organization
Edit an organization when you want to change its name.
### Before you begin
- Ensure that you have Grafana Server Administrator permissions
**To edit an organization:**
1. Sign in to Grafana as a server administrator.
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Orgs**.
1. Click the organization you want to edit.
1. Update the organization name and click **Update**.
![Server admin Edit Organization](/static/img/docs/manage-users/server-admin-edit-org-7-3.png)

View File

@ -12,7 +12,7 @@ You are required to specify an Admin role for each organization. The first user
## Before you begin
- Add an organization
- [Create an organization]({{< relref "../../manage-organizations/_index.md">}})
- [Add a user]({{< relref "./add-user.md">}}) to Grafana
- Ensure you have Grafana server administrator privileges

View File

@ -1,14 +0,0 @@
+++
title = "Server admin tasks"
weight = 100
+++
# Server admin tasks
Grafana Server Admins use the **Server Admin** menu to manage user accounts and organizations set up on the Grafana server.
They perform tasks described in the following pages:
- [Manage users as a Server Admin]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}) - Describes user management tasks that Grafana Server Admins can perform.
- [Manage organizations as a Server Admin]({{< relref "server-admin-manage-orgs.md" >}}) - Describes organization management tasks that Grafana Server Admins can perform.
- [User API]({{< relref "../../http_api/user.md" >}}) - Manage users or change passwords programmatically.

View File

@ -1,103 +0,0 @@
+++
title = "Manage organization"
weight = 200
+++
# Manage organizations as a Server Admin
This topic explains organization management tasks performed by Grafana Server Admins.
In order to perform any of these tasks, you must be logged in to Grafana on an account with Grafana Server Admin permissions. For more information about Grafana Admin permissions, refer to [Grafana Server Admin role]
({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}).
> **Note:** The Grafana Server Admin role does not exist in Grafana Cloud. Grafana Cloud users cannot perform tasks listed in this section.
## View organization list
See a complete list of organizations set up on your Grafana server.
{{< docs/shared "manage-users/view-server-org-list.md" >}}
Grafana displays all organizations set up on the server, listed in alphabetical order by organization name. The following information is displayed:
- **Id -** The ID number of the organization.
- **Name -** The name of the organization.
![Server Admin organization list](/static/img/docs/manage-users/server-org-list-7-3.png)
## Create organization
Add an organization to your Grafana server.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list.md" >}}
1. Click **+ New org**.
1. Enter the name of the new organization and then click **Create**.
{{< /docs/list >}}
Two things happen:
- Grafana creates a new organization with you as the sole member and Admin.
- Grafana opens the new organization [Preferences tab]({{< relref "../../administration/preferences/_index.md" >}}).
You can now add users or perform other Organization Admin tasks.
## Delete organization
Permanently remove an organization from your Grafana server.
**Warning:** Deleting the organization also deletes all teams and dashboards for this organization.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list.md" >}}
1. Click the red **X** next to the organization that you want to remove.
1. Click **Delete**.
{{< /docs/list >}}
## Edit an organization
Grafana Server Admins can perform some organization management tasks that are almost identical to Organization Admin tasks, just accessed from a different menu path.
![Server admin Edit Organization](/static/img/docs/manage-users/server-admin-edit-org-7-3.png)
### View organization members and roles
See which user accounts are assigned to the organization and their assigned roles.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list.md" >}}
1. Click the name of the organization for which you want to view members.
1. Scroll down to the Organization Users section. User accounts are displayed in alphabetical order.
{{< /docs/list >}}
### Change organization name
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
1. In the **Name** field, type the new organization name.
1. Click **Update**.
{{< /docs/list >}}
### Change organization member role
Change the organization role assigned to a user account that is assigned to the organization you are editing.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
1. In the Organization Users section, locate the user account that you want to change the role of.
1. In the **Role** field, select the new role that you want to assign.
{{< /docs/list >}}
## Remove a user from an organization
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
1. In the Organization Users section, locate the user account that you want to change the role of.
1. Click the red **X** next to the user account listing and then click **Delete**.
{{< /docs/list >}}