Skip to content

Commit 0e01ee1

Browse files
authored
fix: add release stages (#113)
1 parent caa3c8e commit 0e01ee1

File tree

3 files changed

+30
-37
lines changed

3 files changed

+30
-37
lines changed

docs/for-devs/console/catalog.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,7 @@ The `redis-cluster` Helm chart can be used to create a Redis master-replica clus
4040

4141
The `rabbitmq-cluster` Helm chart can be used to create a `RabbitmqCluster`, `queues` and `Policy`s.
4242

43-
Using the `rabbitmq-cluster` Helm chart requires `RabbitMQ` to be enabled by a platform administrator.
44-
45-
8. SpinApp
46-
47-
The `spin-app` Helm chart can be used to create a `SpinApp`. A SpinApp is a Custom Resource to deploy WebAssembly microservices and web applications based on Spin.
48-
49-
Using the `spin-app` Helm chart requires a `spin-shim-executor` to be added to the Team by a platform administrator.
43+
Using the `rabbitmq-cluster` Helm chart requires `RabbitMQ` to be enabled by a platform administrator.
5044

5145

5246
## Using the Catalog

docs/for-ops/console/apps.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,38 @@ title: Platform - Apps
44
sidebar_label: Apps
55
---
66

7-
<!-- ![Console apps](../../img/platform-apps.png) -->
7+
The apps section lists all platform apps available.
88

9-
The apps section lists all apps available.
9+
## Platform App release stages
1010

11-
### Activating apps
11+
Platform apps in Akamai App Platform have 3 release stages: Alpha, Beta and GA. Alpha apps are experimental and may change significantly, while beta apps are more stable. General Availability (GA) apps are considered stable and have a commitment to remain unchanged in a major version.
1212

13-
During installation only the Core applications are activated. To active more apps, hoover over the app you would like to activate and click on the power-on button. All apps are installed with a default configuration. To change the configuration, click on the configuration button and then click on `Values` tab.
13+
App Platform also sets standards for the following platform app integration criteria:
14+
15+
1. Backup and restore: Databases used by a platform app are automatically backed-up and restore procedures are tested.
16+
2. Smooth database upgrades: Databases used by a platform app are automatically upgraded.
17+
3. Lifecycle management: The platform app is part of the platform release cycle and will be upgraded accordingly.
18+
4. Authentication: Only authenticated users can access the platform app.
19+
5. Graceful Termination: Pods of a platform app will terminate gracefully in case of a node drain operation.
20+
6. Continuity: A platform app will not be removed without a deprecation notice.
21+
7. Kubernetes version support: A platform app is supported on all App Platform supported Kubernetes versions.
22+
8. Monitoring and observability: Prometheus rules and grafana dashboards are provided and maintained for the app.
23+
9. Resource management: Correct resources are set and managed.
24+
25+
26+
Based on the release stage, a platform app partially or fully complies to the integration criteria due to its immaturity or current limitations of the platform itself:
27+
28+
| Release Stage | Integration Criteria Compliance |
29+
| ------------- | ---------------------------------- |
30+
| Alpha | Minimal compliant (4, 5) |
31+
| Beta | Partial compliant (4, 5, 6, 7, 9) |
32+
| GA | Fully compliant |
33+
34+
Alpha platform apps are labeled as `ALPHA`. Beta platform apps are labeled as `BETA`. GA platform apps do not have a label.
35+
36+
## Activating Core Apps
37+
38+
During installation only the Core apps are activated. To active more apps, hoover over the app you would like to activate and click on the power-on button. All apps are installed with a default configuration. To change the configuration, click on the configuration button and then click on `Values` tab.
1439

1540
:::info
1641
Note: Some apps have dependencies with other apps. The dependencies can be found [here](https://github.com/linode/apl-core/blob/main/core.yaml). Dependencies are handled automatically.

docs/for-ops/console/team-admin-catalog.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,6 @@ The contents of the Catalog and the RBAC configuration (which Team can use which
1212

1313
The Catalog contains a set of Helm charts that can be used as quick starts, but also offers the option (for platform administrators only) to add more Helm charts to the Catalog, using the `+ Add Helm Chart` option.
1414

15-
## Helm charts available for platform administrators
16-
17-
Next to the Helm charts that are by default included in the Catalog and made available for Teams, the Catalog also by default includes a set of curated Helm charts that can only be installed by platform administrators. These Helm charts are visible in the Catalog for the Team `Admin`.
18-
19-
The Helm charts that are by default added to the Catalog are maintained in the [apl-charts](https://github.com/linode/apl-charts) GitHub repository. Currently the following Helm charts are made available for platform-administrators:
20-
21-
1. Kwasm Operator
22-
23-
The `kwasm-operator` Helm chart can be used to add WebAssembly support to the Kubernetes Nodes. `kwasm-operator` is a prerequisite for installing `spin-operator`
24-
25-
2. Spin Operator
26-
27-
The `spin-operator` Helm chart can be used to enable deploying Spin applications to Kubernetes.
28-
29-
3. Spin Shim Executor
30-
31-
The `spin-shim-executor` Helm chart can be used to create a `SpinAppExecutor` utilized by Spin Operator to determine which executor type should be used in running a SpinApp.
32-
33-
4. KubeFlow Pipelines Cluster Resources
34-
35-
The `kfp-cluster-resources` Helm chart can be used to install the KubeFlow Pipelines CRDs.
36-
37-
5. Kubeflow Pipelines
38-
39-
The `kubeflow-pipelines` Helm chart can be used to install KubeFlow Pipelines in any Team.
40-
4115
## Adding Helm charts to the Catalog
4216

4317
1. Select view `team` and select team `admin` in the top bar.

0 commit comments

Comments
 (0)