SaltStack安装以及简单应用
1. SaltStack介绍
// 自动化运维工具
作为一个运维人员,很大一部分工作是在业务的配置管理和状态维护以及版本发布上,而当业务场景及公司规模上了一定规模后,人为手工的去做这些工作将变得极其困难,此时我们将需要利用一些自动化运维的工具来达到批量管理的目的。
常用的自动化运维工具有:
puppet
ansible
saltstack
此三款属同类工具,皆可用来提高运维管理的效率,但它们又各有优势,目前主流的自动化运维工具是ansible和saltstack。其中ansible无需安装客户端,这是其最大的优势,而saltstack则需要安装客户端工具,类似zabbix的agent。应用场景方面,ansible常用于小型企业,而saltstack则常用于中大型企业,因为ansible无法并行执行而saltstack可以并行。但不论其特点如何,本质上均属同类,所以只需要掌握一种即可轻松胜任运维工作。
// saltstack的特点
基于python开发的C/S架构配置管理工具
底层使用ZeroMQ消息队列pub/sub方式通信
使用SSL证书签发的方式进行认证管理,传输采用AES加密
// saltstack服务架构
在saltstack架构中服务器端叫Master,客户端叫Minion。
在Master和Minion端都是以守护进程的模式运行,一直监听配置文件里面定义的ret_port(接受minion请求)和publish_port(发布消息)的端口。
当Minion运行时会自动连接到配置文件里面定义的Master地址ret_port端口进行连接认证。
saltstack除了传统的C/S架构外,其实还有一种叫做masterless的架构,其不需要单独安装一台 master 服务器,只需要在每台机器上安装 Minion端,然后采用本机只负责对本机的配置管理机制服务的模式。
2. SaltStack四大功能与四大运行方式
SaltStack有四大功能,分别是:
远程执行
配置管理/状态管理
云管理(cloud)
事件驱动
SaltStack可以通过远程执行实现批量管理,并且通过描述状态来达到实现某些功能的目的。
SaltStack四大运行方式:
local本地运行
Master/Minion传统方式
Syndic分布式
Salt ssh
3. SaltStack组件介绍
组件 | 功能 |
---|---|
Salt Master | 用于将命令和配置发送到在受管系统上运行的Salt minion |
Salt Minions | 从Salt master接收命令和配置 |
Execution Modules | 从命令行针对一个或多个受管系统执行的临时命令。对…有用: 1. 实时监控,状态和库存 2. 一次性命令和脚本 3. 部署关键更新 |
Formulas (States) | 系统配置的声明性或命令式表示 |
Grains | Grains是有关底层受管系统的静态信息,包括操作系统,内存和许多其他系统属性。 |
Pillar | 用户定义的变量。这些安全变量被定义并存储在Salt Master中,然后使用目标“分配”给一个或多个Minion。 Pillar数据存储诸如端口,文件路径,配置参数和密码之类的值。 |
Top File | 将Formulas (States)和Salt Pillar数据与Salt minions匹配。 |
Runners | 在Salt master上执行的模块,用于执行支持任务。 Salt runners报告作业状态,连接状态,从外部API读取数据,查询连接的Salt minions等。 |
Returners | 将Salt minions返回的数据发送到另一个系统,例如数据库。 Salt Returners可以在Salt minion或Salt master上运行。 |
Reactor | 在SaltStack环境中发生事件时触发反应。 |
Salt Cloud / Salt Virt | 在云提供商/虚拟机管理程序上提供系统,并立即将其置于管理之下。 |
Salt SSH | 在没有Salt minion的系统上通过SSH运行Salt命令。 |
4. SaltStack安装与最小化配置
环境说明:
主机类型 | IP | 要安装的应用 |
---|---|---|
控制机 | 192.168.116.180 | salt salt-cloud salt-master salt-minion salt-ssh salt-syndic |
被控机 | 192.168.116.145 | salt-minion |
官方yum源地址:https://repo.saltstack.com
Python 2已被弃用,并且从3001版本开始不再受支持。
4.1 在控制机上安装saltstack主控端软件
//配置yum源
[root@xian ~]# wget https://repo.saltstack.com/yum/redhat/salt-repo-latest-2.el7.noarch.rpm
[root@xian ~]# yum -y localinstall salt-repo-latest-2.el7.noarch.rpm
Retrieving https://repo.saltstack.com/yum/redhat/salt-repo-latest-2.el7.noarch.rpm
Preparing... ################################# [100%]
Updating / installing...
1:salt-repo-latest-2.el7 ################################# [100%]
[root@xian ~]# yum clean all
Loaded plugins: fastestmirror
Cleaning repos: base centos-sclo-rh centos-sclo-sclo extras
: proxysql_repo salt-latest updates
Cleaning up everything
Maybe you want: rm -rf /var/cache/yum, to also free up space taken by orphaned data from disabled or removed repos
Cleaning up list of fastest mirrors
//安装saltstack主控端
[root@xian ~]# yum -y install salt salt-master salt-minion salt-ssh salt-syndic
//修改主控端的配置文件
[root@xian yum.repos.d]# sed -i '/^#master:/a master: 192.168.116.180' /etc/salt/minion
[root@xian yum.repos.d]# sed -n '/^master/p' /etc/salt/minion
master: 192.168.116.180
//启动主控端的salt-master和salt-minion,并设置开机自启
[root@xian ~]# systemctl enable --now salt-master salt-minion
Created symlink from /etc/systemd/system/multi-user.target.wants/salt-master.service to /usr/lib/systemd/system/salt-master.service.
Created symlink from /etc/systemd/system/multi-user.target.wants/salt-minion.service to /usr/lib/systemd/system/salt-minion.service.
[root@xian ~]# ss -antl
State Recv-Q Send-Q Local Address:Port Peer Address:Port
LISTEN 0 128 *:22 *:*
LISTEN 0 128 *:4505(发布) *:*
LISTEN 0 100 127.0.0.1:25 *:*
LISTEN 0 128 *:4506(接收) *:*
LISTEN 0 128 :::22 :::*
LISTEN 0 100 ::1:25 :::*
4.2 在被控机上安装salt-minion客户端
//配置yum源
[root@yeqixian ~]# rpm -ivh https://repo.saltstack.com/yum/redhat/salt-repo-latest-2.el7.noarch.rpm
Retrieving https://repo.saltstack.com/yum/redhat/salt-repo-latest-2.el7.noarch.rpm
Preparing... ################################# [100%]
Updating / installing...
1:salt-repo-latest-2.el7 ################################# [100%]
[root@yeqixian ~]# yum clean all
Loaded plugins: fastestmirror
Cleaning repos: salt-latest yei
Cleaning up everything
Maybe you want: rm -rf /var/cache/yum, to also free up space taken by orphaned data from disabled or removed repos
Cleaning up list of fastest mirrors
[root@yeqixian ~]# yum -y install salt-minion
//修改被控端的配置文件,将master设为主控端的IP
[root@yeqixian ~]# sed -i '/^#master:/a master: 192.168.116.180' /etc/salt/minion
[root@yeqixian ~]# sed -n '/^master/p' /etc/salt/minion
master: 192.168.116.180
//启动受控端的salt-minion并设置开机自启
[root@yeqixian ~]# systemctl enable --now salt-minion
Created symlink from /etc/systemd/system/multi-user.target.wants/salt-minion.service to /usr/lib/systemd/system/salt-minion.service.
4.3 saltstack配置文件
saltstack的配置文件在/etc/salt目录
saltstack配置文件说明:
配置文件 | 说明 |
---|---|
/etc/salt/master | 主控端(控制端)配置文件 |
/etc/salt/minion | 受控端配置文件 |
配置文件/etc/salt/master默认的配置就可以很好的工作,故无需修改此配置文件。
配置文件/etc/salt/minion常用配置参数
- master:设置主控端的IP
- id:设置受控端本机的唯一标识符,可以是ip也可以是主机名或自取某有意义的单词
在日常使用过程中,经常需要调整或修改Master配置文件,SaltStack大部分配置都已经指定了默认值,只需根据自己的实际需求进行修改即可。下面的几个参数是比较重要的
- max_open_files:可根据Master将Minion数量进行适当的调整
- timeout:可根据Master和Minion的网络状况适当调整
- auto_accept和autosign_file:在大规模部署Minion时可设置自动签证
- master_tops和所有以external开头的参数:这些参数是SaltStack与外部系统进行整合的相关配置参数
5. SaltStack认证机制
saltstack主控端是依靠openssl证书来与受控端主机认证通讯的,受控端启动后会发送给主控端一个公钥证书文件,在主控端用salt-key命令来管理证书。
salt-minion与salt-master的认证过程:
minion在第一次启动时,会在/etc/salt/pki/minion/下自动生成一对密钥,然后将公钥发给master
master收到minion的公钥后,通过salt-key命令接受该公钥。此时master的/etc/salt/pki/master/minions目录将会存放以minion id命名的公钥,然后master就能对minion发送控制指令了
//salt-key常用选项
-L //列出所有公钥信息
-a minion //接受指定minion等待认证的key
-A //接受所有minion等待认证的key
-r minion //拒绝指定minion等待认证的key
-R //拒绝所有minion等待认证的key
-f minion //显示指定key的指纹信息
-F //显示所有key的指纹信息
-d minion //删除指定minion的key
-D //删除所有minion的key
-y //自动回答yes
//查看当前证书情况
[root@xian salt]# tree pki
pki
├── master
│ ├── master.pem
│ ├── master.pub
│ ├── minions(接受的公钥)
│ ├── minions_autosign
│ ├── minions_denied
│ ├── minions_pre(未接受的公钥)
│ │ ├── xian
│ │ └── yeqixian
│ └── minions_rejected
└── minion
├── minion.pem
└── minion.pub
[root@xian salt]# salt-key -L
Accepted Keys:
Denied Keys:
Unaccepted Keys:
xian
yeqixian
Rejected Keys:
//接受指定minion的新证书
[root@xian salt]# salt-key -ya xian
The following keys are going to be accepted:
Unaccepted Keys:
xian
Key for minion xian accepted.
[root@xian salt]# salt-key -L
Accepted Keys:
xian
Denied Keys:
Unaccepted Keys:
yeqixian
Rejected Keys:
//接受所有minion的新证书
[root@xian salt]# salt-key -yA
The following keys are going to be accepted:
Unaccepted Keys:
yeqixian
Key for minion yeqixian accepted.
[root@xian salt]# salt-key -L
Accepted Keys:
xian
yeqixian
Denied Keys:
Unaccepted Keys:
Rejected Keys:
6. SaltStack远程执行
//测试指定受控端hostname=xian主机是否存活
[root@xian salt]# salt "xian" test.ping
xian:
True
[root@xian salt]# salt 'xi*' test.ping
xian:
True
//测试所有受控端主机是否存活
[root@xian salt]# salt '*' test.ping
xian:
True
yeqixian:
True
//万能命令cmd.run
[root@xian salt]# salt '*' cmd.run 'touch /tmp/abc'
7. salt命令使用
//语法:salt [options] '<target>' <function> [arguments]
//常用的options
--version //查看saltstack的版本号
--versions-report //查看saltstack以及依赖包的版本号
-h //查看帮助信息
-c CONFIG_DIR //指定配置文件目录(默认为/etc/salt/)
-t TIMEOUT //指定超时时间(默认是5s)
--async //异步执行
-v //verbose模式,详细显示执行过程
--username=USERNAME //指定外部认证用户名
--password=PASSWORD //指定外部认证密码
--log-file=LOG_FILE //指定日志记录文件
//常用target参数
-E //正则匹配
-L //列表匹配
-S //CIDR匹配网段
-G //grains匹配
--grain-pcre //grains加正则匹配
-N //组匹配
-R //范围匹配
-C //综合匹配(指定多个匹配)
-I //pillar值匹配
//示例
[root@xian salt]# salt -E '^xi*' test.ping
xian:
True
[root@xian salt]# salt -L xian,yeqixian test.ping
xian:
True
yeqixian:
True
[root@xian salt]# salt -S '192.168.116.0/24' test.ping
xian:
True
yeqixian:
True
[root@xian salt]# salt -G 'os:CentOS' test.ping
yeqixian:
True
xian:
True
[root@master ~]# salt -N centos test.ping
yeqixian:
True
xian:
True
//此处的centos是一个组名,需要在master配置文件中定义nodegroups参数,且需要知道minion的id信 \
//息才能将其定义至某个组中
[root@xian salt]# salt -C 'G@os:CentOS or L@xian' test.ping
xian:
True
yeqixian:
True
//G@os:CentOS or L@xian是一个复合组合,支持使用and和or关联多个条件
8. YAML语言
YAML是一种直观的能够被电脑识别的数据序列化格式,是一个可读性高并且容易被人类阅读,容易和脚本语言交互,用来表达资料序列的编程语言。
它类似于标准通用标记语言的子集XML的数据描述语言,语法比XML简单很多。
//YAML语言的格式如下:
house:
family:
name: Doe
parents:
- John
- Jane
children:
- Paul
- Mark
- Simone
address:
number: 34
street: Main Street
city: Nowheretown
zipcode: 12345
YAML的基本规则:
使用缩进来表示层级关系,每层2个空格,禁止使用TAB键
当冒号不是处于最后时,冒号后面必须有一个空格
用 - 表示列表,- 的后面必须有一个空格
用 # 表示注释
YAML配置文件要放到SaltStack让我们放的位置,可以在SaltStack的 Master 配置文件中查找file_roots即可看到。
[root@xian ~]# vim /etc/salt/master
# Example:
# file_roots:
# base:
# - /srv/salt/
# dev:
# - /srv/salt/dev/services
# - /srv/salt/dev/states
# prod:
# - /srv/salt/prod/services
# - /srv/salt/prod/states
#
添加以下文本
file_roots:
base:
- /srv/salt/base
test:
- /srv/salt/test
dev:
- /srv/salt/dev
prod:
- /srv/salt/prod
[root@xian ~]# mkdir -p /srv/salt/{base,test,dev,prod}
[root@xian ~]# tree /srv/salt/
/srv/salt/
├── base
├── dev
├── prod
└── test
4 directories, 0 files
[root@xian ~]# systemctl restart salt-master
需要注意:
- base是默认的位置,如果file_roots只有一个,则base是必备的且必须叫base,不能改名
9. 用SaltStack配置一个Nginx实例
9.1 在Master上部署sls配置文件并执行
[root@xian ~]# cd /srv/salt/base/
[root@xian base]# mkdir -p web/nginx
[root@xian base]# cd web/nginx
[root@xian nginx]# vim nginx.sls
nginx-install:
pkg.installed:
- name: nginx
nginx-service:
service.running:
- name: nginx
- enable: True
[root@xian nginx]# ls
nginx.sls
// YAML 配置文件中顶格写的被称作ID,必须全局唯一,不能重复
// SaltStack 读 YAML 配置文件时是从上往下读,所以要把先执行的写在前面
//执行状态描述文件
[root@xian ~]# salt 'yeqixian' state.sls web.nginx.nginx
yeqixian:
----------
ID: nginx-install
Function: pkg.installed
Name: nginx
Result: True
Comment: The following packages were installed/updated: nginx
Started: 17:19:14.285049
Duration: 5873.81 ms
Changes:
----------
centos-indexhtml:
----------
new:
7-9.el7.centos
old:
gperftools-libs:
----------
new:
2.6.1-1.el7
old:
nginx:
----------
new:
1:1.16.1-1.el7
old:
nginx-all-modules:
----------
new:
1:1.16.1-1.el7
old:
nginx-filesystem:
----------
new:
1:1.16.1-1.el7
old:
nginx-mod-http-image-filter:
----------
new:
1:1.16.1-1.el7
old:
nginx-mod-http-perl:
----------
new:
1:1.16.1-1.el7
old:
nginx-mod-http-xslt-filter:
----------
new:
1:1.16.1-1.el7
old:
nginx-mod-mail:
----------
new:
1:1.16.1-1.el7
old:
nginx-mod-stream:
----------
new:
1:1.16.1-1.el7
old:
----------
ID: nginx-service
Function: service.running
Name: nginx
Result: True
Comment: Service nginx has been enabled, and is running
Started: 17:19:20.165677
Duration: 215.527 ms
Changes:
----------
nginx:
True
Summary for yeqixian
------------
Succeeded: 2 (changed=2)
Failed: 0
------------
Total states run: 2
Total run time: 6.089 s
9.2 在Minion上检查
[root@yeqixian ~]# systemctl status nginx
● nginx.service - The nginx HTTP and reverse proxy server
Loaded: loaded (/usr/lib/systemd/system/nginx.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2020-08-18 17:19:20 CST; 2min 34s ago
Main PID: 4093 (nginx)
CGroup: /system.slice/nginx.service
├─4093 nginx: master process /usr/sbin/nginx
├─4094 nginx: worker process
├─4095 nginx: worker process
├─4096 nginx: worker process
├─4097 nginx: worker process
├─4098 nginx: worker process
├─4100 nginx: worker process
├─4101 nginx: worker process
└─4102 nginx: worker process
Aug 18 17:19:20 yeqixian systemd[1]: Starting The nginx HTTP and ....
Aug 18 17:19:20 yeqixian nginx[4088]: nginx: the configuration fi...k
Aug 18 17:19:20 yeqixian nginx[4088]: nginx: configuration file /...l
Aug 18 17:19:20 yeqixian systemd[1]: Started The nginx HTTP and r....
Hint: Some lines were ellipsized, use -l to show in full.
10. top file
10.1 top file介绍
直接通过命令执行sls文件时够自动化吗?答案是否定的,因为我们还要告诉某台主机要执行某个任务,自动化应该是我们让它干活时,它自己就知道哪台主机要干什么活,但是直接通过命令执行sls文件并不能达到这个目的,为了解决这个问题,top file 应运而生。
top file就是一个入口,top file的文件名可通过在 Master的配置文件中搜索top.sls找出,且此文件必须在 base 环境中,默认情况下此文件必须叫top.sls。
top file的作用就是告诉对应的主机要干什么活,比如让web服务器启动web服务,让数据库服务器安装mysql等等。
top file 实例:
[root@master ~]# cd /srv/salt/base/
[root@master base]# ls
web
[root@master base]# vim top.sls
base: //要执行状态文件的环境
'192.168.69.202': //要执行状态文件的目标
- web.apache.apache //要执行的状态文件
//停止minion的httpd
[root@minion ~]# systemctl stop httpd
[root@master base]# cd
[root@master ~]# salt '*' state.highstate //使用高级状态来执行
192.168.69.201:
----------
ID: states
Function: no.None
Result: False
Comment: No Top file or master_tops data matches found. //在top file里没找到它要干啥
Changes:
Summary for 192.168.69.201
------------
Succeeded: 0
Failed: 1
------------
Total states run: 1
Total run time: 0.000 ms
192.168.69.202:
----------
ID: apache-install
Function: pkg.installed
Name: httpd
Result: True
Comment: All specified packages are already installed
Started: 14:39:39.373195
Duration: 1207.756 ms
Changes:
----------
ID: apache-service
Function: service.running
Name: httpd
Result: True
Comment: Service httpd is already enabled, and is running
Started: 14:39:40.582298
Duration: 636.999 ms
Changes:
----------
httpd:
True
Summary for 192.168.69.202
------------
Succeeded: 2 (changed=1)
Failed: 0
------------
Total states run: 2
Total run time: 1.845 s
ERROR: Minions returned with non-zero exit code
//查看minion的httpd状态
● httpd.service - The Apache HTTP Server
Loaded: loaded (/usr/lib/systemd/system/httpd.service; enabled; vendor preset: disabled)
Active: active (running) since 三 2019-02-20 14:39:41 CST; 1min 10s ago
Docs: man:httpd(8)
man:apachectl(8)
Process: 11071 ExecStop=/bin/kill -WINCH ${MAINPID} (code=exited, status=0/SUCCESS)
Main PID: 11138 (httpd)
Status: "Total requests: 0; Current requests/sec: 0; Current traffic: 0 B/sec"
CGroup: /system.slice/httpd.service
├─11138 /usr/sbin/httpd -DFOREGROUND
├─11139 /usr/sbin/httpd -DFOREGROUND
├─11140 /usr/sbin/httpd -DFOREGROUND
├─11141 /usr/sbin/httpd -DFOREGROUND
├─11143 /usr/sbin/httpd -DFOREGROUND
└─11144 /usr/sbin/httpd -DFOREGROUND
2月 20 14:39:40 minion systemd[1]: Starting The Apache HTTP Server...
2月 20 14:39:41 minion httpd[11138]: AH00558: httpd: Could not reliably determine the server's fully ...ssage
2月 20 14:39:41 minion systemd[1]: Started The Apache HTTP Server.
Hint: Some lines were ellipsized, use -l to show in full.
注意:
若top file里面的目标是用 * 表示的,要注意的是,top file里面的 * 表示的是所有要执行状态的目标,而 salt '*' state.highstate 里面的 * 表示通知所有机器干活,而是否要干活则是由top file来指定的
10.2 高级状态highstate的使用
管理SaltStack时一般最常用的管理操作就是执行高级状态
[root@master ~]# salt '*' state.highstate //生产环境禁止这样使用salt命令
注意:
上面让所有人执行高级状态,但实际工作当中,一般不会这么用,工作当中一般都是通知某台或某些台目标主机来执行高级状态,具体是否执行则是由top file来决定的。
若在执行高级状态时加上参数test=True,则它会告诉我们它将会做什么,但是它不会真的去执行这个操作。
//停掉minon上的httpd服务
[root@minion ~]# systemctl stop httpd
[root@minion ~]# systemctl status httpd
● httpd.service - The Apache HTTP Server
Loaded: loaded (/usr/lib/systemd/system/httpd.service; enabled; vendor preset: disabled)
Active: inactive (dead) since 三 2019-02-20 14:58:04 CST; 22s ago
Docs: man:httpd(8)
man:apachectl(8)
Process: 12401 ExecStop=/bin/kill -WINCH ${MAINPID} (code=exited, status=0/SUCCESS)
Process: 11138 ExecStart=/usr/sbin/httpd $OPTIONS -DFOREGROUND (code=exited, status=0/SUCCESS)
Main PID: 11138 (code=exited, status=0/SUCCESS)
Status: "Total requests: 0; Current requests/sec: 0; Current traffic: 0 B/sec"
2月 20 14:39:40 minion systemd[1]: Starting The Apache HTTP Server...
2月 20 14:39:41 minion httpd[11138]: AH00558: httpd: Could not reliably determine the server's fully ...ssage
2月 20 14:39:41 minion systemd[1]: Started The Apache HTTP Server.
2月 20 14:58:03 minion systemd[1]: Stopping The Apache HTTP Server...
2月 20 14:58:04 minion systemd[1]: Stopped The Apache HTTP Server.
Hint: Some lines were ellipsized, use -l to show in full.
//在master上执行高级状态的测试
[root@master ~]# salt '192.168.69.202' state.highstate test=True
192.168.69.202:
----------
ID: apache-install
Function: pkg.installed
Name: httpd
Result: True
Comment: All specified packages are already installed
Started: 14:58:50.450451
Duration: 1055.942 ms
Changes:
----------
ID: apache-service
Function: service.running
Name: httpd
Result: None
Comment: Service httpd is set to start //将会启动httpd
Started: 14:58:51.508031
Duration: 57.505 ms
Changes:
Summary for 192.168.69.202
------------
Succeeded: 2 (unchanged=1)
Failed: 0
------------
Total states run: 2
Total run time: 1.113 s
//在minion上查看httpd是否启动
[root@minion ~]# systemctl status httpd
● httpd.service - The Apache HTTP Server
Loaded: loaded (/usr/lib/systemd/system/httpd.service; enabled; vendor preset: disabled)
Active: inactive (dead) since 三 2019-02-20 14:58:04 CST; 2min 27s ago
Docs: man:httpd(8)
man:apachectl(8)
Process: 12401 ExecStop=/bin/kill -WINCH ${MAINPID} (code=exited, status=0/SUCCESS)
Process: 11138 ExecStart=/usr/sbin/httpd $OPTIONS -DFOREGROUND (code=exited, status=0/SUCCESS)
Main PID: 11138 (code=exited, status=0/SUCCESS)
Status: "Total requests: 0; Current requests/sec: 0; Current traffic: 0 B/sec"
2月 20 14:39:40 minion systemd[1]: Starting The Apache HTTP Server...
2月 20 14:39:41 minion httpd[11138]: AH00558: httpd: Could not reliably determine the server's fully ...ssage
2月 20 14:39:41 minion systemd[1]: Started The Apache HTTP Server.
2月 20 14:58:03 minion systemd[1]: Stopping The Apache HTTP Server...
2月 20 14:58:04 minion systemd[1]: Stopped The Apache HTTP Server.
Hint: Some lines were ellipsized, use -l to show in full.
//由此可见高级状态并没有执行,因为httpd并没有启动