Skip to content

Commit 086072d

Browse files
authored
fix: v3 readme (#1722)
1 parent f930344 commit 086072d

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
<p align="center">
1515
<a href="https://img.shields.io/badge/contributions-welcome-orange.svg"><img alt="Contributions" src="https://img.shields.io/badge/contributions-welcome-orange.svg" /></a>
1616
<a href="https://apl-docs.net/"><img src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg" alt="Website apl-docs.net"></a>
17-
<a href="https://join.slack.com/t/otomi/shared_invite/zt-1axa4vima-E~LHN36nbLR~ay5r5pGq9A"><img src="https://img.shields.io/badge/slack--channel-blue?logo=slack"></a>
1817
</p>
1918

2019
<p align="center"><img src="https://github.com/linode/apl-core/blob/main/docs/img/apl-console.png/?raw=true" width="100%" align="center" alt="APL Console"></p>
@@ -23,19 +22,16 @@
2322

2423
### Helm
2524

26-
To install APL, make sure to have a Kubernetes cluster running with at least:
25+
To install Application Platform for LKE, make sure to have a Kubernetes cluster running with at least:
2726

2827
- Version `1.28`, `1.29` or `1.30`
29-
- A node pool with at least **8 vCPU** and **16GB+ RAM** (more resources might be required based on the activated capabilities)
28+
- A node pool with **8 vCPU** and **24GB RAM**
3029
- Calico CNI installed (or any other CNI that supports K8s network policies)
3130
- A default storage class configured
3231
- 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)
3332

34-
> [!NOTE]
35-
> The transition from Otomi to APL is still in progress. Installing APL will use the latest Otomi release (v2.11.5).
36-
37-
> [!TIP]
38-
> Install APL with DNS to unlock it's full potential. Check [here](https://apl-docs.net) for more info.
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.
3935
4036
Add the Helm repository:
4137

@@ -47,16 +43,18 @@ helm repo update
4743
and then install the Helm chart:
4844

4945
```bash
50-
helm install apl apl/otomi \
46+
helm install apl apl/apl \
5147
--set cluster.name=$CLUSTERNAME \
5248
--set cluster.provider=$PROVIDER # use 'linode' for LKE or 'custom' for any other cloud/infrastructure
5349
```
5450

55-
When the installer job is completed, follow the [activation steps](https://apl-docs.net/docs/get-started/activation).
51+
When the installer job is completed, follow the [post installation steps](https://apl-docs.net/docs/get-started/installation/post-installation-steps).
5652

5753
## Integrations
5854

59-
**Core Applications (that are always installed):**
55+
**Core Applications**
56+
57+
Get instant access to the following pre-configured Kubernetes Apps:
6058

6159
- [Istio](https://github.com/istio/istio): The service mesh framework with end-to-end transit encryption
6260
- [Argo CD](https://github.com/argoproj/argo-cd): Declarative Continuous Deployment
@@ -69,16 +67,18 @@ When the installer job is completed, follow the [activation steps](https://apl-d
6967
- [Tekton dashboard](https://github.com/tektoncd/dashboard): Web-based UI for Tekton Pipelines and Tekton Triggers
7068
- [Gitea](https://github.com/go-gitea/gitea): Self-hosted Git service
7169
- [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
71+
72+
**Optional Applications**
7273

73-
**Optional Applications (that you can activate to compose your ideal platform):**
74+
One-click activation of the following Kubernetes Apps:
7475

7576
- [Velero](https://github.com/vmware-tanzu/velero): Back up and restore your Kubernetes cluster resources and persistent volumes
7677
- [Knative](https://github.com/knative/serving): Deploy and manage serverless workloads
77-
- [Drone](https://github.com/harness/drone): Continuous integration platform built on Docker
7878
- [Prometheus](https://github.com/prometheus/prometheus): Collecting container application metrics
7979
- [Grafana](https://github.com/grafana/grafana): Visualize metrics, logs, and traces from multiple sources
8080
- [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, image scanning, and image signing
81+
- [Harbor](https://github.com/goharbor/harbor): Container image registry with role-based access control and image scanning
8282
- [Kyverno](https://github.com/kyverno/kyverno): Kubernetes native policy management
8383
- [Jaeger](https://github.com/jaegertracing/jaeger): End-to-end distributed tracing and monitor for complex distributed systems
8484
- [Kiali](https://github.com/kiali/kiali): Observe Istio service mesh relations and connections
@@ -87,8 +87,6 @@ When the installer job is completed, follow the [activation steps](https://apl-d
8787
- [Falco](https://github.com/falcosecurity/falco): Cloud Native Runtime Security
8888
- [Grafana Tempo](https://github.com/grafana/tempo): High-scale distributed tracing backend
8989
- [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
90-
- [Paketo build packs](https://github.com/paketo-buildpacks): Cloud Native Buildpack implementations for popular programming
91-
- [Kaniko](https://github.com/GoogleContainerTools/kaniko): Build container images from a Dockerfile
9290

9391
## Documentation
9492

0 commit comments

Comments
 (0)