Skip to content

Commit c3b1681

Browse files
authored
docs(platform): rebrand ACE → KubeDB Platform in API reference (#142)
Rename the AppsCode Cloud/Container Engine (ACE) brand to KubeDB Platform and remove the b3 backend name from the low-level API reference (docs/platform/api), the OpenAPI spec (openapi.yaml), and the Swagger UI viewer (api.html). - 'ACE Platform' / 'AppsCode Cloud Engine (ACE)' -> 'KubeDB Platform' - b3 -> 'KubeDB Platform API' / 'KubeDB Platform API Server' by context - group names: ACE Installer -> Platform Installer, ACE Upgrade -> Platform Upgrade On-the-wire artifacts are preserved: clusterManagers enum value "ACE", appName "ACE", AceOptionsSpec, cookie i_like_ace, tenant id ace.user.{id}, and the ace-installer / ace-upgrade URL slugs (routes unchanged). Signed-off-by: Tamal Saha <tamal@appscode.com>
1 parent 0a401a3 commit c3b1681

58 files changed

Lines changed: 320 additions & 321 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api.html

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

docs/platform/api/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ aliases:
1313
- /docs/platform/{{.version}}/api/README/
1414
---
1515

16-
# ACE Platform API Reference
16+
# KubeDB Platform API Reference
1717

18-
Low-level reference for the AppsCode Cloud Engine (ACE) platform backend (`b3`)
19-
REST API. Every endpoint lists its HTTP method, path, authentication, path/query
18+
Low-level reference for the KubeDB Platform API. Every endpoint lists its HTTP method, path, authentication, path/query
2019
parameters, and request/response shapes so you can implement a client directly
2120
against it.
2221

@@ -55,8 +54,8 @@ root.
5554
| [Multi-cluster (OCM)](../api/multicluster-ocm/hubs-spokes/) | Hub/spoke, cluster sets, feature sets |
5655
| [Client Organizations](../api/client-organizations/management/) | Managed-service client orgs |
5756
| [Cloud Providers](../api/cloud-providers/cloud-providers/) | Provider discovery for provisioning |
58-
| [ACE Installer](../api/ace-installer/ace-installer/) | Self-host installer bundles |
59-
| [ACE Upgrade](../api/ace-upgrade/platform-upgrade/) | Platform & cluster upgrades |
57+
| [Platform Installer](../api/ace-installer/ace-installer/) | Self-host installer bundles |
58+
| [Platform Upgrade](../api/ace-upgrade/platform-upgrade/) | Platform & cluster upgrades |
6059
| [Licensing & Contracts](../api/licensing-contracts/registration/) | Contracts, licenses, registration |
6160
| [Billing Dashboard](../api/billing-dashboard/admin-dashboard/) | Usage reports & billing dashboards |
6261
| [Marketplace](../api/marketplace/webhook-service/) | Cloud-marketplace webhooks & metering |

docs/platform/api/ace-installer/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ layout: docs
33
menu:
44
docsplatform_{{.version}}:
55
identifier: api-ace-installer
6-
name: ACE Installer
6+
name: Platform Installer
77
parent: api
88
weight: 100
99
menu_name: docsplatform_{{.version}}
1010
section_menu_id: api
1111
---
1212

13-
# ACE Installer API
13+
# Platform Installer API
1414

15-
The ACE Installer API generates and manages self-host installer bundles for the
16-
AppsCode Container Engine (ACE) platform. It serves the installer options schema,
15+
The Platform Installer API generates and manages self-host installer bundles for the
16+
KubeDB Platform. It serves the installer options schema,
1717
generates and imports installer bundles, lists and inspects generated installers,
1818
and supports reconfigure/upgrade/versioning and marketplace-installer status.
1919

2020
> **AppsCode-hosted only.** Every route under `/api/v1/ace-installer/...` is available
21-
> only on the AppsCode-hosted (SaaS) deployment. On self-hosted ACE installations these
21+
> only on the AppsCode-hosted (SaaS) deployment. On self-hosted KubeDB Platform installations these
2222
> routes are not registered and return `404 Not Found`. All calls require a bearer token,
2323
> an org context (resolved from the `org` query param), and per-action authorization
2424
> checks (`view_installers`, `create_installers`, `import_installers`,
@@ -27,6 +27,6 @@ and supports reconfigure/upgrade/versioning and marketplace-installer status.
2727
2828
## Pages
2929

30-
- [ACE Installer](../ace-installer.md) — schema/model, generate/import,
30+
- [Platform Installer](../ace-installer.md) — schema/model, generate/import,
3131
installer metadata and latest version, installers CRUD, reconfigure/upgrade,
3232
versions/archives, and marketplace installer status.

docs/platform/api/ace-installer/ace-installer.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ layout: docs
33
menu:
44
docsplatform_{{.version}}:
55
identifier: api-ace-installer-ace-installer
6-
name: ACE Installer
6+
name: Platform Installer
77
parent: api-ace-installer
88
weight: 10
99
menu_name: docsplatform_{{.version}}
1010
section_menu_id: api
1111
---
1212

13-
# ACE Installer
13+
# Platform Installer
1414

15-
The ACE Installer endpoints generate and manage self-host installer bundles for the
16-
AppsCode Container Engine (ACE) platform. All paths on this page are relative to the
15+
The Platform Installer endpoints generate and manage self-host installer bundles for the
16+
KubeDB Platform. All paths on this page are relative to the
1717
API root `/api/v1` — for example `/ace-installer/schema.json` is
1818
`/api/v1/ace-installer/schema.json`.
1919

2020
> **AppsCode-hosted only.** These routes exist only on the AppsCode-hosted (SaaS)
21-
> deployment. On self-hosted ACE installations the `/ace-installer` routes are not
21+
> deployment. On self-hosted KubeDB Platform installations the `/ace-installer` routes are not
2222
> registered and every call returns `404 Not Found`. (This was confirmed live — see the
2323
> verification notes below.)
2424
@@ -44,7 +44,7 @@ organization's hosted-mode capability:
4444
A documented call looks like:
4545

4646
```
47-
curl -H "Authorization: token $ACE_TOKEN" \
47+
curl -H "Authorization: token $AKP_TOKEN" \
4848
"https://appscode.com/api/v1/ace-installer/latest-version?org=appscode"
4949
```
5050

@@ -58,7 +58,7 @@ curl -H "Authorization: token $ACE_TOKEN" \
5858

5959
### InstallerMetadata
6060

61-
Metadata describing a generated or imported ACE installer.
61+
Metadata describing a generated or imported installer.
6262

6363
```json
6464
{
@@ -89,7 +89,7 @@ Metadata describing a generated or imported ACE installer.
8989
|-------|------|-------------|
9090
| `ID` | string | Installer ID. |
9191
| `installerName` | string | Installer name (installers are grouped by name). |
92-
| `deploymentType` | string | ACE deployment type. |
92+
| `deploymentType` | string | KubeDB Platform deployment type. |
9393
| `requestedDomain` | string | Domain requested for the installer. |
9494
| `host` | string | Effective host for the deployment. |
9595
| `hostType` | string | Host type. |
@@ -101,7 +101,7 @@ Metadata describing a generated or imported ACE installer.
101101
| `adminEmail` | string | Email of the platform admin. |
102102
| `accessTokenID` | integer (int64) | ID of the access token that created the installer. |
103103
| `clusterID` | string | Cluster identifier bound to the installer. |
104-
| `version` | string | ACE installer chart version. |
104+
| `version` | string | installer chart version. |
105105
| `promotedToProduction` | boolean | Whether the installer has been promoted to production. |
106106
| `createTimestamp` | string (date-time) | Creation time. |
107107
| `expiryTimestamp` | string (date-time) | Expiry time. |
@@ -153,7 +153,7 @@ Metadata describing a generated or imported ACE installer.
153153

154154
### GET /ace-installer/schema.json
155155

156-
Returns the raw OpenAPI v3 JSON schema for ACE installer options
156+
Returns the raw OpenAPI v3 JSON schema for installer options
157157
(`ace-options/values.openapiv3_schema.yaml`) as a dynamic JSON object.
158158

159159
- **Auth:** token; org resolved from the `org` query param.
@@ -168,12 +168,12 @@ Returns the raw OpenAPI v3 JSON schema for ACE installer options
168168
documented here.
169169

170170
> **Verified:** returned `404` against `appscode` on the self-hosted platform
171-
> (`<ace-host>`) on 2026-07-14 — the ace-installer routes are AppsCode-hosted only and are
171+
> (`<akp-host>`) on 2026-07-14 — the ace-installer routes are AppsCode-hosted only and are
172172
> not registered on this install (body: `{"message":"Not Found"}`).
173173
174174
### GET /ace-installer/model.json
175175

176-
Returns the default ACE options model (`AceOptionsSpec`) pre-filled with the requesting
176+
Returns the default options model (`AceOptionsSpec`) pre-filled with the requesting
177177
user's admin details, as a dynamic JSON object.
178178

179179
- **Auth:** token; org context.
@@ -189,7 +189,7 @@ user's admin details, as a dynamic JSON object.
189189

190190
### POST /ace-installer/generate
191191

192-
Generates a new ACE installer from the supplied `AceOptionsSpec` options and returns the
192+
Generates a new installer from the supplied `AceOptionsSpec` options and returns the
193193
resulting installer metadata.
194194

195195
- **Auth:** token; org context; requires `create_installers`.
@@ -242,7 +242,7 @@ request.
242242
243243
### GET /ace-installer/latest-version
244244

245-
Returns the latest available ACE installer chart version.
245+
Returns the latest available installer chart version.
246246

247247
- **Auth:** token; org context; requires `view_installers`.
248248
- **Query parameters:** `org` (string, required).
@@ -254,7 +254,7 @@ Returns the latest available ACE installer chart version.
254254

255255
| Field | Type | Description |
256256
|-------|------|-------------|
257-
| `version` | string | Latest ACE installer chart version. |
257+
| `version` | string | Latest installer chart version. |
258258

259259
> **Verified:** returned `404` against `appscode` on the self-hosted platform on
260260
> 2026-07-14 (AppsCode-hosted only; route not registered).
@@ -356,7 +356,7 @@ Reconfigures an existing installer using the supplied `AceOptionsSpec` options.
356356
357357
### POST /ace-installer/installers/{name}/{id}/upgrade
358358

359-
Upgrades an existing installer to the latest ACE installer version and returns the updated
359+
Upgrades an existing installer to the latest installer version and returns the updated
360360
installer metadata.
361361

362362
- **Auth:** token; org context; requires `upgrade_installers`.

docs/platform/api/ace-installer/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ menu_name: docsplatform_{{.version}}
1010
section_menu_id: api
1111
---
1212

13-
# ACE Installer — Overview
13+
# Platform Installer — Overview
1414

1515
`/api/v1/ace-installer` (AppsCode-hosted only)
1616

@@ -21,7 +21,7 @@ Generates and manages self-host installer bundles. Token + org context; per-acti
2121
| GET | `/schema.json`, `/model.json` | Installer JSON schema / default options |
2222
| POST | `/generate` | Generate an installer |
2323
| POST | `/import` | Import an installer |
24-
| GET | `/installer-meta`, `/latest-version` | Installer metadata / latest ACE version |
24+
| GET | `/installer-meta`, `/latest-version` | Installer metadata / latest KubeDB Platform version |
2525
| GET | `/installers/` (+`/:name/`, `/:name/:id`) | List / inspect installers |
2626
| DELETE | `/installers/:name/:id` | Delete a generated installer |
2727
| POST | `/installers/:name/:id/{reconfigure,upgrade}` | Reconfigure / upgrade an installer |
@@ -32,4 +32,4 @@ Generates and manages self-host installer bundles. Token + org context; per-acti
3232

3333
## Reference pages
3434

35-
- [ACE installer](../ace-installer.md)
35+
- [installer](../ace-installer.md)

docs/platform/api/ace-upgrade/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ layout: docs
33
menu:
44
docsplatform_{{.version}}:
55
identifier: api-ace-upgrade
6-
name: ACE Upgrade
6+
name: Platform Upgrade
77
parent: api
88
weight: 110
99
menu_name: docsplatform_{{.version}}
1010
section_menu_id: api
1111
---
1212

13-
# ACE Upgrade
13+
# Platform Upgrade
1414

15-
APIs for upgrading the ACE platform itself and for upgrading the ACE feature
15+
APIs for upgrading the KubeDB Platform itself and for upgrading the KubeDB Platform feature
1616
stack running inside imported and spoke clusters. Upgrades are FluxCD/Helm-driven
1717
and run asynchronously; progress and history are tracked in upgrader `ConfigMap`
1818
data, which these endpoints surface as dynamic key/value maps.
@@ -24,7 +24,7 @@ also be supplied as a `token` or `access_token` query parameter).
2424
There are two distinct authorization models, which is why the endpoints are split
2525
across two pages:
2626

27-
- **Platform upgrade** routes (`/api/v1/upgrade*`) act on the ACE platform as a
27+
- **Platform upgrade** routes (`/api/v1/upgrade*`) act on the KubeDB Platform as a
2828
whole. They require an organization context (`?org=<slug>`) and **site-admin
2929
organization authorization**`view_upgrade_history:org` for the read routes
3030
and `upgrade_platform:org` for the trigger route.

docs/platform/api/ace-upgrade/cluster-upgrade.md

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

1313
# Cluster Upgrade
1414

15-
Endpoints for upgrading the ACE feature stack running inside a member cluster.
15+
Endpoints for upgrading the KubeDB Platform feature stack running inside a member cluster.
1616
There are two flavours:
1717

1818
- **Imported cluster** routes (`/clusters/{owner}/{cluster}/upgrade*`) upgrade the
@@ -25,7 +25,7 @@ There are two flavours:
2525

2626
Paths below are relative to the API root `/api/v1` (so
2727
`/clusters/{owner}/{cluster}/upgrade` means
28-
`https://<ace-host>/api/v1/clusters/{owner}/{cluster}/upgrade`).
28+
`https://<akp-host>/api/v1/clusters/{owner}/{cluster}/upgrade`).
2929

3030
**Authentication & authorization.** All routes require a personal access token
3131
(`Authorization: token <YOUR_TOKEN>`). Access is gated by **cluster assignment**
@@ -74,8 +74,8 @@ Returns `400` when no upgrade status is recorded in the cluster yet.
7474
> been run on this cluster, so there is no upgrader ConfigMap. On 2026-07-14.
7575
7676
```
77-
curl -H "Authorization: token $ACE_TOKEN" \
78-
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade
77+
curl -H "Authorization: token $AKP_TOKEN" \
78+
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade
7979
```
8080

8181
---
@@ -102,8 +102,8 @@ maps.
102102
> against `appscode/ace` (hub) (empty list `[]`) on 2026-07-14.
103103
104104
```
105-
curl -H "Authorization: token $ACE_TOKEN" \
106-
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade/history
105+
curl -H "Authorization: token $AKP_TOKEN" \
106+
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade/history
107107
```
108108

109109
---
@@ -131,8 +131,8 @@ cluster.
131131
> `200` against `appscode/ace` (hub) (`{"version":"v2026.6.19"}`) on 2026-07-14.
132132
133133
```
134-
curl -H "Authorization: token $ACE_TOKEN" \
135-
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade/current-version
134+
curl -H "Authorization: token $AKP_TOKEN" \
135+
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade/current-version
136136
```
137137

138138
---
@@ -160,8 +160,8 @@ the target used for imported-cluster upgrades.
160160
> against `appscode/ace` (hub) (`{"version":"v2026.6.19"}`) on 2026-07-14.
161161
162162
```
163-
curl -H "Authorization: token $ACE_TOKEN" \
164-
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade/latest-version
163+
curl -H "Authorization: token $AKP_TOKEN" \
164+
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade/latest-version
165165
```
166166

167167
---
@@ -180,8 +180,8 @@ progress is tracked in an upgrader `ConfigMap` (poll
180180
is not assigned to the caller.
181181

182182
```
183-
curl -X POST -H "Authorization: token $ACE_TOKEN" \
184-
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade
183+
curl -X POST -H "Authorization: token $AKP_TOKEN" \
184+
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade
185185
```
186186

187187
> Not verified live: this is a mutating (`POST`) endpoint and is documented from
@@ -214,8 +214,8 @@ Returns `400` when no upgrade status is recorded for the spoke yet.
214214
> upgrade recorded on the hub for this cluster. On 2026-07-14.
215215
216216
```
217-
curl -H "Authorization: token $ACE_TOKEN" \
218-
https://<ace-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade
217+
curl -H "Authorization: token $AKP_TOKEN" \
218+
https://<akp-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade
219219
```
220220

221221
---
@@ -242,8 +242,8 @@ Returns the upgrade history for a spoke cluster as a list of `ConfigMap` data ma
242242
> `200` against `appscode/arnob-dev` (spoke) (empty list `[]`) on 2026-07-14.
243243
244244
```
245-
curl -H "Authorization: token $ACE_TOKEN" \
246-
https://<ace-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade/history
245+
curl -H "Authorization: token $AKP_TOKEN" \
246+
https://<akp-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade/history
247247
```
248248

249249
---
@@ -261,8 +261,8 @@ asynchronous post-processing.
261261
cluster is not assigned to the caller.
262262

263263
```
264-
curl -X POST -H "Authorization: token $ACE_TOKEN" \
265-
https://<ace-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade
264+
curl -X POST -H "Authorization: token $AKP_TOKEN" \
265+
https://<akp-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade
266266
```
267267

268268
> Not verified live: this is a mutating (`POST`) endpoint and is documented from

docs/platform/api/ace-upgrade/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ menu_name: docsplatform_{{.version}}
1010
section_menu_id: api
1111
---
1212

13-
# ACE Upgrade — Overview
13+
# Platform Upgrade — Overview
1414

1515
Platform and per-cluster upgrades (FluxCD-driven).
1616

0 commit comments

Comments
 (0)