chaos/docker-salt-master
Archived
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Change default registry

Browse Source
This commit is contained in:
Carlos Álvaro
2022-09-28 09:07:03 +02:00
parent e2b22c388b
commit 56c976d72c
4 changed files with 32 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/build-and-test.yml vendored
View File

@@ -7,6 +7,10 @@ on:
paths-ignore: paths-ignore:
- "./**/*.md" - "./**/*.md"
- "LICENSE" - "LICENSE"
- 'social/'
- '.gitignore'
- 'docker-compose.yml'
- 'Makefile'
env: env:
IMAGE_NAME: localhost:5000/cdalvaro/docker-salt-master:${{ github.sha }} IMAGE_NAME: localhost:5000/cdalvaro/docker-salt-master:${{ github.sha }}

8
.github/workflows/publish.yml vendored
View File

@@ -5,8 +5,12 @@ on:
branches: branches:
- main - main
paths-ignore: paths-ignore:
- './**/*.md' - "./**/*.md"
- 'LICENSE' - "LICENSE"
- 'social/'
- '.gitignore'
- 'docker-compose.yml'
- 'Makefile'
release: release:
types: types:
- published - published

40
README.md
View File

@@ -19,24 +19,25 @@ the [Official Salt Project Installation Guide](https://docs.saltproject.io/en/la
## 🐳 Installation ## 🐳 Installation
Automated builds of the image are available on [Dockerhub](https://hub.docker.com/r/cdalvaro/docker-salt-master/) and is Automated builds of the image are available on
[GitHub Container Registry](https://github.com/cdalvaro/docker-salt-master/pkgs/container/docker-salt-master) and is
the recommended method of installation. the recommended method of installation.
```sh ```sh
docker pull cdalvaro/docker-salt-master:3005 docker pull ghcr.io/cdalvaro/docker-salt-master:3005_1
``` ```
You can also pull the latest tag which is built from the repository `HEAD` You can also pull the latest tag which is built from the repository `HEAD`
```sh ```sh
docker pull cdalvaro/docker-salt-master:latest docker pull ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
These images are also available These images are also available
from [GitHub Container Registry](https://github.com/users/cdalvaro/packages/container/package/docker-salt-master): from [Docker Registry](https://hub.docker.com/r/cdalvaro/docker-salt-master):
```sh ```sh
docker pull ghcr.io/cdalvaro/docker-salt-master:latest docker pull cdalvaro/docker-salt-master:latest
``` ```
and from [Quay.io](https://quay.io/repository/cdalvaro/docker-salt-master): and from [Quay.io](https://quay.io/repository/cdalvaro/docker-salt-master):
@@ -73,7 +74,7 @@ docker run --name salt_master --detach \
--env 'SALT_LOG_LEVEL=info' \ --env 'SALT_LOG_LEVEL=info' \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
## ⚙️ Configuration ## ⚙️ Configuration
@@ -111,7 +112,7 @@ docker run --name salt_master -d \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
--volume $(pwd)/config/:/home/salt/data/config/ \ --volume $(pwd)/config/:/home/salt/data/config/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
This image provides support for automatically restart `salt-master` when configuration files change. This image provides support for automatically restart `salt-master` when configuration files change.
@@ -141,7 +142,7 @@ docker run --name salt_master -d \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
--volume $(pwd)/config/:/home/salt/data/config/ \ --volume $(pwd)/config/:/home/salt/data/config/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
Also, you can set your `docker-salt-master` instance to auto accept minions that match certain grains. To do that, add Also, you can set your `docker-salt-master` instance to auto accept minions that match certain grains. To do that, add
@@ -184,7 +185,7 @@ docker run --name salt_stack --detach \
--env 'SALT_MASTER_SIGN_PUBKEY=True' \ --env 'SALT_MASTER_SIGN_PUBKEY=True' \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
The container will create the `master_sign` key and its signature. More information about how to configure the minion The container will create the `master_sign` key and its signature. More information about how to configure the minion
@@ -197,7 +198,7 @@ Additionally, you can generate new keys by executing the following command:
```sh ```sh
docker run --name salt_stack -it --rm \ docker run --name salt_stack -it --rm \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
cdalvaro/docker-salt-master:latest \ ghcr.io/cdalvaro/docker-salt-master:latest \
app:gen-signed-keys new_master_sign app:gen-signed-keys new_master_sign
``` ```
@@ -221,7 +222,7 @@ version: '3.9'
services: services:
salt-master: salt-master:
image: cdalvaro/docker-salt-master:latest image: ghcr.io/cdalvaro/docker-salt-master:latest
ports: ports:
- "4505:4505" - "4505:4505"
- "4506:4506" - "4506:4506"
@@ -297,7 +298,7 @@ docker run --name salt_stack --detach \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
--volume $(pwd)/config/:/home/salt/data/config/ \ --volume $(pwd)/config/:/home/salt/data/config/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
If you choose using the [docker-compose.yml](docker-compose.yml) to manage your salt-master instance, uncomment salt-api If you choose using the [docker-compose.yml](docker-compose.yml) to manage your salt-master instance, uncomment salt-api
@@ -383,7 +384,7 @@ docker run --name salt_stack -it --rm \
--env "PUID=$(id -u)" --env "PGID=$(id -g)" \ --env "PUID=$(id -u)" --env "PGID=$(id -g)" \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
### Git Fileserver ### Git Fileserver
@@ -486,7 +487,7 @@ docker run --name salt_stack -it --rm \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/3pfs/:/home/salt/data/3pfs/ \ --volume $(pwd)/3pfs/:/home/salt/data/3pfs/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
If you need to add more third party formulas, you can restart the container, or you can type the following command: If you need to add more third party formulas, you can restart the container, or you can type the following command:
@@ -511,7 +512,7 @@ docker run --name salt_master --detach \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
--volume $(pwd)/logs/:/home/salt/data/logs/ \ --volume $(pwd)/logs/:/home/salt/data/logs/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
Check [Available Configuration Parameters](#available-configuration-parameters) section for configuring logrotate. Check [Available Configuration Parameters](#available-configuration-parameters) section for configuring logrotate.
@@ -523,7 +524,8 @@ script: `/usr/local/sbin/healthcheck` (although it is disabled by default). It i
service is alive and responding. service is alive and responding.
If you are running this image under k8s, you can define a _liveness command_ as If you are running this image under k8s, you can define a _liveness command_ as
explained [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-command). explained [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-command)
.
If you use `docker-compose` as your container orchestrator, you can add the following entries to your compose file: If you use `docker-compose` as your container orchestrator, you can add the following entries to your compose file:
@@ -533,7 +535,7 @@ version: "3.4"
services: services:
master: master:
container_name: salt_master container_name: salt_master
image: cdalvaro/docker-salt-master:latest image: ghcr.io/cdalvaro/docker-salt-master:latest
healthcheck: healthcheck:
test: [ "CMD", "/usr/local/sbin/healthcheck" ] test: [ "CMD", "/usr/local/sbin/healthcheck" ]
start_period: 30s start_period: 30s
@@ -553,7 +555,7 @@ docker run --name salt_master --detach \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
--volume $(pwd)/logs/:/home/salt/data/logs/ \ --volume $(pwd)/logs/:/home/salt/data/logs/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
Then you can manually check this info by running the following command: Then you can manually check this info by running the following command:
@@ -655,7 +657,7 @@ docker run --name salt_master -d \
--volume $(pwd)/roots/:/home/salt/data/srv/ \ --volume $(pwd)/roots/:/home/salt/data/srv/ \
--volume $(pwd)/keys/:/home/salt/data/keys/ \ --volume $(pwd)/keys/:/home/salt/data/keys/ \
--volume $(pwd)/config/:/home/salt/data/config/ \ --volume $(pwd)/config/:/home/salt/data/config/ \
cdalvaro/docker-salt-master:latest ghcr.io/cdalvaro/docker-salt-master:latest
``` ```
## 🧑‍🚀 Usage ## 🧑‍🚀 Usage

2
docker-compose.yml
View File

@@ -3,7 +3,7 @@ version: '3.9'
services: services:
master: master:
container_name: salt_master container_name: salt_master
image: cdalvaro/docker-salt-master:latest image: ghcr.io/cdalvaro/docker-salt-master:latest
restart: always restart: always
volumes: volumes:
- "roots/:/home/salt/data/srv" - "roots/:/home/salt/data/srv"