系统角色的使用、角色结构创建和使用方式

最新推荐文章于 2024-05-31 14:00:15 发布

1314444

最新推荐文章于 2024-05-31 14:00:15 发布

阅读量486

点赞数

分类专栏：自动化运维

1314444

本文链接：https://blog.csdn.net/qq_48289488/article/details/119429652

版权

自动化运维专栏收录该内容

24 篇文章 1 订阅

订阅专栏

一、系统角色的使用timesync

1、角色的执行顺序

对于playbook中的每个play，任务将按照任务列表中的顺序执行。首先执行完所有任务后。再将任务通知的处理程序执行。
要在角色之前执行任务，可以给play配置pre_tasks部分
要在play的普通任务和它们通知的执行程序之后执行任务，可以用post_tasks部分

2、时间同步示例

[root@master playbook]# ls
base  roles  test.yml                  //建议单独创建一个目录用于存放角色
[root@master roles]# cp -a /usr/share/ansible/roles/rhel-system-roles.timesync/ timesync
[root@master roles]# ls
timesync

//受管主机上
[root@mysql ~]# yum -y remove chrony.x86_64
[root@mysql ~]# rm -rf /etc/chrony.*
[root@mysql ~]# date -s "1999-08-08 08:08:08"
1999年 08月 08日 星期日 08:08:08 CST


[root@master playbook]# cat test.yml 
---
- hosts: httpd
  vars:
    timesync_ntp_servers:
      - hostname: time1.aliyun.com
        iburst: yes
    power: true
  pre_tasks:
    - debug:
        msg: " pre-task "
      changed_when: power
      notify:
        - my handler
  roles:
    - timesync
  tasks: 
    - debug:
        msg: " first task "
      changed_when: power
      notify:
        - my handler
  post_tasks:
    - debug:
         msg: " post_task "
      changed_when: power
      notify:
        - my handler
  handlers:
    - name: my handler
      debug:
         msg: " running my handlers "

[root@master playbook]# ansible-playbook test.yml 

PLAY [httpd] *****************************************************************************************

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

TASK [debug] *****************************************************************************************
changed: [192.168.129.133] => {
    "msg": " pre-task "
}

RUNNING HANDLER [my handler] *************************************************************************
ok: [192.168.129.133] => {
    "msg": " running my handlers "
}

TASK [timesync : Check if only NTP is needed] ********************************************************
ok: [192.168.129.133]

TASK [timesync : Check if single PTP is needed] ******************************************************
skipping: [192.168.129.133]

TASK [timesync : Check if both NTP and PTP are needed] ***********************************************
skipping: [192.168.129.133]

TASK [timesync : Determine current NTP provider] *****************************************************
ok: [192.168.129.133]

TASK [timesync : Select NTP provider] ****************************************************************
ok: [192.168.129.133]

TASK [timesync : Install chrony] *********************************************************************
ok: [192.168.129.133]

TASK [timesync : Install ntp] ************************************************************************
skipping: [192.168.129.133]

TASK [timesync : Install linuxptp] *******************************************************************
skipping: [192.168.129.133]

TASK [timesync : Run phc_ctl on PTP interface] *******************************************************
skipping: [192.168.129.133]

TASK [timesync : Check if PTP interface supports HW timestamping] ************************************
skipping: [192.168.129.133]

TASK [timesync : Get chrony version] *****************************************************************
ok: [192.168.129.133]

TASK [timesync : Get ntp version] ********************************************************************
skipping: [192.168.129.133]

TASK [timesync : Generate chrony.conf file] **********************************************************
changed: [192.168.129.133]

TASK [timesync : Generate chronyd sysconfig file] ****************************************************
ok: [192.168.129.133]

TASK [timesync : Generate ntp.conf file] *************************************************************
skipping: [192.168.129.133]

TASK [timesync : Generate ntpd sysconfig file] *******************************************************
skipping: [192.168.129.133]

TASK [timesync : Generate ptp4l.conf file] ***********************************************************
skipping: [192.168.129.133]

TASK [timesync : Generate ptp4l sysconfig file] ******************************************************
skipping: [192.168.129.133]

TASK [timesync : Generate phc2sys sysconfig file] ****************************************************
skipping: [192.168.129.133]

TASK [timesync : Generate timemaster.conf file] ******************************************************
skipping: [192.168.129.133]

TASK [timesync : Update network sysconfig file] ******************************************************
ok: [192.168.129.133]

TASK [timesync : Disable chronyd] ********************************************************************
skipping: [192.168.129.133]

TASK [timesync : Disable ntpd] ***********************************************************************
fatal: [192.168.129.133]: FAILED! => {"changed": false, "msg": "Could not find the requested service ntpd: host"}
...ignoring

TASK [timesync : Disable ntpdate] ********************************************************************
fatal: [192.168.129.133]: FAILED! => {"changed": false, "msg": "Could not find the requested service ntpdate: host"}
...ignoring

TASK [timesync : Disable sntp] ***********************************************************************
fatal: [192.168.129.133]: FAILED! => {"changed": false, "msg": "Could not find the requested service sntp: host"}
...ignoring

TASK [timesync : Disable ptp4l] **********************************************************************
fatal: [192.168.129.133]: FAILED! => {"changed": false, "msg": "Could not find the requested service ptp4l: host"}
...ignoring

TASK [timesync : Disable phc2sys] ********************************************************************
fatal: [192.168.129.133]: FAILED! => {"changed": false, "msg": "Could not find the requested service phc2sys: host"}
...ignoring

TASK [timesync : Disable timemaster] *****************************************************************
fatal: [192.168.129.133]: FAILED! => {"changed": false, "msg": "Could not find the requested service timemaster: host"}
...ignoring

TASK [timesync : Enable chronyd] *********************************************************************
ok: [192.168.129.133]

TASK [timesync : Enable ntpd] ************************************************************************
skipping: [192.168.129.133]

TASK [timesync : Enable ptp4l] ***********************************************************************
skipping: [192.168.129.133]

TASK [timesync : Enable phc2sys] *********************************************************************
skipping: [192.168.129.133]

TASK [timesync : Enable timemaster] ******************************************************************
skipping: [192.168.129.133]

TASK [debug] *****************************************************************************************
changed: [192.168.129.133] => {
    "msg": " first task "
}

RUNNING HANDLER [timesync : restart chronyd] *********************************************************
changed: [192.168.129.133]

RUNNING HANDLER [my handler] *************************************************************************
ok: [192.168.129.133] => {
    "msg": " running my handlers "
}

TASK [debug] *****************************************************************************************
changed: [192.168.129.133] => {
    "msg": " post_task "
}

RUNNING HANDLER [my handler] *************************************************************************
ok: [192.168.129.133] => {
    "msg": " running my handlers "
}

PLAY RECAP *******************************************************************************************
192.168.129.133            : ok=23   changed=5    unreachable=0    failed=0    skipped=18   rescued=0    ignored=6  

//查看
[root@master playbook]# ansible httpd -a 'date'
192.168.129.133 | CHANGED | rc=0 >>
2021年 08月 05日 星期四 23:40:09 CST

二、系统角色使用selinux

有时候，SELinux角色必须确保重新引导（重启）受管主机，以便能够完整应用其更改。但是，它本身从不会重新引导主机。如此一来，用户便可以控制重新引导的处理方式。
该角色将一个布尔值变量selinux_reboot_required设为True，如果需要重新引导，则失败。你可以使用block/rescure结构来从失败中恢复，具体操作为：如果该变量未设为true，则让play失败，如果值是true，则重新引导受管主机并重新运行该角色。

示例一：

---
- hosts: httpd
  vars:
    selinux_state: enforcing
  tasks:
    - name: Apply Selinux role
      block:
        - name: role use
          include_role:
            name: selinux
      rescue:
        - name: Check for failure for other reasons than  required reboot
          fail:
          when: not selinux_reboot_required

        - name: Restart managed host
          reboot:

        - name: Reapply Selinux role to cpmplete changes
          include_role:
            name: selinux

[root@master playbook]# ansible-playbook test.yml 

PLAY [httpd] *****************************************************************************************

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

TASK [role use] **************************************************************************************

TASK [selinux : Install SELinux python2 tools] *******************************************************
skipping: [192.168.129.133]

TASK [selinux : Install SELinux python3 tools] *******************************************************
ok: [192.168.129.133]

TASK [selinux : refresh facts] ***********************************************************************
ok: [192.168.129.133]

TASK [selinux : Install SELinux tool semanage on Fedora] *********************************************
ok: [192.168.129.133]

TASK [selinux : Set permanent SELinux state if enabled] **********************************************
skipping: [192.168.129.133]

TASK [selinux : Set permanent SELinux state if disabled] *********************************************
[WARNING]: Reboot is required to set SELinux state to 'enforcing'
changed: [192.168.129.133]

TASK [selinux : Set ansible facts if needed] *********************************************************
ok: [192.168.129.133]

TASK [selinux : Fail if reboot is required] **********************************************************
fatal: [192.168.129.133]: FAILED! => {"changed": false, "msg": "Reboot is required to apply changes. Re-execute the role after boot."}

TASK [Check for failure for other reasons than  required reboot] *************************************
skipping: [192.168.129.133]

TASK [Restart managed host] **************************************************************************
changed: [192.168.129.133]

TASK [Reapply Selinux role to cpmplete changes] ******************************************************

TASK [selinux : Install SELinux python2 tools] *******************************************************
skipping: [192.168.129.133]

TASK [selinux : Install SELinux python3 tools] *******************************************************
ok: [192.168.129.133]

TASK [selinux : refresh facts] ***********************************************************************
ok: [192.168.129.133]

TASK [selinux : Install SELinux tool semanage on Fedora] *********************************************
ok: [192.168.129.133]

TASK [selinux : Set permanent SELinux state if enabled] **********************************************
ok: [192.168.129.133]

TASK [selinux : Set permanent SELinux state if disabled] *********************************************
skipping: [192.168.129.133]

TASK [selinux : Set ansible facts if needed] *********************************************************
ok: [192.168.129.133]

TASK [selinux : Fail if reboot is required] **********************************************************
skipping: [192.168.129.133]

TASK [selinux : debug] *******************************************************************************
skipping: [192.168.129.133]

TASK [selinux : Drop all local modifications] ********************************************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux boolean local modifications] ***************************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux file context local modifications] **********************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux port local modifications] ******************************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux login local modifications] *****************************************
skipping: [192.168.129.133]

TASK [selinux : Reload SELinux policy] ***************************************************************
changed: [192.168.129.133]

TASK [selinux : Set SELinux booleans] ****************************************************************

TASK [selinux : Set SELinux file contexts] ***********************************************************

TASK [selinux : Restore SELinux labels on filesystem tree] *******************************************

TASK [selinux : Restore SELinux labels on filesystem tree in check mode] *****************************

TASK [selinux : Set an SELinux label on a port] ******************************************************

TASK [selinux : Set linux user to SELinux user mapping] **********************************************

PLAY RECAP *******************************************************************************************
192.168.129.133            : ok=13   changed=3    unreachable=0    failed=0    skipped=18   rescued=1    ignored=0 

//查看受管主机的selinux
[root@master ansible]# ansible httpd -a "getenforce"
192.168.129.133 | CHANGED | rc=0 >>
Enforcing

示例二：

//传输配置文件
[root@master files]# scp httpd:/etc/httpd/conf/httpd.conf httpd.conf.j2
[root@master files]# ls
httpd.conf.j2

//编辑模板
[root@master files]# vim httpd.conf.j2 
#Listen 12.34.56.78:80
Listen {{ port }}

[root@master playbook]# cat httpd.yml 
---
- hosts: httpd
  vars:
    PORT: 83
    selinux_state: enforcing
    seliux_ports:
      - ports: ' {{ PORT }} '
        settype: 'httpd_port_t  '
        proto: ' tcp '
        state: ' present '
  tasks:
    - name: install httpd
      yum:
        name: httpd
        state: present

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

    - name: selinux for httpd
      block:
        - name: role use
          include_role:
            name: selinux
      rescue:
        - name: Check for failure for other reasons than  required reboot
          fail:
          when: not selinux_reboot_required

        - name: Restart managed host
          reboot:

        - name: Reapply Selinux role to cpmplete changes
          include_role:
            name: selinux
        - name: service for httpd
          service: 
            name: httpd
            state: started
            enabled: yes
  handlers:
    - name: restart httpd
      service:
        name: httpd
        state: restarted


[root@master playbook]# ansible-playbook httpd.yml 

PLAY [httpd] *****************************************************************************************

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

TASK [install httpd] *********************************************************************************
ok: [192.168.129.133]

TASK [config httpd] **********************************************************************************
ok: [192.168.129.133]

TASK [role use] **************************************************************************************

TASK [selinux : Install SELinux python2 tools] *******************************************************
skipping: [192.168.129.133]

TASK [selinux : Install SELinux python3 tools] *******************************************************
ok: [192.168.129.133]

TASK [selinux : refresh facts] ***********************************************************************
ok: [192.168.129.133]

TASK [selinux : Install SELinux tool semanage on Fedora] *********************************************
ok: [192.168.129.133]

TASK [selinux : Set permanent SELinux state if enabled] **********************************************
ok: [192.168.129.133]

TASK [selinux : Set permanent SELinux state if disabled] *********************************************
skipping: [192.168.129.133]

TASK [selinux : Set ansible facts if needed] *********************************************************
ok: [192.168.129.133]

TASK [selinux : Fail if reboot is required] **********************************************************
skipping: [192.168.129.133]

TASK [selinux : debug] *******************************************************************************
skipping: [192.168.129.133]

TASK [selinux : Drop all local modifications] ********************************************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux boolean local modifications] ***************************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux file context local modifications] **********************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux port local modifications] ******************************************
skipping: [192.168.129.133]

TASK [selinux : Purge all SELinux login local modifications] *****************************************
skipping: [192.168.129.133]

TASK [selinux : Reload SELinux policy] ***************************************************************
changed: [192.168.129.133]

TASK [selinux : Set SELinux booleans] ****************************************************************

TASK [selinux : Set SELinux file contexts] ***********************************************************

TASK [selinux : Restore SELinux labels on filesystem tree] *******************************************

TASK [selinux : Restore SELinux labels on filesystem tree in check mode] *****************************

TASK [selinux : Set an SELinux label on a port] ******************************************************

TASK [selinux : Set linux user to SELinux user mapping] **********************************************

PLAY RECAP *******************************************************************************************
192.168.129.133            : ok=9    changed=1    unreachable=0    failed=0    skipped=15   rescued=0    ignored=0

在这里插入图片描述

三、角色结构创建

1、目录结构

默认情况下，Ansible在Ansible Playbook所在目录的roleq子目录中查找角色。这样，用户可以利用playbook和其他支持文件存储角色。
如果Ansible无法在该位置找到角色，它会按照顺序在Ansible配置设置roles_path所指定的目录中查找。此变量包含要搜索的目录的冒号分隔列表。此变量的默认值为:

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

例如：在

/etc/ansible/ansible.cfg

文件中添加

[root@master ~]# grep roles_path /etc/ansible/ansible.cfg 
roles_path    = ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

roles_path（以冒号分隔）
这允许用户将角色安装到由多个项目共享的系统上。例如，用户可能将自己的角色安装在自己的主目录下的~l.ansible/roles子目录中，而系统可能将所有用户的角色安装在/usr/share/ansible/roles目录中。

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

[root@master roles]# tree motd/
motd/
├── defaults
│   └── main.yml
├── files
├── handlers
│   └── main.yml
├── meta
│   └── main.yml
├── README.md
├── tasks
│   └── main.yml
├── templates
├── tests
│   ├── inventory
│   └── test.yml
└── vars
    └── main.yml

子目录	功能
defaults	此目录中的`main.yml`文件包含角色变量的默认值，使用角色时可以覆盖这些默认值。这些变量的优先级较低，应该在play中更改和自定义。
files	此目录包含由角色任务引用的静态文件。
handlers	此目录中的`main.yml`文件包含角色的处理程序定义。
meta	此目录中的`main.yml`文件包含与角色相关的信息，如作者、许可证、平台和可选的角色依赖项。
README.md	提供人类可读的基本描述、有关如何使用该角色的文档和示例，以及其发挥作用需要满足的任何非ansible要求
meta	此目录中的`main.yml`文件包含与角色相关的信息，如作者、许可证、平台和可选的角色依赖项。
tasks	此目录中的`main.yml`文件包含角色的任务定义。
templates	此目录包含由角色任务引用的`Jinja2`模板。
tests	此目录可以包含清单和名为`test.yml`的playbook，可用于测试角色。
vars	此目录中的`main.yml`文件定义角色的变量值。这些变量通常用于角色内部用途。这些变量的优先级较高，在playbook中使用时不应更改。

2、创建角色框架

可以使用标准Linux命令创建新角色所需的所有子目录和文件。此外，也可以通过命令行实用程序来自动执行新角色创建过程。
ansible-galaxy命令行工具可用于管理Ansible角色，包括新角色的创建。用户可以运行ansible-galaxy init来创建新角色的目录结构。指定角色的名称作为命令的参数，该命令在当前工作目录中为新角色创建子目录。

[root@master playbook]# cd roles/
[root@master roles]# ansible-galaxy init httpd
- Role httpd was created successfully
[root@master roles]# ls
httpd  selinux  timesync

[root@master roles]# tree httpd/
httpd/
|-- README.md
|-- defaults
|   `-- main.yml
|-- files
|-- handlers
|   `-- main.yml
|-- meta
|   `-- main.yml
|-- tasks
|   `-- main.yml
|-- templates
|-- tests
|   |-- inventory
|   `-- test.yml
`-- vars
    `-- main.yml

8 directories, 8 files

四、角色结构的使用方式

1、使用

//任务
[root@master playbook]# cat roles/httpd/tasks/main.yml
---
# tasks file for httpd
- name: install 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
    enabled: yes

//模板
[root@master roles]# cat httpd/templates/httpd.conf.j2 
#Listen 12.34.56.78:80
Listen {{ PORT }}

//定义变量
[root@master roles]# cat httpd/defaults/main.yml 
---
# defaults file for httpd
PORT: 82

//触发通知 handlers
[root@master roles]# cat httpd/handlers/main.yml 
---
# handlers file for httpd
- name: restart httpd
  service:
    name: httpd
    state: restarted

//执行playbook
[root@master playbook]# cat httpd.yml 
---
- hosts: httpd
  roles: 
    - httpd

[root@master playbook]# ansible-playbook httpd.yml 

PLAY [httpd] *****************************************************************************************

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

TASK [install httpd] *********************************************************************************
ok: [192.168.129.133]

TASK [config httpd] **********************************************************************************
changed: [192.168.129.133]

TASK [service httpd] *********************************************************************************
changed: [192.168.129.133]

RUNNING HANDLER [restart httpd] **********************************************************************
changed: [192.168.129.133]

PLAY RECAP *******************************************************************************************
192.168.129.133            : ok=5    changed=3    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

//查看
[root@mysql ~]# ss -anlt
State        Recv-Q       Send-Q             Local Address:Port               Peer Address:Port       
LISTEN       0            128                      0.0.0.0:111                     0.0.0.0:*              
LISTEN       0            128                      0.0.0.0:22                      0.0.0.0:*             
LISTEN       0            128                         [::]:111                        [::]:*          
LISTEN       0            128                            *:82                            *:*          
LISTEN       0            128                         [::]:22                         [::]:*          
LISTEN       0            5                          [::1]:631                        [::]:*

2、角色内容开发的推荐做法

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

3、在playbook中使用角色

[root@master playbook]# cat  test.yml 
---
- hosts: all
  roles:
    - role: roles/httpd            //这一行也可以简写为：- httpd

4、通过变量更改角色的行为

编写良好的角色利用默认变量来改变角色行为，使之与相关的配置场景相符。这有助于让角色变得更为通用，可在各种不同的上下文中重复利用。
如果通过以下方式定义了相同的变量，则角色的defaults目录中定义的变量的值将被覆盖
- 在清单文件中定义，作为主机变量或组变量
- 在playbook项目的group_vars或host_vars目录下的YAML文件中定义
- 作为变量嵌套在play的vars关键字中定义
- 在play的roles关键字中包含该角色时作为变量定义

[root@master playbook]# cat  httpd.yml 
---
- hosts: httpd
  vars:
    PORT: 81
  roles: 
    - httpd
//以上种方式定义变量时，PORT变量将替换defaults变量的值。

[root@master roles]# cat httpd/vars/main.yml 
---
# vars file for httpd
PORT: 81
//以这种方式定义的变量不能覆盖roles/vars/main.yml文件中的变量

[root@master playbook]# cat httpd.yml 
---
- hosts: httpd
  roles: 
    - role: httpd  //角色
      PORT: 81
//这种方式定义能覆盖defaults与vars变量的值（都会覆盖）

总结：

角色内嵌参数、事实、通过include_ va rs加载的变量、注册的变量
vars/main. yml中定义的变量
playbook中vars部分定义的变量
主机变量、主机组变量
defaults/main. yml中定义的变量

五、使用ansible galaxy部署角色

1、简介

1. 介绍ansible galaxy

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

2. 获取Ansible Galaxy帮助

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

3. 浏览Ansible Galaxy中的角色

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

4. 创建角色的方法

//第一种
[root@master roles]# ansible-galaxy init httpd
//第二种
[root@master roles]# ansible-galaxy role init nginx

2、Ansible Galaxy命令行工具

1. 从命令行搜索角色

ansible-galaxy search子命令在Ansible Galaxy中搜索角色。如果以参数形式指定了字符串，则可用于按照关键字在Ansible Galaxy中搜索角色。用户可以使用**–author**（作者）、–platforms（平台）和**–galaxy-tags**（标记）选项来缩小搜索结果的范围。也可以将这些选项用作主要的搜索键。
搜索结果按照字母顺序显示，而不是Best Match分数降序排列。

[root@master ~]# ansible-galaxy search 'redis' --platforms EL 		 //表示搜索包含redis并且适用于企业Linux(EL)平台的角色的名称。换种写法：ansible-galaxy search redis --platform Fedora

Found 235 roles matching your search:

 Name                                            Description
 ----                                            -----------
 0x0i.consul                                     Consul - a service discovery, mesh and configuration>
 0x0i.grafana                                    Grafana - an analytics and monitoring observability >
 0x5a17ed.ansible_role_netbox                    Installs and configures NetBox, a DCIM suite, in a p>
 1it.sudo                                        Ansible role for managing sudoers
 adfinis-sygroup.redis                           Ansible role for Redis
 AerisCloud.librato                              Install and configure the Librato Agent
 ……略

//搜素
[root@master roles]# ansible-galaxy role search geerlingguy.redis/

Found 26 roles matching your search:

 Name                            Description
 ----                            -----------
 alban.andrieu.logstash-settings A role for installing logstash configuration
 alikins.php_redis               PhpRedis support for Linux
 alikins.redis                   Redis for Linux
 binarycode.redis                Redis for Linux
 bpresles.redis                  Redis for Linux
 bsmeding.ansible_role_nautobot  Installs Nautobot (fork from Netbox) CMDB
……

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

[root@master ~]# ansible-galaxy role info robertdebock.httpd

Role: robertdebock.httpd
        description: Install and configure httpd on your system.
        active: True
        commit: 9fc0e5c1f38873f26c1d896d7db1424b2e07181b
        commit_message: 404 is also good.
        commit_url: https://api.github.com/repos/robertdebock/ansible-role-httpd/git/commits/9fc0e5c1>
        company: none
        created: 2017-11-10T16:04:25.981866Z
        download_count: 141057
        forks_count: 11
        github_branch: master
        github_repo: ansible-role-httpd
        github_user: robertdebock
        id: 21855
……略

2. 从Ansible Galaxy安装角色

使用ansible-galaxy install子命令从Ansible Galaxy下载角色，并将它安装到控制节点本地。
- 默认情况下，角色安装到用户的roles_path下的第一个可写目录中。根据为Ansible设置的默认roles_path，角色通常将安装到用户的~/.ansible/roles目录。默认的roles_path可能会被用户当前Ansible配置文件或环境变量ANSIBLE_ROLES_PATH覆盖，这将影响ansible-galaxy的行为。
- 也可以通过使用-p DIRECTORY选项，指定具体的目录来安装角色。

[root@master ~]# 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.7.0.tar.gz
- extracting geerlingguy.redis to /root/roles/geerlingguy.redis
- geerlingguy.redis (1.7.0) was installed successfully

[root@master ~]# ls roles/
geerlingguy.redis

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

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

[root@master roles]# vim requirements.yml
- src: geerlingguy.redis			//src属性指定角色的来源
  version: "1.5.0"  				//version属性是可选的，指定要安装的角色版本

//使用-r requirements-file选项指定角色文件来安装角色
[root@master ~]#  ansible-galaxy install -r roles/requirements.yml -p roles/

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

用户可以使用ansible-galaxy来安装不在Ansible Galaxy中的角色。可以在私有的Git存储库或Web服务器上托管自有的专用或内部角色。

[root@master roles]# cat 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: git@gitlab.com: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关键字可以是与严自角色的软件存储库的分支、标记或提交哈希对应的任何值。

若要安装与playbook项目关联的角色，可执行ansible-galaxy install命令：

//以文件的方式安装到指定位置
[root@master roles]# ansible-galaxy role install -r roles/requirements.yml -p roles
//安装指定位置
[root@master roles]# ansible-galaxy role install requirements.yml -p .

4. 管理下载的角色

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

//方法一
[root@master ~]# ansible-galaxy role install robertdebock.httpd 
- downloading role 'httpd', owned by robertdebock
- downloading role from https://github.com/robertdebock/ansible-role-httpd/archive/7.0.0.tar.gz
- extracting robertdebock.httpd to /root/.ansible/roles/robertdebock.httpd
- robertdebock.httpd (7.0.0) was installed successfully

[root@master ~]# ansible-galaxy list
# /root/.ansible/roles
- robertdebock.httpd, 7.0.0
# /usr/share/ansible/roles
- linux-system-roles.certificate, (unknown version)
- linux-system-roles.crypto_policies, (unknown version)
- linux-system-roles.ha_cluster, (unknown version)
- linux-system-roles.kdump, (unknown version)
……略

//方法二：
[root@master roles]# ansible-galaxy role install robertdebock.httpd -p .
- downloading role 'httpd', owned by robertdebock
- downloading role from https://github.com/robertdebock/ansible-role-httpd/archive/7.0.0.tar.gz
- extracting robertdebock.httpd to /root/roles/robertdebock.httpd
- robertdebock.httpd (7.0.0) was installed successfully

[root@master roles]# ansible-galaxy list -p .
# /root/roles
- robertdebock.httpd, 7.0.0
# /root/.ansible/roles
# /usr/share/ansible/roles
- linux-system-roles.certificate, (unknown version)
- linux-system-roles.crypto_policies, (unknown version)
- linux-system-roles.ha_cluster, (unknown version)
- linux-system-roles.kdump, (unknown version)

可以使用ansible-galaxy remove子命令本地删除角色。(必须是要安装的角色，自己制作的不能删除)

[root@master ~]# ansible-galaxy role remove robertdebock.httpd 
- successfully removed robertdebock.httpd

[root@master ~]# ansible-galaxy list
# /root/.ansible/roles
# /usr/share/ansible/roles
- linux-system-roles.certificate, (unknown version)
- linux-system-roles.crypto_policies, (unknown version)
- linux-system-roles.ha_cluster, (unknown version)
- linux-system-roles.kdump, (unknown version)
……略

在playbook中使用下载并安装的角色的方式与任何其他角色都一样。在roles部分中利用其下载的角色名称来加以引用。如果角色不在项目的roles目录中，则将检查roles_path来查看角色是否安装在了其中一个目录中。

[root@master roles]# 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