kubernetes
/
git-sync
mirror of https://github.com/kubernetes/git-sync.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix README to actually run

This commit is contained in:
Tim Hockin 2016-08-20 20:41:05 -07:00
parent 4c112490af
commit 0a403496bf
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,19 +4,27 @@ git-sync is a command that pull a git repository to a local directory.
It can be used to source a container volume with the content of a git repo. It can be used to source a container volume with the content of a git repo.
In order to ensure that the git repository content is cloned and updated atomically, you cannot use a volume root directory as the directory for your local repository. In order to ensure that the git repository content is cloned and updated atomically, you cannot use a volume root directory as the directory for your local repository.
The local repository is created in a subdirectory of /git, with the subdirectory name specified by GIT_SYNC_DEST. The local repository is created in a subdirectory of /git, with the subdirectory name specified by GIT_SYNC_DEST.
## Usage ## Usage
``` ```
# build the container # build the container
docker build -t git-sync . docker build -t yourname/git-sync .
# or
make container
# run the git-sync container # run the git-sync container
docker run -d GIT_SYNC_REPO=https://github.com/GoogleCloudPlatform/kubernetes GIT_SYNC_DEST=/git -e GIT_SYNC_BRANCH=gh-pages -r HEAD -v /git-data:/git git-sync docker run -d \
-e GIT_SYNC_REPO=https://github.com/kubernetes/kubernetes \
-e GIT_SYNC_DEST=/git \
-e GIT_SYNC_BRANCH=gh-pages \
-v /git-data:/git \
git-sync
# run a nginx container to serve sync'ed content # run a nginx container to serve sync'ed content
docker run -d -p 8080:80 -v /git-data:/usr/share/nginx/html nginx docker run -d -p 8080:80 -v /git-data:/usr/share/nginx/html nginx
``` ```
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/git-sync/README.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/git-sync/README.md?pixel)]()