diff --git a/.nvimrc b/.nvimrc deleted file mode 100644 index 1da8158..0000000 --- a/.nvimrc +++ /dev/null @@ -1,2 +0,0 @@ -" set markdown options to set fo+=a textwidth=120 -autocmd FileType markdown setlocal textwidth=120 fo+=a cc=+1 diff --git a/README.md b/README.md index ca953b6..bff328c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -
- Katenary Logo +
+ Katenary Logo
+ +🚀 Unleash Productivity with Katenary! 🚀 + +Tired of manual conversions? Katenary harnesses the labels from your "compose" file to craft complete Helm Charts +effortlessly, saving you time and energy. + +🛠️ Simple autmated CLI: Katenary handles the grunt work, generating everything needed for seamless service binding +and Helm Chart creation. + +💡 Effortless Efficiency: You only need to add labels when it's necessary to precise things. Then call `katenary convert` and let the magic happen. + +# What ? + Katenary is a tool to help to transform `docker-compose` files to a working Helm Chart for Kubernetes. > **Important Note:** Katenary is a tool to help to build Helm Chart from a docker-compose file, but docker-compose diff --git a/doc/docs/coding.md b/doc/docs/coding.md index a63e93e..a1e00de 100644 --- a/doc/docs/coding.md +++ b/doc/docs/coding.md @@ -36,8 +36,10 @@ The generation is made by using a `HelmChart` object: ```golang chart := NewChart(appName string) -``` Then, some processes are made to detect the "main app verion" (tag for the main service image), bootstrapping -declared ports in labels, managing links to bind containers in one pods... +``` + +Then, some processes are made to detect the "main app verion" (tag for the main service image), bootstrapping declared +ports in labels, managing links to bind containers in one pods... Then, a loop basically makes this: @@ -54,7 +56,7 @@ for _, service := range project.Services { **A lot** of string manipulations are made by each `Yaml()` methods. This is where you find the complex and impacting operations. The `Yaml` methods **don't return a valid YAML content**. This is a Helm Chart Yaml content with template -conditions, vamues and calls to helper templates. +conditions, values and calls to helper templates. > The `Yaml()` methods, in each object, need contribution, help, fixes, enhancements... They work, but there is a lot of > complexity. Please, create issues, pull-requests and conversation in the GitHub repository. diff --git a/doc/docs/index.md b/doc/docs/index.md index 202015b..3121831 100644 --- a/doc/docs/index.md +++ b/doc/docs/index.md @@ -1,18 +1,35 @@ -
+ + + # Welcome to Katenary documentation +🚀 Unleash Productivity with Katenary! 🚀 -!!! Edit "Thanks to..." - **Katenary is built with:** -
:fontawesome-brands-golang:{ .go-logo } +Tired of manual conversions? Katenary harnesses the labels from your "compose" file to craft complete Helm Charts +effortlessly, saving you time and energy. - **Documentation is built with:** -
- MkDocs using Material for MkDocs theme template. +🛠️ Simple autmated CLI: Katenary handles the grunt work, generating everything needed for seamless service binding +and Helm Chart creation. - > Special thanks to all contributors, testors, and of course packages and tools authors. +💡 Effortless Efficiency: You only need to add labels when it's necessary to precise things. Then call `katenary convert` and let the magic happen. + +# What ? Katenary is a tool made to help you to transform "compose" files (`docker-compose.yml`, `podman-compose.yml`...) to complete and production ready [Helm Chart](https://helm.sh). @@ -25,7 +42,6 @@ It uses your current file and optionnaly labels to configure the result. It's an opensource project, under MIT licence, partially developped at [Smile](https://www.smile.eu). The project source code is hosted on the [:fontawesome-brands-github: Katenary GitHub Repository](https://github.com/metal3d/katenary). - ## Install Katenary Katenary is developped using the :fontawesome-brands-golang:{ .gopher } [Go](https://go.dev) language. @@ -88,3 +104,35 @@ source <(katenary completion bash) Add this line in you `~/.profile` or `~/.bashrc` file to have completion at startup. +!!! Edit "Special thanks" + + **Katenary is built with:**
+ + > Special thanks to all contributors, testors, and of course packages and tools authors. + + :fontawesome-brands-golang:{ .go-logo } + + Go is an open source programming language that makes it easy to build simple, reliable, and efficient software. + Docker, Rancher, Helm, Kubernetes, Grafana, Prometheus, and many others are written in Go. Katenary uses Go-Compose + to parse compose files wich is the same library used by Podman-Compose and Docker-Compose. It also uses the + Kubernetes official packages to create Kubernetes objects before to generate the Helm Chart. + + **Thanks to everyone who contributes to all these projects.** + + **Everything was also possible because of:**
+ + + + **Documentation is built with:**
+ + MkDocs using Material for MkDocs theme template. + diff --git a/doc/docs/statics/Logo_Smile.png b/doc/docs/statics/Logo_Smile.png deleted file mode 100644 index 6b9cfd3..0000000 Binary files a/doc/docs/statics/Logo_Smile.png and /dev/null differ diff --git a/doc/docs/statics/logo-bright.svg b/doc/docs/statics/logo-bright.svg new file mode 100644 index 0000000..f1ef1ff --- /dev/null +++ b/doc/docs/statics/logo-bright.svg @@ -0,0 +1,35 @@ + + + + + + + + + + + diff --git a/doc/docs/statics/logo-dark.svg b/doc/docs/statics/logo-dark.svg new file mode 100644 index 0000000..7f3ffa0 --- /dev/null +++ b/doc/docs/statics/logo-dark.svg @@ -0,0 +1,35 @@ + + + + + + + + + + + diff --git a/doc/docs/statics/logo.png b/doc/docs/statics/logo.png deleted file mode 100644 index c9ac789..0000000 Binary files a/doc/docs/statics/logo.png and /dev/null differ diff --git a/doc/docs/statics/logo.svg b/doc/docs/statics/logo.svg new file mode 100644 index 0000000..bc85b66 --- /dev/null +++ b/doc/docs/statics/logo.svg @@ -0,0 +1,145 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml index e45174d..6035216 100644 --- a/doc/mkdocs.yml +++ b/doc/mkdocs.yml @@ -3,7 +3,7 @@ docs_dir: ./docs theme: name: material custom_dir: overrides - logo: statics/logo.png + logo: statics/logo-dark.svg palette: - scheme: slate toggle: diff --git a/misc/LogoMakr-1TEtSp.png b/misc/LogoMakr-1TEtSp.png deleted file mode 100644 index f1c3a7e..0000000 Binary files a/misc/LogoMakr-1TEtSp.png and /dev/null differ diff --git a/misc/Logo_Smile.png b/misc/Logo_Smile.png deleted file mode 100644 index 6b9cfd3..0000000 Binary files a/misc/Logo_Smile.png and /dev/null differ diff --git a/misc/logo.png b/misc/logo.png deleted file mode 100644 index c9ac789..0000000 Binary files a/misc/logo.png and /dev/null differ