Change license date, enhance and fix documentation
This commit is contained in:
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
MIT License
|
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
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
@@ -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
|
🛠️ Simple autmated CLI: Katenary handles the grunt work, generating everything needed for seamless service binding
|
||||||
and Helm Chart creation.
|
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.
|
||||||
|
|
||||||
<div style="margin: auto" class="zoomable">
|
<div style="margin: auto" class="zoomable">
|
||||||
<img src="statics/workflow.png" id="workflow-image"/>
|
<img src="statics/workflow.png" id="workflow-image"/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
# What ?
|
# What is it?
|
||||||
|
|
||||||
Katenary is a tool made to help you to transform "compose" files (`docker-compose.yml`, `podman-compose.yml`...) to
|
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).
|
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
|
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.
|
`$HOME/.local/bin` directory if it exists.
|
||||||
|
|
||||||
|
```bash
|
||||||
sh <(curl -sSL https://raw.githubusercontent.com/metal3d/katenary/master/install.sh)
|
sh <(curl -sSL https://raw.githubusercontent.com/metal3d/katenary/master/install.sh)
|
||||||
|
```
|
||||||
|
|
||||||
!!! Info "Upgrading is integrated to the `katenary` command"
|
!!! Info "Upgrading is integrated to the `katenary` command"
|
||||||
Katenary propose a `upgrade` subcommand to update the current binary to the latest stable release.
|
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
|
But, note that the "master" branch is not the "stable" version. It's preferable to switch to a tag, or to use the
|
||||||
releases.
|
releases.
|
||||||
|
|
||||||
|
To compile it, you can use the following commands:
|
||||||
|
|
||||||
|
```bash
|
||||||
git clone https://github.com/metal3d/katenary.git
|
git clone https://github.com/metal3d/katenary.git
|
||||||
cd katenary
|
cd katenary
|
||||||
make build
|
make build
|
||||||
make install
|
make install
|
||||||
|
```
|
||||||
|
|
||||||
`make install` copies `./katenary` binary to your user binary path (`~/.local/bin`)
|
`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.:
|
You can install it in other directory by changing the `PREFIX` variable. E.g.:
|
||||||
|
|
||||||
|
```bash
|
||||||
make build
|
make build
|
||||||
sudo make install PREFIX=/usr/local
|
sudo make install PREFIX=/usr/local
|
||||||
|
```
|
||||||
|
|
||||||
Check if everything is OK using `katenary version` and / or `katenary help`
|
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.
|
Katenary uses the very nice project named `cobra` to manage flags, argument and auto-completion.
|
||||||
|
|
||||||
You can activate it with:
|
You can activate it with:
|
||||||
|
|
||||||
|
```bash
|
||||||
# replace "bash" by "zsh" if needed
|
# replace "bash" by "zsh" if needed
|
||||||
source <(katenary completion bash)
|
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"
|
!!! Edit "Special thanks"
|
||||||
|
|
||||||
**Katenary is built with:** <br />
|
**Katenary is built with:** <br />
|
||||||
|
|
||||||
> Special thanks to all contributors, testors, and of course packages and tools authors.
|
|
||||||
|
|
||||||
<a href="https://go.dev" target="_blank">:fontawesome-brands-golang:{ .go-logo }</a>
|
<a href="https://go.dev" target="_blank">:fontawesome-brands-golang:{ .go-logo }</a>
|
||||||
|
|
||||||
Go is an open source programming language that makes it easy to build simple, reliable, and efficient software.
|
Go is an open source programming language that makes it easy to build simple, reliable, and efficient software. Because Docker, Podman,
|
||||||
Docker, Rancher, Helm, Kubernetes, Grafana, Prometheus, and many others are written in Go. Katenary uses Go-Compose
|
Kubernetes, and Helm are written in Go, Katenary is also written in Go and borrows packages from these projects to
|
||||||
to parse compose files wich is the same library used by Podman-Compose and Docker-Compose. It also uses the
|
make it as efficient as possible.
|
||||||
Kubernetes official packages to create Kubernetes objects before to generate the Helm Chart.
|
|
||||||
|
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.**
|
**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:** <br />
|
**Everything was also possible because of:** <br />
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
|
<li><a href="https://helm.sh" target="_blank"><img src="https://helm.sh/img/helm.svg" style="height: 1rem"/>
|
||||||
<li><a href="https://helm.sh" target="_blank"><img src="https://helm.sh/img/helm.svg" style="height: 1rem"/>
|
Helm</a> that is the main toppic of Katenary, Kubernetes is easier to use with it.</li>
|
||||||
Helm</a> that is the main toppic of Katenary, Kubernetes is easier to use with it.</li>
|
<li><a href="https://cobra.dev/"><img src="https://cobra.dev/home/logo.png" style="height: 1rem"/> Cobra</a> that
|
||||||
|
makes command, subcommand and completion possible for Katenary with ease.</li>
|
||||||
<li><a href="https://cobra.dev/"><img src="https://cobra.dev/home/logo.png" style="height: 1rem"/> Cobra</a> that
|
<li>Podman, Docker, Kubernetes that are the main tools that Katenary is made for.</li>
|
||||||
makes command, subcommand and completion possible for Katenary with ease.</li>
|
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
**Documentation is built with:** <br />
|
**Documentation is built with:** <br />
|
||||||
@@ -116,3 +147,6 @@ Add this line in you `~/.profile` or `~/.bashrc` file to have completion at star
|
|||||||
<a href="https://www.mkdocs.org/" target="_blank">MkDocs</a> using <a
|
<a href="https://www.mkdocs.org/" target="_blank">MkDocs</a> using <a
|
||||||
href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> theme template.
|
href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> 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.
|
||||||
|
Reference in New Issue
Block a user