Skip to content

fix: add release stages #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
8 changes: 1 addition & 7 deletions docs/for-devs/console/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,7 @@ The `redis-cluster` Helm chart can be used to create a Redis master-replica clus

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

Using the `rabbitmq-cluster` Helm chart requires `RabbitMQ` to be enabled by a platform administrator.

8. SpinApp

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.

Using the `spin-app` Helm chart requires a `spin-shim-executor` to be added to the Team by a platform administrator.
Using the `rabbitmq-cluster` Helm chart requires `RabbitMQ` to be enabled by a platform administrator.


## Using the Catalog
Expand Down
31 changes: 27 additions & 4 deletions docs/for-ops/console/apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,36 @@ title: Platform - Apps
sidebar_label: Apps
---

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

The apps section lists all apps available.
## Platform App release stages

### Activating apps
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.

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.
App Platform also sets standards for the following platform app integration criteria:

1. Backup and restore: Databases used by a platform app are automatically backed-up and restore procedures are tested.
2. Seamless database upgrades: Databases used by a platform app are automatically upgraded without downtime.
3. High Availability: A platform app is by default configured for High Availability.
4. Lifecycle management: The platform app is part of the platform release cycle and will be upgraded accordingly.
5. Authentication: Only authenticated users can access the platform app.
6. Graceful Termination: Pods of a platform app will terminate gracefully in case of a node drain operation.
7. Continuity: A platform app will not be removed without a deprecation notice.
8. Kubernetes version support: A platform app is supported on all App Platform supported Kubernetes versions.

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:

| Release Stage | Integration Criteria Compliance |
| ------------- | ---------------------------------- |
| Alpha | Minimal compliant (5, 6) |
| Beta | Partial compliant (3, 5, 6, 7, 8) |
| GA | Fully compliant |

Alpha platform apps are labeled as `ALPHA`. Beta platform apps are labeled as `BETA`. GA platform apps do not have a label.

## Activating Core Apps

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.

:::info
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.
Expand Down
26 changes: 0 additions & 26 deletions docs/for-ops/console/team-admin-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,6 @@ The contents of the Catalog and the RBAC configuration (which Team can use which

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.

## Helm charts available for platform administrators

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`.

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:

1. Kwasm Operator

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`

2. Spin Operator

The `spin-operator` Helm chart can be used to enable deploying Spin applications to Kubernetes.

3. Spin Shim Executor

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.

4. KubeFlow Pipelines Cluster Resources

The `kfp-cluster-resources` Helm chart can be used to install the KubeFlow Pipelines CRDs.

5. Kubeflow Pipelines

The `kubeflow-pipelines` Helm chart can be used to install KubeFlow Pipelines in any Team.

## Adding Helm charts to the Catalog

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