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
Copy file name to clipboardExpand all lines: docs/platform/selfhost-setup/install/aws-marketplace.md
+5-43Lines changed: 5 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ menu:
5
5
identifier: aws-marketplace
6
6
name: AWS Marketplace
7
7
parent: selfhosted-installer
8
-
weight: 10
8
+
weight: 6
9
9
menu_name: docsplatform_{{.version}}
10
10
section_menu_id: selfhost-setup
11
11
---
@@ -18,11 +18,7 @@ To install **KubeDB Platform**, you need to have the permissions to manage **EC2
18
18
19
19
### Prerequisite
20
20
21
-
Before you begin, please ensure your Kubernetes cluster meets the following minimum system requirements:
22
-
***Worker Nodes**: At least one dedicated worker node.
23
-
***CPU**: 4–6 vCPUs.
24
-
***Memory**: 16 GB of RAM.
25
-
***Networking**: A routable IP address for external connectivity.
21
+
See [Prerequisites](common-config.md#prerequisites) in the Common Configuration guide for the minimum cluster requirements and the optional k3s setup note.
26
22
27
23
You have to create an `Access Key` and `Secret Key` with following policies attached. Check out similar [eksctl docs](https://eksctl.io/usage/minimum-iam-policies/) for reference.
28
24
@@ -267,38 +263,11 @@ These credentials define the primary super-user and the initial organizational s
267
263
For openshift cluster toggle Red Hat OpenShift cluster and give Kube API Server endpoint
268
264
269
265
### 4. Registry
270
-
KubeDB Platform requires access to various container registries and Helm repositories to pull necessary images and charts.
271
-
272
-
**Docker Registry:** Go to the docker registry section first then look for the following settings
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.
274
-
***Helm Repositories:** In the helm repositories section put your helm repository url
275
-
If using private or authenticated registries, provide:
276
-
***Credentials:** Username and Password.
277
-
***Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
278
-
***Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
266
+
See [Registry](common-config.md#registry) in the Common Configuration guide for Docker registry proxies, Helm repositories, credentials, certs, and image pull secrets.
279
267
280
268
### 5. Monitoring
281
269
282
-
Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
283
-
284
-
***Alert Manager Email:** Enable email notifications for Alertmanager alerts.
285
-
***Enable Email:** Turns email notifications on or off.
286
-
***To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
287
-
***From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
288
-
***Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
289
-
***Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
290
-
***Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
291
-
***Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
292
-
***Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
293
-
***Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
294
-
***Enable Webhook:** Turns webhook delivery on or off.
295
-
***URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
296
-
***Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
270
+
See [Monitoring](common-config.md#monitoring) in the Common Configuration guide for Alertmanager email and webhook configuration.
302
271
303
272
304
273
### 6. Settings
@@ -313,14 +282,7 @@ In this section you can enable or disable features. You can also create an initi
313
282
314
283
315
284
### 8. Branding & UI Customization
316
-
Administrators can globally re-brand the KubeDB Platform interface to match corporate identity.
317
-
318
-
***App Name:** Changes the browser tab title.
319
-
***Primary Color:** Enter a Hex code (default: `#009948`).
320
-
***Assets:**
321
-
***Logo:** Upload a 200x30px image (SVG/PNG recommended).
322
-
***Favicon:** Upload a 20KB icon file.
323
-
***App Tag:** Toggle **"Show App Tag"** to display or hide the version/tagging info in the UI.
285
+
See [Branding & UI Customization](common-config.md#branding--ui-customization) in the Common Configuration guide to re-brand the platform interface.
Copy file name to clipboardExpand all lines: docs/platform/selfhost-setup/install/azure-marketplace.md
+6-56Lines changed: 6 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ menu:
5
5
identifier: azure-marketplace
6
6
name: Azure Marketplace
7
7
parent: selfhosted-installer
8
-
weight: 10
8
+
weight: 7
9
9
menu_name: docsplatform_{{.version}}
10
10
section_menu_id: selfhost-setup
11
11
---
@@ -16,11 +16,7 @@ Welcome to the KubeDB Platform's **Azure Marketplace** deployment! This guide wi
16
16
17
17
### Prerequisites
18
18
19
-
Before you begin, please ensure your Kubernetes cluster meets the following minimum system requirements:
20
-
***Worker Nodes**: At least one dedicated worker node.
21
-
***CPU**: 4–6 vCPUs.
22
-
***Memory**: 16 GB of RAM.
23
-
***Networking**: A routable IP address for external connectivity.
19
+
See [Prerequisites](common-config.md#prerequisites) in the Common Configuration guide for the minimum cluster requirements and the optional k3s setup note.
24
20
25
21
## Getting Started
26
22
@@ -70,53 +66,17 @@ Put **Subscription ID**, **Tenant ID**, **Client ID** and **Client Secret** in t
70
66
71
67
### 4. Global Administrative Settings
72
68
73
-
These credentials define the primary super-user and the initial organizational structure.
74
-
75
-
***System Admin:** In this section, provide the administrator's following information.
76
-
-**Admin Account Display Name:** The display name for the administrator account.
77
-
-**Admin Account Email:** The email address for the administrator account.
78
-
-**Admin Account Password:** The password for the administrator account.You may manually set a password or leave it blank to allow the system to **auto-generate** a secure administrative password.
79
-
-**Initial Organization Name:** You can choose what will be the initial organization name for your account
69
+
See [Global Administrative Settings](common-config.md#global-administrative-settings) in the Common Configuration guide for the System Admin account fields (display name, email, password, and initial organization).
80
70
81
71
For openshift cluster toggle Red Hat OpenShift cluster and give Kube API Server endpoint
82
72
83
-
<br/>
84
-
<imgwidth="50%"src="../images/admin-setting.png">
85
-
86
73
### 5. Registry
87
74
88
-
KubeDB Platform requires access to various container registries and Helm repositories to pull necessary images and charts.
89
-
90
-
**Docker Registry:** Go to the docker registry section first then look for the following settings
91
-
***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.
92
-
***Helm Repositories:** In the helm repositories section put your helm repository url
93
-
If using private or authenticated registries, provide:
94
-
***Credentials:** Username and Password.
95
-
***Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
96
-
***Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
75
+
See [Registry](common-config.md#registry) in the Common Configuration guide for Docker registry proxies, Helm repositories, credentials, certs, and image pull secrets.
97
76
98
77
### 6. Monitoring
99
78
100
-
Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
101
-
102
-
***Alert Manager Email:** Enable email notifications for Alertmanager alerts.
103
-
***Enable Email:** Turns email notifications on or off.
104
-
***To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
105
-
***From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
106
-
***Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
107
-
***Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
108
-
***Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
109
-
***Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
110
-
***Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
111
-
***Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
112
-
***Enable Webhook:** Turns webhook delivery on or off.
113
-
***URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
114
-
***Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
79
+
See [Monitoring](common-config.md#monitoring) in the Common Configuration guide for Alertmanager email and webhook configuration.
120
80
121
81
### 7. Settings
122
82
@@ -133,17 +93,7 @@ In this section you can enable or disable features. You can also create an init
133
93
134
94
### 9. Branding & UI Customization
135
95
136
-
Administrators can globally re-brand the KubeDB Platform interface to match corporate identity.
137
-
138
-
***App Name:** Changes the browser tab title.
139
-
***Primary Color:** Enter a Hex code (default: `#009948`).
140
-
***Assets:**
141
-
***Logo:** Upload a 200x30px image (SVG/PNG recommended).
142
-
***Favicon:** Upload a 20KB icon file.
143
-
***App Tag:** Toggle **"Show App Tag"** to display or hide the version/tagging info in the UI.
144
-
145
-
<br/>
146
-
<imgwidth="50%"src="../images/branding.png">
96
+
See [Branding & UI Customization](common-config.md#branding--ui-customization) in the Common Configuration guide to re-brand the platform interface.
Copy file name to clipboardExpand all lines: docs/platform/selfhost-setup/install/cloud-demo.md
+10-94Lines changed: 10 additions & 94 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ menu:
5
5
identifier: selfhost-cloud-demo-deployment
6
6
name: Cloud Demo Deployment
7
7
parent: selfhosted-installer
8
-
weight: 10
8
+
weight: 2
9
9
menu_name: docsplatform_{{.version}}
10
10
section_menu_id: selfhost-setup
11
11
---
@@ -16,15 +16,7 @@ Welcome to the KubeDB Platform's "Cloud Demo" deployment! Follow these steps to
16
16
17
17
### Prerequisites
18
18
19
-
Before you begin, please ensure your Kubernetes cluster meets the following minimum system requirements:
20
-
* Worker Nodes: At least one dedicated worker node.
21
-
* CPU: 4–6 vCPUs.
22
-
* Memory: 16 GB of RAM.
23
-
* Networking: A routable IP address for external connectivity.
24
-
25
-
26
-
27
-
You will get an instruction to deploy a k3s cluster in Ubuntu VM or you can skip this step if you already have a cluster.
19
+
See [Prerequisites](common-config.md#prerequisites) in the Common Configuration guide for the minimum cluster requirements and the optional k3s setup note.
28
20
29
21
### 1. Visit the AppsCode Self-Hosted Page
30
22
@@ -44,110 +36,34 @@ Before beginning the installation, identify your target infrastructure and clust
**Subnet IDs:** Make sure you have added the allocation id of Target IP as well. Run the following command to create EIP Allocation IDs `aws ec2 allocate-address --region <region>`
63
-
64
-
**EIP Allocation IDs:** Give EIP allocation IDs for your public subnets.
39
+
See [Additional configuration for EKS cluster](common-config.md#additional-configuration-for-eks-cluster) in the Common Configuration guide for the EBS CSI / AWS Load Balancer Controller prerequisites and the commands to fetch the Kube API server endpoint, subnet IDs, and EIP allocation IDs.
65
40
66
41
### 3. Global Administrative Settings
67
-
These credentials define the primary super-user and the initial organizational structure.
68
-
69
-
***System Admin:** In this section, provide the administrator's following information.
70
-
-**Admin Account Display Name:** The display name for the administrator account.
71
-
-**Admin Account Email:** The email address for the administrator account.
72
-
-**Admin Account Password:** The password for the administrator account. You may manually set a password or leave it blank to allow the system to **auto-generate** a secure administrative password.
73
-
-**Initial Organization Name:** You can choose what will be the initial organization name for your account
74
-
75
-
<br/>
76
-
<imgwidth="50%"src="../images/admin-setting.png">
42
+
See [Global Administrative Settings](common-config.md#global-administrative-settings) in the Common Configuration guide for the System Admin account fields (display name, email, password, and initial organization).
77
43
78
44
### 4. Registry
79
-
KubeDB Platform requires access to various container registries and Helm repositories to pull necessary images and charts.
80
-
81
-
**Docker Registry:** Go to the docker registry section first then look for the following settings
82
-
***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.
83
-
***Helm Repositories:** In the helm repositories section put your helm repository url
84
-
If using private or authenticated registries, provide:
85
-
***Credentials:** Username and Password.
86
-
***Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
87
-
***Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
45
+
See [Registry](common-config.md#registry) in the Common Configuration guide for Docker registry proxies, Helm repositories, credentials, certs, and image pull secrets.
88
46
89
47
### 5. Monitoring
90
48
91
-
Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
92
-
93
-
***Alert Manager Email:** Enable email notifications for Alertmanager alerts.
94
-
***Enable Email:** Turns email notifications on or off.
95
-
***To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
96
-
***From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
97
-
***Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
98
-
***Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
99
-
***Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
100
-
***Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
101
-
***Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
102
-
***Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
103
-
***Enable Webhook:** Turns webhook delivery on or off.
104
-
***URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
105
-
***Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
49
+
See [Monitoring](common-config.md#monitoring) in the Common Configuration guide for Alertmanager email and webhook configuration.
111
50
112
51
113
52
### 6. Settings
114
53
115
54
#### Domain White List and Proxy Servers
116
55
117
-
* Add domain one by one for whitelisting
118
-
***Proxy Servers:** If you have proxy servers then put **HTTP Proxy**, **HTTPS Proxy** and **No Proxy**
See [Domain White List and Proxy Servers](common-config.md#domain-white-list-and-proxy-servers) in the Common Configuration guide for whitelisting domains, proxy servers, and login/logout URLs.
123
57
124
58
### 7. Ingress & Gateway
125
59
126
-
Configure how the application is exposed to the internet or your internal network.
127
-
128
-
***Ingress & Gateway:** Enable either the **Gateway API** or standard **Ingress**.
See [Ingress & Gateway](common-config.md#ingress--gateway) in the Common Configuration guide for exposing the platform via the Gateway API or standard Ingress.
132
61
133
62
### 8. Self Management
134
-
In this section you can enable or disable features
135
-
136
-
<br/>
137
-
<imgwidth="50%"src="../images/features.png">
63
+
See [Self Management](common-config.md#self-management) in the Common Configuration guide to enable or disable platform features.
138
64
139
65
### 9. Branding & UI Customization
140
-
Administrators can globally re-brand the KubeDB Platform interface to match corporate identity.
141
-
142
-
***App Name:** Changes the browser tab title.
143
-
***Primary Color:** Enter a Hex code (default: `#009948`).
144
-
***Assets:**
145
-
***Logo:** Upload a 200x30px image (SVG/PNG recommended).
146
-
***Favicon:** Upload a 20KB icon file.
147
-
***App Tag:** Toggle **"Show App Tag"** to display or hide the version/tagging info in the UI.
148
-
149
-
<br/>
150
-
<imgwidth="50%"src="../images/branding.png">
66
+
See [Branding & UI Customization](common-config.md#branding--ui-customization) in the Common Configuration guide to re-brand the platform interface.
0 commit comments