kubernetes
/
git-sync
mirror of https://github.com/kubernetes/git-sync.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A sidecar app which clones a git repo and keeps it in sync with the upstream.
212 Commits 5 Branches 57 Tags 19 MiB
Shell 49.8%
Go 45.9%
Makefile 3%
Dockerfile 1.3%
Go to file
Tim Hockin 2a42fba009 Handle running as pid 1 
This detects when it is running as pid 1, and becomes an init process.
Specifically this means handling SIGCHLD and reaping processes
(otherwise they become zombies) and forwarding signals to "real"
process.

We fork and re-exec ourselves so that we only get *this* SIGCHLD for
orphaned processes (re-parented to 1) and not the real events from
running things like git or ssh.
 		2019-10-27 09:45:27 -07:00
build Use vendor and build automatic build cache 2019-03-25 08:54:44 -07:00
cmd/git-sync Handle running as pid 1 2019-10-27 09:45:27 -07:00
demo Fix hugo demo and docs 2018-12-17 11:44:50 -08:00
docs Fix Typo 2019-02-21 15:46:51 +01:00
pkg Handle running as pid 1 2019-10-27 09:45:27 -07:00
vendor Use official logr rather than thockin 2019-03-25 08:54:44 -07:00
.gitignore Use the go-build-template 2016-10-30 17:09:06 -07:00
CONTRIBUTING.md Create CONTRIBUTING.md 2016-08-22 16:18:11 -07:00
Dockerfile.in Handle running as pid 1 2019-10-27 09:45:27 -07:00
LICENSE Initial commit 2016-08-20 14:09:57 -07:00
Makefile Fix multi-platform build in Makefile 2019-07-26 14:08:27 -07:00
OWNERS OWNERS wants 'approvers' not 'maintainers' 2019-01-15 08:39:42 -08:00
README.md Merge branch 'master' into master 2019-01-23 08:04:22 -08:00
RELEASING.md Clean up / document build and release 2019-01-25 10:45:09 -08:00
SECURITY_CONTACTS Update embargo doc link in SECURITY_OWNERS and changes PST to PSC 2019-03-08 10:23:48 -07:00
code-of-conduct.md Update code-of-conduct.md 2017-12-20 13:32:20 -05:00
go.mod Use official logr rather than thockin 2019-03-25 08:54:44 -07:00
go.sum Use official logr rather than thockin 2019-03-25 08:54:44 -07:00
slow_git.sh add timeout tests 2019-01-04 22:32:53 +00:00
test_e2e.sh ✨ support of depth flag 2019-10-22 16:43:51 +02:00

README.md

git-sync

git-sync is a simple command that pulls a git repository into a local directory. It is a perfect "sidecar" container in Kubernetes - it can periodically pull files down from a repository so that an application can consume them.

git-sync can pull one time, or on a regular interval. It can pull from the HEAD of a branch, or from a git tag, or from a specific git hash. It will only re-pull if the target of the run has changed in the upstream repository. When it re-pulls, it updates the destination directory atomically. In order to do this, it uses a git worktree in a subdirectory of the --root and flips a symlink.

git-sync can also be configured to make webhook call upon sucessful git repo syncronisation. The call is made when right after the symlink is updated.

Usage

# build the container
make container REGISTRY=registry VERSION=tag

# build the container behind a proxy
make container REGISTRY=registry VERSION=tag HTTP_PROXY=http://<proxy_address>:<proxy_port> HTTPS_PROXY=https://<proxy_address>:<proxy_port>

# run the container
docker run -d \
    -v /tmp/git-data:/tmp/git \
    registry/git-sync:tag \
        --repo=https://github.com/kubernetes/git-sync
        --branch=master
        --wait=30

# run an nginx container to serve the content
docker run -d \
    -p 8080:80 \
    -v /tmp/git-data:/usr/share/nginx/html \
    nginx

Webhooks

Webhooks are executed asynchronously from the main git-sync process. If a webhook-url is configured, when a change occurs to the local git checkout a call is sent using the method defined in webhook-method (default to POST). git-sync will continually attempt this webhook call until it succeeds (based on webhook-success-status). If unsuccessful, git-sync will wait webhook-backoff (default 3s) before re-attempting the webhook call.

Usage

A webhook is configured using a set of CLI flags. At its most basic only webhook-url needs to be set.

docker run -d \
    -v /tmp/git-data:/git \
    registry/git-sync:tag \
        --repo=https://github.com/kubernetes/git-sync
        --branch=master
        --wait=30
        --webhook-url="http://localhost:9090/-/reload"

Analytics