You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
16
+
Site administrators can upgrade the KubeDB Platform management cluster directly from the platform UI by uploading a configuration file downloaded from the AppsCode portal.
17
17
18
18
---
19
19
@@ -27,21 +27,21 @@ Before starting the upgrade, download the required values file from the AppsCode
27
27
28
28
---
29
29
30
-
## Step 1 — Open ACE Upgrade
30
+
## Step 1 — Open KubeDB Platform Upgrade
31
31
32
-

32
+

33
33
34
-
Go to **SITE ADMINISTRATION > ACE Upgrade** from the left-hand menu.
34
+
Go to **SITE ADMINISTRATION > KubeDB Platform Upgrade** from the left-hand menu.
35
35
36
-
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.
36
+
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.
Copy file name to clipboardExpand all lines: docs/platform/guides/get-started/architecture.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,14 +15,14 @@ Let's first discuss some basic terminologies, those will be repeated many times
15
15
16
16

17
17
18
-
### ACE
19
-
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.
18
+
### KubeDB Platform
19
+
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.
20
20
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`.
21
21
22
22
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.
23
-
ACE is used as the hub of OCM mode. Thats why we call this `Hub cluster` too.
23
+
KubeDB Platform is used as the hub of OCM mode. Thats why we call this `Hub cluster` too.
24
24
25
-
The ACE cluster can be a single-node k3s cluster for staging or development. Or a full-fledged multi-node cluster for prod.
25
+
The KubeDB Platform cluster can be a single-node k3s cluster for staging or development. Or a full-fledged multi-node cluster for prod.
26
26
27
27
The installer page on the `selfhost-ui` on appscode.com provides instructions for quickly setting up a K3s cluster to get started immediately.
28
28
@@ -32,4 +32,4 @@ While importing, if someone make it a spoke, then cluster-manager-spoke features
32
32
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.
33
33
34
34
35
-
Both ACE & DBaaS clusters can be of any vendors like AWS, Azure, Google Cloud etc. It can be an on-prem cluster too.
35
+
Both KubeDB Platform & DBaaS clusters can be of any vendors like AWS, Azure, Google Cloud etc. It can be an on-prem cluster too.
Copy file name to clipboardExpand all lines: docs/platform/guides/get-started/requirements.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,17 @@ layout: docs
3
3
menu:
4
4
docsplatform_{{.version}}:
5
5
identifier: guide-ace-requirements
6
-
name: ACE Requirements
6
+
name: KubeDB Platform Requirements
7
7
parent: guide-start
8
8
weight: 14
9
9
menu_name: docsplatform_{{.version}}
10
10
section_menu_id: guides
11
11
---
12
12
13
-
# Requirements to deploy ACE
14
-
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.
13
+
# Requirements to deploy KubeDB Platform
14
+
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.
15
15
16
-
## Requirements for ACE Cluster
16
+
## Requirements for KubeDB Platform Cluster
17
17
18
18
### 1. Resources
19
19
**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.
@@ -40,7 +40,7 @@ These are the required connectivities to everything work correctly:
40
40
3. 4222 - NATS.io port
41
41
4. 4224 - s3-proxy service port
42
42
43
-
Here is a sample video on how you can setup ACE:
43
+
Here is a sample video on how you can setup KubeDB Platform:
44
44
<iframewidth="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>
45
45
46
46
## Requirements for DBaaS Cluster
@@ -52,7 +52,7 @@ Minimum: Kubernetes cluster with 3 worker nodes, each with 8- 16GB ram, PVC supp
52
52
Note that, The largest node must be able to fit the largest DB Pod(in terms of CPU, memory).
53
53
54
54
### 2. Networking
55
-
Literally all the Networking requirements described for ACE are also applicable here, except the `Port Requiements` part.
56
-
Only one additional requirement here is that the DBaaS cluster should be accessible from the management/ACE cluster.
55
+
Literally all the Networking requirements described for KubeDB Platform are also applicable here, except the `Port Requiements` part.
56
+
Only one additional requirement here is that the DBaaS cluster should be accessible from the management/KubeDB Platform cluster.
57
57
58
-
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!
58
+
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!
Copy file name to clipboardExpand all lines: docs/platform/guides/integrations/rancher-extension.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,33 +24,33 @@ Before proceeding, make sure you have:
24
24
25
25
- A Rancher setup with access to the **Local** cluster.
26
26
- An account on [appscode.com](https://appscode.com/).
27
-
- The [ACE](https://appscode.com/docs/en/selfhost-setup/) platform deployed on your Rancher cluster.
27
+
- The [KubeDB Platform](https://appscode.com/docs/en/selfhost-setup/) deployed on your Rancher cluster.
28
28
29
29
---
30
30
31
31
## 2. Deploying the KubeDB Rancher Extension
32
32
33
-
### Step 1 – Deploy ACE
33
+
### Step 1 – Deploy KubeDB Platform
34
34
1. Create an account at [appscode.com](https://appscode.com/).
35
-
2. Follow the [self-hosting ACE guide](https://appscode.com/docs/en/selfhost-setup/) to deploy ACE on your Rancher cluster.
36
-
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)
35
+
2. Follow the [self-hosting KubeDB Platform guide](https://appscode.com/docs/en/selfhost-setup/) to deploy KubeDB Platform on your Rancher cluster.
36
+
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)
37
37
38
38
39
39
---
40
40
41
-
### Step 2 – Create a Rancher-Type Organization in ACE
42
-
1. Visit your ACE URL and log in with your **admin account**. 
41
+
### Step 2 – Create a Rancher-Type Organization in KubeDB Platform
42
+
1. Visit your KubeDB Platform URL and log in with your **admin account**. 
43
43
2. Navigate to **Organizations** and create a new organization with the type set to **Rancher**.
44
44
3. Provide a valid **Sync Token**.
45
-
> The Sync Token is used to synchronize Rancher users into the ACE platform.
45
+
> The Sync Token is used to synchronize Rancher users into the KubeDB Platform.
1. Go to **Organization Settings → Rancher Extension**. 
53
-
2. Click **Sync User** to import Rancher users into ACE. 
53
+
2. Click **Sync User** to import Rancher users into KubeDB Platform. 
54
54
55
55
---
56
56
@@ -110,4 +110,4 @@ Follow these steps to install the KubeDB extension in Rancher:
110
110
111
111
✅ Installation Complete!
112
112
You can now deploy and manage your databases directly from the KubeDB menu in your cluster.
113
-
NB: Import your Rancher cluster into the ACE UI under the Rancher organization you created earlier before using the Rancher extension, or it won’t work.
113
+
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.
Copy file name to clipboardExpand all lines: docs/platform/guides/license-management/overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ While AppsCode administrators are responsible for the core lifecycle of contract
29
29
30
30
### Key Components
31
31
32
-
-**Contracts:** Digital agreements, typically established by [AppsCode administrators](https://appsCode.com/contact/) within the Billing Console, that define the terms of AppsCode's product (e.g., ACE, KubeDB, KubeStash, KubeVault etc.) usage. This includes the specific AppsCode products which can be licensed, the duration of the contract, applicable features, and the clusters authorized to use these licenses. Contracts ensure that usage aligns with legal and financial terms, providing a foundation for all subsequent actions in the console. Contracts can be configured for either online or offline license validation.
32
+
-**Contracts:** Digital agreements, typically established by [AppsCode administrators](https://appsCode.com/contact/) within the Billing Console, that define the terms of AppsCode's product (e.g., KubeDB Platform, KubeDB, KubeStash, KubeVault etc.) usage. This includes the specific AppsCode products which can be licensed, the duration of the contract, applicable features, and the clusters authorized to use these licenses. Contracts ensure that usage aligns with legal and financial terms, providing a foundation for all subsequent actions in the console. Contracts can be configured for either online or offline license validation.
33
33
<br> <br>
34
34
-**Licensed cluster:** The `Licensed Cluster` section within the AppsCode Billing Console offers a comprehensive overview and detailed management capabilities for Kubernetes clusters that have been issued AppsCode product licenses. This component is pivotal for administrators to monitor the cluster(s) `licences` and `events` of licensed products across their infrastructure.
Copy file name to clipboardExpand all lines: docs/platform/selfhost-setup/install/aws-marketplace.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ section_menu_id: selfhost-setup
14
14
15
15
Welcome to the KubeDB Platform's **AWS Marketplace** deployment! This guide will walk you through the deployment process via the **AWS Marketplace**, ensuring your environment is configured correctly for a seamless installation.
16
16
17
-
To install **ACE**, you need to have the permissions to manage **EC2**, **IAM**, **CloudFormation** etc.
17
+
To install **KubeDB Platform**, you need to have the permissions to manage **EC2**, **IAM**, **CloudFormation** etc.
18
18
19
19
### Prerequisite
20
20
@@ -267,7 +267,7 @@ These credentials define the primary super-user and the initial organizational s
267
267
For openshift cluster toggle Red Hat OpenShift cluster and give Kube API Server endpoint
268
268
269
269
### 4. Registry
270
-
Ace requires access to various container registries and Helm repositories to pull necessary images and charts.
270
+
KubeDB Platform requires access to various container registries and Helm repositories to pull necessary images and charts.
271
271
272
272
**Docker Registry:** Go to the docker registry section first then look for the following settings
273
273
***Proxies:** Put registry name for Appscode `r.appscode.com` and other Public Registries like Docker Hub, GitHub Container Registry (`ghcr.io`), Kubernetes Registry, Microsoft (`mcr.microsoft.com`), and Quay.
@@ -313,7 +313,7 @@ In this section you can enable or disable features. You can also create an initi
313
313
314
314
315
315
### 8. Branding & UI Customization
316
-
Administrators can globally re-brand the Ace interface to match corporate identity.
316
+
Administrators can globally re-brand the KubeDB Platform interface to match corporate identity.
317
317
318
318
***App Name:** Changes the browser tab title.
319
319
***Primary Color:** Enter a Hex code (default: `#009948`).
0 commit comments