|
| 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 | + |
| 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 | + |
| 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 | + |
| 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 | + |
| 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 | + |
| 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 | + |
| 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 | + |
| 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 | + |
| 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. |
0 commit comments