Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:

- name: Install link checker
run: |
curl -fsSL -o liche https://github.com/appscodelabs/liche/releases/download/v0.1.0/liche-linux-amd64
curl -fsSL -o liche https://github.com/appscodelabs/liche/releases/download/v0.2.0/liche-linux-amd64
chmod +x liche
sudo mv liche /usr/local/bin/liche

Expand All @@ -50,11 +50,11 @@ jobs:

- name: Check links
run: |
liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'
liche -r docs -d $(pwd) -c 10 -p -h -l -s -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'
max_retries=5
retry_count=0
while [ $retry_count -lt $max_retries ]; do
if liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'; then
if liche -r docs -d $(pwd) -c 10 -p -h -l -s -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'; then
echo "Link check passed"
exit 0
fi
Expand Down
10 changes: 5 additions & 5 deletions docs/platform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ This page is the entry point for KubeDB Platform documentation.

## Core sections

- [Selfhost Setup](./selfhost-setup/)
- [Guides](./guides/)
- [Selfhost Setup](../selfhost-setup/)
- [Guides](../guides/)

## Contributor resources

- [Contributing](./contributing.md)
- [Support](./support.md)
- [Contributing](../contributing.md)
- [Support](../support.md)

Use [Guides](./guides/) for day-to-day workflows, then continue to [Selfhost Setup](./selfhost-setup/) for deployment-specific instructions.
Use [Guides](../guides/) for day-to-day workflows, then continue to [Selfhost Setup](../selfhost-setup/) for deployment-specific instructions.
16 changes: 8 additions & 8 deletions docs/platform/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ This section contains practical, task-oriented guides for operating and managing

## Guide categories

- [Account Management](./account-management/)
- [Billing and Usage Guide](./billing-and-usage-guide/)
- [Cluster Management](./cluster-management/)
- [Database Management](./database-management/)
- [Get Started](./get-started/)
- [Integrations](./integrations/)
- [License Management](./license-management/)
- [Account Management](../account-management/)
- [Billing and Usage Guide](../billing-and-usage-guide/)
- [Cluster Management](../cluster-management/)
- [Database Management](../database-management/)
- [Get Started](../get-started/)
- [Integrations](../integrations/)
- [License Management](../license-management/)

## Recommended path

For first-time users, start with [Get Started](./get-started/) and then move to the specific management areas relevant to your workflow.
For first-time users, start with [Get Started](../get-started/) and then move to the specific management areas relevant to your workflow.
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ A Client Organization provides logical separation between different clients shar

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

- **A Hub cluster is set up** — See [Create Hub & Spoke](../../cluster-management/hub-ui/create.md) for the full setup guide.
- **A Hub cluster is set up** — See [Create Hub & Spoke](../../../cluster-management/hub-ui/create.md) for the full setup guide.
- **A Spoke cluster is connected to the Hub** — The Spoke must be linked and accepted by the Hub administrator.
- **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.
- **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.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/guides/billing-and-usage-guide/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ What you’ll see in the Billable table
- Usage covered by the **30‑day free contract** when there’s no paid contract for the selected product.

**How to influence these numbers:**
- Cluster mode (`PROD` vs `NON‑PROD`) and namespace trials are configured in Cost Management: [Cost Management](./cost-management.md)
- Cluster mode (`PROD` vs `NON‑PROD`) and namespace trials are configured in Cost Management: [Cost Management](../cost-management.md)
- 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)

**For more details, please contact** [AppsCode administrators](https://appscode.com/contact/).
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,40 @@ section_menu_id: guides

# Add a Cluster to an Existing Client Organization

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

## Open the Client Organization

Go to **Site Administration → Client Organizations** and click the organization's **Name** in the list to open its details.

![Client Organizations list — click an organization's name to open its details](./images/client-org-overview.png)
![Client Organizations list — click an organization's name to open its details](.././images/client-org-overview.png)

## Find the Add Cluster option

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.

![Client organization details page — the Clusters section with the Add Cluster button](./images/client-org-details.png)
![Client organization details page — the Clusters section with the Add Cluster button](.././images/client-org-details.png)

## Step 1: Select Cluster

In the first step of the **Add Cluster** wizard, choose the cluster to assign and optionally tune where its database workloads are scheduled.

![Add Cluster wizard — Select Cluster step with hub cluster, spoke cluster, and DB nodepool](./images/add-cluster-to-existing-client-org.png)
![Add Cluster wizard — Select Cluster step with hub cluster, spoke cluster, and DB nodepool](.././images/add-cluster-to-existing-client-org.png)

- **Hub Cluster** *(required)* — the management (hub) cluster for this assignment.
- **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.
- **Tolerations** *(optional)* — add tolerations so workloads can be scheduled onto tainted nodes. Each toleration takes an **Effect**, **Key**, **Operator**, and **Value**.

![Add Cluster wizard — Select Cluster step with DB nodepool and tolerations expanded](./images/add-cluster-to-existing-client-org-2.png)
![Add Cluster wizard — Select Cluster step with DB nodepool and tolerations expanded](.././images/add-cluster-to-existing-client-org-2.png)

Click **Next** to continue.

## Remaining Steps

After selecting the cluster, the wizard continues with the same **Gateway Configuration** and **Telemetry Configuration** steps used when creating a client organization:

- [Gateway Configuration](./create-client-organization.md#step-3-gateway-configuration) — choose a shared or dedicated gateway.
- [Telemetry Configuration](./create-client-organization.md#step-4-telemetry-configuration) — configure log and metrics retention.
- [Gateway Configuration](../create-client-organization.md#step-3-gateway-configuration) — choose a shared or dedicated gateway.
- [Telemetry Configuration](../create-client-organization.md#step-4-telemetry-configuration) — configure log and metrics retention.

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.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The wizard has four steps, shown on the right side of the form:

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)
![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.
Expand All @@ -42,7 +42,7 @@ Click **Next** to continue.

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)
![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.
Expand All @@ -59,39 +59,39 @@ Choose how the organization exposes its workloads. There are two top-level optio

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)
![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)
![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)
![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 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)
![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, configure the telemetry settings that will be applied to the organization's `orgName-monitoring` namespace, then finish to create the client organization.

![Create Client Organization wizard — Step 4, Telemetry Configuration with monitoring type, log retention, and metrics retention periods](./images/telemetry-configuration.png)
![Create Client Organization wizard — Step 4, Telemetry Configuration with monitoring type, log retention, and metrics retention periods](.././images/telemetry-configuration.png)

- **Select Monitoring Type** — choose the monitoring stack to provision for the organization.
- **Logs** — set the **Retention Period** for collected logs.
Expand All @@ -106,4 +106,4 @@ Once created, the organization appears in the **Client Organizations** list and

## Next steps

- [Add a Cluster to an Existing Client Organization](./add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
- [Add a Cluster to an Existing Client Organization](../add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
4 changes: 2 additions & 2 deletions docs/platform/guides/client-organization/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ Client organizations are managed from **Site Administration → Client Organizat

## Next steps

- [Create a Client Organization](./create-client-organization.md) — a step-by-step walkthrough of the creation wizard.
- [Add a Cluster to an Existing Client Organization](./add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
- [Create a Client Organization](../create-client-organization.md) — a step-by-step walkthrough of the creation wizard.
- [Add a Cluster to an Existing Client Organization](../add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ section_menu_id: guides

# Create Vendor Managed Clusters

![Create vendor-managed cluster form showing cluster name, region, machine type, and cluster profile selection](../images/add_cluster/create-cluster-form.png)
![Create vendor-managed cluster form showing cluster name, region, machine type, and cluster profile selection](../../images/add_cluster/create-cluster-form.png)

![Creating cluster progress modal showing live status log](../images/add_cluster/create-cluster-progress.png)
![Creating cluster progress modal showing live status log](../../images/add_cluster/create-cluster-progress.png)
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Importing a `Rancher-Managed` cluster requires a Rancher Type Credential and a R

## Create Rancher Type Credential

Add a credential of type "Rancher" — see [Credentials Management](../../account-management/kubernetes/credentials.md#rancher).
Add a credential of type "Rancher" — see [Credentials Management](../../../account-management/kubernetes/credentials.md#rancher).

## Create a Rancher Managed Organization

Rancher clusters belong to Rancher Managed organizations, not personal accounts. Follow [Create a New Organization](../../account-management/orgs-members.md#create-a-new-organization) with these settings:
Rancher clusters belong to Rancher Managed organizations, not personal accounts. Follow [Create a New Organization](../../../account-management/orgs-members.md#create-a-new-organization) with these settings:

1. Set the organization's Origin to `Rancher Managed`.
2. Provide the Rancher `API Endpoint` (found on the `Account & API Keys` page).
Expand All @@ -30,4 +30,4 @@ Rancher clusters belong to Rancher Managed organizations, not personal accounts.
## Import the Cluster

1. Switch to the Rancher organization: in the [AppsCode Console](https://console.appscode.com), click your profile, choose `Switch Account`, and select the Rancher organization.
2. Follow the standard import process in [Import Vendor Managed Clusters](import-vendor-managed.md).
2. Follow the standard import process in [Import Vendor Managed Clusters](../import-vendor-managed.md).
Loading
Loading