From e7762242d2224e5f7a71ec245e008fdb6cb15182 Mon Sep 17 00:00:00 2001 From: Sander Rodenhuis <53382213+srodenhuis@users.noreply.github.com> Date: Thu, 7 Nov 2024 21:34:15 +0100 Subject: [PATCH] fix: naming (#89) --- docs/akamai-app-platform/introduction.md | 6 ++--- docs/apps/overview.md | 3 +-- docs/for-ops/how-to/manage-age.md | 2 +- .../installation/akamai-connected-cloud.md | 26 +++++++++---------- docs/get-started/installation/linode.md | 8 +++--- docs/get-started/installation/overview.md | 8 +++--- .../installation/post-install-steps.md | 4 +-- docs/get-started/labs/labs-overview.md | 4 +-- docs/get-started/overview.md | 12 ++++----- sidebar-docs.js | 2 +- 10 files changed, 37 insertions(+), 38 deletions(-) diff --git a/docs/akamai-app-platform/introduction.md b/docs/akamai-app-platform/introduction.md index 977bfc574..6ad06b6c9 100644 --- a/docs/akamai-app-platform/introduction.md +++ b/docs/akamai-app-platform/introduction.md @@ -4,10 +4,10 @@ title: Introduction sidebar_label: Introduction --- -## Akamai Application Platform +## Akamai App Platform -Akamai Application 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. +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 Application 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 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/). diff --git a/docs/apps/overview.md b/docs/apps/overview.md index 87cb9e165..d9529fb66 100644 --- a/docs/apps/overview.md +++ b/docs/apps/overview.md @@ -4,11 +4,10 @@ title: Apps Overview sidebar_label: Apps Overview --- -## Application Platform for Linode Kubernetes Engine (LKE) integrated Applications +## App Platform for Linode Kubernetes Engine (LKE) integrated Applications Enable all the Kubernetes Applications you need with just one click! - ![integrated-apps](../img/integrated-apps.png) --- diff --git a/docs/for-ops/how-to/manage-age.md b/docs/for-ops/how-to/manage-age.md index 8470635d2..4ef9453bf 100644 --- a/docs/for-ops/how-to/manage-age.md +++ b/docs/for-ops/how-to/manage-age.md @@ -128,7 +128,7 @@ Please make sure to store the `SOPS_AGE_KEY` in a secure place. This key can be obtained from the `otomi-sops-secrets` secret in the `otomi-pipelines` namespace or from the `otomi-api` secret in the `otomi` namespace. ::: -To configure Age public and private keys, add or update the following `kms` section in the values.yaml file when installing the Application Platform. +To configure Age public and private keys, add or update the following `kms` section in the values.yaml file when installing the App Platform. ```yaml kms: diff --git a/docs/get-started/installation/akamai-connected-cloud.md b/docs/get-started/installation/akamai-connected-cloud.md index d6a0811e4..527226341 100644 --- a/docs/get-started/installation/akamai-connected-cloud.md +++ b/docs/get-started/installation/akamai-connected-cloud.md @@ -4,7 +4,7 @@ title: Akamai Connected Cloud sidebar_label: Akamai Connected Cloud --- -# Get started with the Application Platform for LKE +# Get started with the App Platform for LKE ## Create a Kubernetes cluster with the App Platform for LKE @@ -20,16 +20,16 @@ sidebar_label: Akamai Connected Cloud - From the Version dropdown menu, select a Kubernetes version to deploy to your cluster. -4. In the Application Platform for LKE section, select “Yes, enable Application Platform for LKE” +4. In the App Platform for LKE section, select “Yes, enable App Platform for LKE” :::note -The Application Platform for LKE requires HA control plane to be enabled. When Application Platform for LKE is enabled, HA control plane will automatically be enabled. +The App Platform for LKE requires HA control plane to be enabled. When App Platform for LKE is enabled, HA control plane will automatically be enabled. ::: 5. In the Add Node Pools section, select the hardware resources for the Linode worker node(s) that make up your LKE cluster. To the right of each plan, select the plus + and minus - to add or remove a Linode to a node pool one at time. :::note -The Application Platform for LKE requires a node pool with at least **3 worker** nodes with a minimum of **16 GB memory** and **4 CPUs** per node. Make sure to select the required Linode plan. +The App Platform for LKE requires a node pool with at least **3 worker** nodes with a minimum of **16 GB memory** and **4 CPUs** per node. Make sure to select the required Linode plan. ::: :::note @@ -40,9 +40,9 @@ The App Platform for LKE is not supported in combination with Shared CPU. 7. Once a pool has been added to your configuration, it is listed in the Cluster Summary on the right-hand side of Cloud Manager detailing your cluster's hardware resources and monthly cost. Additional pools can be added before finalizing the cluster creation process by repeating the previous step for each additional pool. -8. When you are satisfied with the configuration of your cluster, click the Create Cluster button on the right hand side of the screen. Your cluster's detail page appears, and your Node Pools are listed on this page. First the LKE cluster will be created and once ready the Application Platform for LKE will be installed. The installation of the Application Platform for LKE takes around 10 until 15 minutes. When the installation is finished, the URL of the Portal Endpoint will appear in the Application Platform for LKE section. The progress of the installation will be checked every 60 seconds. When the installation is still in progress, the URL of the Portal Endpoint will not be displayed. Instead the message “Installation in progress” will appear. +8. When you are satisfied with the configuration of your cluster, click the Create Cluster button on the right hand side of the screen. Your cluster's detail page appears, and your Node Pools are listed on this page. First the LKE cluster will be created and once ready the App Platform for LKE will be installed. The installation of the App Platform for LKE takes around 10 until 15 minutes. When the installation is finished, the URL of the Portal Endpoint will appear in the App Platform for LKE section. The progress of the installation will be checked every 60 seconds. When the installation is still in progress, the URL of the Portal Endpoint will not be displayed. Instead the message “Installation in progress” will appear. -9. When the installation of both the LKE cluster and the Application Platform is ready, click on the provided URL of the Portal Endpoint: +9. When the installation of both the LKE cluster and the App Platform is ready, click on the provided URL of the Portal Endpoint: ![details-page](../../img/cluster-details-page.png) @@ -84,9 +84,9 @@ kubectl get secret platform-admin-initial-credentials -n keycloak --template={{. 5. Change the initial password -## Provision Object Storage for the Application Platform +## Provision Object Storage for the App Platform -When signed in to the Console (the web UI of the Application Platform), the first thing you’ll need to do is configure Object Storage. A wizard will be displayed asking you if the Application Platform should provision all the required Buckets and access key for you. This is not required, but strongly recommended as this will prevent `out of disk space errors` when using Storage Volumes for integrated applications. Using Object Storage also has the advantage to create backups of all databases used by the platform. +When signed in to the Console (the web UI of the App Platform), the first thing you’ll need to do is configure Object Storage. A wizard will be displayed asking you if the App Platform should provision all the required Buckets and access key for you. This is not required, but strongly recommended as this will prevent `out of disk space errors` when using Storage Volumes for integrated applications. Using Object Storage also has the advantage to create backups of all databases used by the platform. 1. When asked to create all the required Buckets and access key, click Yes. If you don’t want the platform to create all the required buckets, then click Skip. Note that in this case some features like creating backups of databases will not be available. You can start the Wizard at any time in the Console (Platform View: Maintenance, Show Object Storage Wizard). @@ -99,15 +99,15 @@ All the required Buckets and Access Key will now be created in your account and ## Onboard Teams and Users You can now start enabling Applications, onboarding [Teams](../../for-ops/console/teams) and create [Users](../../for-ops/console/user-management). -We recommend to go through the [Hands-on Labs](../labs/overview) to learn how to take advantage of the Application Platform for LKE. +We recommend to go through the [Hands-on Labs](../labs/overview) to learn how to take advantage of the App Platform for LKE. ## Known issues -If the URL of the Portal Endpoint does not appear in the Application Platform for LKE section after 30 minutes, then the following may be the issue: +If the URL of the Portal Endpoint does not appear in the App Platform for LKE section after 30 minutes, then the following may be the issue: ### Installation gets stuck because of a quota exceeded exception -Next to the resources required for LKE, the Application Platform also uses a NodeBalancer and a minimum of 11 Storage Volumes. This might result in a quota exceeding exception. Linode currently does not provide quota limits in your account details at this time. +Next to the resources required for LKE, the App Platform also uses a NodeBalancer and a minimum of 11 Storage Volumes. This might result in a quota exceeding exception. Linode currently does not provide quota limits in your account details at this time. The following issue might be related to quota exceeding exception: @@ -122,7 +122,7 @@ Resolution: - If you would like to know your account's limits or want to increase the number of entities you can create, the best way is to get that information through a support ticket. ### The Let’s Encrypt secret request was not successful -For each cluster with the Application Platform for LKE enabled, a Let’s Encrypt certificate will be requested. If the certificate is not ready within 30 minutes, the installation of the Application Platform will fail. Run the following command to see if the certificate is created: +For each cluster with the App Platform for LKE enabled, a Let’s Encrypt certificate will be requested. If the certificate is not ready within 30 minutes, the installation of the App Platform will fail. Run the following command to see if the certificate is created: ```bash kubectl get secret -n istio-system @@ -134,4 +134,4 @@ If this secret is not present, then the request failed. Resolution: -- Delete the LKE cluster with Application Platform for LKE enabled and create a new cluster with Application Platform for LKE enabled +- Delete the LKE cluster with App Platform for LKE enabled and create a new cluster with App Platform for LKE enabled diff --git a/docs/get-started/installation/linode.md b/docs/get-started/installation/linode.md index 3c07882fc..deca15957 100644 --- a/docs/get-started/installation/linode.md +++ b/docs/get-started/installation/linode.md @@ -4,9 +4,9 @@ title: Linode sidebar_label: Linode Kubernetes Engine --- -# Install Akamai Application Platform on LKE with DNS +# Install Akamai App Platform on LKE with DNS -Provision a LKE cluster in Cloud Manager or by using the Linode CLI and manually install the Application Platform onto it by using a Linode Domain for DNS. +Provision a LKE cluster in Cloud Manager or by using the Linode CLI and manually install the App Platform onto it by using a Linode Domain for DNS. ## Prerequisites @@ -130,7 +130,7 @@ Adjust the `domainSuffix`, `domainFilters` and `email`! You can also use a different DNS provider. See [here](dns.md) for examples on how to use Akamai EdgeDNS, AWS Route53, Cloudflare DNS and many others. ::: -## Install the Application Platform +## Install the App Platform Install using Helm: @@ -151,7 +151,7 @@ When the installer is finished, copy the `url` and `admin-password` from the con Follow the post installation steps [here](post-install-steps.md). :::tip -Like to learn how to use Application Platform for LKE? Go through the [Get Started labs](../labs/labs-overview.md) +Like to learn how to use App Platform for LKE? Go through the [Get Started labs](../labs/labs-overview.md) ::: ## Known issues diff --git a/docs/get-started/installation/overview.md b/docs/get-started/installation/overview.md index 708a1693d..2ca547ca6 100644 --- a/docs/get-started/installation/overview.md +++ b/docs/get-started/installation/overview.md @@ -4,18 +4,18 @@ title: Installation sidebar_label: Overview --- -**How to get Akamai Application Platform up and running** +**How to get Akamai App Platform up and running** --- ### [Akamai Connected Cloud](akamai-connected-cloud.md) -Provision LKE with the Application Platform in Akamai Connected Cloud. +Provision LKE with the App Platform in Akamai Connected Cloud. ### [Linode Kubernetes Engine (LKE)](linode.md) -Create a LKE cluster and manually install the Application Platform. +Create a LKE cluster and manually install the App Platform. ### [Custom](custom.md) -Install the Application Platform on any other conformant Kubernetes cluster. +Install the App Platform on any other conformant Kubernetes cluster. --- diff --git a/docs/get-started/installation/post-install-steps.md b/docs/get-started/installation/post-install-steps.md index ece4bece5..049b8831f 100644 --- a/docs/get-started/installation/post-install-steps.md +++ b/docs/get-started/installation/post-install-steps.md @@ -21,7 +21,7 @@ At the end of the logs you should see the following message: ```bash ######################################################################################################################################## # -# The Application Platform console is available at https://console.${domainSuffix} +# The App Platform console is available at https://console.${domainSuffix} # # Obtain login credentials by using the below commands: # kubectl get secret platform-admin-initial-credentials -n keycloak -o jsonpath='{.data.username}' | base64 -d @@ -139,7 +139,7 @@ When Object Storage is configured and an API Token is added, then activate the V ## Step 6 (optional): Activate more Apps -Application Platform for LKE is a composable platform. Activate more Apps based on the required platform capabilities: +App Platform for LKE is a composable platform. Activate more Apps based on the required platform capabilities: | Capability | App | Object storage | | --------------- | ------------------------------------------------------ | -------------- | diff --git a/docs/get-started/labs/labs-overview.md b/docs/get-started/labs/labs-overview.md index 8918a966f..4e192a195 100644 --- a/docs/get-started/labs/labs-overview.md +++ b/docs/get-started/labs/labs-overview.md @@ -4,13 +4,13 @@ title: Labs Overview sidebar_label: Labs Overview --- -Welcome to the Application Platform for LKE labs! If you are going to use the Application Platform for LKE or like to learn Kubernetes, these labs are for you. Step by step we'll guide you in how to build, deploy, secure and observe containerized applications on Kubernetes. The labs cover the most common activities performed by developer- and/or DevOps teams. +Welcome to the App Platform for LKE labs! If you are going to use the App Platform for LKE or like to learn Kubernetes, these labs are for you. Step by step we'll guide you in how to build, deploy, secure and observe containerized applications on Kubernetes. The labs cover the most common activities performed by developer- and/or DevOps teams. --- **Make sure everything is ready to get started** -### [Provision a LKE Kubernetes cluster and install the Application Platform](get-started/installation/linode.md) +### [Provision a LKE Kubernetes cluster and install the App Platform](get-started/installation/linode.md) ### [Lab prerequisites](labs-prerequisites.md) diff --git a/docs/get-started/overview.md b/docs/get-started/overview.md index 4efd9fdec..33d36561f 100644 --- a/docs/get-started/overview.md +++ b/docs/get-started/overview.md @@ -4,15 +4,15 @@ title: Overview sidebar_label: Overview --- -**How to get started with Akamai Application Platform** +**How to get started with Akamai App Platform** --- -### Step 1: [Install the Application Platform](installation/overview.md) -Install the Application Platform on Linode Kubernetes Engine (LKE) or any other conformant Kubernetes cluster. +### Step 1: [Install the App Platform](installation/overview.md) +Install the App Platform on Linode Kubernetes Engine (LKE) or any other conformant Kubernetes cluster. ### Step 2: [Follow the post installation steps ](installation/post-install-steps.md) -Configure the Application Platform for usage. +Configure the App Platform for usage. -### Step 3: [Explore the Application Platform using the Labs](labs/labs-overview.md) -Explore the Application Platform with a comprehensive set of hands-on labs. \ No newline at end of file +### Step 3: [Explore the App Platform using the Labs](labs/labs-overview.md) +Explore the App Platform with a comprehensive set of hands-on labs. \ No newline at end of file diff --git a/sidebar-docs.js b/sidebar-docs.js index 5edee8aa9..9e12e38d7 100644 --- a/sidebar-docs.js +++ b/sidebar-docs.js @@ -1,6 +1,6 @@ module.exports = { mainSidebar: { - "Akamai Application Platform": [ + "Akamai App Platform": [ "akamai-app-platform/introduction", ], "Getting Started": [