doc(README): Remove GitPython section (not recommended)
This commit is contained in:
Carlos Álvaro
committed by
Carlos Álvaro
Carlos Álvaro
parent
46c00e99e0
commit
aeaae89940
@@ -6,6 +6,8 @@ for the list of changes in SaltStack.
|
||||
|
||||
**3005.1_2**
|
||||
|
||||
- Remove `GitPython` documentation, since it has some
|
||||
[using warnings](https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html#id2).
|
||||
- Add _Development_ section to [README.md](README.md).
|
||||
- CI(tests): Install `salt-minion` for integration tests.
|
||||
- CI(tests): Improve log support.
|
||||
|
||||
14
README.md
14
README.md
@@ -389,8 +389,7 @@ docker run --name salt_stack -it --rm \
|
||||
|
||||
### Git Fileserver
|
||||
|
||||
This image uses [GitPython](https://github.com/gitpython-developers/GitPython) and [PyGit2](https://www.pygit2.org) as
|
||||
gitfs backends to allow Salt to serve files from git repositories.
|
||||
This image uses [PyGit2](https://www.pygit2.org) as gitfs backend to allow Salt to serve files from git repositories.
|
||||
|
||||
It can be enabled by adding `gitfs` to
|
||||
the [`fileserver_backend`](https://docs.saltproject.io/en/latest/ref/configuration/master.html#std:conf_master-fileserver_backend)
|
||||
@@ -398,13 +397,6 @@ list (see [Available Configuration Parameters](#available-configuration-paramete
|
||||
repositories
|
||||
in [`gitfs_remotes`](https://docs.saltproject.io/en/latest/ref/configuration/master.html#std:conf_master-gitfs_remotes).
|
||||
|
||||
#### GitPython
|
||||
|
||||
The default name for the ssh key is `gitfs_ssh` but it can be changed with the env
|
||||
variables `SALT_GITFS_SSH_PRIVATE_KEY` and `SALT_GITFS_SSH_PUBLIC_KEY`.
|
||||
|
||||
This keys must be placed inside `/home/salt/data/keys` directory.
|
||||
|
||||
#### PyGit2
|
||||
|
||||
You can create an ssh key for pygit2 with the following command:
|
||||
@@ -608,7 +600,7 @@ Below you can find a list with the available options that can be used to customi
|
||||
installation.
|
||||
|
||||
| Parameter | Description |
|
||||
|:--------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|:--------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `DEBUG` | Set this to `True` to enable entrypoint debugging. |
|
||||
| `TIMEZONE` / `TZ` | Set the container timezone. Defaults to `UTC`. Values are expected to be in Canonical format. Example: `Europe/Madrid`. See the list of [acceptable values](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |
|
||||
| `PUID` | Sets the uid for user `salt` to the specified uid. Default: `1000`. |
|
||||
@@ -631,8 +623,6 @@ installation.
|
||||
| [`SALT_MASTER_PUBKEY_SIGNATURE`](https://docs.saltproject.io/en/latest/ref/configuration/master.html#master-pubkey-signature) | The name of the file in the master's pki-directory that holds the pre-calculated signature of the master's public-key. Default: `master_pubkey_signature`. |
|
||||
| `SALT_MASTER_PUBKEY_SIGNATURE_FILE` | The path of the salt-master public key file with the pre-calculated signature. It will be copied inside the pki directory if a file with name `SALT_MASTER_PUBKEY_SIGNATURE` doesn't exist. Useful to load the password from secrets. _Unset_ by default. |
|
||||
| `SALT_MASTER_ROOT_USER` | Forces `salt-master` to be run as `root` instead of `salt`. Default: `False`. |
|
||||
| `SALT_GITFS_SSH_PRIVATE_KEY` | The name of the ssh private key for gitfs. Default: `gitfs_ssh`. |
|
||||
| `SALT_GITFS_SSH_PUBLIC_KEY` | The name of the ssh public key for gitfs. Default: `gitfs_ssh`.pub`. |
|
||||
| [`SALT_REACTOR_WORKER_THREADS`](https://docs.saltproject.io/en/latest/ref/configuration/master.html#reactor-worker-threads) | The number of workers for the runner/wheel in the reactor. Default: `10`. |
|
||||
| [`SALT_WORKER_THREADS`](https://docs.saltproject.io/en/latest/ref/configuration/master.html#worker-threads) | The number of threads to start for receiving commands and replies from minions. Default: `5`. |
|
||||
| [`SALT_BASE_DIR`](https://docs.saltproject.io/en/latest/ref/configuration/master.html#file-roots) | The `base` path in `file_roots` to look for `salt` and `pillar` directories. Default: `/home/salt/data/srv`. |
|
||||
|
||||
@@ -29,7 +29,3 @@ SALT_MASTER_SIGN_PUBKEY=${SALT_MASTER_SIGN_PUBKEY:-False}
|
||||
SALT_MASTER_USE_PUBKEY_SIGNATURE=${SALT_MASTER_USE_PUBKEY_SIGNATURE:-False}
|
||||
SALT_MASTER_SIGN_KEY_NAME=${SALT_MASTER_SIGN_KEY_NAME:-master_sign}
|
||||
SALT_MASTER_PUBKEY_SIGNATURE=${SALT_MASTER_PUBKEY_SIGNATURE:-master_pubkey_signature}
|
||||
|
||||
##### SSH settings #####
|
||||
SALT_GITFS_SSH_PRIVATE_KEY=${SALT_GITFS_SSH_PRIVATE_KEY:-gitfs_ssh}
|
||||
SALT_GITFS_SSH_PUBLIC_KEY=${SALT_GITFS_SSH_PUBLIC_KEY:-gitfs_ssh.pub}
|
||||
|
||||
Reference in New Issue
Block a user