git-sync

packaged by Chainguard

Chainguard Container for git-sync

A sidecar app which clones a git repo and keeps it in sync with the upstream.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/git-sync:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

Chainguard's git-sync image is comparable to the upstream git-sync image (registry.k8s.io/git-sync/git-sync) and runs the same /git-sync entrypoint, with two differences:

• It runs as UID 65532 instead of 65533.
• The default sync root (GITSYNC_ROOT) is /tmp/git instead of /git.

Pass --root or set GITSYNC_ROOT if your manifests rely on the upstream path.

Getting Started

git-sync clones a repository into its root directory and keeps a symlink pointing at the latest checkout. To try it, create a directory owned by your user and run a one-time sync as that user:

mkdir -p /tmp/git-data
docker run --rm \
  -u "$(id -u):$(id -g)" \
  -v /tmp/git-data:/tmp/git \
  cgr.dev/ORGANIZATION/git-sync:latest \
  --repo=https://github.com/kubernetes/git-sync \
  --link=head \
  --one-time

The synced files are available through the head link:

ls /tmp/git-data/head/demo/html

index.html

To keep the checkout updated instead of syncing once, replace --one-time with --period=60s.

Configuration

git-sync usually runs as a sidecar that shares a volume with the container that consumes the files. The following Deployment syncs a repository into an emptyDir volume every 60 seconds:

cat > git-sync.yaml <<EOF
apiVersion: apps/v1
kind: Deployment
metadata:
  name: git-sync
spec:
  replicas: 1
  selector:
    matchLabels:
      app: git-sync
  template:
    metadata:
      labels:
        app: git-sync
    spec:
      containers:
        - name: git-sync
          image: cgr.dev/ORGANIZATION/git-sync:latest
          args:
            - --repo=https://github.com/kubernetes/git-sync
            - --root=/git
            - --link=head
            - --period=60s
            - --git-config=safe.directory:/git
          volumeMounts:
            - name: content
              mountPath: /git
      volumes:
        - name: content
          emptyDir: {}
EOF
kubectl apply -f git-sync.yaml

Starting with git-sync 4.8.0, git-sync no longer sets safe.directory=* (kubernetes/git-sync#993). An emptyDir volume is owned by root while this image runs as UID 65532, so without the --git-config=safe.directory:/git argument git rejects the root as "dubious ownership" and nothing is synced. Set the exception to the same path as --root.

Once the Pod is running, confirm the sync:

kubectl exec deploy/git-sync -c git-sync -- ls /git/head/demo/html

index.html

To consume the files, add your application container to the same Pod and mount the content volume.

Documentation and Resources

• git-sync on GitHub
• Using git-sync on Kubernetes

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.