Skip to content

Commit 839d9ba

Browse files
authored
Merge pull request #103 from linode/rm-deploy-changes
fix: updates for 4.3.0
2 parents 98cf9ca + 7389828 commit 839d9ba

Some content is hidden

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

59 files changed

+182
-166
lines changed

docs/akamai-app-platform/introduction.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,83 @@ title: Introduction
44
sidebar_label: Introduction
55
---
66

7-
## Akamai App Platform
7+
## What is Akamai App Platform
88

99
Akamai App Platform is a platform that combines developer and operations-centric tools, automation and self-service to streamline the application lifecycle when using Kubernetes. From development to delivery to management of containerized application workloads.
1010

1111
The platform connects many of the technologies found in the Cloud Native Computing Foundation (CNCF) landscape in a way to provide direct value. No more re-inventing the wheel when building and maintaining your own Kubernetes based platform or bespoke stack.
1212

1313
The App Platform is optimized to run on Linode Kubernetes Engine (LKE), but can also (manually) be installed on any other [conformant Kubernetes cluster](https://www.cncf.io/training/certification/software-conformance/).
14+
15+
The platform includes:
16+
17+
- An **integrated and pre-configured Stack of open source Kubernetes projects** to support all the essential capabilities for running cloud native applications in production on Kubernetes.
18+
19+
- An easy **self-service portal** for Developers to build images, create workloads, create secrets and publicly expose services
20+
21+
- A **Catalog** with pre-build golden path templates that can be customized.
22+
23+
- Kubernetes **Operators and GitOps** to manage the state of the platform based on configuration-as-code.
24+
25+
## The Akamai Application Platform helps
26+
27+
- Speed up time to market by automating and simplifying building and running applications on Kubernetes, reducing the complexity for Development teams.
28+
29+
- Reduce toil and avoid technical debt by providing a pre-configured and integrated suite of tools for CI/CD, Observability and Security out-of-the-box, accelerating the application delivery and enhancing security.
30+
31+
- Support multi-tenancy by allowing multiple teams or projects to share the same cluster, with self-service features that enable faster, independent deployments by developers.
32+
33+
- Self-Serving Developers to allow Developers to Build, Deploy, Expose, Observe and Secure containerized applications on Kubernetes using a web based self-service portal
34+
35+
36+
### The Akamai Application Platform supports Developers with easy self-service
37+
38+
- Build OCI compliant images from source code.
39+
40+
- Deploy containerized workloads the GitOps way using the provided quickstarts or BYO golden path templates.
41+
42+
- Automatically update container images of workloads.
43+
44+
- Publicly expose applications.
45+
46+
- Get instant access to logs, metrics and traces.
47+
48+
- Store images in a private registry.
49+
50+
- Configure network policies, response headers and CNAMEs.
51+
52+
- Check applications against a comprehensive set of built-in security policies.
53+
54+
- Create and manage secrets.
55+
56+
- Create private Git repositories and use the built-in CI/CD pipelines
57+
58+
59+
### And supports Platform Administrators with all the required platform capabilities when using Kubernetes
60+
61+
- Get all the required capabilities in an integrated and automated way.
62+
63+
- Onboard development Teams in a comprehensive multi-tenant setup and make them self-serving.
64+
65+
- Manage users.
66+
67+
- Ensure governance with security policies.
68+
69+
- Implement zero-trust networking.
70+
71+
- Change the desired state of the platform based on Configuration-as-Code.
72+
73+
- Support multi- and hybrid cloud scenarios.
74+
75+
- Prevent cloud provider lock-in.
76+
77+
- Implement full observability.
78+
79+
- Comply with Disaster Recovery requirements
80+
81+
## Integrated and pre-configured Kubernetes projects
82+
83+
Get a complete suite of integrated and pre-configured Kubernetes projects to support all the required platform capabilities. Compose your ideal platform by enableling the Kubernetes applications to support all the required capabilities:
84+
85+
![integrated-apps](../img/integrated-apps.png)
86+

docs/apps/drone.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/apps/falco.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ Before activating Falco, please first check which [Driver](https://falco.org/doc
1616

1717
- modern-bpf
1818

19-
If you know which driver should be used, activate Falco, go to the `Values`, add the `Driver` and submit changes. Now `Deploy Changes`.
19+
If you know which driver should be used, activate Falco, go to the `Values`, add the `Driver` and submit changes.
2020

2121
When Falco is installed, a set of rules to `white-list` all known behaviour is added. These rules are added using the Raw Values.

docs/apps/gitea.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ sidebar_label: Gitea
66

77
## About
88

9-
Gitea is a community managed lightweight code hosting solution written in Go. Because Tekton is used to deploy changes to the values repo, it needs a git hosting solution. Gitea is used to host all of the internal Git repositories used by the platform and can also be used for other purposes.
9+
Gitea is a community managed lightweight code hosting solution written in Go. Gitea is used to host all of the internal Git repositories used by the platform and can also be used for other purposes.

docs/for-devs/console/builds.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ Now choose the type of the build:
5757

5858
### Buildpacks
5959

60-
1. Add the URL of the Git repository that contains the application source code
60+
1. Add the URL of the Git repository that contains the application source code.
6161

62-
2. (optional) Add the path. This is a subpath within the repo where the source to build is located
62+
2. (optional) Add the path. This is a subpath within the repo where the source to build is located.
6363

64-
3. (optional) Change the revision. This can be a commit, a tag, or a branch
64+
3. (optional) Change the revision. This can be a commit, a tag, or a branch.
6565

66-
4. (optional) Add Environment variables to set during build-time
66+
4. (optional) Add Environment variables to set during build-time.
6767

6868
5. (Optional) Select `External Repo` if the repository used for the Build is not a public or a private Git repo in the local Gitea. When selected, fill in the secret name that contains the required SSH credentials. Read more [here](https://tekton.dev/docs/how-to-guides/clone-repository/#git-authentication) about how to setup SSH authentication with your Git provider.
6969

@@ -75,31 +75,31 @@ To see the more status details of the build, click on the `PipelineRun` link of
7575

7676
### Configure a webhook for the Git repo in Gitea
7777

78-
1. In the Console, click on `Apps` in the left menu and then open `Gitea`
78+
1. In the Console, click on `Apps` in the left menu and then open `Gitea`.
7979

80-
2. In the top left menu of Gitea, click on `Explore` and then on the `green` repo
80+
2. In the top left menu of Gitea, click on `Explore` and then on the `green` repo.
8181

82-
3. Go to `Settings` (top right) and then to `Webhooks`
82+
3. Go to `Settings` (top right) and then to `Webhooks`.
8383

84-
4. Click `Add Webhook` and select `Gitea`
84+
4. Click `Add Webhook` and select `Gitea`.
8585

8686
5. In the `Target URL`, paste the webhook URL from your clipboard.
8787

88-
6. Click `Add Webhook`
88+
6. Click `Add Webhook`.
8989

9090
### Expose the trigger listener publicly
9191

9292
When using an external (private) Git repository, the trigger event listener that is created can also be exposed publicly. To expose the event listener publicly:
9393

94-
1. Go to Services
94+
1. Go to Services.
9595

96-
2. Click create new service
96+
2. Click create new service.
9797

98-
3. Select the `el-gitea-webhook-<build-name>` internal service
98+
3. Select the `el-gitea-webhook-<build-name>` internal service.
9999

100-
4. Under `Exposure`, select `External`
100+
4. Under `Exposure`, select `External`.
101101

102-
5. Click `Submit` and the `Deploy Changes`
102+
5. Click `Submit`.
103103

104104
### Restart a build
105105

docs/for-devs/console/catalog.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,41 @@ title: Catalog
44
sidebar_label: Catalog
55
---
66

7+
## About the Catalog quick starts
8+
79
The Catalog is a library of curated Helm charts to create Kubernetes resources. By default the Catalog contains a set of Helm charts provided to get started quickly, but they can also be modified depending on your requirements or be removed from the Catalog.
810

911
The contents of the Catalog and the RBAC configuration (which Team can use which Helm chart) are managed by the platform administrator. Contact the platform administrator if you would like to add your own charts to use within your Team.
1012

11-
## About the Catalog quick starts
12-
1313
The Catalog contains a set of Helm charts that can be used as quick starts. The following quick starts are available:
1414

1515
### Kubernetes Deployment
1616

17-
The `quickstart-k8s-deployment` Helm chart can be used to create a Kubernetes `Deployment` (to deploy a single image), a `Service` and a `ServiceAccount`. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` can be created.
17+
The `k8s-deployment` Helm chart can be used to create a Kubernetes `Deployment` (to deploy a single image), a `Service` and a `ServiceAccount`. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` can be created.
1818

1919
### Kubernetes Deployment with Open Telemetry Instrumentation
2020

21-
The `quickstart-k8s-deployment-otel` Helm chart can be used to create a Kubernetes `Deployment` (to deploy a single image), a `Service`, a `ServiceAccount` and an `Instrumentation` resource. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` can be created.
21+
The `k8s-deployment-otel` Helm chart can be used to create a Kubernetes `Deployment` (to deploy a single image), a `Service`, a `ServiceAccount` and an `Instrumentation` resource. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` can be created.
2222

2323
### Kubernetes Canary Deployments
2424

25-
The `quickstart-k8s-deployments-canary` Helm chart can be used to create 2 Kubernetes `Deployments` (to deploy 2 versions of an image), a `Service` and a `ServiceAccount` resource. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` (for each version) can be created.
25+
The `k8s-deployments-canary` Helm chart can be used to create 2 Kubernetes `Deployments` (to deploy 2 versions of an image), a `Service` and a `ServiceAccount` resource. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` (for each version) can be created.
2626

2727
### Knative-service
2828

29-
The `quickstart-knative-service` Helm chart can be used to create a Knative `Service` (to deploy a single image), a `Service` and a `ServiceAccount`. Optionally a Prometheus `ServiceMonitor` can be created.
29+
The `knative-service` Helm chart can be used to create a Knative `Service` (to deploy a single image), a `Service` and a `ServiceAccount`. Optionally a Prometheus `ServiceMonitor` can be created.
3030

3131
### PostgreSQL cluster
3232

33-
The `quickstart-postgresql` Helm chart can be used to create a cloudnativepg PostgreSQL `Cluster`. Optionally a Prometheus `PodMonitor` and a `Configmap` (for adding a postgresql dashboard to Grafana) can be created.
33+
The `postgresql-cluster` Helm chart can be used to create a cloudnativepg PostgreSQL `Cluster`. Optionally a Prometheus `PodMonitor` and a `Configmap` (for adding a postgresql dashboard to Grafana) can be created.
3434

3535
### Redis master-replica cluster
3636

37-
The `quickstart-redis` Helm chart can be used to create a Redis master-replica cluster.
37+
The `redis-cluster` Helm chart can be used to create a Redis master-replica cluster.
3838

3939
### RabbitMQ Cluster and/or Queues
4040

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

4343

4444
## Using the Catalog
@@ -47,7 +47,7 @@ The `quickstart-rabbitmq` Helm chart can be used to create a `RabbitmqCluster`,
4747

4848
2. You will now see all the templates that are available to use
4949

50-
![catalog](../../img/catalog.png)
50+
![Team catalog](../../img/team-catalog.png)
5151

5252
3. Click on the `k8s-deployment` template
5353

docs/for-devs/console/deploy-changes.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/for-devs/console/overview.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,7 @@ sidebar_label: Overview
1010

1111
The Console is the web UI of the platform and offers access to all integrated apps and self-service features. The Console has a topbar showing a Team selector. The Team selector allows you to switch between different Teams (if you are a member of different Teams).
1212

13-
The Team view in the Console gives access to 3 menu sections:
14-
15-
Deploy section:
16-
17-
- [Deploy Changes](deploy-changes): Commit changes to the configuration repository
18-
- Revert Changes: Revert your changes made in the Console
13+
The Team view in the Console gives access to 2 sections:
1914

2015
Self-service section:
2116

docs/for-devs/console/projects.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,19 @@ A Project is a collection of a Build, a Workload and a Service in ONE form.
99
## Create a Project
1010

1111
1. In the left menu click on `Projects` and then on `Create project`.
12+
1213
2. Provide a name for the project.
1314

1415
Note: The name of the project will be used for all created resources (build, workload and service).
1516

16-
3. Select `Create build form source` or `Use an existing image`
17-
4. If `Create build from source` is selected: follow the [instruction](builds.md) for creating a Build
18-
5. If `Use an existing image` is selected: follow the [instruction](workloads.md) for creating a Workload
17+
3. Select `Create build form source` or `Use an existing image`.
18+
19+
4. If `Create build from source` is selected: follow the [instruction](builds.md) for creating a Build.
20+
21+
5. If `Use an existing image` is selected: follow the [instruction](workloads.md) for creating a Workload.
1922

2023
Note: The `image.repository` and `image.tag` parameters in the values of the workload are automatically set when `Create build form source` is used. If `Use an existing image` is selected, the `image.repository` and `image.tag` parameters need to be set manually.
2124

22-
6. Follow the [instruction](services.md) for creating a Service to expose the workload
23-
7. Click `Submit` and then `Deploy changes`
25+
6. Follow the [instruction](services.md) for creating a Service to expose the workload.
26+
27+
7. Click `Submit`.

docs/for-devs/console/settings.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,10 @@ Enable to install a Grafana instance for the team.
3030

3131
- Grafana is provisioned with multiple dashboards that rely on the Platform Prometheus. If Prometheus on the Platform is not enabled, these dashboards will not work!
3232

33-
### Prometheus
34-
35-
Enable to install a Prometheus instance for the team. The Prometheus instance is configured to only scrape metrics from `PodMonitors` and `ServiceMonitors` that have the label `prometheus: team-<team-name>`.
36-
3733
### Alertmanger
3834

39-
Enable to install an Alertmanager instance for the team. The Alertmanger instance will only show alerts based on `Rules` for the Team's Prometheus.
40-
41-
### Private
35+
Enable to install an Alertmanager instance for the team.
4236

43-
Select to disable cross-team access (and make the Team Grafana private for Team members only)
4437

4538
## Configure alert settings
4639

@@ -65,7 +58,7 @@ There is no validation as there is no schema published. Add/change resource quot
6558
:::
6659

6760

68-
## Configure Network Policies
61+
## Enable Network Policies
6962

7063
| Option | Description |
7164
| ---------------- | -------------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)