ansible学习笔记-playbook快速入门

playbook

ansible命令适合执行简单的操作。如果要完成一个复杂的部署,需要很多ansible操作,写起来会很乱。

所以有了ansible-playbook

把一件事切分成很多任务,有序的组织起来

目录结构解读

官方给的playbook工程的最佳实践

production                # 生产环境的服务器清单
stage                     # stage环境的服务器清单

group_vars/
   group1                 # 这里我们给特定的组赋值
   group2                 # ""
host_vars/
   hostname1              # 主机变量
   hostname2              # ""

library/                  # 如果有自定义的模块,放在这里(可选)
filter_plugins/           # 如果有自定义的过滤插件,放在这里(可选)

site.yml                  # 主 playbook文件
webservers.yml            # Web 服务器的 playbook
dbservers.yml             # 数据库服务器的 playbook

roles/
    common/               # 这个目录代表了一个名为common的 "role"
        tasks/            #
            main.yml      #  <-- tasks file can include smaller files if wanted
        handlers/         #
            main.yml      #  <-- handlers file
        templates/        #  <-- files for use with the template resource
            ntp.conf.j2   #  <------- templates end in .j2
        files/            #
            bar.txt       #  <-- files for use with the copy resource
            foo.sh        #  <-- script files for use with the script resource
        vars/             #
            main.yml      #  <-- variables associated with this role
        defaults/         #
            main.yml      #  <-- default lower priority variables for this role
        meta/             #
            main.yml      #  <-- role dependencies

    webserver/              # 像上面的common一样,这个目录代表了一个名为webserver的 "role"
    monitoring/           # ""
    fooapp/               # ""

第一眼看起来很乱,不要慌,我们一个一个看就清晰了。看完这几个文件,也就初步学会playbook了。

其中重点要看的是roles目录!!!

服务器清单文件

比如这里的production和stage文件。在ansible中常称为inventory file

可以自己根据需要创建。

我这里创建一个redis文件,内容如下

[prod]
redis1 ansible_ssh_host=10.178.151.211

[prod]是组名,用中括号括起

下面是在组内的服务器地址。

服务器地址这部分可以使用域名、主机名、IP地址表示。但是使用域名或主机名时,需要ansible主机能够反解析到相应的IP地址,所以一般此类配置中多使用IP地址;

在这个例子中,redis1是自定义的主机名别名,具体的ip写在ansible_ssh_host。

ansible_ssh_host是ansible内置的inventory参数,下面讲。

主机变量

在主机条目上可以加变量,以便后面的playbook执行时使用,比如

[prod]
redis1 ansible_ssh_host=10.178.151.211 password=UYSbdyf
组变量

就是给整个组加变量

[prod]
redis1 ansible_ssh_host=10.178.151.211
[prod:vars]
password=UYSbdyf
inventory参数

通过参数指定ssh的交互

有以下参数,

ansible_ssh_host 
ansible_ssh_port
ansible_ssh_user
ansible_ssh_pass
ansible_sudo_pass
ansible_connection
ansible_ssh_private_key_file
ansible_shell_type
ansible_python_interpreter

使用方式如下,比如改了ssh的端口

[prod]
redis1 ansible_ssh_host=10.178.151.211 ansible_ssh_port=50022 ansible_ssh_user=root

group_vars

用于存放group相关的变量

在上面的inventory 文件中,我们定义过组变量

如果组变量可以抽取出来多个组公用,就可以放在group_vars下。

比如上面我给名叫prod的组定义过变量。现在要抽取出来,就要在group_vars目录下创建一个名为prod的文件

把变量放进去。

所以,文件名和组名是对应的。

文件内容格式如下:

---
password=UYSbdyf

host_vars

用于存放host相关的变量

和组名同理。主机变量名和这里创建的文件名必须一致。

playbook主文件

比如这里的site.yml

主playbook文件,我们开始执行一个playbook就是从这个主文件开始

ansible-playbook site.yml

这个主文件不是一定要叫site.yml。随便起名。根据你自己的业务来起名即可。比如后面的webservers.yml和dbservers.yml。

我们这里写一个redis.yml,用来部署redis

- hosts: redis
  remote_user: root
  gather_facts: True
  roles:
  - redis

主文件的内容就是指定哪些主机进行什么操作。用什么用户等等。

roles

roles是整个playbook的重点。role可以理解为做一件事的一个角色。

roles目录下面根据你自己的业务,可以定义多个role子目录,对应完成某件工作。

为了做成这件事的一些列操作都写到这个role子目录下。比如这里的common,webserver,monitoring,fooapp等

我这里新建一个redis目录

tasks

tasks下的文件就是完成工作的一个个具体动作,

至少要包含main.yml,playbook执行时默认就找这个main.yml。可以定义其他的yml文件,在main.yml引入

比如

- name: System Add group {{ redisgroup }}
  group: gid={{ usergid }} name={{ redisgroup }} state=present system=yes

- name: System Add user {{ redisuser }}
  user:
    name: '{{ redisuser }}'
    ...省略

- name: create redis database directory
  file: path='/data/redis_data' state=directory mode='0755' owner={{ redisuser }} group={{ redisgroup }}

- name: create logs directory
  file: path='/data/logs/redis' state=directory mode='0755' owner={{ redisuser }} group={{ redisgroup }}

- name: yum install {{ pkgname }}
  yum: name={{ pkgname }} state=present

- name: Template Set {{ pkgname }} Config Files
  template:  src='redis.conf.j2' dest='/etc/redis.conf' owner={{ redisuser }} group={{ redisgroup }} mode='0755'
  notify:
    - restart redis service

通过-name来说明这个动作的作用

可以看到里面使用了变量。用{{xx}}包围的。这些变量放在vars文件夹下。

其中的动作Action,group,user,file,yum等就是我们上一篇中说的ansible的内置模块

playbook对task的执行时从上到下按顺序一个一个执行的。执行的结果是幂等的。这个特性非常使用。

对一台客户机多次执行playbook是安全的。

为什么是幂等的呢?

仔细观察task的动作,会发现其对动作的描述都是声明式的。

比如 yum: name={{ pkgname }} state=present

有一个state值是present,表明我们期望达到的效果是安装了这个包。所以ansible会采取的操作是先检查有没有安装,没有安装才进行安装。

在这个例子中,还用到了template模块。它会去找templates目录下的模板文件,进行变量替换后,放到客户机指定的目录下。

还有一个notify,这个特性和下面要讲到的handler有关

handlers

应当包含一个main.yml文件,用于定义此角色用到的各handlers,

在handler中可以使用inclnude引入其它的handlers文件;

handler是干嘛的?

handler是用来描述当关注的资源的状态发生变化时要采取的操作。

比如main.yml中这样写

- name: restart redis service
  service: name={{ pkgname }} state=restarted

这里的name要注意,它的值必须和上面task文件中norify的值一致!!,不是随便写的。

也就是说,当task中的redis.conf文件修改了之后,会触发notify这个名叫restart redis service的handler

这个handler执行的操作就是调用service模块,对某个service进行restart

templates

存放模板文件。

playbook使用jinja2模板文件。

比如我们讲redis.conf作为一个模板配置文件redis.conf.j2

bind {{ bindip }}
protected-mode yes
port 6379
tcp-backlog 511
timeout 0
tcp-keepalive 300
daemonize {{ mode }}
...

模板文件中的变量从vars目录下取

files

用来存放会用到的文件。

比如script模块用到的sh脚本文件。需要copy到目标主机的安装包等。

vars

存在自定义的变量。

应当包含一个main.yml文件

defaults

应当包含一个main.yml文件,也是用于为当前role定义变量。只不过设定的时默认值。优先级低于vars。

meta

应当包含一个main.yml文件,用于定义此角色的特殊设定及其依赖关系;ansible1.3及其以后的版本才支持;

我还没用过~

library 和 filter_plugins

ansible支持自定义扩展功能,新手先不用管这个

执行

执行就简单了,通过ansible-playbook redis.yaml 命令运行即可

# ansible-playbook -h
#ansible-playbook常用选项:
--check  or -C    #只检测可能会发生的改变,但不真正执行操作
--list-hosts      #列出运行任务的主机
--list-tags       #列出playbook文件中定义所有的tags
--list-tasks      #列出playbook文件中定义的所以任务集
--limit           #主机列表 只针对主机列表中的某个主机或者某个组执行
-f                #指定并发数,默认为5个
-t                #指定tags运行,运行某一个或者多个tags。(前提playbook中有定义tags)
-v                #显示过程  -vv  -vvv更详细
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 140,856评论 1 295
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 60,475评论 1 254
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 92,639评论 0 208
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 40,628评论 0 171
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,311评论 1 250
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,533评论 1 167
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,235评论 2 266
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,017评论 0 161
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 28,738评论 6 225
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,358评论 0 211
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,115评论 2 211
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,444评论 1 222
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,138评论 0 31
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 26,965评论 2 209
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,349评论 3 200
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,574评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 25,901评论 0 163
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,314评论 2 227
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,433评论 2 228

推荐阅读更多精彩内容