diff --git a/docs/platform/guides/client-organization/_index.md b/docs/platform/guides/client-organization/_index.md new file mode 100644 index 0000000..5ec644e --- /dev/null +++ b/docs/platform/guides/client-organization/_index.md @@ -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 +--- diff --git a/docs/platform/guides/client-organization/create-client-organization.md b/docs/platform/guides/client-organization/create-client-organization.md new file mode 100644 index 0000000..cd80302 --- /dev/null +++ b/docs/platform/guides/client-organization/create-client-organization.md @@ -0,0 +1,94 @@ +--- +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, review the telemetry configuration that will be applied to the organization's `orgName-monitoring` namespace, then finish to create the client organization. + +Once created, the organization appears in the **Client Organizations** list and its admin can sign in to begin using it. diff --git a/docs/platform/guides/client-organization/images/create-client-organization-2.png b/docs/platform/guides/client-organization/images/create-client-organization-2.png new file mode 100644 index 0000000..546bf36 Binary files /dev/null and b/docs/platform/guides/client-organization/images/create-client-organization-2.png differ diff --git a/docs/platform/guides/client-organization/images/create-client-organization.png b/docs/platform/guides/client-organization/images/create-client-organization.png new file mode 100644 index 0000000..0e2fc64 Binary files /dev/null and b/docs/platform/guides/client-organization/images/create-client-organization.png differ diff --git a/docs/platform/guides/client-organization/images/create-new-custom-gateway.png b/docs/platform/guides/client-organization/images/create-new-custom-gateway.png new file mode 100644 index 0000000..f3baa0a Binary files /dev/null and b/docs/platform/guides/client-organization/images/create-new-custom-gateway.png differ diff --git a/docs/platform/guides/client-organization/images/preload-existing-gateway.png b/docs/platform/guides/client-organization/images/preload-existing-gateway.png new file mode 100644 index 0000000..11de628 Binary files /dev/null and b/docs/platform/guides/client-organization/images/preload-existing-gateway.png differ diff --git a/docs/platform/guides/client-organization/images/use-dedicated-gateway.png b/docs/platform/guides/client-organization/images/use-dedicated-gateway.png new file mode 100644 index 0000000..5821746 Binary files /dev/null and b/docs/platform/guides/client-organization/images/use-dedicated-gateway.png differ diff --git a/docs/platform/guides/client-organization/images/use-existing-gateway.png b/docs/platform/guides/client-organization/images/use-existing-gateway.png new file mode 100644 index 0000000..8b5577f Binary files /dev/null and b/docs/platform/guides/client-organization/images/use-existing-gateway.png differ diff --git a/docs/platform/guides/client-organization/images/use-shared-gateway.png b/docs/platform/guides/client-organization/images/use-shared-gateway.png new file mode 100644 index 0000000..6efaa5d Binary files /dev/null and b/docs/platform/guides/client-organization/images/use-shared-gateway.png differ diff --git a/docs/platform/guides/client-organization/overview.md b/docs/platform/guides/client-organization/overview.md new file mode 100644 index 0000000..6106f0a --- /dev/null +++ b/docs/platform/guides/client-organization/overview.md @@ -0,0 +1,38 @@ +--- +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.