Skip to content
Merged
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
10 changes: 5 additions & 5 deletions api.html

Large diffs are not rendered by default.

9 changes: 4 additions & 5 deletions docs/platform/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ aliases:
- /docs/platform/{{.version}}/api/README/
---

# ACE Platform API Reference
# KubeDB Platform API Reference

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

Expand Down Expand Up @@ -55,8 +54,8 @@ root.
| [Multi-cluster (OCM)](../api/multicluster-ocm/hubs-spokes/) | Hub/spoke, cluster sets, feature sets |
| [Client Organizations](../api/client-organizations/management/) | Managed-service client orgs |
| [Cloud Providers](../api/cloud-providers/cloud-providers/) | Provider discovery for provisioning |
| [ACE Installer](../api/ace-installer/ace-installer/) | Self-host installer bundles |
| [ACE Upgrade](../api/ace-upgrade/platform-upgrade/) | Platform & cluster upgrades |
| [Platform Installer](../api/ace-installer/ace-installer/) | Self-host installer bundles |
| [Platform Upgrade](../api/ace-upgrade/platform-upgrade/) | Platform & cluster upgrades |
| [Licensing & Contracts](../api/licensing-contracts/registration/) | Contracts, licenses, registration |
| [Billing Dashboard](../api/billing-dashboard/admin-dashboard/) | Usage reports & billing dashboards |
| [Marketplace](../api/marketplace/webhook-service/) | Cloud-marketplace webhooks & metering |
Expand Down
12 changes: 6 additions & 6 deletions docs/platform/api/ace-installer/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-ace-installer
name: ACE Installer
name: Platform Installer
parent: api
weight: 100
menu_name: docsplatform_{{.version}}
section_menu_id: api
---

# ACE Installer API
# Platform Installer API

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

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

## Pages

- [ACE Installer](../ace-installer.md) — schema/model, generate/import,
- [Platform Installer](../ace-installer.md) — schema/model, generate/import,
installer metadata and latest version, installers CRUD, reconfigure/upgrade,
versions/archives, and marketplace installer status.
32 changes: 16 additions & 16 deletions docs/platform/api/ace-installer/ace-installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-ace-installer-ace-installer
name: ACE Installer
name: Platform Installer
parent: api-ace-installer
weight: 10
menu_name: docsplatform_{{.version}}
section_menu_id: api
---

# ACE Installer
# Platform Installer

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

> **AppsCode-hosted only.** These routes exist only on the AppsCode-hosted (SaaS)
> deployment. On self-hosted ACE installations the `/ace-installer` routes are not
> deployment. On self-hosted KubeDB Platform installations the `/ace-installer` routes are not
> registered and every call returns `404 Not Found`. (This was confirmed live — see the
> verification notes below.)

Expand All @@ -44,7 +44,7 @@ organization's hosted-mode capability:
A documented call looks like:

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

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

### InstallerMetadata

Metadata describing a generated or imported ACE installer.
Metadata describing a generated or imported installer.

```json
{
Expand Down Expand Up @@ -89,7 +89,7 @@ Metadata describing a generated or imported ACE installer.
|-------|------|-------------|
| `ID` | string | Installer ID. |
| `installerName` | string | Installer name (installers are grouped by name). |
| `deploymentType` | string | ACE deployment type. |
| `deploymentType` | string | KubeDB Platform deployment type. |
| `requestedDomain` | string | Domain requested for the installer. |
| `host` | string | Effective host for the deployment. |
| `hostType` | string | Host type. |
Expand All @@ -101,7 +101,7 @@ Metadata describing a generated or imported ACE installer.
| `adminEmail` | string | Email of the platform admin. |
| `accessTokenID` | integer (int64) | ID of the access token that created the installer. |
| `clusterID` | string | Cluster identifier bound to the installer. |
| `version` | string | ACE installer chart version. |
| `version` | string | installer chart version. |
| `promotedToProduction` | boolean | Whether the installer has been promoted to production. |
| `createTimestamp` | string (date-time) | Creation time. |
| `expiryTimestamp` | string (date-time) | Expiry time. |
Expand Down Expand Up @@ -153,7 +153,7 @@ Metadata describing a generated or imported ACE installer.

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

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

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

> **Verified:** returned `404` against `appscode` on the self-hosted platform
> (`<ace-host>`) on 2026-07-14 — the ace-installer routes are AppsCode-hosted only and are
> (`<akp-host>`) on 2026-07-14 — the ace-installer routes are AppsCode-hosted only and are
> not registered on this install (body: `{"message":"Not Found"}`).

### GET /ace-installer/model.json

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

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

### POST /ace-installer/generate

Generates a new ACE installer from the supplied `AceOptionsSpec` options and returns the
Generates a new installer from the supplied `AceOptionsSpec` options and returns the
resulting installer metadata.

- **Auth:** token; org context; requires `create_installers`.
Expand Down Expand Up @@ -242,7 +242,7 @@ request.

### GET /ace-installer/latest-version

Returns the latest available ACE installer chart version.
Returns the latest available installer chart version.

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

| Field | Type | Description |
|-------|------|-------------|
| `version` | string | Latest ACE installer chart version. |
| `version` | string | Latest installer chart version. |

> **Verified:** returned `404` against `appscode` on the self-hosted platform on
> 2026-07-14 (AppsCode-hosted only; route not registered).
Expand Down Expand Up @@ -356,7 +356,7 @@ Reconfigures an existing installer using the supplied `AceOptionsSpec` options.

### POST /ace-installer/installers/{name}/{id}/upgrade

Upgrades an existing installer to the latest ACE installer version and returns the updated
Upgrades an existing installer to the latest installer version and returns the updated
installer metadata.

- **Auth:** token; org context; requires `upgrade_installers`.
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/api/ace-installer/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ menu_name: docsplatform_{{.version}}
section_menu_id: api
---

# ACE Installer — Overview
# Platform Installer — Overview

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

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

## Reference pages

- [ACE installer](../ace-installer.md)
- [installer](../ace-installer.md)
8 changes: 4 additions & 4 deletions docs/platform/api/ace-upgrade/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-ace-upgrade
name: ACE Upgrade
name: Platform Upgrade
parent: api
weight: 110
menu_name: docsplatform_{{.version}}
section_menu_id: api
---

# ACE Upgrade
# Platform Upgrade

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

- **Platform upgrade** routes (`/api/v1/upgrade*`) act on the ACE platform as a
- **Platform upgrade** routes (`/api/v1/upgrade*`) act on the KubeDB Platform as a
whole. They require an organization context (`?org=<slug>`) and **site-admin
organization authorization** — `view_upgrade_history:org` for the read routes
and `upgrade_platform:org` for the trigger route.
Expand Down
36 changes: 18 additions & 18 deletions docs/platform/api/ace-upgrade/cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ section_menu_id: api

# Cluster Upgrade

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

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

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

**Authentication & authorization.** All routes require a personal access token
(`Authorization: token <YOUR_TOKEN>`). Access is gated by **cluster assignment**
Expand Down Expand Up @@ -74,8 +74,8 @@ Returns `400` when no upgrade status is recorded in the cluster yet.
> been run on this cluster, so there is no upgrader ConfigMap. On 2026-07-14.

```
curl -H "Authorization: token $ACE_TOKEN" \
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade
curl -H "Authorization: token $AKP_TOKEN" \
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade
```

---
Expand All @@ -102,8 +102,8 @@ maps.
> against `appscode/ace` (hub) (empty list `[]`) on 2026-07-14.

```
curl -H "Authorization: token $ACE_TOKEN" \
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade/history
curl -H "Authorization: token $AKP_TOKEN" \
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade/history
```

---
Expand Down Expand Up @@ -131,8 +131,8 @@ cluster.
> `200` against `appscode/ace` (hub) (`{"version":"v2026.6.19"}`) on 2026-07-14.

```
curl -H "Authorization: token $ACE_TOKEN" \
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade/current-version
curl -H "Authorization: token $AKP_TOKEN" \
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade/current-version
```

---
Expand Down Expand Up @@ -160,8 +160,8 @@ the target used for imported-cluster upgrades.
> against `appscode/ace` (hub) (`{"version":"v2026.6.19"}`) on 2026-07-14.

```
curl -H "Authorization: token $ACE_TOKEN" \
https://<ace-host>/api/v1/clusters/appscode/ace/upgrade/latest-version
curl -H "Authorization: token $AKP_TOKEN" \
https://<akp-host>/api/v1/clusters/appscode/ace/upgrade/latest-version
```

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

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

> Not verified live: this is a mutating (`POST`) endpoint and is documented from
Expand Down Expand Up @@ -214,8 +214,8 @@ Returns `400` when no upgrade status is recorded for the spoke yet.
> upgrade recorded on the hub for this cluster. On 2026-07-14.

```
curl -H "Authorization: token $ACE_TOKEN" \
https://<ace-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade
curl -H "Authorization: token $AKP_TOKEN" \
https://<akp-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade
```

---
Expand All @@ -242,8 +242,8 @@ Returns the upgrade history for a spoke cluster as a list of `ConfigMap` data ma
> `200` against `appscode/arnob-dev` (spoke) (empty list `[]`) on 2026-07-14.

```
curl -H "Authorization: token $ACE_TOKEN" \
https://<ace-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade/history
curl -H "Authorization: token $AKP_TOKEN" \
https://<akp-host>/api/v1/clusters/appscode/arnob-dev/spoke/upgrade/history
```

---
Expand All @@ -261,8 +261,8 @@ asynchronous post-processing.
cluster is not assigned to the caller.

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

> Not verified live: this is a mutating (`POST`) endpoint and is documented from
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/api/ace-upgrade/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ menu_name: docsplatform_{{.version}}
section_menu_id: api
---

# ACE Upgrade — Overview
# Platform Upgrade — Overview

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

Expand Down
Loading
Loading