https://github.com/ananace/flexvolume-git-live
Live git checkouts as a flexvolume driver for Kubernetes
https://github.com/ananace/flexvolume-git-live
flexvolume flexvolume-driver git kubernetes
Last synced: 5 months ago
JSON representation
Live git checkouts as a flexvolume driver for Kubernetes
- Host: GitHub
- URL: https://github.com/ananace/flexvolume-git-live
- Owner: ananace
- Created: 2019-10-15T14:18:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-03T13:33:56.000Z (over 5 years ago)
- Last Synced: 2025-04-23T03:02:42.554Z (7 months ago)
- Topics: flexvolume, flexvolume-driver, git, kubernetes
- Language: Shell
- Size: 46.9 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Live Git Flexvolume for Kubernetes
==================================
Flexvolume driver for Git repos that should track updates to the mounted repo.
Installing
----------
This Flexvolume driver is a bash script that makes use of binaries installed on
the Kubernetes nodes.
Installing the script itself is done simply as;
```bash
VOLUME_PLUGIN_DIR="/usr/libexec/kubernetes/kubelet-plugins/volume/exec"
mkdir -p "$VOLUME_PLUGIN_DIR/ananace~git-live"
cd "$VOLUME_PLUGIN_DIR/ananace~git-live"
curl -L -O https://raw.githubusercontent.com/ananace/flexvolume-git-live/master/git-live
chmod 755 git-live
```
The `git-live` script requires a couple of tools to be installed on all the
nodes where it's to be used, additionally it currently requires systemd for
launching the background updates;
- `awk`
- `base64`
- `git`
- `grep`
- `jq`
- `realpath`
- `sha256sum`
Running
-------
Once the Flexvolume plugin has been installed on all relevant nodes, running it
is as simple as creating a Kubernetes pod that will use it for a volume;
```yaml
apiVersion: v1
kind: Pod
metadata:
name: git-example
spec:
containers:
- name: busybox
image: busybox
command:
- sh
- -c
- |
ls -l /data
tail -f /data/README.md
volumeMounts:
- name: data
mountPath: /data
volumes:
- name: data
flexVolume:
driver: ananace/git-live
options:
repo: https://github.com/ananace/flexvolume-git-live
interval: 5d
readOnly: true
```
This example pod will check out the flexvolume sources and then actively print
any new lines as they are added to the README file and pushed.
The interval argument is handled in the same manner as [systemd.time][1]
timespans. The default interval - if not specified - can be set in the
`git-live` script as `DEFAULT_INTERVAL_SEC`, and is by default set to 15 minutes.
Caveats
-------
Due to the fact that checkouts are done as root on the underlying system, the
git index has been moved away from the repository itself. This unfortunately
means that tools inside the running pod will not be able to retrieve any data
from the index of the git mount.
Currently, there's no way to differentiate read-only and read-write, the
background updates will *always* override any user changes on every interval.
If you only require a static git checkout that doesn't follow any new commits,
the Kubernetes documentation [provides a better route][2].
[1]: https://www.freedesktop.org/software/systemd/man/systemd.time.html#Parsing%20Time%20Spans
[2]: https://kubernetes.io/docs/concepts/storage/volumes/#gitrepo