# README
github-operator
This kubernetes operator watches from k8s manifests GithubSecret
and then read the specified secrets from
Google Cloud Security Manager and stores them in Github Repository Secrets.
📔 Note It only support Github DependaBot secrets for now.
Description
This operator helps to setup Github Action Secrets by reading them from Google Cloud Secret Manager and store them as Github Action Secrets.
That enables automatic management of Github Action Secrets from within Kubernetes. Can then also be integrated into the flinkit microservice workflow.
Packaging
Helm
make helm-template
cp -fv helm/templates/ ../github-operator-infra/shared/workload/templates/
Getting Started
You’ll need a Kubernetes cluster to run against. You can use Minikube to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info
shows).
Starting minikube
- Start minikube
minikube start
- Enable GCP Authentication
minikube addons enable gcp-auth
- Using minikube docker daemon
eval $(minikube docker-env)
Running on the minikube cluster
- Install Instances of Custom Resources:
kubectl apply -f config/samples/secret_v1alpha1_githubsecret.yaml
- Build your image:
make docker-build
- Deploy the controller to the cluster:
make deploy
- Create needed K8s Secret
kube create secret generic github-operator-secrets --from-literal=GITHUB_TOKEN=insert_the_token_here
Uninstall CRDs
To delete the CRDs from the cluster:
make uninstall
Undeploy controller
UnDeploy the controller from the cluster:
make undeploy
How it works
This project aims to follow the Kubernetes Operator pattern.
It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
Test It Out
- Install the CRDs into the cluster:
make install
- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run
NOTE: You can also run this in one step by running: make install run
Modifying the API definitions
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifests
NOTE: Run make --help
for more information on all potential make
targets
More information can be found via the Kubebuilder Documentation
License
Copyright 2023.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Related Articles
Minikube
Kubernetes Operators
hello-world-tutorial-with-kubernetes-operators Building Operators with Golang advanced-topics handle-cleanup-on-deletion manage-cr-status-conditions