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

README: Break flags into sections

This commit is contained in:
Tim Hockin 2022-03-08 09:05:35 -08:00
parent 3ffc83e29e
commit f94cd1d4dd
1 changed files with 43 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -83,32 +83,37 @@ docker run -d \
--webhook-url="http://localhost:9090/-/reload" --webhook-url="http://localhost:9090/-/reload"
``` ```
## Parameters ## Primary flags
| Flag | Environment Variable | Default | Description | | Flag | Environment Variable | Default | Description |
|----------------------------|---------------------------------|-------------------------------|-------------| |----------------------------|---------------------------------|-------------------------------|-------------|
| `--repo` | GIT_SYNC_REPO | (required) | the git repository to clone | | `--repo` | GIT_SYNC_REPO | (required) | the git repository to clone |
| `--branch` | GIT_SYNC_BRANCH | "master" | the git branch to check out | | `--branch` | GIT_SYNC_BRANCH | "master" | the git branch to check out |
| `--rev` | GIT_SYNC_REV | "HEAD" | the git revision (tag or hash) to check out | | `--rev` | GIT_SYNC_REV | "HEAD" | the git revision (tag or hash) to check out |
| `--depth` | GIT_SYNC_DEPTH | 0 | use a shallow clone with a history truncated to the specified number of commits |
| `--submodules` | GIT_SYNC_SUBMODULES | recursive | git submodule behavior: one of 'recursive', 'shallow', or 'off' |
| `--root` | GIT_SYNC_ROOT | "$HOME/git" | the root directory for git-sync operations, under which --dest will be created | | `--root` | GIT_SYNC_ROOT | "$HOME/git" | the root directory for git-sync operations, under which --dest will be created |
| `--dest` | GIT_SYNC_DEST | "" | the name of (a symlink to) a directory in which to check-out files under --root (defaults to the leaf dir of --repo) | | `--dest` | GIT_SYNC_DEST | "" | the name of (a symlink to) a directory in which to check-out files under --root (defaults to the leaf dir of --repo) |
| `--wait` | GIT_SYNC_WAIT | 1 (second) | the number of seconds between syncs | | `--wait` | GIT_SYNC_WAIT | 1 (second) | the number of seconds between syncs |
| `--timeout` | GIT_SYNC_TIMEOUT | 120 | the max number of seconds allowed for a complete sync |
| `--one-time` | GIT_SYNC_ONE_TIME | false | exit after the first sync | | `--one-time` | GIT_SYNC_ONE_TIME | false | exit after the first sync |
| `--max-sync-failures` | GIT_SYNC_MAX_SYNC_FAILURES | 0 | the number of consecutive failures allowed before aborting (the first sync must succeed, -1 will retry forever after the initial sync) | | `--max-sync-failures` | GIT_SYNC_MAX_SYNC_FAILURES | 0 | the number of consecutive failures allowed before aborting (the first sync must succeed, -1 will retry forever after the initial sync) |
| `--change-permissions` | GIT_SYNC_PERMISSIONS | 0 | the file permissions to apply to the checked-out files (0 will not change permissions at all) | | `-v` | (none) | "" | log level for V logs |
## Flags which control how git runs
| Flag | Environment Variable | Default | Description |
|----------------------------|---------------------------------|-------------------------------|-------------|
| `--depth` | GIT_SYNC_DEPTH | 0 | use a shallow clone with a history truncated to the specified number of commits |
| `--submodules` | GIT_SYNC_SUBMODULES | recursive | git submodule behavior: one of 'recursive', 'shallow', or 'off' |
| `--timeout` | GIT_SYNC_TIMEOUT | 120 | the max number of seconds allowed for a complete sync |
| `--sparse-checkout-file` | GIT_SYNC_SPARSE_CHECKOUT_FILE | "" | the location of an optional [sparse-checkout](https://git-scm.com/docs/git-sparse-checkout#_sparse_checkout) file, same syntax as a .gitignore file. | | `--sparse-checkout-file` | GIT_SYNC_SPARSE_CHECKOUT_FILE | "" | the location of an optional [sparse-checkout](https://git-scm.com/docs/git-sparse-checkout#_sparse_checkout) file, same syntax as a .gitignore file. |
| `--sync-hook-command` | GIT_SYNC_HOOK_COMMAND | "" | DEPRECATED: use --exechook-command instead | | `--git-config` | GIT_SYNC_GIT_CONFIG | "" | additional git config options in 'key1:val1,key2:val2' format |
| `--exechook-command` | GIT_SYNC_EXECHOOK_COMMAND | "" | the command executed with the syncing repository as its working directory after syncing a new hash of the remote repository. it is subject to the sync time out and will extend period between syncs. (doesn't support the command arguments) | | `--git-gc` | GIT_SYNC_GIT_GC | "auto" | git garbage collection behavior: one of 'auto', 'always', 'aggressive', or 'off' |
| `--exechook-timeout` | GIT_SYNC_EXECHOOK_TIMEOUT | 30 (seconds) | the timeout for the sync hook command | | `--git` | GIT_SYNC_GIT | "git" | the git command to run (subject to PATH search, mostly for testing |
| `--exechook-backoff` | GIT_SYNC_EXECHOOK_BACKOFF | 3 (seconds) | the time to wait before retrying a failed sync hook command |
| `--webhook-url` | GIT_SYNC_WEBHOOK_URL | "" | the URL for a webhook notification when syncs complete | ## Flags which configure authentication
| `--webhook-method` | GIT_SYNC_WEBHOOK_METHOD | "POST" | the HTTP method for the webhook |
| `--webhook-success-status` | GIT_SYNC_WEBHOOK_SUCCESS_STATUS | 200 | the HTTP status code indicating a successful webhook (-1 disables success checks to make webhooks fire-and-forget) | | Flag | Environment Variable | Default | Description |
| `--webhook-timeout` | GIT_SYNC_WEBHOOK_TIMEOUT | 1 (second) | the timeout for the webhook | |----------------------------|---------------------------------|-------------------------------|-------------|
| `--webhook-backoff` | GIT_SYNC_WEBHOOK_BACKOFF | 3 (seconds) | the time to wait before retrying a failed webhook |
| `--username` | GIT_SYNC_USERNAME | "" | the username to use for git auth | | `--username` | GIT_SYNC_USERNAME | "" | the username to use for git auth |
| `--password` | GIT_SYNC_PASSWORD | "" | the password or [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) to use for git auth. (users should prefer --password-file or env vars for passwords) | | `--password` | GIT_SYNC_PASSWORD | "" | the password or [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) to use for git auth. (users should prefer --password-file or env vars for passwords) |
| `--password-file` | GIT_SYNC_PASSWORD_FILE | "" | the path to password file which contains password or personal access token (see --password) | | `--password-file` | GIT_SYNC_PASSWORD_FILE | "" | the path to password file which contains password or personal access token (see --password) |
@ -119,11 +124,31 @@ docker run -d \
| `--add-user` | GIT_SYNC_ADD_USER | false | add a record to /etc/passwd for the current UID/GID (needed to use SSH with a different UID) | | `--add-user` | GIT_SYNC_ADD_USER | false | add a record to /etc/passwd for the current UID/GID (needed to use SSH with a different UID) |
| `--cookie-file` | GIT_COOKIE_FILE | false | use git cookiefile | | `--cookie-file` | GIT_COOKIE_FILE | false | use git cookiefile |
| `--askpass-url` | GIT_ASKPASS_URL | "" | the URL for GIT_ASKPASS callback | | `--askpass-url` | GIT_ASKPASS_URL | "" | the URL for GIT_ASKPASS callback |
| `--git` | GIT_SYNC_GIT | "git" | the git command to run (subject to PATH search, mostly for testing |
## Flags which configure hooks
| Flag | Environment Variable | Default | Description |
|----------------------------|---------------------------------|-------------------------------|-------------|
| `--exechook-command` | GIT_SYNC_EXECHOOK_COMMAND | "" | the command executed with the syncing repository as its working directory after syncing a new hash of the remote repository. it is subject to the sync time out and will extend period between syncs. (doesn't support the command arguments) |
| `--exechook-timeout` | GIT_SYNC_EXECHOOK_TIMEOUT | 30 (seconds) | the timeout for the sync hook command |
| `--exechook-backoff` | GIT_SYNC_EXECHOOK_BACKOFF | 3 (seconds) | the time to wait before retrying a failed sync hook command |
| `--webhook-url` | GIT_SYNC_WEBHOOK_URL | "" | the URL for a webhook notification when syncs complete |
| `--webhook-method` | GIT_SYNC_WEBHOOK_METHOD | "POST" | the HTTP method for the webhook |
| `--webhook-success-status` | GIT_SYNC_WEBHOOK_SUCCESS_STATUS | 200 | the HTTP status code indicating a successful webhook (-1 disables success checks to make webhooks fire-and-forget) |
| `--webhook-timeout` | GIT_SYNC_WEBHOOK_TIMEOUT | 1 (second) | the timeout for the webhook |
| `--webhook-backoff` | GIT_SYNC_WEBHOOK_BACKOFF | 3 (seconds) | the time to wait before retrying a failed webhook |
## Flags which configure observability
| Flag | Environment Variable | Default | Description |
|----------------------------|---------------------------------|-------------------------------|-------------|
| `--http-bind` | GIT_SYNC_HTTP_BIND | "" | the bind address (including port) for git-sync's HTTP endpoint | | `--http-bind` | GIT_SYNC_HTTP_BIND | "" | the bind address (including port) for git-sync's HTTP endpoint |
| `--http-metrics` | GIT_SYNC_HTTP_METRICS | true | enable metrics on git-sync's HTTP endpoint | | `--http-metrics` | GIT_SYNC_HTTP_METRICS | true | enable metrics on git-sync's HTTP endpoint |
| `--http-pprof` | GIT_SYNC_HTTP_PPROF | false | enable the pprof debug endpoints on git-sync's HTTP endpoint | | `--http-pprof` | GIT_SYNC_HTTP_PPROF | false | enable the pprof debug endpoints on git-sync's HTTP endpoint |
| `--git-config` | GIT_SYNC_GIT_CONFIG | "" | additional git config options in 'key1:val1,key2:val2' format |
| `--git-gc` | GIT_SYNC_GIT_GC | "auto" | git garbage collection behavior: one of 'auto', 'always', 'aggressive', or 'off' | ## Other flags
| Flag | Environment Variable | Default | Description |
|----------------------------|---------------------------------|-------------------------------|-------------|
| `--change-permissions` | GIT_SYNC_PERMISSIONS | 0 | the file permissions to apply to the checked-out files (0 will not change permissions at all) |
| `--error-file` | GIT_SYNC_ERROR_FILE | "" | the name of a file into which errors will be written under --root | | `--error-file` | GIT_SYNC_ERROR_FILE | "" | the name of a file into which errors will be written under --root |
| `-v` | (none) | "" | log level for V logs |