https://github.com/microdevops-com/salt-project-template

Salt Project Template
https://github.com/microdevops-com/salt-project-template

saltstack

Last synced: about 2 months ago
JSON representation

Salt Project Template

• Host: GitHub
• URL: https://github.com/microdevops-com/salt-project-template
• Owner: microdevops-com
• License: gpl-3.0
• Created: 2019-08-22T19:02:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-13T05:27:53.000Z (2 months ago)
• Last Synced: 2024-11-13T06:21:44.942Z (2 months ago)
• Topics: saltstack
• Language: Shell
• Homepage:
• Size: 95.4 MB
• Stars: 2
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# About

Project Template for Salt Masters /srv.

# Prepare the repository

Create empty Git repo:

```

mkdir example-salt

cd example-salt

git init 

```

Add this repo as Git Submodule to a project:

```

git submodule add --name .salt-project-template -b master -- https://github.com/microdevops-com/salt-project-template .salt-project-template

```

Copy example `template_install.sh` from template to the repo:

```

cp .salt-project-template/template_install.sh.example template_install.sh

```

Edit `template_install.sh` depending on your needs.

Run template install:

```

./template_install.sh

```

Fill the repo with some additional data:

- `README.md`

- `pillar/top_sls` files (see pillar/top_sls/srv1.example.com.example)

- `pillar/bootstrap` files (see pillar/bootstrap/.../srv1_example_com.example)

- `pillar/users/example/admins.sls`

- `pillar/ip/example/example.sls` (see pillar/ip/example/example.sls.example)

- `pillar/ufw_simple/vars.jinja` (see pillar/ufw_simple/vars.jinja.example) or `pillar/ufw/vars.jinja` (see pillar/ufw/vars.jinja.example)

- `pillar/hosts/example.sls` (see https://github.com/microdevops-com/microdevops-formula/blob/master/hosts/pillar.example - static hosts file, recommended to distribute heartbeat_receivers, alerta hosts here)

For Salt-SSH:

- `etc/salt/roster` (see roster.example in `.salt-project-template`)

# Use the repository

Either push to GitLab and pipeline should deploy depo code to Salt Masters or build the docker image

Then use [Gitlab Pipelines](https://github.com/microdevops-com/gitlab-server-job) to run salt/salt-ssh.

Or build and run locally for Salt-SSH with SSH Agent:

```

docker build --pull -t example-salt:latest .

docker run -it --rm -v $SSH_AUTH_SOCK:/root/.ssh-agent -e SSH_AUTH_SOCK=/root/.ssh-agent example-salt:latest

salt-ssh srv1.example.com test.ping

```