Skip to content

Commit

Permalink
feat(docs): improve docs with examples (#31)
Browse files Browse the repository at this point in the history
- Add overview image to improve understanding on how garm-operator
fits into garm landscape
- provide examples for better understanding on how to use / interact
with operator

---------

Co-authored-by: Mario Constanti <github@constanti.de>
  • Loading branch information
rafalgalaw and bavarianbidi authored Dec 5, 2023
1 parent 573272d commit 036999a
Show file tree
Hide file tree
Showing 6 changed files with 3,223 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@

`garm-operator` is a [Kubernetes®](https://kubernetes.io) operator that manages the lifecycle of [garm](https://github.com/cloudbase/garm) objects by creating/updating/deleting corresponding objects in the Kubernetes cluster.

![garm components overview](docs/assets/overview.png "Architecture Overview")

## 🔀 Versioning

### Garm Version
Expand Down Expand Up @@ -102,4 +104,4 @@ Please visit <https://www.mercedes-benz-techinnovation.com/en/imprint/> for info

Notice: Before you use the program in productive use, please take all necessary precautions,
e.g. testing and verifying the program with regard to your specific use.
The program was tested solely for our own use cases, which might differ from yours.
The program was tested solely for our own use cases, which might differ from yours.
Loading

0 comments on commit 036999a

Please sign in to comment.