ContainerImage.GitSparseClone/README.md

61 lines
1.9 KiB
Markdown
Raw Normal View History

2020-02-17 13:00:57 +00:00
# Docker.Containers.GitSparseClone [![Build Status](https://ci.spamasaurus.com/api/badges/djpbessems/Docker.Containers.GitSparseClone/status.svg)](https://ci.spamasaurus.com/djpbessems/Docker.Containers.GitSparseClone)
2020-02-18 10:51:49 +00:00
Useful as a Kubernetes sidecar Container that downloads specific files from a git-repository (sparse clone) to a Kubernetes volumeMount, which other containers in the same Pod can then also mount and use.
2020-02-17 12:38:48 +00:00
2020-02-18 10:51:49 +00:00
### Build:
`docker build -t gitsparseclone .`
### Usage:
Create a `deployment-with-sidecar.yml` with the following contents:
2020-02-17 13:00:57 +00:00
```
2020-02-18 10:51:49 +00:00
apiVersion: apps/v1
kind: Deployment
metadata:
name: deployment-with-sidecar
labels:
app: deployment-with-sidecar
spec:
replicas: 1
selector:
matchLabels:
app: deployment-with-sidecar
template:
metadata:
labels:
app: deployment-with-sidecar
spec:
containers:
- name: main
image: <<name of your main-container image>>
volumeMounts:
- name: files
readOnly: true
mountPath: "/mnt/files"
- name: sidecar
image: djpbessems/gitsparseclone
env:
- name: SPARSE_CHECKOUT
value: |-
specific/folder/in/repository/*
another/folder/in/repository/*
- name: REMOTE_REPO
value: <<fqdn of your git repository>
- name: REMOTE_BRANCH
value: <<branch of your git repository>>
- name: TARGET_DIR
value: /mnt/files
# Optional
- name: http_proxy
value: <<fqdn of your proxy>>
2020-02-17 13:00:57 +00:00
# Optional
2020-02-18 10:51:49 +00:00
- name: https_proxy
value: <<fqdn of your proxy>>
volumeMounts:
- name: files
mountPath: "/mnt/files"
volumes:
2020-02-19 15:11:25 +00:00
- name: files
2020-02-18 10:51:49 +00:00
emptyDir: {}
```
Then deploy to Kubernetes:
`kubectl apply -f deployment-with-sidecar.yml`