Skip to content

Commit fb75a0a

Browse files
Trimmed marketing fluff (e.g. "seamlessly", "unlock its full potential", redundant intros/closings) from the cluster-management and database-management guide sections
Signed-off-by: Arnob Kumar Saha <arnob@appscode.com>
1 parent c42424b commit fb75a0a

34 files changed

Lines changed: 104 additions & 181 deletions

docs/platform/guides/cluster-management/add-cluster/import-rancher-cluster.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,21 @@ section_menu_id: guides
1313

1414
# Adding a Rancher Managed Cluster to Platform Console
1515

16-
Adding a `Rancher-Managed` cluster to the Platform Console involves a slightly different process. In order to import a `Rancher-Managed` cluster to the Platform Console, you need to create a Rancher Managed Organization and a Rancher Type Credential.
16+
Importing a `Rancher-Managed` cluster requires a Rancher Type Credential and a Rancher Managed Organization.
1717

1818
## Create Rancher Type Credential
1919

20-
To create a Rancher type credential, refer to the [Credentials Management Documentation](../../account-management/kubernetes/credentials.md#rancher) and follow the instructions to add a new credential of type "Rancher."
20+
Add a credential of type "Rancher" — see [Credentials Management](../../account-management/kubernetes/credentials.md#rancher).
2121

2222
## Create a Rancher Managed Organization
2323

24-
Unlike personal accounts, Rancher clusters are associated with Rancher Managed organizations. Follow the [Create a New Organization](../../account-management/orgs-members.md#create-a-new-organization) documentation with the following additional steps:
24+
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:
2525

26-
1. Choose the organization's Origin as `Rancher Managed`.
27-
2. Provide the Rancher `API Endpoint`, which you can find under the `Account & API Keys` page.
28-
3. Click `Create` to complete the organization creation process.
26+
1. Set the organization's Origin to `Rancher Managed`.
27+
2. Provide the Rancher `API Endpoint` (found on the `Account & API Keys` page).
28+
3. Click `Create`.
2929

3030
## Import the Cluster
3131

32-
Before importing a Rancher Managed cluster into the Platform Console, you must switch to the Rancher organization. Follow these steps:
33-
34-
1. Go to [AppsCode Console](https://console.appscode.com).
35-
2. Click on the Profile Icon or username.
36-
3. Choose `Switch Account`.
37-
4. Select your Rancher organization.
38-
39-
Once you are in the Rancher organization, follow the standard cluster import process outlined in the [Import Vendor Managed Clusters](import-vendor-managed.md) documentation.
32+
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.
33+
2. Follow the standard import process in [Import Vendor Managed Clusters](import-vendor-managed.md).

docs/platform/guides/cluster-management/add-cluster/import-vendor-managed.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,33 +13,22 @@ section_menu_id: guides
1313

1414
# Adding a Vendor-Managed Cluster to Platform Console
1515

16-
Enhance your platform experience by seamlessly connecting your vendor-managed Kubernetes cluster to the [Platform Console](https://console.appscode.com/). Follow these step-by-step instructions:
17-
18-
1. Visit [Platform Console](https://console.appscode.com/).
19-
2. Click on the `Add Cluster` button.
16+
1. Go to the [Platform Console](https://console.appscode.com/) and click `Add Cluster`.
2017

2118
### Choose Provider
2219

23-
3. From the `Vendor Managed` section, select the provider hosting your Kubernetes cluster.
20+
2. In the `Vendor Managed` section, select the provider hosting your cluster.
2421

2522
### Select Credential
2623

27-
4. Choose a credential with the necessary permissions for accessing and importing the cluster. If you don't have a credential, create one by clicking the `+Create Credential` button [here](../../account-management/kubernetes/credentials.html).
28-
5. Select the created credential and click `Next`.
24+
3. Choose a credential with permission to access and import the cluster, then click `Next`. To create one, use the `+Create Credential` button (see [Credentials](../../account-management/kubernetes/credentials.html)).
2925

3026
### Select Cluster
3127

32-
6. This step varies based on your provider:
33-
- For `Linode` or `Digital Ocean`, directly select the cluster.
34-
- For `AKS`, `EKS`, and `GKE`:
35-
- Choose the appropriate `Resource Group`, `Region`, or `Project` where the cluster resides.
36-
- Select the specific cluster for import.
37-
38-
### Customize Feature and Import
39-
40-
7. Complete the process by clicking `Import` to bring the selected cluster into the Platform Console.
28+
4. Selection depends on the provider:
29+
- `Linode` / `Digital Ocean`: select the cluster directly.
30+
- `AKS` / `EKS` / `GKE`: choose the `Resource Group`, `Region`, or `Project`, then select the cluster.
4131

42-
### Explore
43-
8. Once imported, explore the cluster's details and capabilities within the dashboard.
32+
### Customize Features and Import
4433

45-
By following these steps, you'll seamlessly integrate your vendor-managed Kubernetes cluster, unlocking its full potential within the platform. Feel free to refer back to this tutorial for guidance.
34+
5. Click `Import` to bring the cluster into the Platform Console, then explore it in the dashboard.

docs/platform/guides/cluster-management/add-cluster/overview.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,14 @@ section_menu_id: guides
1212

1313
# Adding a Cluster to Platform Console
1414

15-
Integrating your Kubernetes cluster, whether it's vendor-managed or self-managed, into the platform console is a simple process that elevates your cluster management experience.
15+
Adding a Kubernetes cluster to the Platform Console takes two steps:
1616

17-
The procedure consists of two primary steps:
17+
## Step 1: Select the Cluster
1818

19-
## Step 1: Cluster Selection
19+
- **Vendor-Managed:** [Import Vendor Managed Clusters](import-vendor-managed.md)
20+
- **Rancher-Managed:** [Import Rancher Managed Clusters](import-rancher-cluster.md)
21+
- **Self-Managed:** [Import Self-Managed Clusters](self-managed/import-self-managed.md)
2022

21-
#### For Vendor-Managed Clusters
23+
## Step 2: Customize Features
2224

23-
To include Vendor-Managed clusters in the platform console, follow the steps outlined in [Import Vendor Managed Clusters](import-vendor-managed.md).
24-
25-
For Rancher Managed cluster, refer to [Import Rancher Managed Clusters](import-rancher-cluster.md) documentation.
26-
27-
#### For Self-Managed Clusters
28-
29-
If you have a self-managed Kubernetes cluster, refer to [Import Self-Managed Clusters](self-managed/import-self-managed.md) for detailed instructions on adding it to the platform console.
30-
31-
## Step 2: Feature Customization
32-
33-
Following the successful addition of your cluster, the next step involves customizing features to be installed during the cluster import process into our system. This ensures a seamless integration and optimizes the functionality of your cluster within the platform.
34-
35-
Explore your cluster further and leverage the full capabilities of the platform console.
36-
37-
Feel free to refer to the comprehensive documents linked above for a detailed walkthrough of each step in the process.
25+
Choose the features to install during import. The selected features are deployed into the cluster as part of the import process.

docs/platform/guides/cluster-management/add-cluster/self-managed/import-private.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,21 @@ section_menu_id: guides
1313

1414
# Adding a Private Self-Managed Cluster to Platform Console
1515

16-
Optimize your platform experience by seamlessly connecting your private or air-gapped self-managed Kubernetes cluster to the Platform Console. Follow these detailed steps for a smooth integration process:
16+
1. Go to the [Platform Console](https://console.appscode.com/) and click `Add Cluster`.
1717

18-
1. Navigate to the [Platform Console](https://console.appscode.com/).
19-
2. Click on the `Add Cluster` button to initiate the integration.
18+
### Select Cluster Type
2019

21-
### Cluster Type Selection - Private
22-
23-
3. From the `Self Managed` section, choose the option for a private or air-gapped cluster.
20+
2. In the `Self Managed` section, choose the private/air-gapped cluster option.
2421

2522
### Provide Kubeconfig and Get Import Link
2623

27-
4. Provide the kubeconfig for your private Kubernetes cluster. Click `Get Import Link` button and you will get two commands. Execute either of these commands in your Kubernetes cluster.
24+
3. Provide the kubeconfig for your cluster and click `Get Import Link`. Run either of the two returned commands inside your cluster.
2825

29-
### Feature Customization
26+
### Customize Features
3027

31-
5. After completion, the UI will automatically transition to the feature customization step, optimizing your cluster's capabilities within the platform.
28+
4. The UI then moves to the feature customization step.
3229

3330
### Explore
3431

35-
6. Once imported, explore the cluster's details and capabilities within the Platform Console.
36-
37-
By following these steps, you'll seamlessly integrate your private or air-gapped self-managed Kubernetes cluster, unlocking its full potential within the platform. Feel free to refer back to this tutorial for guidance.
32+
5. Once imported, explore the cluster in the Platform Console.
3833

docs/platform/guides/cluster-management/add-cluster/self-managed/import-public.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,21 @@ section_menu_id: guides
1313

1414
# Adding a Public Self-Managed Cluster to Platform Console
1515

16-
Elevate your Kubernetes cluster management with Platform Console by seamlessly integrating your public self-managed Kubernetes cluster. Follow these detailed steps for a smooth integration process:
16+
1. Go to the [Platform Console](https://console.appscode.com/) and click `Add Cluster`.
1717

18-
1. Navigate to the [Platform Console](https://console.appscode.com/).
19-
2. Click on the `Add Cluster` button to initiate the integration.
18+
### Select Cluster Type
2019

21-
### Cluster Type Selection - Public
20+
2. In the `Self Managed` section, choose the public cluster option.
2221

23-
3. From the `Self Managed` section, choose the option for a public cluster.
22+
### Provide Kubeconfig
2423

25-
### Provide Public Kubeconfig
24+
3. Provide the kubeconfig for your cluster.
2625

27-
4. Provide the public kubeconfig for your Kubernetes cluster. This file contains essential information for establishing a connection between your cluster and the Platform Console.
26+
### Customize Features
2827

29-
### Feature Customization
30-
31-
5. Proceed seamlessly to the feature customization step, enhancing your cluster's capabilities within the platform.
28+
4. Proceed to the feature customization step.
3229

3330
### Explore
3431

35-
6. Once imported, explore the cluster's details and capabilities within the Platform Console.
36-
37-
By following these steps, you'll effortlessly integrate your public self-managed Kubernetes cluster, unlocking its full potential within the platform. Feel free to refer back to this tutorial for guidance.
32+
5. Once imported, explore the cluster in the Platform Console.
3833

docs/platform/guides/cluster-management/add-cluster/self-managed/import-self-managed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ section_menu_id: guides
1212

1313
# Adding a Self-Managed Cluster to Platform Console
1414

15-
If you possess a kubeconfig for either a public Kubernetes cluster or an air-gapped cluster, categorically referred to as self-managed clusters, here are the guides to seamlessly import these clusters into the Platform Console:
15+
A self-managed cluster is any cluster you have a kubeconfig for public or air-gapped. Use the guides below to import it into the Platform Console:
1616

1717
<div class="is-flex gap-8">
1818
<a href="./import-public.html" class="single-card">

docs/platform/guides/cluster-management/cluster-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ section_menu_id: guides
1212

1313
# Manage Feature Sets
1414

15-
**Feature Sets** are groups of AppsCode product capabilities that you can install or remove on any connected cluster. This page walks you through all 18 available Feature Sets and shows a step-by-step enable flow for the two most commonly used ones: **Backup & Recovery** and **Databases**.
15+
**Feature Sets** are groups of AppsCode product capabilities that you can install or remove on any connected cluster. This page covers all 18 available Feature Sets and shows the enable flow for two common ones: **Backup & Recovery** and **Databases**.
1616

1717
---
1818

docs/platform/guides/cluster-management/cluster-helm-charts.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ section_menu_id: guides
1313

1414
# Manage Helm Charts in Platform Console
1515

16-
Platform Console offers a robust Helm Chart Management feature, allowing users to effortlessly manage Helm releases within their Kubernetes clusters. This functionality streamlines the installation of new charts, interaction with existing releases, and provides an overall intuitive interface for Helm chart management.
16+
Platform Console's Helm Chart Management lets you manage Helm releases within your Kubernetes clusters — installing new charts, modifying existing releases, and rolling back versions from the UI.
1717

1818
## Accessing Helm Chart Management
1919

@@ -26,21 +26,11 @@ To navigate to the Helm Chart Management page:
2626

2727
### Install New Charts
2828

29-
Installing new Helm charts is a straightforward process:
30-
3129
1. **Choose Chart Source:** Select a chart source from publicly available URLs or provide a custom URL.
3230
2. **Select Chart and Version:** Browse and choose the desired chart and version.
3331
3. **Customize Installation:** Provide a custom release name, namespace, and specify a custom values file during installation.
3432

3533
### Interact with Existing Releases
3634

37-
Efficiently manage existing Helm releases:
38-
3935
- **Modify Releases:** Adjust existing Helm releases based on evolving requirements.
40-
- **Rollback to Previous Versions:** Easily revert to previous versions of Helm releases if needed.
41-
42-
### User-Friendly Interface
43-
44-
The Helm Chart Management page in the Platform Console ensures an intuitive and user-friendly interface. This allows users to manage Helm releases seamlessly, minimizing the reliance on complex Helm CLI commands.
45-
46-
Explore the power of Helm chart management within the Platform Console and enhance your Kubernetes experience.
36+
- **Rollback to Previous Versions:** Revert to previous versions of Helm releases if needed.

docs/platform/guides/cluster-management/cluster-sidebar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ section_menu_id: guides
1212

1313
# Customize the Cluster Sidebar
1414

15-
The **Cluster Sidebar** is your primary navigation panel inside a connected cluster. By default, it shows a curated set of Kubernetes workloads and AppsCode custom resources. The **Sidebar Settings** page lets you fully customize which menu items appear, so you can tailor the experience to your team's needs.
15+
The **Cluster Sidebar** is the navigation panel inside a connected cluster. By default it shows a set of Kubernetes workloads and AppsCode custom resources. The **Sidebar Settings** page lets you customize which menu items appear.
1616

1717
---
1818

@@ -59,7 +59,7 @@ For example, typing `cert` instantly filters the list and highlights all matches
5959

6060
## Step 4 — Add or Rearrange Items (Drag & Drop)
6161

62-
To add a resource to your sidebar, simply **drag** it from the **All Available Menus** panel on the left and **drop** it into the **Updated List** panel on the right at the position you prefer.
62+
To add a resource to your sidebar, **drag** it from the **All Available Menus** panel on the left and **drop** it into the **Updated List** panel on the right at the position you prefer.
6363

6464
In the example below, the user is dragging **Appscode K8s Management → ProjectQuota** into the current sidebar layout. You can see it appearing as a floating drag indicator (``) in the left panel.
6565

docs/platform/guides/cluster-management/cluster-upgrade.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,7 @@ section_menu_id: guides
1515

1616
## Overview
1717

18-
This guide walks through upgrading a **KubeDB Platform** deployment
19-
across all cluster tiers, the base management cluster, the KubeDB Platform cluster, general imported
20-
clusters, and spoke clusters. The example below upgrades from release `2025.5.16` to
21-
`2025.6.x`.
18+
Upgrade a **KubeDB Platform** deployment across all cluster tiers: the base management cluster, the KubeDB Platform cluster, general imported clusters, and spoke clusters. The example below upgrades from release `2025.5.16` to `2025.6.x`.
2219

2320
---
2421

0 commit comments

Comments
 (0)