Skip to content

Commit fb16dcb

Browse files
fix: apl readme rebranding (#1642)
Co-authored-by: Jehoszafat Zimnowoda <[email protected]>
1 parent c1d9134 commit fb16dcb

File tree

2 files changed

+25
-86
lines changed

2 files changed

+25
-86
lines changed

README.md

+25-86
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,61 @@
1-
<h1 align="center">
2-
<img src="https://otomi.io/img/otomi-logo.svg" width="224px"/><br/>
3-
Self-hosted Application Platform for Kubernetes
4-
</h1>
5-
6-
<h3 align="center">Announcement 👇👇
7-
<br></br>
8-
Otomi has been acquired by <a href="https://www.linode.com/otomi/">Akamai</a>. We believe that with Akamai’s support and resources, we can create an even more powerful Kubernetes application platform. More details will follow later this year.
9-
<br></br>
1+
<h3 align="center">
2+
<img src="https://github.com/linode/manager/blob/develop/packages/manager/src/assets/logo/akamai-logo-color.svg" width="200" />
3+
<br />
4+
<br />
5+
Application Platform for Linode Kubernetes Engine
106
</h3>
117

128
<p align="center">
139
<a href="https://github.com/linode/apl-core/releases/"><img alt="Releases" src="https://img.shields.io/github/release-date/linode/apl-core?label=latest%20release" /></a>
1410
<a href="https://img.shields.io/github//linode/apl-core/actions/workflows/main.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/linode/apl-core/main.yml" /></a>
1511
<a href="https://img.shields.io/github/last-commit/linode/apl-core"><img alt="Last commit" src="https://img.shields.io/github/last-commit/linode/apl-core" /></a>
1612
<a href="https://img.shields.io/crates/l/ap"><img alt="License" src="https://img.shields.io/crates/l/ap" /></a>
13+
</p>
14+
<p align="center">
1715
<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>
1816
<a href="http://otomi.io/"><img src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg" alt="Website otomi.io"></a>
1917
<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>
2018
</p>
2119

22-
<p align="center"><img src="https://github.com/linode/apl-core/blob/main/docs/img/otomi-console.png/?raw=true" width="100%" align="center" alt="Otomi integrated applications"></p>
23-
24-
<h4 align="center">
25-
Otomi turns any Kubernetes cluster into an Application Platform to provide paved roads from code to production
26-
</h4>
20+
<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>
2721

2822
## Getting started
2923

3024
### Helm
3125

32-
To install Otomi, make sure to have a K8s cluster running with at least:
26+
To install APL, make sure to have a Kubernetes cluster running with at least:
3327

3428
- Version `1.27`, `1.28` or `1.29`
3529
- A node pool with at least **8 vCPU** and **16GB+ RAM** (more resources might be required based on the activated capabilities)
3630
- Calico CNI installed (or any other CNI that supports K8s network policies)
3731
- A default storage class configured
38-
- When using the `custom` provider, make sure the K8s LoadBalancer Service created by `Otomi` can obtain an external IP (using a cloud load balancer or MetalLB)
32+
- 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)
33+
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://otomi.io) for more info.
3939
40-
> **_NOTE:_** Install Otomi with DNS to unlock it's full potential. Check [otomi.io](https://otomi.io) for more info.
4140

4241
Add the Helm repository:
4342

4443
```bash
45-
helm repo add otomi https://otomi.io/apl-core
44+
helm repo add apl https://linode.github.io/apl-core/
4645
helm repo update
4746
```
4847

4948
and then install the Helm chart:
5049

5150
```bash
52-
helm install otomi otomi/otomi \
51+
helm install apl apl/otomi \
5352
--set cluster.name=$CLUSTERNAME \
54-
--set cluster.provider=$PROVIDER # use 'azure', 'aws', 'google', 'digitalocean', 'ovh', 'vultr', 'scaleway', 'civo', 'linode', or 'custom' for any other cloud or onprem infrastructure
53+
--set cluster.provider=$PROVIDER # use 'linode' for LKE or 'custom' for any other cloud/infrastructure
5554
```
5655

5756
When the installer job is completed, follow the [activation steps](https://otomi.io/docs/get-started/activation).
5857

59-
## Platform architecture
60-
61-
Otomi consists out of the following components:
62-
63-
### Self-service portal and Cloud Shell
64-
65-
The `otomi-console` self-service portal offers a seamless user experience for DevSecOps teams and platform administrators. Platform administrators can use Otomi Console to enable and configure platform capabilities and onboard development teams. DevOps teams can use Otomi Console to build images, deploy and expose Workloads, configure CNAMEs, configure network policies and manage secrets. Otomi Console also provides context aware access to platform capabilities like code repositories, registries, logs, metrics, traces, dashboards, etc. Next to the web based self-service, both teams and admins can start a Cloud Shell and run CLI commands.
66-
67-
### Platform Control plane
68-
69-
All changes made through the Console are validated by the platform control plane (`otomi-api`) and then committed as code in Git. This will automatically trigger the platform to synchronize the desired state to the Kubernetes state of the platform based on GitOps.
70-
71-
### Pre-filled Catalog
72-
73-
A Catalog with reusable templates to create workloads. The Catalog is pre-filled with a set of templates maintained in the `otomi/charts` repo. You can also add your own charts and offer them to the teams on the platform.
74-
75-
### Automation
76-
77-
The automation (a set of Kubernetes operators) is used to synchronize the desired state to the state of applications like Keycloak, Harbor and Gitea.
78-
79-
### Capabilities
80-
81-
Otomi offers a set of integrated Kubernetes applications (using upstream open source projects) for all the required platform capabilities. Core applications are always installed, optional applications can be activated on-demand. When an application is activated, the application will be installed based on a configuration profile that contains defaults, best-practices and platform integrations. Default configuration can be adjusted using the Console.
58+
## Integrations
8259

8360
**Core Applications (that are always installed):**
8461

@@ -93,8 +70,6 @@ Otomi offers a set of integrated Kubernetes applications (using upstream open so
9370
- [Tekton dashboard](https://github.com/tektoncd/dashboard): Web-based UI for Tekton Pipelines and Tekton Triggers
9471
- [Gitea](https://github.com/go-gitea/gitea): Self-hosted Git service
9572
- [Cloudnative-pg](https://github.com/cloudnative-pg/cloudnative-pg): Open source operator designed to manage PostgreSQL workloads
96-
- [Paketo build packs](https://github.com/paketo-buildpacks): Cloud Native Buildpack implementations for popular programming
97-
- [Kaniko](https://github.com/GoogleContainerTools/kaniko): Build container images from a Dockerfile
9873

9974
**Optional Applications (that you can activate to compose your ideal platform):**
10075

@@ -105,57 +80,21 @@ Otomi offers a set of integrated Kubernetes applications (using upstream open so
10580
- [Grafana](https://github.com/grafana/grafana): Visualize metrics, logs, and traces from multiple sources
10681
- [Grafana Loki](https://github.com/grafana/loki): Collecting container application logs
10782
- [Harbor](https://github.com/goharbor/harbor): Container image registry with role-based access control, image scanning, and image signing
108-
- [OPA/Gatekeeper](https://github.com/open-policy-agent/gatekeeper): Policy-based control for cloud-native environments
83+
- [Kyverno](https://github.com/kyverno/kyverno): Kubernetes native policy management
10984
- [Jaeger](https://github.com/jaegertracing/jaeger): End-to-end distributed tracing and monitor for complex distributed systems
11085
- [Kiali](https://github.com/kiali/kiali): Observe Istio service mesh relations and connections
11186
- [Minio](https://github.com/minio/minio): High performance Object Storage compatible with Amazon S3 cloud storage service
11287
- [Trivy](https://github.com/aquasecurity/trivy-operator): Kubernetes-native security toolkit
11388
- [Falco](https://github.com/falcosecurity/falco): Cloud Native Runtime Security
11489
- [Grafana Tempo](https://github.com/grafana/tempo): High-scale distributed tracing backend
11590
- [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
116-
117-
### Supported providers
118-
119-
Otomi can be installed on any Kubernetes cluster. At this time, the following providers are supported:
120-
121-
- `aws` for [AWS Elastic Kubernetes Service](https://aws.amazon.com/eks/)
122-
- `azure` for [Azure Kubernetes Service](https://azure.microsoft.com/en-us/products/kubernetes-service)
123-
- `google` for [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine?hl=en)
124-
- `linode` for [Linode Kubernetes Engine](https://www.linode.com/products/kubernetes/)
125-
- `ovh` for [OVH Cloud](https://www.ovhcloud.com/en/public-cloud/kubernetes/)
126-
- `vultr` for [Vultr Kubernetes Engine](https://www.vultr.com/kubernetes/)
127-
- `scaleway` for [Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/)
128-
- `civo` for [Civo Cloud K3S](https://www.civo.com/)
129-
- `custom` for any other cloud/infrastructure
130-
131-
## Otomi Projects
132-
133-
Otomi open source consists out of the following projects:
134-
135-
- Otomi Core (this project): The heart of Otomi
136-
- [Otomi Tasks](https://github.com/redkubes/otomi-tasks): Autonomous jobs orchestrated by Otomi Core
137-
- [Otomi Clients](https://github.com/redkubes/otomi-clients): Factory to build and publish openapi clients used in by otomi-tasks
138-
- [Otomi Charts](https://github.com/linode/apl-charts): Quickstart Helm templates offered in the Catalog
91+
- [Paketo build packs](https://github.com/paketo-buildpacks): Cloud Native Buildpack implementations for popular programming
92+
- [Kaniko](https://github.com/GoogleContainerTools/kaniko): Build container images from a Dockerfile
13993

14094
## Documentation
14195

142-
Check out the [dev docs index](./docs/README.md) for developer documentation or go to [otomi.io](https://otomi.io) for more detailed documentation.
143-
144-
## Contribution
145-
146-
If you wish to contribute please read our [Contributor Code of Conduct](https://otomi.io/community/code-of-conduct) and [Contribution Guidelines](https://otomi.io/community/get-involved).
147-
148-
If you want to say **thank you** or/and support the active development of Otomi:
149-
150-
- [Star](https://github.com/linode/apl-core) the Otomi project on Github
151-
- Feel free to write articles about the project on [dev.to](https://dev.to/), [medium](https://medium.com/) or on your personal blog and share your experiences
152-
153-
This project exists thanks to all the people who have contributed
154-
155-
<a href="https://github.com/linode/apl-core/graphs/contributors">
156-
<img src="https://contrib.rocks/image?repo=linode/apl-core" />
157-
</a>
96+
Check out [otomi.io](https://otomi.io) for more detailed documentation.
15897

15998
## License
16099

161-
Otomi is licensed under the [Apache 2.0 License](https://github.com/linode/apl-core/blob/main/LICENSE).
100+
APL is licensed under the [Apache 2.0 License](https://github.com/linode/apl-core/blob/main/LICENSE).

docs/img/apl-console.png

710 KB
Loading

0 commit comments

Comments
 (0)