https://github.com/projectsyn/lieutenant-operator
The Project Syn Inventory API Operator
https://github.com/projectsyn/lieutenant-operator
kubernetes lieutenant operator operator-sdk projectsyn
Last synced: 11 months ago
JSON representation
The Project Syn Inventory API Operator
- Host: GitHub
- URL: https://github.com/projectsyn/lieutenant-operator
- Owner: projectsyn
- License: bsd-3-clause
- Created: 2020-01-09T15:01:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-20T05:30:35.000Z (11 months ago)
- Last Synced: 2025-06-20T06:29:13.090Z (11 months ago)
- Topics: kubernetes, lieutenant, operator, operator-sdk, projectsyn
- Language: Go
- Homepage: https://docs.syn.tools/lieutenant-operator/
- Size: 1.14 MB
- Stars: 3
- Watchers: 10
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Project Syn: Lieutenant Operator
Kubernetes Operator which implements the backend for [Lieutenant API](https://github.com/projectsyn/lieutenant-api).
The operator keeps inventory about all the tenants and clusters in a SYN managed k8s cluster.
It also handles the management of some requirements like Git repositories and secret management.
It can automatically populate Git repositories with template files when a new cluster is added.
It will also generate a token to be used by Steward.
This repository is part of Project Syn.
For documentation on Project Syn and this component, see https://syn.tools.
## Documentation
Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora].
It is located in the [docs/](docs) folder.
The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content.
You can use the `make docs-serve` command and then browse to http://localhost:2020 to preview the documentation.
## Deployment
A Kustomize setup is available under `config/samples/deployment`.
Example:
```
kubectl create ns syn-lieutenant
kubectl -n syn-lieutenant apply -k config/crd/
kubectl -n syn-lieutenant apply -k config/samples/deployment
```
Some example data to test the operator is available under `config/samples/`.
## Development
The Operator is implemented using [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
There are many `make` targets available.
Run `make help` to get a list of relevant targets.
## Contributing and license
This library is licensed under [BSD-3-Clause](LICENSE).
For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md).
[commodore]: https://docs.syn.tools/commodore/index.html
[asciidoc]: https://asciidoctor.org/
[antora]: https://antora.org/