Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giannisalinetti/passgen-operator
https://github.com/giannisalinetti/passgen-operator
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/giannisalinetti/passgen-operator
- Owner: giannisalinetti
- Created: 2020-10-24T20:45:41.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-26T11:36:25.000Z (about 4 years ago)
- Last Synced: 2024-10-28T06:50:10.307Z (about 2 months ago)
- Language: Makefile
- Size: 23.4 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Passgen Operator
## Overview
The Passgen Operator provides Kubernetes native deployment of the
[passgen](https://github.com/giannisalinetti/passgen) tool used to offer a
basic web-based password generator.
The operator provides a Customer Resource Definition and the logic to create
the passgen deployment, along with the certificates secret, service and
the OpenShift route.
## The Passgen CRD
The following parameters can be customized:
- **size**: tune the number of replicas
- **imageName**: name of the passgen image. Default is *quay.io/gbsalinetti/passgen*
- **imageTag**: the passgen image tag. Default is *latest*
- **hostname**: custom hostname for the OpenShift route
- **tlsCert**: Custom TLS certificate
- **tlsKey**: Custom TLS private key
## Operator Installation
First install the CRD:
```
$ make install
```
Build and push the passgen-operator image:
```
$ IMG=/: make docker-build docker-push
```
Deploy the passgen-operator in your cluster:
```
$ IMG=/: make deploy
```
## CR Installation
Install the Passgen custom resource using the config sample or generating
a new CR.
The following example shows the usage of the config sample:
```
apiVersion: passgen.example.com/v1
kind: Passgen
metadata:
name: passgen-sample
spec:
size: 1
imageName: quay.io/gbsalinetti/passgen
imageTag: latest
hostname: passgen.apps.ocp4.example.com
tlsCert: |
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
tlsKey: |
-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
```
Install it with the kubectl CLI:
```
$ kubectl apply -f config/samples/passgen_v1_passgen.yaml
```
## Testing the Passgen application
Passgen generates passwords with different options with outputs as simple
strings or json.
The following example produces a JSON object of 100 passwords of 32 characters,
with random numbers, chars, special chars, uppercase and lowercase:
```
$ curl -s -k 'https://passgen.apps.ocp4.example.com/passwd?json=true&iterations=100' | jq -M
```
## CR Removal
Uninstall the Passgen custom resource
```
$ kubectl delete -f config/samples/passgen_v1_passgen.yaml
```
## Operator Removal
Using the Makefile the operator removal is very easy:
```
$ make undeploy
```
Remove the CRD:
```
$ kubectl delete crd/passgens.passgen.example.com
```
## Contributing
Contributions to this project are welcome.
## Maintainers
Gianni Salinetti