创建角色、ansible-galaxy(在线角色)的使用

创建角色、ansible-galaxy(在线角色)的使用

一、创建角色

角色创建流程
在Ansible中创建角色不需要特别的开发工具。创建和使用角色包含三个步骤：

• 创建角色目录结构
• 定义角色内容
• 在playbook中使用角色

1.创建角色目录结构

默认情况下，Ansible在Ansible Playbook所在目录的roles子目录中查找角色。这样，用户可以利用playbook和其他支持文件存储角色。

如果Ansible无法在该位置找到角色，它会按照顺序在Ansible配置设置roles_path所指定的目录中查找。此变量包含要搜索的目录的冒号分隔列表。此变量的默认值为：

~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

• 系统自带角色位置

[root@server]# ls /usr/share/ansible/roles
linux-system-roles.kdump     rhel-system-roles.kdump
linux-system-roles.network   rhel-system-roles.network
linux-system-roles.postfix   rhel-system-roles.postfix
linux-system-roles.selinux   rhel-system-roles.selinux
linux-system-roles.storage   rhel-system-roles.storage
linux-system-roles.timesync  rhel-system-roles.timesync

• 每个角色具有自己的目录，采用标准化的目录结构。例如，以下目录结构包含了定义motd角色的文件。

[root@server ansible]# tree roles/
roles/
└── motd
    ├── defaults
    │   └── main.yml
    ├── files
    ├── handlers
    ├── meta
    │   └── main.yml
    ├── tasks
    │   └── main.yml
    └── templates
        └── motd.j2

README.md提供人类可读的基本角色描述、有关如何使用该角色的文档和示例，以及其发挥作用所需要满足的任何非Ansible要求。
meta子目录包含一个main.yml文件，该文件指定有关模块的作者、许可证、兼容性和依赖项的信息。
files子目录包含固定内容的文件，而templates子目录则包含使用时可由角色部署的模板。
其他子目录中可以包含main.yml文件，它们定义默认的变量值、处理程序、任务、角色元数据或变量，具体取决于所处的子目录。

如果某一子目录存在但为空，如本例中的handlers，它将被忽略。如果某一角色不使用功能，则其子目录可以完全省略。例如，本例中的vars子目录已被省略。

2.创建角色框架

ansible-galaxy命令行工具可用于管理Ansible角色，包括新角色的创建。用户可以运行ansible-galaxy init来创建新角色的目录结构。指定角色的名称作为命令的参数，该命令在当前工作目录中为新角色创建子目录。

• 用ansible-galaxy init命令创建一个名为httpd的角色

[root@server ansible]# pwd       //当前位置在项目角色目录里
/etc/ansible
[root@ansible roles]# ansible-galaxy init httpd     //创建httpd角色
- Role httpd was created successfully
[root@server roles]# ls
httpd
[root@server roles]# tree httpd       //查看httpd的子目录
httpd
├── defaults       //文件包含角色变量的默认值，这些变量的优先级较低
│   └── main.yml
├── files          //包含由角色任务引用的静态文件。
├── handlers       //文件包含角色的处理程序定义。
│   └── main.yml
├── meta           //文件包含与角色相关的信息，如作者、许可证、平台和可选的角色依赖项。
│   └── main.yml
├── README.md
├── tasks          //文件包含角色的任务定义
│   └── main.yml
├── templates      //此目录包含由角色任务引用的Jinja2模板。
├── tests          //此目录可以包含清单和名为test.yml的playbook，可用于测试角色
│   ├── inventory
│   └── test.yml
└── vars           //定义角色的变量值,这些变量通常用于角色内部用途,这些变量的优先级较高
    └── main.yml

8 directories, 8 files

3.定义角色内容

创建目录结构后，用户必须编写角色的内容。ROLENAME/tasks/main.yml任务文件是一个不错的起点，它是由角色运行的主要任务列表。

用httpd这个角色安装配置启动httpd

• 先编写tasks任务

[root@server tasks]# cat main.yml 
---
# tasks file for httpd
- name: install httpd        //安装httpd
  yum: 
    name: httpd
    state: present

- name: config httpd
  template: 
    src: ../templates/httpd.conf.j2
    dest: /etc/httpd/conf/httpd.conf
  notify: 
    - restart httpd

- name: service httpd
  service: 
    name: httpd
    state: started

• 在受控机上传输配置文件到主控机

[root@httpd]# ls /etc/httpd/
conf  conf.d  conf.modules.d  logs  modules  run  state
[root@httpd]# cd /etc/httpd/conf
[root@httpd conf]# ls
httpd.conf  magic

传输文件到server主控机指定位置
[root@linux131 conf]# scp httpd.conf
192.168.58.10:/project/roles/httpd/templates/httpd.conf.j2
The authenticity of host '192.168.58.10(192.168.58.10)' can't be established.
ECDSA key fingerprint is SHA256:kmliopfYJmTtxXJVhwqIJL5XizwRyu8iA98oJYoVOjI.
Are you sure you want to continue connecting (yes/no/[fingerprint])? yue^H^H^Hyes
Please type 'yes', 'no' or the fingerprint: yes
Warning: Permanently added '192.168.58.10' (ECDSA) to the list of known hosts.
root@192.168.58.10's password: 
httpd.conf                                    100%   12KB   1.9MB/s   00:00 

查看是否传输成功
[root@server httpd]# cd templates/
[root@server templates]# ls
httpd.conf.j2
[root@server templates]# cat httpd.conf.j2 
#
略...

修改配置文件
[root@server templates]# vim httpd.conf.j2 
Listen 80

[root@server templates]# vim httpd.conf.j2 
 //修改后
Listen {{ port }}

• defaults编写变量

[root@server defaults]# cat main.yml 
---
# defaults file for httpd
port: 80
[root@server defaults]# 

• handlers 编写重启服务

[root@server handlers]# cat main.yml 
---
# handlers file for httpd
- name: restart httpd
  service: 
    name: httpd
    state: restarted

• 查看测试任务

[root@server tests]# ls
inventory  test.yml
[root@server tests]# cat inventory 
localhost

[root@server tests]# cat test.yml 
---
- hosts: localhost
  remote_user: root
  roles:
    - httpd

• 编写playbook

[root@server ansible]# ls
ansible.cfg  hosts  inventory  playbook  roles  run.yml
[root@server ansible]# cat run.yml 
---
- hosts: 192.168.58.20
  vars: 
    port: 8080
  roles: 
    - role: roles/httpd

• 查看受控机上没有8080端口，也没有httpd

[root@httpd ~]# ss -anlt
State     Recv-Q    Send-Q       Local Address:Port        Peer Address:Port    
LISTEN    0         128                0.0.0.0:22               0.0.0.0:*       
LISTEN    0         128                   [::]:22                      [::]:*    
[root@httpd ~]# rpm -qa|grep httpd
[root@httpd ~]# 

• 执行playbook

[root@server ansible]# ansible-playbook run.yml
[WARNING]: Found variable using reserved name: port

PLAY [192.168.58.20] *********************************************************

TASK [Gathering Facts] *********************************************************
ok: [192.168.58.20]

TASK [roles/httpd : install httpd] *********************************************
ok: [192.168.58.20]

TASK [roles/httpd : config httpd] **********************************************
ok: [192.168.58.20]

TASK [roles/httpd : service httpd] *********************************************
changed: [192.168.58.20]

PLAY RECAP *********************************************************************
192.168.58.20            : ok=4    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

• 查看受控机上端口多了个8080

[root@httpd conf]# ss -anlt
State     Recv-Q    Send-Q       Local Address:Port         Peer Address:Port    
LISTEN    0         128                0.0.0.0:22                0.0.0.0:*       
LISTEN    0         128                      *:8080                    *:*       
LISTEN    0         128                   [::]:22                   [::]:*     

4.角色内容开发的推荐做法

角色允许以模块化方式编写playbook。为了最大限度地提高新开发角色的效率，请考虑在角色开发中采用以下推荐做法：

• 在角色自己的版本控制存储库中维护每个角色。Ansible很适合使用基于git的存储库。
• 角色存储库中不应存储敏感信息，如密码或SSH密钥。敏感值应以变量的形式进行参数化，其默认值应不敏感。使用角色的playbook负责通过Ansible Vault变量文件、环境变量或其他ansible-playbook选项定义敏感变量。
• 使用ansible-galaxy init启动角色，然后删除不需要的任何目录和文件。
• 创建并维护README.md和meta/main.yml文件，以记录用户的角色的用途、作者和用法。
• 让角色侧重于特定的用途或功能。可以编写多个角色，而不是让一个角色承担许多任务。
• 经常重用和重构角色。避免为边缘配置创建新的角色。如果现有角色能够完成大部分的所需配置，请重构现有角色以集成新的配置方案。使用集成和回归测试技术来确保角色提供所需的新功能，并且不对现有的playbook造成问题。

5.定义角色依赖项

角色依赖项使得角色可以将其他角色作为依赖项包含在内。例如，一个定义文档服务器的角色可能依赖于另一个安装和配置web服务器的角色。依赖关系在角色目录层次结构中的meta/main.yml文件内定义。

以下是一个示例meta/main.yml文件

dependencies:             //依赖
  - role: apache          //角色
    port: 8080            //端口
  - role: postgres        //角色 
    dbname: serverlist    //数据库
    admin_user: felix     //管理用户

默认情况下，角色仅作为依赖项添加到playbook中一次。若有其他角色也将它作为依赖项列出，它不会再次运行。此行为可以被覆盖，将meta/main.yml文件中的allow_duplicates变量设置为yes即可。

注意 限制角色对其他角色的依赖。依赖项使得维护角色变得更加困难，尤其是当它具有许多复杂的依赖项时。

6.在playbook中使用角色

要访问角色，可在play的roles:部分引用它。下列playbook引用了motd角色。由于没有指定变量，因此将使用默认变量值应用该角色。

• 修改playbook，没有指定变量

[root@server ansible]# cat run.yml 
---
- hosts: 192.168.58.20
  roles: 
    - role: roles/httpd

• 执行

[root@server ansible]# ansible-playbook run.yml 
[WARNING]: Found variable using reserved name: port

PLAY [192.168.58.20] ************************************************************

TASK [Gathering Facts] **********************************************************
ok: [192.168.58.20]

TASK [roles/httpd : install httpd        //安装httpd] *****************************
ok: [192.168.58.20]

TASK [roles/httpd : config httpd] ***********************************************
changed: [192.168.58.20]

TASK [roles/httpd : service httpd] **********************************************
ok: [192.168.58.20]

RUNNING HANDLER [roles/httpd : restart httpd] ***********************************
changed: [192.168.58.20]

PLAY RECAP **********************************************************************
192.168.58.20              : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

• 查看，恢复了默认端口80

[root@httpd conf]# ss -anlt
State     Recv-Q    Send-Q       Local Address:Port         Peer Address:Port    
LISTEN    0         128                0.0.0.0:22                0.0.0.0:*       
LISTEN    0         128                      *:80                      *:*       
LISTEN    0         128                   [::]:22                   [::]:*       

二、使用ansible galaxy部署角色

1.介绍ansible galaxy

Ansible Galaxy https://galaxy.ansible.com是一个Ansible内容公共资源库，这些内容由许许多多Ansible管理员和用户编写。它包含数千个Ansible角色，具有可搜索的数据库，可帮助Ansible用户确定或许有助于他们完成管理任务的角色。Ansible Galaxy含有面向新的Ansible用户和角色开发人员的文档和视频链接。

此外，用于从Ansible Galaxy获取和管理角色的ansible-galaxy命令也可用于为您的项目获取和管理自有的git存储库中的角色。

1.1 获取Ansible Galaxy帮助

通过Ansible Galaxy网站主页上的Documenttaion标签，可以进入描述如何使用Ansible Galaxy的页面。其中包含了介绍如何从Ansible Galaxy下载和使用角色的内容。该页面也提供关于如何开发角色并上传到Ansible Galaxy的说明。

1.2 浏览Ansible Galaxy中的角色

通过Ansible Galaxy网站主页上左侧的Search标签，用户可以访问关于Ansible Galaxy上发布的角色的信息。用户可以使用标记通过角色的名称或通过其他角色属性来搜索Ansible角色。结果按照Best Match分数降序排列，此分数依据角色质量、角色受欢迎程度和搜索条件计算而得。

2 . Ansible Galaxy命令行工具

2.1 命令行搜索角色

ansible-galaxy search子命令在Ansible Galaxy中搜索角色。如果以参数形式指定了字符串，则可用于按照关键字在Ansible Galaxy中搜索角色。用户可以使用–author、–platforms和–galaxy-tags选项来缩小搜索结果的范围。搜索到的都是可以用的。

命令ansible-galaxy search --author geerlingguy将显示由用户geerlingguy提交的所有角色。

[root@server ansiible]# ansible-galaxy search --author geerlingguy

Found 99 roles matching your search:

 Name                              Description
 ----                              -----------
 geerlingguy.adminer               Installs Adminer for Database management.
 geerlingguy.ansible               Ansible for RedHat/CentOS/Debian/Ubuntu.
 geerlingguy.apache                Apache 2.x for Linux.
 geerlingguy.apache-php-fpm        Apache 2.4+ PHP-FPM support for Linux.
 geerlingguy.aws-inspector         AWS Inspector installation for Linux.
 geerlingguy.awx                   Installs and configures AWX (Ansible Tower>
 geerlingguy.awx-container         Ansible AWX container for Docker.
 geerlingguy.backup                Backup for Simple Servers.
略...

结果按照字母顺序显示，而不是Best Match分数降序排列。

• 下例显示了包含redis并且适用于企业Linux(EL)平台的角色的名称。

[root@server ansible ]# ansible-galaxy search 'redis' --platforms EL

Found 221 roles matching your search:

 Name                                            Description
 ----                                            -----------
 0x0i.consul                                     Consul - a service discovery>
 0x0i.grafana                                    Grafana - an analytics and m>
 0x5a17ed.ansible_role_netbox                    Installs and configures NetB>
 1it.sudo                                        Ansible role for managing su>
 adfinis-sygroup.redis                           Ansible role for Redis
 AerisCloud.librato                              Install and configure the Li>
 AerisCloud.redis                                Installs redis on a server
 AlbanAndrieu.java                               Manage Java installation
略...

ansible-galaxy info子命令显示与角色相关的更多详细信息。Ansible Galaxy从多个位置获取这一信息，包括角色的meta/main.yml文件及其GigHub存储库。

• 以下命令显示了Ansible Galaxy提供的geerlingguy.redis角色的相关信息。

[root@server ansible]# ansible-galaxy info geerlingguy.redis

positional arguments:
  ROLE_ACTION
    init       Initialize new role with the base structure of a role.
    remove     Delete roles from roles_path.
    delete     Removes the role from Galaxy. It does not remove or alter the
               actual GitHub repository.
    list       Show the name and version of each role installed in the
               roles_path.
    search     Search the Galaxy database by tags, platforms, author and
               multiple keywords.
    import     Import a role
    setup      Manage the integration between Galaxy and the given source.
    info       View more details about a specific role.
    install    Install role(s) from file(s), URL(s) or Ansible Galaxy

optional arguments:
  -h, --help   show this help message and exit

2.2 从Ansible Galaxy安装角色

ansible-galaxy install子命令从Ansible Galaxy下载角色，并将它安装到控制节点本地。

默认情况下，角色安装到用户的roles_path下的第一个可写目录中。根据为Ansible设置的默认roles_path，角色通常将安装到用户的~/.ansible/roles目录。默认的roles_path可能会被用户当前Ansible配置文件或环境变量ANSIBLE_ROLES_PATH覆盖，这将影响ansible-galaxy的行为。

• 安装角色geerlingguy.redis

[root@ansible ~]# ansible-galaxy install geerlingguy.redis
- downloading role 'redis', owned by geerlingguy
- downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.6.0.tar.gz
- extracting geerlingguy.redis to /root/.ansible/roles/geerlingguy.redis
- geerlingguy.redis (1.6.0) was installed successfully

查看安装位置，在当前目录的ansible/roles/里
[root@server ansible]# ls .ansible/roles/
geerlingguy.redis

用户可以通过使用-p 选项，指定具体的目录来安装角色。

在下例中，ansible-galaxy将geerlingguy.redis角色安装到playbook项目的roles目录中。命令的当前工作目录是/ansible

[root@server ansible]# ls
playbook.yml  roles
[root@server ansible]# ansible-galaxy install geerlingguy.redis -p roles/
- downloading role 'redis', owned by geerlingguy
- downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.6.0.tar.gz
- extracting geerlingguy.redis to /project/roles/geerlingguy.redis
- geerlingguy.redis (1.6.0) was installed successfully
[root@server ansible]# ls roles/
geerlingguy.redis  httpd
[root@server ansible]# pwd
/etc/ansible

3.使用要求文件安装角色

可以使用ansible-galaxy，根据某一文本文件中的定义来安装一个角色列表。例如，如果用户的一个playbook需要安装特定的角色，可以在项目目录中创建一个roles/requirements.yml文件来指定所需的角色。此文件充当playbook项目的依赖项清单，使得playbook的开发和调试能与任何支持角色分开进行。

src属性指定角色的来源，本例中为来自Ansible Galaxy的geerlingguy.redis角色。version属性是可选的，指定要安装的角色版本，本例中为1.5.0。例如，一个用于安装geerlingguy.redis的简单requirements.yml可能类似于如下：

3.1安装角色

[root@server roles]# ls
geerlingguy.redis  httpd
[root@server roles]# rm -rf geerlingguy.redis/       //先删掉刚下载的角色
[root@server roles]# ls
httpd
[root@server roles]# cat requirements.yml            //写个文件添加要下载的角色
- src: geerlingguy.redis
- src: robertdebock.httpd

• -r指定要安装文件的内容，-p指定安装位置

[root@server ansible]# ansible-galaxy install -r roles/requirements.yml -p roles/
- downloading role 'redis', owned by geerlingguy
- downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.6.0.tar.gz
- extracting geerlingguy.redis to /project/roles/geerlingguy.redis
- geerlingguy.redis (1.6.0) was installed successfully
- downloading role 'httpd', owned by robertdebock
- downloading role from https://github.com/robertdebock/ansible-role-httpd/archive/5.3.0.tar.gz
- extracting robertdebock.httpd to /project/roles/robertdebock.httpd
- robertdebock.httpd (5.3.0) was installed successfully
- src: geerlingguy.redis
  version: "1.5.0"  
[root@server ansible]# ls roles/        //查看，成功安装角色
geerlingguy.redis  httpd  requirements.yml  robertdebock.httpd

应当在requirements.yml文件中指定角色版本，特别是生产环境中的playbook。
如果不指定版本，将会获取角色的最新版本。如果作者对角色做出了更改，并与用户的playbook不兼容，这可能会造成自动化失败或其他问题。

用户可以使用ansible-galaxy来安装不在Ansible Galaxy中的角色。可以在私有的Git存储库或Web服务器上托管自有的专用或内部角色。下例演示了如何利用各种远程来源配置要求文件。

[root@server ansible]# cat roles/requirements.yml
# from Ansible Galaxy, using the latest version
- src: geerlingguy.redis

# from Ansible Galaxy, overriding the name and using a specific version
- src: geerlingguy.redis
  version: "1.5.0"
  name: redis_prod
  
# from any Git-based repository, using HTTPS
- src: https://gitlab.com/guardianproject-ops/ansible-nginx-acme.git
  scm: git
  version: 56e00a54
  name: nginx-acme
  
# from any Git-based repository, using SSH
- src: [e-mail]:guardianproject-ops/ansible-nginx-acme.git
  scm: git
  version: master
  name: nginx-acme-ssh
  
# from a role tar ball, given a URL
# supports 'http', 'https', or 'file' protocols
- src: file:///opt/local/roles/myrole.tar
  name: myrole

src关键字指定Ansible Galaxy角色名称。如果角色没有托管在Ansible Galaxy中，则src关键字将指明角色的URL。

如果角色托管在来源控制存储库中，则需要使用scm属性。ansible-galaxy命令能够从基于git或mercurial的软件存储库下载和安装角色。基于Git的存储库要求scm值为git，而托管在Mercurial存储库中的角色则要求值为hg。如果角色托管在Ansible Galaxy中，或者以tar存档形式托管在Web服务器上，则省略scm关键字。

name关键字用于覆盖角色的本地名称。version关键字用于指定角色的版本。version关键字可以是与严自角色的软件存储库的分支、标记或提交哈希对应的任何值。

3.2 管理下载的角色

ansible-galaxy命令也可管理本地的角色，如位于playbook项目的roles目录中的角色。ansible-galaxy list子命令列出本地找到的角色。

[root@server ansible]# ansible-galaxy list
# /root/.ansible/roles
- geerlingguy.redis, 1.6.0
# /usr/share/ansible/roles
- linux-system-roles.kdump, (unknown version)
- linux-system-roles.network, (unknown version)
- linux-system-roles.postfix, (unknown version)
- linux-system-roles.selinux, (unknown version)
- linux-system-roles.storage, (unknown version)
- linux-system-roles.timesync, (unknown version)
- rhel-system-roles.kdump, (unknown version)
- rhel-system-roles.network, (unknown version)
- rhel-system-roles.postfix, (unknown version)
- rhel-system-roles.selinux, (unknown version)
- rhel-system-roles.storage, (unknown version)
- rhel-system-roles.timesync, (unknown version)
# /etc/ansible/roles

[root@server ansible]# ansible-galaxy list
# /root/.ansible/roles
- geerlingguy.redis, 1.6.0
# /usr/share/ansible/roles
- linux-system-roles.kdump, (unknown version)
- linux-system-roles.network, (unknown version)
- linux-system-roles.postfix, (unknown version)
- linux-system-roles.selinux, (unknown version)
- linux-system-roles.storage, (unknown version)
- linux-system-roles.timesync, (unknown version)
- rhel-system-roles.kdump, (unknown version)
- rhel-system-roles.network, (unknown version)
- rhel-system-roles.postfix, (unknown version)
- rhel-system-roles.selinux, (unknown version)
- rhel-system-roles.storage, (unknown version)
- rhel-system-roles.timesync, (unknown version)
# /etc/ansible/roles              //刚下载的两个角色
- geerlingguy.redis, 1.6.0
- httpd, (unknown version)
- robertdebock.httpd, 5.3.0

可以使用ansible-galaxy remove子命令本地删除角色。

[root@ansible roles]# ansible-galaxy remove geerlingguy.redis
[root@ansible roles]# ansible-galaxy list

在playbook中使用下载并安装的角色的方式与任何其他角色都一样。在roles部分中利用其下载的角色名称来加以引用。如果角色不在项目的roles目录中，则将检查roles_path来查看角色是否安装在了其中一个目录中，将使用第一个匹配项。以下use-role.ymlplaybook引用了redis_prod和geerlingguy.redis角色：

[root@localhost project]# cat use-role.yml
---
- name: use redis_prod for prod machines
  hosts: redis_prod_servers
  remote_user: devops
  become: True
  roles:
    - redis_prod

- name: use geerlingguy.redis for Dev machines
  hosts: redis_dev_servers
  remote_user: devops
  become: True
  roles:
    - geerlingguy.redis