Skip to content

Commit 26f2c9a

Browse files
authored
fix: remove install instructions in README (#1771)
1 parent 92cc4fc commit 26f2c9a

File tree

1 file changed

+57
-49
lines changed

1 file changed

+57
-49
lines changed

README.md

+57-49
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="https://github.com/linode/manager/blob/develop/packages/manager/src/assets/logo/akamai-logo-color.svg" width="200" />
33
<br />
44
<br />
5-
Application Platform for Linode Kubernetes Engine
5+
Akamai Application Platform (for LKE)
66
</h3>
77

88
<p align="center">
@@ -20,73 +20,81 @@
2020

2121
## Getting started
2222

23-
### Helm
23+
### Step 1: [Install the Application Platform](https://apl-docs.net/docs/get-started/installation/overview)
24+
Install the Application Platform on Linode Kubernetes Engine (LKE) or any other conformant Kubernetes cluster.
2425

25-
To install Application Platform for LKE, make sure to have a Kubernetes cluster running with at least:
26+
### Step 2: [Follow the post installation steps ](https://apl-docs.net/docs/get-started/installation/post-installation-steps)
27+
Configure the Application Platform for your use case.
2628

27-
- Version `1.28`, `1.29` or `1.30`
28-
- A node pool with **8 vCPU** and **24GB RAM**
29-
- Calico CNI installed (or any other CNI that supports K8s network policies)
30-
- A default storage class configured
31-
- When using the `custom` provider, make sure the K8s LoadBalancer Service created by APL can obtain an external IP (using a cloud load balancer or MetalLB)
29+
### Step 3: [Explore the Application Platform using the Labs](https://apl-docs.net/docs/get-started/labs/overview)
30+
Explore the Application Platform with a comprehensive set of hands-on labs.
3231

33-
> [TIP]
34-
> Install APL with DNS to unlock it's full potential. Check [here](https://apl-docs.net/docs/get-started/installation/dns) for more information.
32+
## Akamai Application Platform supports
3533

36-
Add the Helm repository:
34+
**Developers** - With easy self-service.
3735

38-
```bash
39-
helm repo add apl https://linode.github.io/apl-core/
40-
helm repo update
41-
```
36+
- Build OCI compliant images from source code.
37+
- Deploy containerized workloads the GitOps way using the provided quickstarts or BYO golden path templates.
38+
- Automatically update container images of workloads.
39+
- Publicly expose applications.
40+
- Get instant access to logs, metrics and traces.
41+
- Store images in a private registry.
42+
- Configure network policies, response headers and CNAMEs.
43+
- Check applications against a comprehensive set of built-in security policies.
44+
- Create and manage secrets.
45+
- Create private Git repositories and use the built-in CI/CD pipelines.
4246

43-
and then install the Helm chart:
47+
**Platform Administrators** - With all the required platform capabilities when using Kubernetes.
4448

45-
```bash
46-
helm install apl apl/apl \
47-
--set cluster.name=$CLUSTERNAME \
48-
--set cluster.provider=$PROVIDER # use 'linode' for LKE or 'custom' for any other cloud/infrastructure
49-
```
50-
51-
When the installer job is completed, follow the [post installation steps](https://apl-docs.net/docs/get-started/installation/post-installation-steps).
49+
- Get all the required capabilities in a pre-configured, integrated and automated way.
50+
- Onboard development Teams in a comprehensive multi-tenant setup and make them self-serving.
51+
- Manage users.
52+
- Ensure governance with security policies.
53+
- Implement zero-trust networking.
54+
- Change the desired state of the platform based on Configuration-as-Code.
55+
- Support multi- and hybrid cloud PaaS.
56+
- Prevent cloud provider lock-in.
57+
- Implement full observability.
58+
- Comply with Disaster Recovery requirements.
5259

5360
## Integrations
5461

5562
**Core Applications**
5663

5764
Get instant access to the following pre-configured Kubernetes Apps:
5865

59-
- [Istio](https://github.com/istio/istio): The service mesh framework with end-to-end transit encryption
60-
- [Argo CD](https://github.com/argoproj/argo-cd): Declarative Continuous Deployment
61-
- [Keycloak](https://github.com/keycloak/keycloak): Identity and access management for modern applications and services
62-
- [Cert Manager](https://github.com/cert-manager/cert-manager) - Bring your own wildcard certificate or request one from Let's Encrypt
63-
- [Nginx Ingress Controller](https://github.com/kubernetes/ingress-nginx): Ingress controller for Kubernetes
64-
- [External DNS](https://github.com/kubernetes-sigs/external-dns): Synchronize exposed ingresses with DNS providers
65-
- [Tekton Pipeline](https://github.com/tektoncd/pipeline): K8s-style resources for declaring CI/CD pipelines
66-
- [Tekton Triggers](https://github.com/tektoncd/triggers): Trigger pipelines from event payloads
67-
- [Tekton dashboard](https://github.com/tektoncd/dashboard): Web-based UI for Tekton Pipelines and Tekton Triggers
68-
- [Gitea](https://github.com/go-gitea/gitea): Self-hosted Git service
69-
- [Cloudnative-pg](https://github.com/cloudnative-pg/cloudnative-pg): Open source operator designed to manage PostgreSQL workloads
70-
- [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets): Encrypt your Secret into a SealedSecret, which is safe to store - even inside a public repository
66+
- [Istio](https://github.com/istio/istio): The service mesh framework with end-to-end transit encryption.
67+
- [Argo CD](https://github.com/argoproj/argo-cd): Declarative Continuous Deployment.
68+
- [Keycloak](https://github.com/keycloak/keycloak): Identity and access management for modern applications and services.
69+
- [Cert-manager](https://github.com/cert-manager/cert-manager) - Bring your own wildcard certificate or request one from Let's Encrypt.
70+
- [Nginx Ingress Controller](https://github.com/kubernetes/ingress-nginx): Ingress controller for Kubernetes.
71+
- [ExternalDNS](https://github.com/kubernetes-sigs/external-dns): Synchronize exposed ingresses with DNS providers.
72+
- [Tekton Pipeline](https://github.com/tektoncd/pipeline): K8s-style resources for declaring CI/CD pipelines.
73+
- [Tekton Triggers](https://github.com/tektoncd/triggers): Trigger pipelines from event payloads.
74+
- [Tekton Dashboard](https://github.com/tektoncd/dashboard): Web-based UI for Tekton Pipelines and Tekton Triggers.
75+
- [Gitea](https://github.com/go-gitea/gitea): Self-hosted Git service.
76+
- [Cloudnative-pg](https://github.com/cloudnative-pg/cloudnative-pg): Open source operator designed to manage PostgreSQL workloads.
77+
- [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets): Encrypt your Secret into a SealedSecret and store secrets in a Git repository.
7178

7279
**Optional Applications**
7380

7481
One-click activation of the following Kubernetes Apps:
7582

76-
- [Velero](https://github.com/vmware-tanzu/velero): Back up and restore your Kubernetes cluster resources and persistent volumes
77-
- [Knative](https://github.com/knative/serving): Deploy and manage serverless workloads
78-
- [Prometheus](https://github.com/prometheus/prometheus): Collecting container application metrics
79-
- [Grafana](https://github.com/grafana/grafana): Visualize metrics, logs, and traces from multiple sources
80-
- [Grafana Loki](https://github.com/grafana/loki): Collecting container application logs
81-
- [Harbor](https://github.com/goharbor/harbor): Container image registry with role-based access control and image scanning
82-
- [Kyverno](https://github.com/kyverno/kyverno): Kubernetes native policy management
83-
- [Jaeger](https://github.com/jaegertracing/jaeger): End-to-end distributed tracing and monitor for complex distributed systems
84-
- [Kiali](https://github.com/kiali/kiali): Observe Istio service mesh relations and connections
85-
- [Minio](https://github.com/minio/minio): High performance Object Storage compatible with Amazon S3 cloud storage service
86-
- [Trivy](https://github.com/aquasecurity/trivy-operator): Kubernetes-native security toolkit
87-
- [Falco](https://github.com/falcosecurity/falco): Cloud Native Runtime Security
88-
- [Grafana Tempo](https://github.com/grafana/tempo): High-scale distributed tracing backend
89-
- [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-operator): Instrument, generate, collect, and export telemetry data to help you analyze your software’s performance and behavior
83+
- [Velero](https://github.com/vmware-tanzu/velero): Back up and restore your Kubernetes cluster resources and persistent volumes.
84+
- [Knative](https://github.com/knative/serving): Deploy and manage serverless workloads.
85+
- [Prometheus](https://github.com/prometheus/prometheus): Collecting container application metrics.
86+
- [Alertmanager](https://github.com/prometheus/alertmanager): Handle alerts send by Prometheus.
87+
- [Grafana](https://github.com/grafana/grafana): Visualize metrics, logs, and traces from multiple sources.
88+
- [Grafana Loki](https://github.com/grafana/loki): Collecting container logs.
89+
- [Harbor](https://github.com/goharbor/harbor): Container image registry with role-based access control and image scanning.
90+
- [Kyverno](https://github.com/kyverno/kyverno): Kubernetes native policy management.
91+
- [Jaeger](https://github.com/jaegertracing/jaeger): End-to-end distributed tracing and monitor for complex distributed systems.
92+
- [Kiali](https://github.com/kiali/kiali): Observe Istio service mesh relations and connections.
93+
- [Minio](https://github.com/minio/minio): High performance Object Storage compatible with Amazon S3 cloud storage service.
94+
- [Trivy Operator](https://github.com/aquasecurity/trivy-operator): Kubernetes-native security toolkit.
95+
- [Falco](https://github.com/falcosecurity/falco): Cloud Native Runtime Security.
96+
- [Grafana Tempo](https://github.com/grafana/tempo): High-scale distributed tracing backend.
97+
- [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-operator): Instrument, generate, collect, and export telemetry data to help you analyze your software’s performance and behavior.
9098

9199
## Documentation
92100

0 commit comments

Comments
 (0)