Skip to content
Open
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
14 changes: 14 additions & 0 deletions docs/platform/guides/client-organization/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: docs
menu:
docsplatform_{{.version}}:
identifier: client-organization
name: Client Organization
parent: guides
description: Manage client organizations on KubeDB Platform
icon: https://img.icons8.com/?size=100&id=80695&format=png&color=000000
popular: true
weight: 25
menu_name: docsplatform_{{.version}}
section_menu_id: guides
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
layout: docs
menu:
docsplatform_{{.version}}:
identifier: client-organization-add-cluster
name: Add a Cluster
parent: client-organization
weight: 30
menu_name: docsplatform_{{.version}}
section_menu_id: guides
---

# Add a Cluster to an Existing Client Organization

You can assign additional clusters to a client organization after it has been created. The **Add Cluster** wizard reuses the same **Gateway Configuration** and **Telemetry Configuration** steps as the [Create Client Organization](./create-client-organization.md) wizard.

## Open the Client Organization

Go to **Site Administration → Client Organizations** and click the organization's **Name** in the list to open its details.

![Client Organizations list — click an organization's name to open its details](./images/client-org-overview.png)

## Find the Add Cluster option

On the organization's details page, the **Clusters** section lists the clusters already assigned to the organization. Click **Add Cluster** in the top-right of that section to start the wizard.

![Client organization details page — the Clusters section with the Add Cluster button](./images/client-org-details.png)

## Step 1: Select Cluster

In the first step of the **Add Cluster** wizard, choose the cluster to assign and optionally tune where its database workloads are scheduled.

![Add Cluster wizard — Select Cluster step with hub cluster, spoke cluster, and DB nodepool](./images/add-cluster-to-existing-client-org.png)

- **Hub Cluster** *(required)* — the management (hub) cluster for this assignment.
- **Spoke Cluster** *(required)* — the spoke cluster where the organization's databases run.
- **Configure DB Nodepool** *(optional)* — key/value labels used to target specific nodes for database workloads.
- **Tolerations** *(optional)* — add tolerations so workloads can be scheduled onto tainted nodes. Each toleration takes an **Effect**, **Key**, **Operator**, and **Value**.

![Add Cluster wizard — Select Cluster step with DB nodepool and tolerations expanded](./images/add-cluster-to-existing-client-org-2.png)

Click **Next** to continue.

## Remaining Steps

After selecting the cluster, the wizard continues with the same **Gateway Configuration** and **Telemetry Configuration** steps used when creating a client organization:

- [Gateway Configuration](./create-client-organization.md#step-3-gateway-configuration) — choose a shared or dedicated gateway.
- [Telemetry Configuration](./create-client-organization.md#step-4-telemetry-configuration) — configure log and metrics retention.

Configure them as needed, then finish to add the cluster to the organization. The new cluster then appears in the **Clusters** section of the organization's details page.
109 changes: 109 additions & 0 deletions docs/platform/guides/client-organization/create-client-organization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
layout: docs
menu:
docsplatform_{{.version}}:
identifier: client-organization-create
name: Create a Client Organization
parent: client-organization
weight: 20
menu_name: docsplatform_{{.version}}
section_menu_id: guides
---

# Create a Client Organization

This guide walks through the **Create Client Organization** wizard. To open it, go to **Site Administration → Client Organizations** and start a new organization.

The wizard has four steps, shown on the right side of the form:

1. **User Information** — organization and admin details.
2. **Select Cluster** — hub and spoke cluster assignment.
3. **Gateway Configuration** — how the organization exposes its workloads.
4. **Telemetry Configuration** — review the monitoring setup and finish.

## Step 1: User Information

Enter the organization details and choose its administrator.

![Create Client Organization wizard — Step 1, User Information form with organization name, custom annotations, organization admin, and visibility](./images/create-client-organization.png)

- **Organization Name** *(required)* — used to provision the three namespaces (`orgName`, `orgName-gw`, and `orgName-monitoring`).
- **Organization Display Name** — a friendly name shown in the UI.
- **Custom Annotations** — optional key/value pairs added to the client organization namespace. Click **Add Annotations** to add more.
- **Organization Admin** — choose **Existing User** to assign an existing account, or **Create New User** to provision a new admin by entering a **Username** and **Email**.
- **Visibility** — controls who can see the organization:
- **Public** — visible to everyone.
- **Limited** — visible to logged-in users only.
- **Private** — visible only to organization members.

Click **Next** to continue.

## Step 2: Select Cluster

Assign the organization to a hub and spoke cluster, and optionally tune where its database workloads are scheduled.

![Create Client Organization wizard — Step 2, Select Cluster with hub cluster, spoke cluster, DB nodepool, and tolerations](./images/create-client-organization-2.png)

- **Hub Cluster** *(required)* — the management (hub) cluster for this organization.
- **Spoke Cluster** *(required)* — the spoke cluster where the organization's databases run.
- **Configure DB Nodepool** *(optional)* — key/value labels used to target specific nodes for database workloads. Click **Add Annotations** to add more.
- **Tolerations** *(optional)* — add tolerations so workloads can be scheduled onto tainted nodes. Each toleration takes an **Effect**, **Key**, **Operator** (for example, `Exists`), and **Value**.

Click **Next** to continue, or **Previous** to go back.

## Step 3: Gateway Configuration

Choose how the organization exposes its workloads. There are two top-level options.

### Use Shared Gateway

Select **Use Shared Gateway** to reuse the platform's shared gateway. No additional gateway configuration is required.

![Create Client Organization wizard — Step 3, Use Shared Gateway selected with no extra configuration](./images/use-shared-gateway.png)

### Use Dedicated Gateway

Select **Use Dedicated Gateway** to give the organization its own gateway. Then pick a **Dedicated Gateway Type**.

![Create Client Organization wizard — Step 3, Use Dedicated Gateway selected with the dedicated gateway type options](./images/use-dedicated-gateway.png)

#### Use Existing Gateway

Choose **Use Existing Gateway** and select a **Gateway Preset Config** to reuse an already-defined gateway configuration.

![Create Client Organization wizard — dedicated gateway using an existing gateway preset config](./images/use-existing-gateway.png)

#### Use Custom Gateway

Choose **Use Custom Gateway** to define the gateway yourself. Use **Can it be used as a shared Gateway?** to pick a starting point.

**Preload From Existing One** — start from an existing **Gateway Preset Config**, then edit the pre-filled fields across the **In Cluster** (certificates and keys), **Envoy Service** (service type, external IP, traffic policy, ports, provisioner type), and **Infra** (DNS provider, host type, host/domain, TLS issuer) sections.

![Create Client Organization wizard — custom dedicated gateway preloaded from an existing preset, showing In Cluster, Envoy Service, and Infra sections](./images/preload-existing-gateway.png)

**Create New From Start** — build the gateway from scratch by filling in the same **In Cluster**, **Envoy Service**, and **Infra** sections with your own values.

![Create Client Organization wizard — custom dedicated gateway created from scratch with empty In Cluster, Envoy Service, and Infra sections](./images/create-new-custom-gateway.png)

Click **Next** to continue.

## Step 4: Telemetry Configuration

In the final step, configure the telemetry settings that will be applied to the organization's `orgName-monitoring` namespace, then finish to create the client organization.

![Create Client Organization wizard — Step 4, Telemetry Configuration with monitoring type, log retention, and metrics retention periods](./images/telemetry-configuration.png)

- **Select Monitoring Type** — choose the monitoring stack to provision for the organization.
- **Logs** — set the **Retention Period** for collected logs.
- **Metrics** — set the retention periods for collected metrics:
- **Yearly Retention** — how long aggregated yearly metrics are kept.
- **Five Minute Retention** — how long five-minute resolution metrics are kept.
- **One Hour Retention** — how long one-hour resolution metrics are kept.

Click **Submit** to create the client organization, or **Previous** to go back.

Once created, the organization appears in the **Client Organizations** list and its admin can sign in to begin using it.

## Next steps

- [Add a Cluster to an Existing Client Organization](./add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
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.
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.
39 changes: 39 additions & 0 deletions docs/platform/guides/client-organization/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: docs
menu:
docsplatform_{{.version}}:
identifier: client-organization-overview
name: Overview
parent: client-organization
weight: 10
menu_name: docsplatform_{{.version}}
section_menu_id: guides
---

# Client Organizations

A **Client Organization** is an isolated tenant that a platform administrator provisions from **Site Administration**. It lets you give a team or customer their own organization on KubeDB Platform, scoped to a specific cluster, gateway, and monitoring setup.

When you create a client organization, the platform provisions three namespaces from the organization name (`orgName`):

| Namespace | Purpose |
| --- | --- |
| `orgName` | The organization's primary workload namespace. |
| `orgName-gw` | Holds the organization's gateway resources. |
| `orgName-monitoring` | Holds the organization's telemetry and monitoring resources. |

Each client organization is created with:

- An **organization admin** — either an existing user or a newly created one.
- An assigned **hub** and **spoke** cluster.
- A **gateway** configuration (shared or dedicated).
- A **telemetry** configuration applied to the monitoring namespace.

## Where to find it

Client organizations are managed from **Site Administration → Client Organizations**, under the **ADMINISTRATION** group in the left sidebar. You need site administration access to view and use this section.

## Next steps

- [Create a Client Organization](./create-client-organization.md) — a step-by-step walkthrough of the creation wizard.
- [Add a Cluster to an Existing Client Organization](./add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
Loading