diff --git a/LICENSE b/LICENSE index 45c7cbf..76b1ebf 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Patrice Ferlet +Copyright (c) 2022-2024 Patrice Ferlet Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/doc/docs/index.md b/doc/docs/index.md index 4d02118..9493492 100644 --- a/doc/docs/index.md +++ b/doc/docs/index.md @@ -10,14 +10,15 @@ 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. +💡 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 ? +# What is it? 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). @@ -42,7 +43,9 @@ that is in your `PATH`. If you are a Linux user, you can use the "one line installation command" which will download the binary in your `$HOME/.local/bin` directory if it exists. +```bash sh <(curl -sSL https://raw.githubusercontent.com/metal3d/katenary/master/install.sh) +``` !!! Info "Upgrading is integrated to the `katenary` command" Katenary propose a `upgrade` subcommand to update the current binary to the latest stable release. @@ -59,17 +62,23 @@ sh <(curl -sSL https://raw.githubusercontent.com/metal3d/katenary/master/install But, note that the "master" branch is not the "stable" version. It's preferable to switch to a tag, or to use the releases. +To compile it, you can use the following commands: + +```bash git clone https://github.com/metal3d/katenary.git cd katenary make build make install +``` `make install` copies `./katenary` binary to your user binary path (`~/.local/bin`) You can install it in other directory by changing the `PREFIX` variable. E.g.: +```bash make build sudo make install PREFIX=/usr/local +``` Check if everything is OK using `katenary version` and / or `katenary help` @@ -78,37 +87,59 @@ Check if everything is OK using `katenary version` and / or `katenary help` Katenary uses the very nice project named `cobra` to manage flags, argument and auto-completion. You can activate it with: + +```bash # replace "bash" by "zsh" if needed source <(katenary completion bash) +``` -Add this line in you `~/.profile` or `~/.bashrc` file to have completion at startup. +Add this line in you `~/.profile`, `~/.bash_aliases` or `~/.bashrc` file to have completion at startup. + + +## What a name... + +A catenary is the curve that a hanging chain or cable assumes under its own weight when supported only at its ends. +I, the maintainer, decided to name "Katenary" this project because it's like a chain that links a boat to a dock. +Making the link between the "compose" world and the "Kubernetes" world is the main goal of this project. + +Anyway, it's too late to change the name now :smile: + +!!! Note "But I like this name!" + + I spent time to find it :wink: + +## Special thanks to... + +I really want to thank all the contributors, testers, and of course, the authors of the packages and tools that are used +in this project. There is too many to list here. Katenary can works because of all these people. Open source is a great +thing! :heart: !!! 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. + + Go is an open source programming language that makes it easy to build simple, reliable, and efficient software. Because Docker, Podman, + Kubernetes, and Helm are written in Go, Katenary is also written in Go and borrows packages from these projects to + make it as efficient as possible. + + Thanks to Kubernetes to provide [Kind](https://kind.sigs.k8s.io) that is used to test Katenary locally. **Thanks to everyone who contributes to all these projects.** + Katenary can progress because of all these people. All contributions, as comments, issues, pull requests and + feedbacks are welcome. + **Everything was also possible because of:**
**Documentation is built with:**
@@ -116,3 +147,6 @@ Add this line in you `~/.profile` or `~/.bashrc` file to have completion at star MkDocs using Material for MkDocs theme template. +## License + +Katenary is an open source project under the MIT license. You can use it, modify it, and distribute it as you want.