Skip to content

Commit

Permalink
feat: app descriptions in core (#881)
Browse files Browse the repository at this point in the history
The otomi-core provides app descriptions to otomi-api and otomi-console via core.yaml file.

Co-authored-by: Maurice Faber <maurice.faber@redkubes.com>
  • Loading branch information
srodenhuis and Maurice Faber committed Aug 22, 2022
1 parent 9f04eb3 commit f72ebd6
Show file tree
Hide file tree
Showing 3 changed files with 252 additions and 21 deletions.
4 changes: 4 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
"ignoreRegExpList": ["/'s\\b/"],
"ignoreWords": [
"adrs",
"KUBECFG",
"CNAME",
"SBOM",
"Venafi",
"adrlog",
"adrlogstop",
"anyuid",
Expand Down
59 changes: 41 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<a href="https://img.shields.io/crates/l/ap"><img alt="License" src="https://img.shields.io/crates/l/ap" /></a>
<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>
<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>
<a href="https://join.slack.com/t/otomi/shared_invite/zt-1axa4vima-E~LHN36nbLR~ay5r5pGq9A"><img src="https://img.shields.io/static/v1?label=Slack&message=Join&color=4A154B" alt="Join Slack channel"></a>
<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>
<a href="https://twitter.com/RedKubes"><img src="https://img.shields.io/static/v1?label=Twitter&message=Follow&color=1DA1F2" alt="Follow us on Twitter"></a>
<a href="https://www.facebook.com/groups/otomiusers"><img src="https://img.shields.io/static/v1?label=Facebook&message=Join group&color=1877F2" alt="Join Facebook group"></a>
<a href="https://www.youtube.com/channel/UCarOB4QW6lTqKG17XUT2uaA"><img alt="YouTube Channel Subscribers" src="https://img.shields.io/youtube/channel/subscribers/UCarOB4QW6lTqKG17XUT2uaA?style=social"></a>
Expand All @@ -25,9 +25,30 @@

## About Otomi

**Otomi** is an open source self-hosted DevOps platform for Kubernetes and offers an integrated stack of pre-configured Kubernetes applications combined with (developer) self-service and automation. Otomi can be installed in one run on any Kubernetes cluster, offering a complete DevOps platform experience out-of-the-box. No more reinventing the wheel when building and maintaining your own K8s based DevOps platform.
**Otomi** is a complete stack of integrated Kubernetes applications, combined with automation and self-service. Otomi can be installed with one command on any Kubernetes cluster, offering a complete platform experience out-of-the-box. No more re-inventing the wheel when building and maintaining your own Kubernetes based platform.

## Otomi helps

1 . **Developers** - To focus on their apps only
* Deploy containerized apps with a few click without writing any K8s YAML manifests
* Get access to logs and metrics of deployed apps
* Store charts and images in a private registry
* Build and run custom CI pipelines
* Enable declarative end-to-end app lifecycle management
* Configure ingress for apps with a single click
* Manage your own secrets

2. **Platform & Operations teams** - To setup and manage production-ready Kubernetes-based platforms
* Onboard development teams on shared clusters in a comprehensive multi-tenant setup
* Get all the required observability tools in an integrated way
* Ensure governance with security policies
* Implement zero-trust networking with east-west and north-south network controll within K8s
* Provide self-service features to development teams
* Change the desired state of the platform based on configuration-as-code

3. **DevOps teams** - To take full controll and responsibility over the complete stack
* Get all the tools needed to build, deploy and run apps on K8s

![Otomi features](https://github.com/redkubes/otomi-core/blob/main/docs/img/otomi-features.gif)

## Getting started

Expand All @@ -53,7 +74,7 @@ and then install the Helm chart:
helm install otomi otomi/otomi \
--set cluster.k8sVersion=$VERSION \ # 1.19, 1.20, 1.21, 1.22 and 1.23 are supported
--set cluster.name=$CLUSTERNAME \
--set cluster.provider=$PROVIDER # use azure, aws, google, digitalocean or custom for any other cloud or onprem K8s
--set cluster.provider=$PROVIDER # use 'azure', 'aws', 'google', 'digitalocean', 'ovh', 'vultr', or 'custom' for any other cloud or onprem K8s
```

When the installer job is completed, follow the [activation steps](https://otomi.io/docs/installation/activation/).
Expand All @@ -64,25 +85,27 @@ Use the [quickstarts](https://github.com/redkubes/quickstart) for Azure, GCP, AW

### Workshops

In our [workshops](https://github.com/redkubes/workshops) repository, we have prepared a comprehensive set of hands-on labs to get a good understanding/overview of everything Otomi has to offer.
Use the [workshops](https://github.com/redkubes/workshops) repository, to go trough a comprehensive set of hands-on labs to get a good understanding/overview of everything Otomi has to offer.

## Otomi Features

- [x] Drag and drop apps to create your own preferred suite
![Otomi features](https://github.com/redkubes/otomi-core/blob/main/docs/img/otomi-features.gif)

- [x] Activate more apps to create your own preferred suite
- [x] GitOps with Argo CD out-of-the-box
- [x] Container image scanning
- [x] Advanced ingress architecture
- [x] Generate validated configuration code with an easy to use web UI
- [x] Advanced ingress architecture with self-service
- [x] Configuration validation
- [x] Configure network policies for internal ingress and external egress
- [x] Deploy Knative serverless workloads without writing any YAML
- [x] Deploy workloads without writing any YAML
- [x] Create and manage secrets in HashiCorp Vault and use them in your workloads
- [x] Create Kubernetes Jobs and Cron Jobs without writing any YAML
- [x] Role-based access to all integrated applications based on group membership
- [x] Role-based access to all integrated applications
- [x] Enforce Pod security policies
- [x] Onboard teams within minutes in a comprehensive multi-tenant setup
- [x] Benefit from predefined automation tasks
- [x] Bring your favorite IdP, DNS and/or CA
- [x] Expose services on private or (multiple) public networks
- [x] Comprehensive multi-tenant setup
- [x] Predefined automation tasks
- [x] SOPS/KMS for encryption of sensitive configuration values
- [x] BYO IdP, DNS and/or CA

And much more...

Expand Down Expand Up @@ -133,15 +156,15 @@ If you wish to contribute please read our [Contributor Code of Conduct](https://

If you want to say **thank you** or/and support the active development of Otomi:

- Add a [GitHub Star](https://github.com/redkubes/otomi-core) to the project
- Feel free to write articles about the project on [dev.to](https://dev.to/), [medium](https://medium.com/) or on your personal blog as we are curious to see how you use `Otomi`
- [Star](https://github.com/redkubes/otomi-core) the Otomi project on Github
- 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

This project exists thanks to all the people who contribute and have contributed.
This project exists thanks to all the people who have contributed

<a href="https://github.com/redkubes/otomi-core/graphs/contributors">
<img src="https://contrib.rocks/image?repo=redkubes/otomi-core" />
</a>

## License

Otomi is free and open-source software licensed under the [Apache 2.0 License](https://github.com/redkubes/otomi-core/blob/main/LICENSE).
Otomi is licensed under the [Apache 2.0 License](https://github.com/redkubes/otomi-core/blob/main/LICENSE).

0 comments on commit f72ebd6

Please sign in to comment.