Skip to content

Commit 791e93e

Browse files
authored
Add docs for client-org (#126)
Signed-off-by: Nihal Azmain <nihal@appscode.com>
1 parent ee3eccb commit 791e93e

16 files changed

Lines changed: 213 additions & 0 deletions
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: client-organization
6+
name: Client Organization
7+
parent: guides
8+
description: Manage client organizations on KubeDB Platform
9+
icon: https://img.icons8.com/?size=100&id=80695&format=png&color=000000
10+
popular: true
11+
weight: 25
12+
menu_name: docsplatform_{{.version}}
13+
section_menu_id: guides
14+
---
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: client-organization-add-cluster
6+
name: Add a Cluster
7+
parent: client-organization
8+
weight: 30
9+
menu_name: docsplatform_{{.version}}
10+
section_menu_id: guides
11+
---
12+
13+
# Add a Cluster to an Existing Client Organization
14+
15+
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.
16+
17+
## Open the Client Organization
18+
19+
Go to **Site Administration → Client Organizations** and click the organization's **Name** in the list to open its details.
20+
21+
![Client Organizations list — click an organization's name to open its details](./images/client-org-overview.png)
22+
23+
## Find the Add Cluster option
24+
25+
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.
26+
27+
![Client organization details page — the Clusters section with the Add Cluster button](./images/client-org-details.png)
28+
29+
## Step 1: Select Cluster
30+
31+
In the first step of the **Add Cluster** wizard, choose the cluster to assign and optionally tune where its database workloads are scheduled.
32+
33+
![Add Cluster wizard — Select Cluster step with hub cluster, spoke cluster, and DB nodepool](./images/add-cluster-to-existing-client-org.png)
34+
35+
- **Hub Cluster** *(required)* — the management (hub) cluster for this assignment.
36+
- **Spoke Cluster** *(required)* — the spoke cluster where the organization's databases run.
37+
- **Configure DB Nodepool** *(optional)* — key/value labels used to target specific nodes for database workloads.
38+
- **Tolerations** *(optional)* — add tolerations so workloads can be scheduled onto tainted nodes. Each toleration takes an **Effect**, **Key**, **Operator**, and **Value**.
39+
40+
![Add Cluster wizard — Select Cluster step with DB nodepool and tolerations expanded](./images/add-cluster-to-existing-client-org-2.png)
41+
42+
Click **Next** to continue.
43+
44+
## Remaining Steps
45+
46+
After selecting the cluster, the wizard continues with the same **Gateway Configuration** and **Telemetry Configuration** steps used when creating a client organization:
47+
48+
- [Gateway Configuration](./create-client-organization.md#step-3-gateway-configuration) — choose a shared or dedicated gateway.
49+
- [Telemetry Configuration](./create-client-organization.md#step-4-telemetry-configuration) — configure log and metrics retention.
50+
51+
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.
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: client-organization-create
6+
name: Create a Client Organization
7+
parent: client-organization
8+
weight: 20
9+
menu_name: docsplatform_{{.version}}
10+
section_menu_id: guides
11+
---
12+
13+
# Create a Client Organization
14+
15+
This guide walks through the **Create Client Organization** wizard. To open it, go to **Site Administration → Client Organizations** and start a new organization.
16+
17+
The wizard has four steps, shown on the right side of the form:
18+
19+
1. **User Information** — organization and admin details.
20+
2. **Select Cluster** — hub and spoke cluster assignment.
21+
3. **Gateway Configuration** — how the organization exposes its workloads.
22+
4. **Telemetry Configuration** — review the monitoring setup and finish.
23+
24+
## Step 1: User Information
25+
26+
Enter the organization details and choose its administrator.
27+
28+
![Create Client Organization wizard — Step 1, User Information form with organization name, custom annotations, organization admin, and visibility](./images/create-client-organization.png)
29+
30+
- **Organization Name** *(required)* — used to provision the three namespaces (`orgName`, `orgName-gw`, and `orgName-monitoring`).
31+
- **Organization Display Name** — a friendly name shown in the UI.
32+
- **Custom Annotations** — optional key/value pairs added to the client organization namespace. Click **Add Annotations** to add more.
33+
- **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**.
34+
- **Visibility** — controls who can see the organization:
35+
- **Public** — visible to everyone.
36+
- **Limited** — visible to logged-in users only.
37+
- **Private** — visible only to organization members.
38+
39+
Click **Next** to continue.
40+
41+
## Step 2: Select Cluster
42+
43+
Assign the organization to a hub and spoke cluster, and optionally tune where its database workloads are scheduled.
44+
45+
![Create Client Organization wizard — Step 2, Select Cluster with hub cluster, spoke cluster, DB nodepool, and tolerations](./images/create-client-organization-2.png)
46+
47+
- **Hub Cluster** *(required)* — the management (hub) cluster for this organization.
48+
- **Spoke Cluster** *(required)* — the spoke cluster where the organization's databases run.
49+
- **Configure DB Nodepool** *(optional)* — key/value labels used to target specific nodes for database workloads. Click **Add Annotations** to add more.
50+
- **Tolerations** *(optional)* — add tolerations so workloads can be scheduled onto tainted nodes. Each toleration takes an **Effect**, **Key**, **Operator** (for example, `Exists`), and **Value**.
51+
52+
Click **Next** to continue, or **Previous** to go back.
53+
54+
## Step 3: Gateway Configuration
55+
56+
Choose how the organization exposes its workloads. There are two top-level options.
57+
58+
### Use Shared Gateway
59+
60+
Select **Use Shared Gateway** to reuse the platform's shared gateway. No additional gateway configuration is required.
61+
62+
![Create Client Organization wizard — Step 3, Use Shared Gateway selected with no extra configuration](./images/use-shared-gateway.png)
63+
64+
### Use Dedicated Gateway
65+
66+
Select **Use Dedicated Gateway** to give the organization its own gateway. Then pick a **Dedicated Gateway Type**.
67+
68+
![Create Client Organization wizard — Step 3, Use Dedicated Gateway selected with the dedicated gateway type options](./images/use-dedicated-gateway.png)
69+
70+
#### Use Existing Gateway
71+
72+
Choose **Use Existing Gateway** and select a **Gateway Preset Config** to reuse an already-defined gateway configuration.
73+
74+
![Create Client Organization wizard — dedicated gateway using an existing gateway preset config](./images/use-existing-gateway.png)
75+
76+
#### Use Custom Gateway
77+
78+
Choose **Use Custom Gateway** to define the gateway yourself. Use **Can it be used as a shared Gateway?** to pick a starting point.
79+
80+
**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.
81+
82+
![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)
83+
84+
**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.
85+
86+
![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)
87+
88+
Click **Next** to continue.
89+
90+
## Step 4: Telemetry Configuration
91+
92+
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.
93+
94+
![Create Client Organization wizard — Step 4, Telemetry Configuration with monitoring type, log retention, and metrics retention periods](./images/telemetry-configuration.png)
95+
96+
- **Select Monitoring Type** — choose the monitoring stack to provision for the organization.
97+
- **Logs** — set the **Retention Period** for collected logs.
98+
- **Metrics** — set the retention periods for collected metrics:
99+
- **Yearly Retention** — how long aggregated yearly metrics are kept.
100+
- **Five Minute Retention** — how long five-minute resolution metrics are kept.
101+
- **One Hour Retention** — how long one-hour resolution metrics are kept.
102+
103+
Click **Submit** to create the client organization, or **Previous** to go back.
104+
105+
Once created, the organization appears in the **Client Organizations** list and its admin can sign in to begin using it.
106+
107+
## Next steps
108+
109+
- [Add a Cluster to an Existing Client Organization](./add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
548 KB
Loading
353 KB
Loading
341 KB
Loading
341 KB
Loading
357 KB
Loading
374 KB
Loading
595 KB
Loading

0 commit comments

Comments
 (0)