diff --git a/README.md b/README.md index 8269d1d..d2092d4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# git2kube - Git to K8s ConfigMap +# git2kube - From Git to Kubernetes [![Build Status](https://travis-ci.org/WanderaOrg/git2kube.svg?branch=master)](https://travis-ci.org/WanderaOrg/git2kube) [![Docker Build Status](https://img.shields.io/docker/build/wanderadock/git2kube.svg)](https://hub.docker.com/r/wanderadock/git2kube/) @@ -17,6 +17,9 @@ Tool for syncing git with Kubernetes. * Ability to synchronise git into target folder using symlinks (suitable for sidecar deployments) * SSH key and Basic auth +### Quickstart +Check out [example](example) folder that should get you started. + ### Docker repository The tool is released as docker image as well, check the [repository](https://hub.docker.com/r/wanderadock/git2kube/). diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..db77a01 --- /dev/null +++ b/example/README.md @@ -0,0 +1,26 @@ +## CronJob +* [cronjob.yaml](cronjob.yaml) +* Deploy git2kube as a Kubernetes CronJob +* Synchronise with Kubernetes ConfigMap or Secret +* Suitable for longer refresh intervals +* Might be harder to monitor +* Updates might have higher latency due to scheduling +* Low resource requirements + +## Watcher +* [watcher.yaml](watcher.yaml) +* Deploy git2kube as a Kubernetes Deployment +* Synchronise with Kubernetes ConfigMap or Secret +* Suitable for short refresh intervals +* Easier to monitor +* Low latency updates +* Low resource requirements + +## Sidecar +* [sidecar.yaml](sidecar.yaml) +* Deploy git2kube as part of different application Pod +* Synchronise with application by using shared volume +* Suitable for short refresh intervals +* Easier to monitor +* Low latency updates +* Bigger resource requirements \ No newline at end of file