Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix typos , add coffee!
  • Loading branch information
zakkg3 authored Oct 26, 2024
1 parent 706766b commit ff10c28
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@
![CI](https://github.com/zakkg3/ClusterSecret/workflows/CI/badge.svg) [![Docker Repository on Quay](https://quay.io/repository/clustersecret/clustersecret/status "Docker Repository on Quay")](https://quay.io/repository/clustersecret/clustersecret) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/clutersecret)](https://artifacthub.io/packages/search?repo=clutersecret)[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4283/badge)](https://bestpractices.coreinfrastructure.org/projects/4283) [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) [![Kubernetes - v1.24.15 | v1.25.11 | v1.26.6 | v1.27.3](https://img.shields.io/static/v1?label=Kubernetes&message=v1.24.15+|+v1.25.11+|+v1.26.6+|+v1.27.3&color=2ea44f)](https://)
---

## Kubernetes ClusterSecret
[*clustersecret.com*](https://clustersecret.com/)

Cluster wide secrets
Kubernetes Cluster wide secrets

ClusterSecret operator makes sure all the matching namespaces have the secret available and up to date.
The clusterSecret operator makes sure all the matching namespaces have the secret available and up to date.

- New namespaces, if they match the pattern, will also have the secret.
- Any change on the ClusterSecret will update all related secrets. Including changing the match pattern.
- Deleting the ClusterSecret deletes "child" secrets (all cloned secrets) too.

Full documentation available at [https://clustersecret.com](https://clustersecret.com/)
Full documentation is available at [https://clustersecret.com](https://clustersecret.com/)

<img src="https://github.com/zakkg3/ClusterSecret/blob/master/docs/clusterSecret.png" alt="Clustersecret diagram">

Expand All @@ -38,9 +37,6 @@ data:
```
## Use cases.
Use it for certificates, registry pulling credentials and so on.
when you need a secret in more than one namespace. you have to:
Expand All @@ -60,13 +56,17 @@ kubectl get secret <secret-name> -n <source-namespace> -o yaml \

Clustersecrets automates this. It keep track of any modification in your secret and it will also react to new namespaces.

If this is helpful, consider supporting the project :)

<a href="https://buymeacoffee.com/4s0l9aymb" target="_blank"><img src="https://buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>


# installation

## Requirements

Current version `0.0.11` is tested for Kubernetes >= 1.19 up to 1.27.3
For older kubernetes (<1.19) use the image tag `0.0.6` in your helm values file.
For older Kubernetes (<1.19) use the image tag `0.0.6` in your helm values file.

architectures available (0.0.11):

Expand Down Expand Up @@ -99,7 +99,7 @@ create a ClusterSecret object yaml like the one above, or in the example in yaml

The ClusterSecret operator will pick it up and will create the secret in every matching namespace: match `matchNamespace` but not matching `avoidNamespaces` RegExp's.

You can specify multiple matching or non-matching RegExp. By default it will match all, same as defining matchNamespace = *
You can specify multiple matching or non-matching RegExp. By default, it will match all, the same as defining matchNamespace = *

## Get the clustersecrets

Expand All @@ -124,13 +124,13 @@ data:
## images
Images are build and push on tag ('git tag') with Github Actions. You can find them here:
Images are built and pushed on tag ('git tag') with GitHub Actions. You can find them here:
https://quay.io/repository/clustersecret/clustersecret
## Known bugs:
- check this on issues tab
- check this on the issues tab
# Roadmap:
Expand All @@ -140,7 +140,7 @@ TO-DO: enable super linter -> DISABLE_ERRORS
# Support
If you need support, start with the troubleshooting guide: Run it in debug mode.
If you need help, you can start with the troubleshooting guide: Run it in debug mode.
You can open issues and we will try to address them.
That said, if you have questions, or just want to establish contact, reach out one way or another. [https://flag5.com](https://flag5.com) || nico at flag5.com
Expand Down

0 comments on commit ff10c28

Please sign in to comment.