Skip to content

Commit 183c8a5

Browse files
committed
Refresh docs
Signed-off-by: Tamal Saha <tamal@appscode.com>
1 parent 3301c89 commit 183c8a5

1,953 files changed

Lines changed: 36631 additions & 4802 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/docs/platform/v2026.6.19/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ This page is the entry point for KubeDB Platform documentation.
2626

2727
## Core sections
2828

29-
- [Selfhost Setup](./selfhost-setup/)
30-
- [Guides](./guides/)
29+
- [Selfhost Setup](../selfhost-setup/)
30+
- [Guides](../guides/)
3131

3232
## Contributor resources
3333

34-
- [Contributing](./contributing.md)
35-
- [Support](./support.md)
34+
- [Contributing](../contributing.md)
35+
- [Support](../support.md)
3636

37-
Use [Guides](./guides/) for day-to-day workflows, then continue to [Selfhost Setup](./selfhost-setup/) for deployment-specific instructions.
37+
Use [Guides](../guides/) for day-to-day workflows, then continue to [Selfhost Setup](../selfhost-setup/) for deployment-specific instructions.

content/docs/platform/v2026.6.19/guides/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,15 @@ This section contains practical, task-oriented guides for operating and managing
2424

2525
## Guide categories
2626

27-
- [Account Management](./account-management/)
28-
- [Billing and Usage Guide](./billing-and-usage-guide/)
29-
- [Cluster Management](./cluster-management/)
30-
- [Database Management](./database-management/)
31-
- [Get Started](./get-started/)
32-
- [Integrations](./integrations/)
33-
- [License Management](./license-management/)
27+
- [Account Management](../guides/account-management/manage-profile/)
28+
- [Billing and Usage Guide](../guides/billing-and-usage-guide/overview)
29+
- [License Management](../guides/license-management/overview)
30+
- [Cluster Management](../guides/cluster-management/cluster-overview)
31+
- [Database Management](../guides/database-management/overview)
32+
- [Get Started](../guides/get-started/architecture)
33+
- [Integrations](../guides/integrations/rancher-extension)
34+
3435

3536
## Recommended path
3637

37-
For first-time users, start with [Get Started](./get-started/) and then move to the specific management areas relevant to your workflow.
38+
For first-time users, start with [Get Started](../guides/get-started/architecture) and then move to the specific management areas relevant to your workflow.

content/docs/platform/v2026.6.19/guides/account-management/kubernetes/credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ To access Scaleway resources, you need your Organization ID and an API secret ke
425425
- **Organization:** Your Scaleway Organization ID (a UUID), found under **Organization Settings** in the Scaleway Console.
426426
- **Token:** Your API Secret Key. Navigate to **Identity and Access Management (IAM) > API Keys**, create a new API key, and copy the **Secret Key**.
427427

428-
Ref: [Scaleway API Keys](https://www.scaleway.com/en/docs/iam/api-keys/)
428+
Ref: [Scaleway API Keys](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/)
429429

430430
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create).
431431

content/docs/platform/v2026.6.19/guides/account-management/site-administration/client-org.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ A Client Organization provides logical separation between different clients shar
2525

2626
Before creating a Client Organization, make sure the following are already in place:
2727

28-
- **A Hub cluster is set up** — See [Create Hub & Spoke](../../cluster-management/hub-ui/create.md) for the full setup guide.
28+
- **A Hub cluster is set up** — See [Create Hub & Spoke](../../../cluster-management/hub-ui/create.md) for the full setup guide.
2929
- **A Spoke cluster is connected to the Hub** — The Spoke must be linked and accepted by the Hub administrator.
30-
- **The Spoke cluster is licensed** — A valid license certificate must be applied to the Spoke. Without it, database features remain in a **Warning** state and the organization cannot be created. See [License Management](../../cluster-management/hub-ui/license-management.md) for details.
30+
- **The Spoke cluster is licensed** — A valid license certificate must be applied to the Spoke. Without it, database features remain in a **Warning** state and the organization cannot be created. See [License Management](../../../cluster-management/hub-ui/license-management.md) for details.
3131

3232
> ⚠️ Always perform these steps from an **Organization/Work account**. Personal accounts do not support Hub-Spoke features.
3333

content/docs/platform/v2026.6.19/guides/billing-and-usage-guide/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ What you’ll see in the Billable table
5959
- Usage covered by the **30‑day free contract** when there’s no paid contract for the selected product.
6060

6161
**How to influence these numbers:**
62-
- Cluster mode (`PROD` vs `NON‑PROD`) and namespace trials are configured in Cost Management: [Cost Management](./cost-management.md)
62+
- Cluster mode (`PROD` vs `NON‑PROD`) and namespace trials are configured in Cost Management: [Cost Management](../cost-management.md)
6363
- Contract behavior (`paid` vs. `30‑day free` when none exists) is described here: [Contract docs](http://appscode.com/docs/en/guides/license-management/contract.html)
6464

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

0 commit comments

Comments
 (0)