You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/akamai-app-platform/introduction.md
+3-4Lines changed: 3 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ sidebar_label: Introduction
6
6
7
7
## What is Akamai App Platform
8
8
9
-
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.
9
+
Akamai App Platform is a Kubernetes platform that combines developer-centric and operations-centric tooling along with automation and a self-service portal. This streamlines the application life cycle when using Kubernetes, from development to delivery to the management of containerized application workloads.
10
10
11
-
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.
11
+
The platform connects many of the technologies found in the Cloud Native Computing Foundation (CNCF) landscape in a way that provides direct value. This avoids the need to reinvent the wheel when building and maintaining your own Kubernetes based platform or bespoke stack.
12
12
13
-
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/).
13
+
App Platform is optimized to run on Linode Kubernetes Engine (LKE), but it can also be manually installed on any other [conformant Kubernetes cluster](https://www.cncf.io/training/certification/software-conformance/).
14
14
15
15
The platform includes:
16
16
@@ -83,4 +83,3 @@ The platform includes:
83
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:
Copy file name to clipboardExpand all lines: docs/for-ops/console/settings/backup.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ To create backups, Object Storage needs to be enabled.
11
11
:::
12
12
13
13
:::info
14
-
The Backup in the Settings will NOT be visible when the installation is done by Akamai Connected Cloud.
14
+
The Backup in the Settings will NOT be visible when the installation is done by Akamai Cloud.
15
15
:::
16
16
17
17
The Backup section provides the option to:
@@ -32,16 +32,16 @@ Select to backup the database of the app.
32
32
### Persistent Volume Backups
33
33
34
34
:::info
35
-
The Persistent Volume Backups section will not be visible when the installation is done by Akamai Connected Cloud. This is because using Velero is not (yet) supported for Linode Volumes.
35
+
The Persistent Volume Backups section will not be visible when App Platform is deployed directly through LKE (not manually installed). This is because using Velero is not (yet) supported for Akamai's Block Storage Volumes.
36
36
:::
37
37
38
38
:::note
39
39
To use Velero to create backups of Persistent Volumes, Object Storage needs to be enabled.
40
40
:::
41
41
42
-
To use Velero to create backups of Persistent Volumes in Linode:
42
+
To use Velero to create backups of Persistent Volumes in Akamai:
43
43
44
-
1. Create a Linode API Token in Linode.
44
+
1. Create a Linode API Token in Akamai's Cloud Manager.
Copy file name to clipboardExpand all lines: docs/for-ops/console/settings/ingress.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ sidebar_label: Ingress
5
5
---
6
6
7
7
:::info
8
-
The Ingress section in the Settings will not be visible when the installation is done by Akamai Connected Cloud. In this case you will not be able to create multiple ingress classes.
8
+
The Ingress section in the Settings will not be visible when App Platform is deployed directly through LKE (not manually installed). In this case you will not be able to create multiple ingress classes.
Copy file name to clipboardExpand all lines: docs/for-ops/sre/known-issues.md
+4-6Lines changed: 4 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ sidebar_label: Known Issues
8
8
9
9
### Details
10
10
11
-
When provisioning App Platform for LKE in Akamai Connected Cloud the installation can fail because a quota exceeded exception. If the URL of the Portal Endpoint does not appear in the App Platform for LKE section after 30 minutes, this could be caused by a quota exceeded exception.
11
+
When provisioning App Platform, the installation can fail because a quota exceeded exception. If the URL of the Portal Endpoint does not appear in the **App Platform** section of the cluster's dashboard after 30 minutes, this could be caused by a quota exceeded exception.
12
12
13
-
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.
13
+
Next to the resources required for LKE, 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.
14
14
15
15
The following issue might be related to quota exceeding exception:
16
16
@@ -28,12 +28,11 @@ N.A.
28
28
29
29
- 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.
30
30
31
-
32
31
## The Let’s Encrypt secret request was not successful
33
32
34
33
### Details
35
34
36
-
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:
35
+
For each LKE cluster with App Platform enabled, a Let’s Encrypt certificate will be requested. If the certificate is not ready within 30 minutes, the installation of App Platform will fail. Run the following command to see if the certificate is created:
37
36
38
37
```bash
39
38
kubectl get secret -n istio-system
@@ -49,11 +48,10 @@ N.A.
49
48
50
49
### Resolution
51
50
52
-
- Delete the LKE cluster with App Platform for LKE enabled and create a new cluster with App Platform for LKE enabled.
51
+
- Delete the LKE cluster with App Platform enabled and create a new cluster, making sure to enable the App Platform.
53
52
54
53
## Argo CD does not synchronize anymore
55
54
56
-
57
55
### Details
58
56
59
57
Argo CD may occasionally stop synchronizing without a clear cause. In some instances, errors may appear in the logs, while in others, no errors are logged. This issue results in platform updates being halted.
Copy file name to clipboardExpand all lines: docs/get-started/installation/akamai-connected-cloud.md
+56-35Lines changed: 56 additions & 35 deletions
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,46 @@
1
1
---
2
2
slug: akamai-connected-cloud
3
-
title: Akamai Connected Cloud
4
-
sidebar_label: Akamai Connected Cloud
3
+
title: Deploy Akamai App Platform on LKE
4
+
sidebar_label: LKE (automatic)
5
5
---
6
6
7
-
# Get started with the App Platform for LKE
7
+
# Deploy Akamai App Platform on LKE
8
8
9
-
## Create a Kubernetes cluster with the App Platform for LKE
9
+
## Create a Kubernetes cluster with App Platform enabled
10
10
11
-
1. Log into your Cloud Manager account.
11
+
These instructions provide the basic steps for deploying App Platform on an LKE cluster. For more complete instructions on creating an LKE cluster, see the [Create a cluster](https://techdocs.akamai.com/cloud-computing/docs/create-a-cluster) guide.
12
12
13
-
2. Select Kubernetes from the left navigation menu and then click Create Cluster.
13
+
1. Log in to your Cloud Manager account.
14
14
15
-
3. The Create a Kubernetes Cluster page appears. At the top of the page, you are required to select the following options
15
+
2. Select Kubernetes from the main navigation menu and then click **Create Cluster**.
16
16
17
-
- In the Cluster Label field, provide a name for your cluster. The name must be unique between all of the clusters on your account. This name is how you identify your cluster in Cloud Manager’s Dashboard.
17
+
3. The _Create a Kubernetes Cluster_ page appears. At the top of the page, select the following options
18
18
19
-
-From the Region dropdown menu, select the Region where you would like your cluster to reside.
19
+
-In the **Cluster Label** field, provide a name for your cluster. The name must be unique between all of the clusters on your account. This name is how you identify your cluster in Cloud Manager.
20
20
21
-
- From the Version dropdown menu, select a Kubernetes version to deploy to your cluster.
21
+
- From the **Region** dropdown menu, select the region where you would like your cluster to reside.
22
22
23
-
4. In the App Platform for LKE section, select “Yes, enable App Platform for LKE”
23
+
- From the **Version** dropdown menu, select a Kubernetes version to use on your cluster.
24
+
25
+
4. In the **App Platform** section, select _Yes, enable App Platform for LKE_.
26
+
27
+
:::note
28
+
App Platform requires HA control plane. When you enable the **App Platform** setting, the **HA control plane** setting is automatically enabled.
29
+
:::
30
+
31
+
5. In the **Add Node Pools** section, select the required resources for the worker nodes. To the right of each plan, select the plus + and minus - to add or remove a node to a node pool one at time.
32
+
33
+
:::note
34
+
During the beta period, App Platform requires a node pool with at least **3 worker** nodes with a minimum of **8 GB memory** and **4 CPUs** per node.
35
+
:::
36
+
37
+
:::note
38
+
App Platform is not supported in combination with Shared CPU Linode plans.
39
+
:::
40
+
41
+
6. Select **Add** to include the node pool in your configuration. If you need more hardware resources after you deploy your cluster, you can always [edit your Node Pool](https://techdocs.akamai.com/cloud-computing/docs/manage-nodes-and-node-pools).
42
+
43
+
7. Once a node pool has been added to your configuration, it is listed in the **Cluster Summary** section 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.
24
44
25
45
:::info
26
46
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.
@@ -44,13 +64,13 @@ The App Platform for LKE is not supported in combination with Shared CPU.
44
64
45
65
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.
46
66
47
-
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.
67
+
8. When you are satisfied with the configuration of your cluster, click the **Create Cluster** button. This creates your cluster and displays the cluster's details page in the Cloud Manager. Once the cluster has been fully provisioned, App Platform is installed. **The installation of App Platform takes around 10 to 15 minutes.** When the installation is finished, the URL of the **Portal Endpoint** is displayed in the **App Platform**section. The progress of the installation is checked every 60 seconds. When the installation is still in progress, the message “Installation in progress” is displayed instead of the URL of the Portal Endpoint.
48
68
49
-
9. When the installation of both the LKE cluster and the App Platform is ready, click on the provided URL of the Portal Endpoint:
69
+
9. When the installation of both the LKE cluster and App Platform is complete, click on the provided URL of the Portal Endpoint:
@@ -60,52 +80,53 @@ You will then see the following sign-in page:
60
80
61
81
1. To access your cluster's Kubeconfig, log in to your Cloud Manager account and navigate to the Kubernetes section.
62
82
63
-
2. From the Kubernetes listing page, click on your cluster's more options ellipsis and select Download Kubeconfig. The file is saved to your computer's Downloads folder.
83
+
2. From the Kubernetes listing page, click on your cluster's _more options_ ellipsis and select **Download Kubeconfig**. The file is saved to your computer's downloads folder.
64
84
65
-
3. Open a terminal shell and save your Kubeconfig file's path to the $KUBECONFIG environment variable. In the example command, the Kubeconfig file is located in the Downloads folder, but you should alter this line with this folder's location on your computer:
85
+
3. Open a terminal shell and save your Kubeconfig file's path to the $KUBECONFIG environment variable. In the example command, the Kubeconfig file is located in the **Downloads** folder, but you should alter this line with this folder's location on your computer:
66
86
67
-
```bash
68
-
export KUBECONFIG=~/Downloads/kubeconfig.yaml
69
-
```
87
+
```bash
88
+
export KUBECONFIG=~/Downloads/kubeconfig.yaml
89
+
```
70
90
71
91
## Obtain the initial access credentials and sign in
72
92
73
93
1. Perform the following command to obtain the user name:
74
94
75
-
```bash
76
-
kubectl get secret platform-admin-initial-credentials -n keycloak --template={{.data.username}} | base64 -d
77
-
```
95
+
```bash
96
+
kubectl get secret platform-admin-initial-credentials -n keycloak --template={{.data.username}} | base64 -d
97
+
```
78
98
79
99
2. Perform the following command to obtain the initial password:
80
100
81
-
```bash
82
-
kubectl get secret platform-admin-initial-credentials -n keycloak --template={{.data.password}} | base64 -d
83
-
```
101
+
```bash
102
+
kubectl get secret platform-admin-initial-credentials -n keycloak --template={{.data.password}} | base64 -d
103
+
```
84
104
85
-
3.Copy the username and password to your clipboard.
105
+
3.Navigate back to App Platform Portal login page in your web browser and sign in with these credentials.
86
106
87
-
4.Sign in to the Console with the provided username and initial password.
107
+
4.The first time you log in, you are prompted to change your password. Enter your new password and click **Submit**. If you need to change your password later, see the [Change user passwords](http://localhost:3001/docs/for-ops/how-to/change-user-passwords)and [Change admin password](http://localhost:3001/docs/for-ops/how-to/change-admin-password) guides.
88
108
89
-
5.Change the initial password
109
+
5.After changing your password, you are taken to the main dashboard. The first time you log in, you are prompted to configure Object Storage. See the [Provision Object Storage for the App Platform](#provision-object-storage-for-the-app-platform) section below.
90
110
91
111
## Provision Object Storage for the App Platform
92
112
93
-
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.
113
+
Aftering logging in to the App Platform Portal for the first time, you should configure Object Storage. 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 of creating backups of all databases used by the platform.
94
114
95
-
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 for now. 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).
115
+
1.The **Object Storage Wizard** screen is automatically displayed when logging in for the first time. This walks you through adding an API token so that it can automatically create amd configure all required Object Storage buckets. Click **Yes** to continue with this process. If you don’t want the platform to create all the required buckets, then click **Skip for now**. In this case, some features like creating backups of databases will not be available. You can start the Wizard at any time in the Portal (Platform View: Maintenance, Show Object Storage Wizard).
96
116
97
-
2. Follow the instructions to [create a Personal Access Token](https://techdocs.akamai.com/linode-api/reference/get-started#personal-access-tokens) and make sure to select**Read/Write**for the Object Storage category. Copy the Access Token.
117
+
1. Follow the instructions to [create a Personal Access Token](https://techdocs.akamai.com/linode-api/reference/get-started#personal-access-tokens). The API token only needs**Read/Write**to Object Storage. Once created, save or copy the generated access token.
98
118
99
-
3. Now paste the Access Token into the wizard and select the region where the buckets should be created from the dropdown list.
119
+
1. Paste the API token into the wizard and select the region where the buckets should be created from the dropdown list. This region should match the region you selected when deploying your LKE cluster.
100
120
101
-
4. Click `Submit`.
121
+
1. Click `Submit`.
102
122
103
-
All the required buckets will now be created in your account and the platform will be configured to use Object Storage to store persistent data and backups. The provided Personal Access Token will not be stored. The created buckets will have the `<cluster-id>` prefix`
123
+
All the required buckets are now created and the platform will be configured to use Object Storage to store persistent data and backups. The provided Personal Access Token will not be stored. The created buckets will have the `<cluster-id>` prefix`
104
124
105
125
## Onboard Teams and Users
126
+
106
127
You can now start enabling Applications, onboarding [Teams](../../for-ops/console/teams) and create [Users](../../for-ops/console/user-management).
107
128
108
-
We recommend to go through the [Hands-on Labs](../labs/overview) to learn how to take advantage of the App Platform for LKE.
129
+
We recommend to go through the [Hands-on Labs](../labs/overview) to learn how to take advantage of the Akamai App Platform.
0 commit comments