README
¶
Project Syn: Lieutenant Operator
Kubernetes Operator which implements the backend for 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.
Please note that this project is in it's early stages and under active development.
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 and Antora. It is located in the docs/ folder. The Divio documentation structure 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 deploy/.
Example:
kubectl create ns syn-lieutenant
kubectl -n syn-lieutenant apply -k deploy/crds/
kubectl -n syn-lieutenant apply -k deploy/
Some example data to test the operator is available under examples/.
Development
to be written
The Operator is implemented using the Operator SDK.
Contributing and license
This library is licensed under BSD-3-Clause. For information about how to contribute see CONTRIBUTING.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
apis/syn
Package syn contains syn API versions.
|
Package syn contains syn API versions. |
|
apis/syn/v1alpha1
Package v1alpha1 contains API Schema definitions for the syn v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=syn.tools Package v1alpha1 contains API Schema definitions for the syn v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=syn.tools
|
Package v1alpha1 contains API Schema definitions for the syn v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=syn.tools Package v1alpha1 contains API Schema definitions for the syn v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=syn.tools |
|
git
Package git simply anonymously imports all the various git implementations so the can be used.
|
Package git simply anonymously imports all the various git implementations so the can be used. |
|
git/helpers
Package helpers contains helper functions for the various git manipulations that can be re-used.
|
Package helpers contains helper functions for the various git manipulations that can be re-used. |