Skip to content

Commit 9db9778

Browse files
committed
Add docs on adding cluster
Signed-off-by: Nihal Azmain <nihal@appscode.com>
1 parent d08207b commit 9db9778

6 files changed

Lines changed: 43 additions & 1 deletion

File tree

docs/platform/guides/client-organization/create-client-organization.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,48 @@ Click **Next** to continue.
8989

9090
## Step 4: Telemetry Configuration
9191

92-
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.
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.
93104

94105
Once created, the organization appears in the **Client Organizations** list and its admin can sign in to begin using it.
106+
107+
## Add a Cluster to an Existing Client Organization
108+
109+
You can also assign additional clusters to a client organization after it has been created.
110+
111+
From **Site Administration → Client Organizations**, select the organization you want to update.
112+
113+
![Client Organizations list with the existing organizations](./images/client-org-overview.png)
114+
115+
On the organization's details page, review its **Basic Info** and the **Clusters** it is already assigned to, then click **Add Cluster**.
116+
117+
![Client organization details page showing Basic Info and the assigned Clusters with the Add Cluster button](./images/client-org-details.png)
118+
119+
### Step 1: Select Cluster
120+
121+
In the first step of the **Add Cluster** wizard, choose the cluster to assign and optionally tune where its database workloads are scheduled.
122+
123+
![Add Cluster wizard — Select Cluster step with hub cluster, spoke cluster, and DB nodepool](./images/add-cluster-to-existing-client-org.png)
124+
125+
- **Hub Cluster** *(required)* — the management (hub) cluster for this assignment.
126+
- **Spoke Cluster** *(required)* — the spoke cluster where the organization's databases run.
127+
- **Configure DB Nodepool** *(optional)* — key/value labels used to target specific nodes for database workloads.
128+
- **Tolerations** *(optional)* — add tolerations so workloads can be scheduled onto tainted nodes. Each toleration takes an **Effect**, **Key**, **Operator**, and **Value**.
129+
130+
![Add Cluster wizard — Select Cluster step with DB nodepool and tolerations expanded](./images/add-cluster-to-existing-client-org-2.png)
131+
132+
Click **Next** to continue.
133+
134+
### Remaining Steps
135+
136+
After selecting the cluster, the wizard continues with the same **Gateway Configuration** and **Telemetry Configuration** steps described above for creating a client organization. Configure them as needed, then finish to add the cluster to the organization.
548 KB
Loading
353 KB
Loading
341 KB
Loading
341 KB
Loading
366 KB
Loading

0 commit comments

Comments
 (0)