saltstack 基础入门文档

saltstack

简述

Salt 和 Puppet Chef 一样可以让你同时在多台服务器上执行命令也包括安装和配置软件。Salt 有两个主要的功能：配置管理和远程执行。

安装

debian/ubuntu

  • 设置debian更新源

wget -q -O- "http://debian.saltstack.com/debian-salt-team-joehealy.gpg.key" | apt-key add -echo "deb http://debian.saltstack.com/debian wheezy-saltstack main" /etc/apt/sources.list

  • 设置ubuntu更新源

add-apt-repository ppa:saltstack/salt 或 echo deb http://ppa.launchpad.net/saltstack/salt/ubuntu `lsb_release -sc` main | tee /etc/apt/sources.list.d/saltstack.listwget -q -O- "http://keyserver.ubuntu.com:11371/pks/lookup?op=get&search=0x4759FA960E27C0A6" | apt-key add -

  • 安装软件包

<pre> apt-get update apt-get install salt-master # On the salt-master apt-get install salt-minion # On each salt-minion apt-get install salt-syndic </pre>

RHEL6/CentOS6

  • 设置RHEL/CentOS更新源

rpm -Uvh http://ftp.linux.ncsu.edu/pub/epel/6/i386/epel-release-6-8.noarch.rpm或

rpm -Uvh http://ftp.linux.ncsu.edu/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm/

<pre> [epel] name=Extra Packages for Enterprise Linux 6 baseurl=http://download.fedoraproject.org/pub/epel/6/x86_64 failovermethod=priority enabled=1 gpgcheck=1 gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-6 </pre>

  • 安装软件包

<pre> yum update yum install salt-master # On the salt-master yum install salt-minion # On each salt-minion </pre>

基本配置

saltstack 的配置文件格式

Salt默认使用PyAMl语法(http://pyyaml.org) 作为它的模板文件的格式，其他很多模板语言在Salt中是可以使用的。 一定要按照正确的格式书写YAML,比如最基本的，它使用到两个空格代替tab，： 或 - 后面要有空格。

例一：

<pre> interface: 0.0.0.0 log_file: /var/log/salt/master key_logfile: /var/log/salt/key

</pre> 例二： <pre> file_roots: base: - /srv/salt </pre>

服务端配置

主控端基本设置 编辑配置文件 /etc/salt/master,修改如下所示配置项，去掉前面的注释符

<pre> interface: 0.0.0.0 # interface (服务端监听IP),0.0.0.0 是监听所有IP log_file: /var/log/salt/master # 记录主控端运行日志 key_logfile: /var/log/salt/key # 记录认证证书日志 </pre>

master默认监听两个端口， 4505(publish_port)为salt的消息发布系统，4506(ret_port)为salt客户端与服务端通信的端口,所以确保客户端能跟服务端的这2个端口通信

客户端配置

受控端基本设置 编辑配置文件 /etc/salt/minion,修改如下所示配置项，去掉前面的注释符#

<pre> master: 42.121.124.237 # 设置主控端IP id: ubuntu-server-001 # 设定受控端编号 log_file: /var/log/salt/minion # 记录受控端服务日志 key_logfile: /var/log/salt/key # 记录认证证书日志 </pre>

最基本字段:

  • master: 服务端，

  • 主机名 id: 客户端主机名(在服务端看到的客户端的名字，可以不设置，默认与hostname相同)

小技巧：查看配置文件信息，过滤注释语句

<pre> sed -e '/^#/d;/^$/d' /etc/salt/minion </pre>

检查服务

主控端，和受控端 启动各自的服务，确保服务启动后没有任何报错信息,如果异常请检查相应日志文件处理

<pre> 主控端: service salt-master restart 受控端: service salt-minion restart </pre>

证书管理

如果一切顺利，请继续！

saltstack 主控端是依靠openssl证书来与受控端主机认证通讯的，受控端启动后会发送给主控端一个公钥证书文件，在主控端用 salt-key 命令来管理证书。

salt minion和master的认证过程：

  • minion在第一次启动时，会在/etc/salt/pki/minion/下自动生成minion.pem(private key), minion.pub(public key)，然后将minion.pub发送给master

  • master在接收到minion的public key后，通过salt-key命令accept minion public key，这样在master的/etc/salt/pki/master/minions下的将会存放以minion id命名的public key, 然后master就能对minion发送指令了

<pre> salt-key -L # 用来查看证书情况 salt-key -a <hostn> # 用来管理接受证书 </pre>

受控端证书认证后会显示如下情形：

<pre> Accepted Keys: ubuntu-server-001 Unaccepted Keys: Rejected Keys: </pre>

主控端和被控端的证书默认都存放在 /etc/salt/pki/ 中，如果遇到证书不生效的情况下，可在主控端证书存放目录删除受控端证书，重新认证一下。

简单的测试

你可以从master 使用一个内置命令 test.ping 来测试他们之间的连接

<pre> salt '*' cmd.run test.ping </pre>

它应该有如下输出:

<pre> ubuntu-server-001: True </pre>

测试与外网的连接

<pre> salt '*' cmd.run "ping -c 4 baidu.com" </pre>

salt更多命令及手册

<pre> salt '*' sys.doc </pre>

如果能返回正确结果，salt的基本配置就完成了。

salt的基本使用

salt按照操作模式可以分为实时管理和配置管理：

远程执行，也可以称为实时管理： 通过执行命令来完成管理任务，优点就是实时性高，缺点就是无法跟踪，保存配置状态； 配置管理，也可以称为状态管理： 通过编写特定的文件用来记录目标系统的配置状态，然后将这些受控主机会定期同步这些配置状态信息；

实时管理

有时候我们需要临时的查看一台或多台机器上的某个文件，或者执行某个命令，最通用的模块是 cmd.run

  • 基本操作命令通用格式

<pre> 格式: 命令 对象 执行模块 参数 示例：salt '*' cmd.run "ping -c 4 baidu.com" </pre>

  • '*' target,操作对象，可以使用salt命令的扩展模式 -E -G 等

  • cmd.run func， 执行模块，函数

  • 参数 args， 传递给 执行模块的参数,

salt也将一些常用的命令做了集成,比如,查看所有节点磁盘使用情况:

<pre> salt '*' disk.usage </pre>

其他命令示例：

<pre> salt '' grains.ls 查看grains分类 salt '' grains.items 查看grains所有信息 salt '' grains.item osrelease 查看grains某个信息 salt '' pillar.items 查看pillar所有信息 </pre>

更多请参考文档：http://docs.saltstack.com/ref/modules/all/index.html

nodegroup

作用：对minion进行分组

参考文档: http://docs.saltstack.com/topics/targeting/nodegroups.html

编辑 /etc/salt/master 启用分组，最基本分组示例：

<pre> nodegroups: UBUNTU: 'ubuntu-12.04-' CENTOS: 'centos-6.4-' </pre>

建立分组之后,操作对象使用分组功能才生效，更多示例：

<pre> nodegroups: group1: 'L@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com' group2: 'G@os:Debian and foo.domain.com' </pre>

在state或者pillar中引用的时候,如下:

<pre> base: group1: - match: nodegroup

- webserver </pre>

请确保这条属性存在

<pre> - match: nodegroup </pre>

更多请参考文档：http://docs.saltstack.com/topics/targeting/nodegroups.html

targeting

从最基本的测试命令来讲述：

<pre> salt '*' test.ping </pre>

引号中以实现很强大的minion的过滤与匹配技术

常用命令:

<pre> salt 'shell正则' 命令 salt -E 'prel 正则' 命令 salt -N GroupName 命令 salt -L 'server_id1,server_id2,server_id3' 命令 </pre>

示例:

<pre> salt -C 'webserv and G@os:Debian or E@web-dc1-srv.' test.ping </pre>

更多请参考官方文档: http://docs.saltstack.com/topics/targeting/compound.html

配置管理，或称状态管理

个人理解，管理一个服务器应用可以从 软件包,配置文件,服务管理 这个三个最基本角度来出发，要启用配置管理，首先应对受控端进行额外的配置

配置受控端

配置受控端主机,以root用户身份来接受主控端主机的管理

  • 编辑/etc/salt/minion

<pre>user: root</pre>

配置主控端，开启配置管理功能

Salt的配置管理指令和文件保存在默认在/srv/salt目录下，这里存放着所有的配置文件，和一些你想要拷贝到从服务器的文件。

配置主控端，编辑 /etc/salt/master 文件

<pre> file_roots: base: - /srv/salt </pre>

手动创建目录和配置文件 /srv/salt/top.sls

  • /srv/salt/top.sls 为默认入口配置文件，这个配置项可以自定义，基本配置如下：

<pre> base: '*': - ubuntu.vim </pre>

详细解释一下这个本配置文件的参数

  • base: 默认的的起点配置项：

  • '*': 这个引号内的是匹配对象，针对所有受控主机

  • ubuntu.vim 就是指资源文件/srv/salt/ubuntu/vim.sls

一个简单的例子：ubuntu 基本系统默是不安装 vim 我们可以利用配置管理把被托管的ubuntu主机全部安装上vim

编辑 /srv/salt/ubuntu/vim.sls

<pre> vim: pkg: - name: vim - installed </pre>

执行命令

<pre>salt '*' state.highstate </pre>

请注意观察返回结果，查看/var/log/salt/下面的日志来调试saltstack配置。

稍微复杂的例子：管理ssh服务

一个更复杂的例子：管理ssh服务，并且使用salt托管配置文件

  • /srv/salt/top.sls 内容：

<pre> base: '*': - ubuntu.ssh </pre>

  • /srv/salt/ubuntu/ssh.sls

<pre> ssh: pkg: - name: ssh - installed service: - name: ssh - running - reload: True - watch: - file: /etc/ssh/ssh_config /etc/ssh/ssh_config: file.managed: - source: salt://ubuntu/ssh_config - user: root - group: root - mode: 644 </pre>

简要解释一下配置文件

  • pkg, service , file 这些都是salt的管理模块,pkg 是包管理模块; file是文件管理模块; service 是包服务管理模块

  • 模块下一级是各个管理模块配置项的属性，以 service: 模块为例

  • name: ssh ubuntu下的服务脚本名称是 ssh

  • running 状态是持续运行，如果受控端配置了自动同步，每格一段时间就会对其状态进行检查

  • reload: True 是否重载服务

  • watch: 监视文件

  • 最后两条属性的整体含义是如果配置文件 /etc/ssh/ssh_config 发生变化，服务重启更新

  • source: salt://ubuntu/ssh_config 托管的配置文件实际存储在 /srv/salt/ubuntu/ssh_config

同样，使用如下命令来验证结果需要

<pre> salt '' state.highstate </pre> _ ## 参考 ### 二进制软件包 rpm deb 不同包管理体系，不同发行版二进制包拆分命名规则不尽相同,相比之下 deb 拆分的力度要更细些。 RHEL6/CentOS 软件包列表 salt

salt-master salt-minion salt-api salt-cloud Deian/Ubuntu 软件包列表 salt-master salt-minion salt-syndic salt-docsalt-common salt-cloud salt-cloud-doc salt-api salt-ssh 下面按照服务端（主控端）和客户端（受控端）来说明主要功能项。 ### 主控端命令列表 /usr/bin/salt 主控命令 /usr/bin/salt-cp 批量复制文件 /usr/bin/salt-key 证书管理/usr/bin/salt-master 服务端程序 /usr/bin/salt-run 管理虚拟机 /usr/bin/salt-ssh 管理ssh /usr/bin/salt-syndic master分布式节点服务程序 ### 受控端命令列表 /usr/bin/salt-call /usr/bin/salt-minion 客户端程序 #### 启用扩展配置文件目录 主控端 /etc/salt/master <pre> default_include: master.d/.conf </pre>

  • 受控端 /etc/salt/minion

<pre> default_include: master.d/*.conf </pre>

命令示例

salt

  • 测试与受控主机网络是否通畅 <pre>salt '*' cmd.run test.ping </pre>

  • 在全部受控主机行执行命令 <pre>salt '*' cmd.run "uptime" </pre>

  • 使用 -E 按照正则匹配操作对象 <pre>salt -E 'ubuntu*' cmd.run "uptime" </pre>

  • 使用 -N 按照分组匹配操作对象 <pre>salt -N 'UBUNTU-GROUPS' cmd.run "uptime" </pre>

  • 使用 -G 按照查询信息匹配操作对象选项 <pre>salt -G 'cpuarch:x86_64' grains.item num_cpus </pre>

  • 查看受控端模块函数帮助信息 <pre>salt '*' sys.doc</pre>

  • 查看受控端模块函数帮助信息 <pre>salt '*' sys.doc service</pre>

salt-master

  • 启动服务 <pre> salt-master -d </pre>

salt-key

  • 查看证书 <pre> salt-key -L </pre>

  • 接受指定的证书 <pre> salt-key -a KeyName </pre>

  • 接受所有未认证的证书 <pre> salt-key -A </pre>

  • 删除所有证书 <pre> salt-key -D </pre>

  • 删除指定的证书 <pre> salt-key -d KeyName </pre>

salt-cp

*批量复制文件到受控主机

<pre> salt-cp '' /home/vmdisk.img /var/lib/libvirtsh/vmdisk.img </pre> 拷贝小文件很有效，简单测试，拷贝2.5MB以上的文件就会超时报错 #### salt-run salt-run 是用于管理虚拟机的命令 查询虚拟机信息 <pre> salt-run virt.hyper_info </pre> 查询虚拟机信息 <pre> salt-run virt.query </pre> * 基于云镜像创建一个新的虚拟机 <pre>salt-run virt.init centos1 2 512 salt://centos.img</pre> #### salt-ssh 编辑配置文件 /etc/salt/roster <pre> ubuntu-12.04-001: host: 10.8.0.18 user: root passwd: root sudo: True </pre>

  • 简单的测试 <pre> salt-ssh '*' test.ping </pre>

  • 测试执行命令 <pre> salt-ssh '*' -r "ifconfig -a" </pre>

salt-syndic

salt的master和minion的交互很大程度上都和网络有关系,比如在管理多个国家的机器的时候(比如大中华局域网),一个master控制多个master,同时被控制的master又可以控制很多的minion，就好比是在 master 和 minions 之间又加了一层的分布式架构。

salt-minion

启动服务 <pre> salt-minion -d </pre>

salt-call

内置模块列表