Skip to content
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

Update Multi-Tenancy docs to use the new Console #4820

Merged
merged 6 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
130 changes: 95 additions & 35 deletions en/identity-server/next/docs/guides/multitenancy/manage-tenants.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,44 @@
# Tenant management
# Manage Root Organizations (Tenants)

By default, {{ product_name }} is configured with a single tenant named `carbon.super`. If you have the required permissions, you can configure more tenant domains and maintain multiple isolated user bases on a single server/cluster at the same time.
!!! Note
**Tenants** will now be referred to as **Root Organizations**.

This change is to ensure consistency across our documentation and to better reflect the hierarchical structure of organizations.

{{ product_name }}, by default, is configured with a single root organization named `carbon.super`. If you have the required permissions, you can configure more root organizations and maintain multiple isolated user bases on a single server/cluster at the same time.

!!! Info
Learn more about [multi-tenancy]({{base_path}}/guides/multitenancy/).

## Add new tenants
!!! note "Use REST APIs to manage root organizations"

Follow the steps given below to add a new tenant from the Management Console.
{{product_name}} also offers REST APIs to conveniently manage root organizations. To try out the Tenant Management REST API, refer [here]({{base_path}}/apis/tenant-management-rest-api/).

!!! Note
You can access the Management Console using the following URL: `https://<hostname>:<port>/carbon`.
## Add a root organization

Follow the steps given below to add a new root organization from the {{ product_name }} Console.

1. Sign in to the super tenant on the Management Console.
1. Sign in to the Console of the `carbon.super` root organization.

!!! info
To add and manage tenants using the Management Console, you need to be signed in as a super user.
To add and manage tenants using the {{ product_name }} Console, you need to be signed in as a super admin user. You can access the {{ product_name }} Console using the following URL: </br>
`https://<IS_HOST>:<PORT>/console`.

2. Go to **Configure** > **Multitenancy** and click **Add New Tenant**.

![Add Tenant]({{base_path}}/assets/img/guides/multitenancy/add-tenant.png)
2. Open the **Root Organization** dropdown from the top left corner and click **Manage Root Organizations**.

![Root Organizations Dropdown]({{base_path}}/assets/img/guides/multitenancy/root-organizations-dropdown.png)

3. On the **Root Organizations** page, click on the **New Root Organization** button.

!!! info
If you have already created root organizations, this page will be populated with them and the button will appear on the top right corner of the page.

3. On the **Register A New Organization** page that opens, enter the tenant details and click **Save**.
![New Root Organization]({{base_path}}/assets/img/guides/multitenancy/new-root-organization.png)

4. On the modal that opens up, enter the root organization details and click **Create**.

![Create Root Organization]({{base_path}}/assets/img/guides/multitenancy/create-root-organization-modal.png)

<table>
<thead>
Expand All @@ -33,50 +50,93 @@ Follow the steps given below to add a new tenant from the Management Console.
<tbody>
<tr>
<td><code>Domain</code></td>
<td>The domain name (e.g., abc.com), which is used as a unique identifier for your domain. You can use it to sign in to the Management Console to be redirected to your specific tenant. The domain is also used in URLs to distinguish one tenant from another.</td>
</tr>
<tr>
<td><code>Select Usage Plan for Tenant</code></td>
<td>The usage plan defines limitations (such as the number of users, bandwidth, etc.) for the tenant.</td>
<td>The domain name (e.g., abc.com) is used as a unique identifier for your organization. The URL for the new root organization's Console will be `https://<IS_HOST>:<PORT>/t/<DOMAIN>/console` URL.</td>
</tr>
<tr>
<td><code>First Name</code> / <code>Last Name</code></td>
<td>The name of the tenant admin.</td>
<td><code>First Name</code></td>
<td>The first name of the root organization admin.</td>
</tr>
<tr>
<td><code>Admin Username</code></td>
<td>The sign-in username of the tenant admin. The username always ends with the domain name (e.g., admin@abc.com).</td>
<td><code>Last Name</code></td>
<td>The last name of the root organization admin.</td>
</tr>
<tr>
<td><code>Admin Password</code></td>
<td>The password used to sign in using the admin username specified.</td>
</tr>
<tr>
<td><code>Admin Password (Repeat)</code></td>
<td>Repeat the password to confirm.</td>
<td><code>Username</code></td>
<td>The username of the root organization admin that will be used for signing in.</td>
</tr>
<tr>
<td><code>Email</code></td>
<td>The email address of the admin.</td>
</tr>
<tr>
<td><code>Password</code></td>
<td>The password used when singing in with the username specified above.</td>
</tr>
</tbody>
</table>

4. Once a new tenant is created, the tenant details appear in the **Tenants List** as shown below.
5. Once a new root organization is created, it will be listed in the the **Root Organization** listing page as shown below.

![View a tenants]({{base_path}}/assets/img/guides/multitenancy/view-tenants.png)
![Root Organization Listing]({{base_path}}/assets/img/guides/multitenancy/root-organizaiton-listing.png)

## View tenant details
## View root organization details

To view tenant details, follow the steps given below.
To view the details of the root organization, follow the steps given below.

1. Sign in to the super tenant on the Management Console.
2. Go to **Configure** > **Multitenancy** and click **View Tenants**.
1. Sign in to the `carbon.super` root organization on the {{ product_name }} Console.
2. Open the **Root Organizations** dropdown from the left top corner and click **Manage Root Organizations**.

!!! info
You will see information of all the tenants that currently exist in the system.
You will see information of all the root organizations that currently exist in the system.

3. If you want to view only tenants of a specific domain, enter the domain name and click **Find**.
3. Several actions can be performed on the root organization from the **Root Organizations** listing page itself.

![Root Organization Actions]({{base_path}}/assets/img/guides/multitenancy/root-organization-card-actions.png)

- **Edit**: Click on the **Edit** button to navigate to the details page of the respective root organization.
- **More**: Click on the elipsis icon to view more actions.
- **Go to Console**: Navigate to the Console of the respective root organization.
- **Disable** / **Enable**: Depending on the current status of the root organization, you can disable or enable it.
- **Delete**: Delete the root organization.

3. If you want to view details of a specific root organization, click on the **Edit** button of the respective root organization. Inside the root organization details page, you can perform the following actions:

- **Edit Admin Details**: You can update the first name, last name, email, and password of the root organization admin.
- **Disable** / **Enable**: Depending on the current status of the root organization, you can disable or enable it.
- **Delete**: Delete the root organization.

![Root Organization Details]({{base_path}}/assets/img/guides/multitenancy/root-organization-details.png)

## Filter root organizations

The root organizations page provides a powerful search and filtering feature to help you easily locate specific root organizations.

!!! note
To try out the Tenant Management REST API, refer [here]({{base_path}}/apis/tenant-management-rest-api/).
Please note that the search and filter feature is case-insensitive.

### Basic search

To simply search for a root organization by its `domain` name, enter the domain name in the search bar and press `Enter`.

This will do a basic search to find the root organizations that **contain** the search term in their `domain` name.

![Root Organization Search]({{base_path}}/assets/img/guides/multitenancy/root-organization-basic-search.png)

### Advanced search

To perform an advanced search, click on the **Filter** icon. This will open up a popup where you can search for root organizations based on the following parameters:

- **Filter attribute**: Search for root organizations based on an attribute.

!!! note
Currently, only the `Domain` attribute is supported.

- **Filter condition**: Choose an operator to perform the search.
- `Starts with`: Matches starting with the entered value.
- `Ends with`: Matches ending with the entered value.
- `Contains`: Matches containing the entered value.
- `Equals`: Matches containing exactly the entered value.

- **Filter value**: Enter the search value.

![Root Organization Advanced Search]({{base_path}}/assets/img/guides/multitenancy/root-organization-advanced-search.png)
2 changes: 1 addition & 1 deletion en/identity-server/next/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ nav:
- Recover your password: guides/your-is/recover-password.md
- Multitenancy:
- Multitenancy: guides/multitenancy/index.md
- Manage tenants: guides/multitenancy/manage-tenants.md
- Manage Root Organizations (Tenants): guides/multitenancy/manage-tenants.md
- Tenant loading policy: guides/multitenancy/configure-the-tenant-loading-policy.md
- Setup:
- Install:
Expand Down