Merge pull request #103 from linode/rm-deploy-changes

fix: updates for 4.3.0

Author: Ani1357

docs/akamai-app-platform/introduction.md

@@ -4,10 +4,83 @@ title: Introduction
 sidebar_label: Introduction
 ---
 
-## Akamai App Platform
+## What is Akamai App Platform
 
 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.
 
 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.
 
 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/).
+
+The platform includes:
+
+- 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.
+
+- An easy **self-service portal** for Developers to build images, create workloads, create secrets and publicly expose services
+
+- A **Catalog** with pre-build golden path templates that can be customized.
+
+- Kubernetes **Operators and GitOps** to manage the state of the platform based on configuration-as-code.
+
+## The Akamai Application Platform helps
+
+- Speed up time to market by automating and simplifying building and running applications on Kubernetes, reducing the complexity for Development teams.
+
+- 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.
+
+- 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.
+
+- Self-Serving Developers to allow Developers to Build, Deploy, Expose, Observe and Secure containerized applications on Kubernetes using a web based self-service portal
+
+
+### The Akamai Application Platform supports Developers with easy self-service
+
+- Build OCI compliant images from source code.
+
+- Deploy containerized workloads the GitOps way using the provided quickstarts or BYO golden path templates.
+
+- Automatically update container images of workloads.
+
+- Publicly expose applications.
+
+- Get instant access to logs, metrics and traces.
+
+- Store images in a private registry.
+
+- Configure network policies, response headers and CNAMEs.
+
+- Check applications against a comprehensive set of built-in security policies.
+
+- Create and manage secrets.
+
+- Create private Git repositories and use the built-in CI/CD pipelines
+
+
+### And supports Platform Administrators with all the required platform capabilities when using Kubernetes
+
+- Get all the required capabilities in an integrated and automated way.
+
+- Onboard development Teams in a comprehensive multi-tenant setup and make them self-serving.
+
+- Manage users.
+
+- Ensure governance with security policies.
+
+- Implement zero-trust networking.
+
+- Change the desired state of the platform based on Configuration-as-Code.
+
+- Support multi- and hybrid cloud scenarios.
+
+- Prevent cloud provider lock-in.
+
+- Implement full observability.
+
+- Comply with Disaster Recovery requirements
+
+## Integrated and pre-configured Kubernetes projects
+
+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:
+
+![integrated-apps](../img/integrated-apps.png)
+

docs/apps/drone.md

@@ -16,6 +16,6 @@ Before activating Falco, please first check which [Driver](https://falco.org/doc
 
 - modern-bpf
 
-If you know which driver should be used, activate Falco, go to the `Values`, add the `Driver` and submit changes. Now `Deploy Changes`.
+If you know which driver should be used, activate Falco, go to the `Values`, add the `Driver` and submit changes.
 
 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/falco.md

@@ -6,4 +6,4 @@ sidebar_label: Gitea
 
 ## About
 
-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.
+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/apps/gitea.md

@@ -57,13 +57,13 @@ Now choose the type of the build:
 
 ### Buildpacks
 
-1. Add the URL of the Git repository that contains the application source code
+1. Add the URL of the Git repository that contains the application source code.
 
-2. (optional) Add the path. This is a subpath within the repo where the source to build is located
+2. (optional) Add the path. This is a subpath within the repo where the source to build is located.
 
-3. (optional) Change the revision. This can be a commit, a tag, or a branch
+3. (optional) Change the revision. This can be a commit, a tag, or a branch.
 
-4. (optional) Add Environment variables to set during build-time
+4. (optional) Add Environment variables to set during build-time.
 
 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.
 
@@ -75,31 +75,31 @@ To see the more status details of the build, click on the `PipelineRun` link of
 
 ### Configure a webhook for the Git repo in Gitea
 
-1. In the Console, click on `Apps` in the left menu and then open `Gitea`
+1. In the Console, click on `Apps` in the left menu and then open `Gitea`.
 
-2. In the top left menu of Gitea, click on `Explore` and then on the `green` repo
+2. In the top left menu of Gitea, click on `Explore` and then on the `green` repo.
 
-3. Go to `Settings` (top right) and then to `Webhooks`
+3. Go to `Settings` (top right) and then to `Webhooks`.
 
-4. Click `Add Webhook` and select `Gitea`
+4. Click `Add Webhook` and select `Gitea`.
 
 5. In the `Target URL`, paste the webhook URL from your clipboard.
 
-6. Click `Add Webhook`
+6. Click `Add Webhook`.
 
 ### Expose the trigger listener publicly
 
 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:
 
-1. Go to Services
+1. Go to Services.
 
-2. Click create new service
+2. Click create new service.
 
-3. Select the `el-gitea-webhook-<build-name>` internal service
+3. Select the `el-gitea-webhook-<build-name>` internal service.
 
-4. Under `Exposure`, select `External`
+4. Under `Exposure`, select `External`.
 
-5. Click `Submit` and the `Deploy Changes`
+5. Click `Submit`.
 
 ### Restart a build
 

docs/for-devs/console/builds.md

@@ -4,41 +4,41 @@ title: Catalog
 sidebar_label: Catalog
 ---
 
+## About the Catalog quick starts
+
 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. 
 
 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.
 
-## About the Catalog quick starts
-
 The Catalog contains a set of Helm charts that can be used as quick starts. The following quick starts are available:
 
 ### Kubernetes Deployment
 
-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.
+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.
 
 ### Kubernetes Deployment with Open Telemetry Instrumentation
 
-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.
+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.
 
 ### Kubernetes Canary Deployments
 
-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.
+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.
 
 ### Knative-service
 
-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.
+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.
 
 ### PostgreSQL cluster
 
-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.
+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.
 
 ### Redis master-replica cluster
 
-The `quickstart-redis` Helm chart can be used to create a Redis master-replica cluster.
+The `redis-cluster` Helm chart can be used to create a Redis master-replica cluster.
 
 ### RabbitMQ Cluster and/or Queues
 
-The `quickstart-rabbitmq` Helm chart can be used to create a `RabbitmqCluster`, `queues` and `Policy`s
+The `rabbitmq-cluster` Helm chart can be used to create a `RabbitmqCluster`, `queues` and `Policy`s
 
 
 ## Using the Catalog
@@ -47,7 +47,7 @@ The `quickstart-rabbitmq` Helm chart can be used to create a `RabbitmqCluster`,
 
 2. You will now see all the templates that are available to use
 
-![catalog](../../img/catalog.png)
+![Team catalog](../../img/team-catalog.png)
 
 3. Click on the `k8s-deployment` template
 

docs/for-devs/console/catalog.md

@@ -10,12 +10,7 @@ sidebar_label: Overview
 
 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).
 
-The Team view in the Console gives access to 3 menu sections:
-
-Deploy section:
-
-- [Deploy Changes](deploy-changes): Commit changes to the configuration repository
-- Revert Changes: Revert your changes made in the Console
+The Team view in the Console gives access to 2 sections:
 
 Self-service section:
 

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

@@ -9,15 +9,19 @@ A Project is a collection of a Build, a Workload and a Service in ONE form.
 ## Create a Project
 
 1. In the left menu click on `Projects` and then on `Create project`.
+
 2. Provide a name for the project.
 
 Note: The name of the project will be used for all created resources (build, workload and service).
 
-3. Select `Create build form source` or `Use an existing image`
-4. If `Create build from source` is selected: follow the [instruction](builds.md) for creating a Build
-5. If `Use an existing image` is selected: follow the [instruction](workloads.md) for creating a Workload
+3. Select `Create build form source` or `Use an existing image`.
+
+4. If `Create build from source` is selected: follow the [instruction](builds.md) for creating a Build.
+
+5. If `Use an existing image` is selected: follow the [instruction](workloads.md) for creating a Workload.
 
 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.
 
-6. Follow the [instruction](services.md) for creating a Service to expose the workload
-7. Click `Submit` and then `Deploy changes`
+6. Follow the [instruction](services.md) for creating a Service to expose the workload.
+
+7. Click `Submit`.

docs/for-devs/console/overview.md

@@ -30,17 +30,10 @@ Enable to install a Grafana instance for the team.
 
 - 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!
 
-### Prometheus
-
-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>`.
-
 ### Alertmanger
 
-Enable to install an Alertmanager instance for the team. The Alertmanger instance will only show alerts based on `Rules` for the Team's Prometheus.
-
-### Private
+Enable to install an Alertmanager instance for the team.
 
-Select to disable cross-team access (and make the Team Grafana private for Team members only)
 
 ## Configure alert settings
 
@@ -65,7 +58,7 @@ There is no validation as there is no schema published. Add/change resource quot
 :::
 
 
-## Configure Network Policies
+## Enable Network Policies
 
 | Option           | Description                                                                            |
 | ---------------- | -------------------------------------------------------------------------------------- |