Skip to content

Commit ff10c28

Browse files
authored
Update README.md
Fix typos , add coffee!
1 parent 706766b commit ff10c28

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,17 @@
22
![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://)
33
---
44

5-
## Kubernetes ClusterSecret
65
[*clustersecret.com*](https://clustersecret.com/)
76

8-
Cluster wide secrets
7+
Kubernetes Cluster wide secrets
98

10-
ClusterSecret operator makes sure all the matching namespaces have the secret available and up to date.
9+
The clusterSecret operator makes sure all the matching namespaces have the secret available and up to date.
1110

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

16-
Full documentation available at [https://clustersecret.com](https://clustersecret.com/)
15+
Full documentation is available at [https://clustersecret.com](https://clustersecret.com/)
1716

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

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

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

59+
If this is helpful, consider supporting the project :)
60+
61+
<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>
62+
6363

6464
# installation
6565

6666
## Requirements
6767

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

7171
architectures available (0.0.11):
7272

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

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

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

104104
## Get the clustersecrets
105105

@@ -124,13 +124,13 @@ data:
124124
125125
## images
126126
127-
Images are build and push on tag ('git tag') with Github Actions. You can find them here:
127+
Images are built and pushed on tag ('git tag') with GitHub Actions. You can find them here:
128128
129129
https://quay.io/repository/clustersecret/clustersecret
130130
131131
## Known bugs:
132132
133-
- check this on issues tab
133+
- check this on the issues tab
134134
135135
# Roadmap:
136136
@@ -140,7 +140,7 @@ TO-DO: enable super linter -> DISABLE_ERRORS
140140
141141
# Support
142142
143-
If you need support, start with the troubleshooting guide: Run it in debug mode.
143+
If you need help, you can start with the troubleshooting guide: Run it in debug mode.
144144
You can open issues and we will try to address them.
145145
146146
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

0 commit comments

Comments
 (0)