Signed-off-by: Shubham Jain <shubhamkjain@outlook.com> |
||
---|---|---|
.. | ||
logos | ||
1-flux-v2.yaml | ||
2-flagger.yaml | ||
3-flux-v1.yaml | ||
README.md |
README.md
Flux Adopters
So you and your organisation are using Flux? That's great. We would love to hear from you! 💖
Adding yourself
Each YAML file in this directory lists the organisations who adopted the specific project in production. So if you use
- Flux v2 or the GitOps Toolkit controllers, you are looking for
1-flux-v2.yaml
- Flagger, it's
2-flagger.yaml
- Flux v1 or Helm Operator, take a look at
3-flux-v1.yaml
You just need to add an entry for your company and upon merging it will automatically be added to our website.
To add your organisation follow these steps:
-
Fork the fluxcd/website repository.
-
Clone it locally with
git clone https://github.com/<YOUR-GH-USERNAME>/website.git
. -
(Optional) Add the logo of your organisation to
adopters/logos
. Good practice is for the logo to be called e.g.<company>.png
. -
Find the right
adopters/<project>.yaml
file as indicated above. -
Add an entry to the YAML file with the
name
of your organisation,url
that links to its website, and the path to thelogo
. Example:- name: Xenit url: https://xenit.se/ logo: logos/xenit.png
You can just add to the end of the file, we already sort alphabetically by name of organisation.
-
Save the file, then do
git add -A
and commit usinggit commit -s -m "Add MY-ORG to adopters"
(commit signoff is required, see DCO). -
Push the commit with
git push origin main
. -
Open a Pull Request to fluxcd/website and a preview build will turn up.
Thanks a lot for being part of our community - we very much appreciate it!
Addendum
/adopters/logo/logo-generic.png
is a slightly modified Flux logo, it is used when no organisation logo is provided.