Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ Then add the credential [here](https://home.appscode.com/user/settings/credentia

## Rancher

To access Rancher clusters through AppsCode, you need to create an API token in your Rancher system. Follow these steps:
To access Rancher clusters through KubeDB Platform, you need to create an API token in your Rancher system. Follow these steps:

1. In Rancher, click on the profile icon.
2. Select `Account & API Keys`.
Expand All @@ -369,7 +369,7 @@ Reference: [Rancher API Keys](https://ranchermanager.docs.rancher.com/reference-

Copy the generated access key, secret key, and API endpoint from the `Account & API Keys` overview page.

Next, add these credentials to the [AppsCode user settings credentials page](https://home.appscode.com/user/settings/credentials/create).
Next, add these credentials to the [KubeDB Platform user settings credentials page](https://home.appscode.com/user/settings/credentials/create).

<img align="right" width="50%" src="../images/credentials/azureStorage.png">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ layout: docs
menu:
docsplatform_{{.version}}:
identifier: account-management-siteadmin-ace-upgrade
name: ACE Upgrade
name: KubeDB Platform Upgrade
parent: account-management-siteadmin
weight: 60
menu_name: docsplatform_{{.version}}
section_menu_id: guides
---


# ACE Upgrade
# KubeDB Platform Upgrade

Site administrators can upgrade the AppsCode Enterprise (ACE) management cluster directly from the platform UI by uploading a configuration file downloaded from the AppsCode portal.
Site administrators can upgrade the KubeDB Platform management cluster directly from the platform UI by uploading a configuration file downloaded from the KubeDB Platform portal.

---

Expand All @@ -27,21 +27,21 @@ Before starting the upgrade, download the required values file from the AppsCode

---

## Step 1 — Open ACE Upgrade
## Step 1 — Open KubeDB Platform Upgrade

![ACE Version Page](../images/upgrade-version-1.png)
![KubeDB Platform Version Page](../images/upgrade-version-1.png)

Go to **SITE ADMINISTRATION > ACE Upgrade** from the left-hand menu.
Go to **SITE ADMINISTRATION > KubeDB Platform Upgrade** from the left-hand menu.

The page displays the current ACE version and the upgrade status of all platform components. Click the **Upgrade Version** button at the top right to begin.
The page displays the current KubeDB Platform version and the upgrade status of all platform components. Click the **Upgrade Version** button at the top right to begin.

---

## Step 2 — Upload the Values File

![Upload Values File](../images/upgrade-version-2.png)

On the **Upgrade ACE** screen:
On the **Upgrade KubeDB Platform** screen:

- Click **Upload values file...** and select the `values.yaml` file downloaded from the AppsCode portal.
- Click **Update Version** to start the upgrade process.
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 @@ -18,7 +18,7 @@ This document provides a detailed overview of the **Usage** section within our b

The AppsCode Billing Console is a web-based hub at [AppsCode Billing Console](https://appscode.com/billing) where you can manage contracts, link clusters, generate license-proxyserver installers, track licensed clusters, and **monitor usage—all in one place**.

This section focuses on the **Usage** dashboard, which shows the resources consumed by downstream AppsCode services like KubeDB running in your clusters.
This section focuses on the **Usage** dashboard, which shows the resources consumed by downstream KubeDB Platform services like KubeDB running in your clusters.

![usage-dashboard](../images/usage-section-home.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The Feature Sets grid on the Cluster Overview page shows all available product m
| **Multicluster Spoke** | Connect this cluster as a spoke to an existing Multicluster Hub. |
| **Networking Addons** | Various networking plugins and extensions for Kubernetes. |
| **Observability** | Cluster monitoring, metrics, and dashboards using Prometheus and Grafana. |
| **Opscenter Tools** | DevOps tooling and management utilities for ACE. |
| **Opscenter Tools** | DevOps tooling and management utilities for KubeDB Platform. |
| **Policy Management** | Platform-level policy enforcement tools. |
| **Secret Management** | Tools for secure secret storage and distribution across namespaces. |
| **Security** | TLS certificate management, secret scanning, and image vulnerability tooling. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Scroll down past the **Basic** section to see the **Feature Sets** grid. Each ca
| **Multicluster Spoke** | Connect this cluster as a spoke to a hub |
| **Networking Addons** | Various networking addons for Kubernetes |
| **Observability** | Cluster monitoring with Prometheus and Grafana |
| **Opscenter Tools** | DevOps tools for ACE |
| **Opscenter Tools** | DevOps tools for KubeDB Platform |
| **Policy Management** | Platform policy management tools |
| **Secret Management** | Tools for secret management |
| **Security** | TLS, secret scanning, and vulnerability tools |
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/guides/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ menu:
identifier: guide-start
name: Get Started
parent: guides
description: Basic information and instructions for first-time users of AppsCode
description: Basic information and instructions for first-time users of KubeDB Platform
icon: https://img.icons8.com/00994A/ios/50/rocket--v1.png
popular: true
weight: 10
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/guides/get-started/add-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ section_menu_id: guides

# Add a Kubernetes Cluster

With your credentials in place, it's time to connect your Kubernetes cluster to the Platform Console. This step allows AppsCode to seamlessly manage and provide insights into your cluster.
With your credentials in place, it's time to connect your Kubernetes cluster to the Platform Console. This step allows KubeDB Platform to seamlessly manage and provide insights into your cluster.

Follow these steps to import your Kubernetes cluster:

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/guides/get-started/add-credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ section_menu_id: guides

# Add Credential

Now that you have successfully registered and logged in to the Platform Console, let's take the next step in setting up your environment. The first crucial task is to add credentials for your Kubernetes clusters. This ensures a secure connection and allows AppsCode to seamlessly manage your clusters.
Now that you have successfully registered and logged in to the Platform Console, let's take the next step in setting up your environment. The first crucial task is to add credentials for your Kubernetes clusters. This ensures a secure connection and allows KubeDB Platform to seamlessly manage your clusters.

Follow these steps to add your credentials:

Expand Down
10 changes: 5 additions & 5 deletions docs/platform/guides/get-started/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Let's first discuss some basic terminologies, those will be repeated many times

![architecture](../images/architecture.png)

### ACE
ACE is the central management cluster where we will deploy all the ui-components. Namely the `backend server(ace-platform-api)`, `kubedb-ui`, `cluster-ui`, `billing-ui`, `platform-ui`, `grafana-ui`, ingresses etc. This will be mainly used by the administrators & devops engineers.
### KubeDB Platform
KubeDB Platform is the central management cluster where we will deploy all the ui-components. Namely the `backend server(ace-platform-api)`, `kubedb-ui`, `cluster-ui`, `billing-ui`, `platform-ui`, `grafana-ui`, ingresses etc. This will be mainly used by the administrators & devops engineers.
As this is the central point of management, we call it `Management cluster`. As all the UI-components installed in this, we sometimes call `UI cluster`.

We also have native-integration of [OCM hub-spoke model](https://open-cluster-management.io/docs/concepts/architecture/). This is by-default enabled. This integration enables the cluster-manager to easily do similar changes(for example: installing a feature) centrally.
ACE is used as the hub of OCM mode. Thats why we call this `Hub cluster` too.
KubeDB Platform is used as the hub of OCM mode. Thats why we call this `Hub cluster` too.

The ACE cluster can be a single-node k3s cluster for staging or development. Or a full-fledged multi-node cluster for prod.
The KubeDB Platform cluster can be a single-node k3s cluster for staging or development. Or a full-fledged multi-node cluster for prod.

The installer page on the `selfhost-ui` on appscode.com provides instructions for quickly setting up a K3s cluster to get started immediately.

Expand All @@ -32,4 +32,4 @@ While importing, if someone make it a spoke, then cluster-manager-spoke features
If you don't want to manage it from the hub, we can just import it as a general cluster. In that case, that auto-sync from hub will not happen.


Both ACE & DBaaS clusters can be of any vendors like AWS, Azure, Google Cloud etc. It can be an on-prem cluster too.
Both KubeDB Platform & DBaaS clusters can be of any vendors like AWS, Azure, Google Cloud etc. It can be an on-prem cluster too.
4 changes: 2 additions & 2 deletions docs/platform/guides/get-started/enable-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ section_menu_id: guides
# Enable Features


Once your cluster is imported, you can enable or disable AppsCode features based on your requirements.
Once your cluster is imported, you can enable or disable KubeDB Platform features based on your requirements.

1. Navigate to your Cluster Overview page, selecting your imported cluster in the [Platform Console](https://console.appscode.com/).
2. In the "Feature Sets" section, you'll find a list of FeatureSets associated with your cluster, along with their current status.
3. Click on any FeatureSet in the list to go to the FeatureSet Management page.
4. On the FeatureSet Management page, you can enable or disable specific features according to your needs.

Managing features in the Platform Console is a straightforward process that allows you to tailor your Platform Console to meet your cluster's requirements. Feel free to explore the features and capabilities offered by AppsCode.
Managing features in the Platform Console is a straightforward process that allows you to tailor your Platform Console to meet your cluster's requirements. Feel free to explore the features and capabilities offered by KubeDB Platform.

For more advanced configurations and detailed documentation, check out the [Features in Details](../cluster-management/cluster-features.md).
14 changes: 7 additions & 7 deletions docs/platform/guides/get-started/register-login.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ section_menu_id: guides
---


# Get Started with AppsCode
# Get Started with KubeDB Platform

## Register and Login

Welcome to AppsCode! This is a new version Follow these quick steps to get started:
Welcome to KubeDB Platform! This is a new version Follow these quick steps to get started:

### 1. Register for an Account

1. Navigate to the [AppsCode Registration Page](https://accounts.appscode.com/user/sign_up).
1. Navigate to the [KubeDB Platform Registration Page](https://accounts.appscode.com/user/sign_up).
2. Provide the following information:
- Username
- Email
Expand All @@ -33,14 +33,14 @@ Welcome to AppsCode! This is a new version Follow these quick steps to get start

### 2. Verify Your Email

After registration, check your email inbox for a verification email from AppsCode.
After registration, check your email inbox for a verification email from KubeDB Platform.

1. Open the verification email.
2. Click on the verification link to confirm your account.

### 3. Log In to AppsCode
### 3. Log In to KubeDB Platform

1. Once your account is verified, go to the [AppsCode Login Page](https://accounts.appscode.com/user/login).
1. Once your account is verified, go to the [KubeDB Platform Login Page](https://accounts.appscode.com/user/login).
2. Enter your registered `Username` or `Email Address` and `Password`.
3. Click on the `Sign In` button.
4. Optionally, you can sign in using your connected External accounts.
Expand All @@ -49,4 +49,4 @@ After registration, check your email inbox for a verification email from AppsCod

You are now logged in to the Platform Console! Take a moment to explore the features and navigate through the dashboard.

Congratulations! You have successfully registered, verified your email, and logged in to AppsCode. If you encounter any issues or have questions, refer to the [AppsCode Documentation](https://appscode.com/docs/) for detailed guidance.
Congratulations! You have successfully registered, verified your email, and logged in to KubeDB Platform. If you encounter any issues or have questions, refer to the [KubeDB Platform Documentation](https://appscode.com/docs/) for detailed guidance.
16 changes: 8 additions & 8 deletions docs/platform/guides/get-started/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ layout: docs
menu:
docsplatform_{{.version}}:
identifier: guide-ace-requirements
name: ACE Requirements
name: KubeDB Platform Requirements
parent: guide-start
weight: 14
menu_name: docsplatform_{{.version}}
section_menu_id: guides
---

# Requirements to deploy ACE
We will discuss the resources requirements. networking requirements & best practices for deploying your first ACE & DBaaS cluster. It is highly recommended to read the [architecture](https://appscode.com/docs/en/guides/get-started/architecture.html) doc first before continuing.
# Requirements to deploy KubeDB Platform
We will discuss the resources requirements. networking requirements & best practices for deploying your first KubeDB Platform & DBaaS cluster. It is highly recommended to read the [architecture](https://appscode.com/docs/en/guides/get-started/architecture.html) doc first before continuing.

## Requirements for ACE Cluster
## Requirements for KubeDB Platform Cluster

### 1. Resources
**Minimum**: Single node with 4 cpu, 16 GB ram, 100 GB disk attached. A k3s cluster will be deployed on that VM. And then the ui-components will be installed.
Expand All @@ -40,7 +40,7 @@ These are the required connectivities to everything work correctly:
3. 4222 - NATS.io port
4. 4224 - s3-proxy service port

Here is a sample video on how you can setup ACE:
Here is a sample video on how you can setup KubeDB Platform:
<iframe width="560" height="315" src="https://www.youtube.com/embed/1diG8qq73f4?si=pisqA3gOrfO1wxlx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

## Requirements for DBaaS Cluster
Expand All @@ -52,7 +52,7 @@ Minimum: Kubernetes cluster with 3 worker nodes, each with 8- 16GB ram, PVC supp
Note that, The largest node must be able to fit the largest DB Pod(in terms of CPU, memory).

### 2. Networking
Literally all the Networking requirements described for ACE are also applicable here, except the `Port Requiements` part.
Only one additional requirement here is that the DBaaS cluster should be accessible from the management/ACE cluster.
Literally all the Networking requirements described for KubeDB Platform are also applicable here, except the `Port Requiements` part.
Only one additional requirement here is that the DBaaS cluster should be accessible from the management/KubeDB Platform cluster.

You now have an overall idea on the requirements. So, [Login](https://appscode.com/docs/en/guides/get-started/register-login.html) into your account & get going with our [installer](https://appscode.com/selfhost/). Happy ACE!
You now have an overall idea on the requirements. So, [Login](https://appscode.com/docs/en/guides/get-started/register-login.html) into your account & get going with our [installer](https://appscode.com/selfhost/). Happy KubeDB Platform!
2 changes: 1 addition & 1 deletion docs/platform/guides/integrations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ menu:
identifier: integrations
name: Integrations
parent: guides
description: Integrate ACE into your Kubernetes platform
description: Integrate KubeDB Platform into your Kubernetes platform
icon: https://img.icons8.com/?size=100&id=80695&format=png&color=000000
popular: true
weight: 40
Expand Down
18 changes: 9 additions & 9 deletions docs/platform/guides/integrations/rancher-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,33 +24,33 @@ Before proceeding, make sure you have:

- A Rancher setup with access to the **Local** cluster.
- An account on [appscode.com](https://appscode.com/).
- The [ACE](https://appscode.com/docs/en/selfhost-setup/) platform deployed on your Rancher cluster.
- The [KubeDB Platform](https://appscode.com/docs/en/selfhost-setup/) deployed on your Rancher cluster.

---

## 2. Deploying the KubeDB Rancher Extension

### Step 1 – Deploy ACE
### Step 1 – Deploy KubeDB Platform
1. Create an account at [appscode.com](https://appscode.com/).
2. Follow the [self-hosting ACE guide](https://appscode.com/docs/en/selfhost-setup/) to deploy ACE on your Rancher cluster.
You can also watch this video tutorial for step-by-step instructions: [Self-Hosting ACE Video Guide](https://www.youtube.com/watch?v=1diG8qq73f4&list=PLoiT1Gv2KR1iqWFGkCozbLqYe31QMsQcX&index=2)
2. Follow the [self-hosting KubeDB Platform guide](https://appscode.com/docs/en/selfhost-setup/) to deploy KubeDB Platform on your Rancher cluster.
You can also watch this video tutorial for step-by-step instructions: [Self-Hosting KubeDB Platform Video Guide](https://www.youtube.com/watch?v=1diG8qq73f4&list=PLoiT1Gv2KR1iqWFGkCozbLqYe31QMsQcX&index=2)


---

### Step 2 – Create a Rancher-Type Organization in ACE
1. Visit your ACE URL and log in with your **admin account**. ![ACE URL](../images/ace-url.png)
### Step 2 – Create a Rancher-Type Organization in KubeDB Platform
1. Visit your KubeDB Platform URL and log in with your **admin account**. ![KubeDB Platform URL](../images/ace-url.png)
2. Navigate to **Organizations** and create a new organization with the type set to **Rancher**.
3. Provide a valid **Sync Token**.
> The Sync Token is used to synchronize Rancher users into the ACE platform.
> The Sync Token is used to synchronize Rancher users into the KubeDB Platform.

![Create Organization](../images/organization-create.png)

---

### Step 3 – Sync Rancher Users
1. Go to **Organization Settings → Rancher Extension**. ![Organization Settings](../images/organization-settings.png)
2. Click **Sync User** to import Rancher users into ACE. ![Sync User](../images/organization-settings-sync-users.png)
2. Click **Sync User** to import Rancher users into KubeDB Platform. ![Sync User](../images/organization-settings-sync-users.png)

---

Expand Down Expand Up @@ -110,4 +110,4 @@ Follow these steps to install the KubeDB extension in Rancher:

✅ Installation Complete!
You can now deploy and manage your databases directly from the KubeDB menu in your cluster.
NB: Import your Rancher cluster into the ACE UI under the Rancher organization you created earlier before using the Rancher extension, or it wont work.
NB: Import your Rancher cluster into the KubeDB Platform UI under the Rancher organization you created earlier before using the Rancher extension, or it won't work.
Loading
Loading