您现在的位置是:首页 > 正文

创建角色、ansible-galaxy的简单使用

2024-02-29 15:55:14阅读 1

创建角色、ansible-galaxy的简单使用

1.1 创建角色

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

创建角色目录结构
定义角色内容
在playbook中使用角色
1.1 创建角色目录结构
默认情况下,Ansible在Ansible Playbook所在目录的roles子目录中查找角色。这样,用户可以利用playbook和其他支持文件存储角色。

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

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

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

1.2 创建角色框架

可以使用标准Linux命令创建新角色所需的所有子目录和文件。此外,也可以通过命令行实用程序来自动执行新角色创建过程。

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

用linux标准命令创建:

[root@localhost roles]# tree httpd/
httpd/
├── defaults
├── files
├── handlers
├── meta
├── tasks
├── templates
├── tests
└── vars

手动创建yml子文件 
[root@localhost httpd]# tree 
.
├── defaults
│   └── main.yml
├── files
├── handlers
│   └── main.yml
├── meta
│   └── main.yml
├── tasks
│   └── main.yml
├── templates
├── tests
│   └── test.yml
└── vars
    └── main.yml

使用ansible-galaxy命令创建:

[root@localhost roles]# ansible-galaxy init httpd
- Role httpd was created successfully
[root@localhost roles]# ls
httpd  project
[root@localhost roles]# tree httpd/
httpd/
├── defaults
│   └── main.yml
├── files
├── handlers
│   └── main.yml
├── meta
│   └── main.yml
├── README.md
├── tasks
│   └── main.yml
├── templates
├── tests
│   ├── inventory
│   └── test.yml
└── vars

1.3 定义角色内容

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

下列tasks/main.yml文件管理受管主机上的/etc/motd文件。它使用template模块将名为motd.j2的模板部署到受管主机上。因为template模块是在角色任务而非playbook任务内配置的,所以从角色的templates子目录检索motd.j2模板。

[root@localhost project]# cat roles/httpd/tasks/main.yml 
---
# tasks file for httpd
- name: install httpd
  yum:
    name: httpd
    state: present

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

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

//编写defaults变量
[root@localhost project]# cat roles/httpd/defaults/main.yml 
---
# defaults file for httpd
PORT: 80

//编写handlers 重启服务
[root@localhost project]# cat roles/httpd/handlers/main.yml 
---
# handlers file for httpd
- name: restart httpd
  service:
    name: httpd
    state: restarted

//编写测试任务
[root@localhost project]# cat test.yml 
---
- hosts: 192.168.200.136
  roles:
    - role: httpd

//执行playbook
[root@localhost project]# ansible-playbook test.yml 

PLAY [192.168.200.136] *****************************************************************************

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

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

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

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

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

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

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

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

1.在角色自己的版本控制存储库中维护每个角色。Ansible很适合使用基于git的存储库。

2.角色存储库中不应存储敏感信息,如密码或SSH密钥。敏感值应以变量的形式进行参数化,其默认值应不敏感。使用角色的playbook负责通过Ansible Vault变量文件、环境变量或其他ansible-playbook选项定义敏感变量。

3.使用ansible-galaxy init启动角色,然后删除不需要的任何目录和文件。

4.创建并维护README.md和meta/main.yml文件,以记录用户的角色的用途、作者和用法。

5.让角色侧重于特定的用途或功能。可以编写多个角色,而不是让一个角色承担许多任务。

6.经常重用和重构角色。避免为边缘配置创建新的角色。如果现有角色能够完成大部分的所需配置,请重构现有角色以集成新的配置方案。使用集成和回归测试技术来确保角色提供所需的新功能,并且不对现有的playbook造成问题。

1.5 定义角色依赖项

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

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

roles/httpd/
├── defaults
│   └── main.yml
├── files
├── handlers
│   └── main.yml
├── meta
│   └── main.yml
├── README.md
├── tasks
│   ├── httpd.conf.j2
│   └── main.yml
├── templates
├── tests
│   ├── inventory
│   └── test.yml
└── vars
    └── main.yml


dependencies:
    - role: apache
    - port: 8080
    - role: postgres
      dbname: serverlist
      admin_user: felix

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

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

1.6 在playbook中使用角色

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

[root@localhost project]# cat roles/httpd/defaults/main.yml 
---
# defaults file for httpd
PORT: 82

[root@localhost project]# cat test.yml 
---
- hosts: 192.168.200.136
  roles:
    - httpd

//执行playbook
[root@localhost project]# ansible-playbook test.yml 

PLAY [192.168.200.136] *****************************************************************************

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

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

TASK [service httpd] *******************************************************************************
ok: [192.168.200.136]

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

PLAY RECAP *****************************************************************************************
192.168.200.136            : ok=4    changed=0    unreachable=0    failed=0    skipped=0    
[root@localhost /]# ss -antl
State    Recv-Q   Send-Q     Local Address:Port           Peer Address:Port        Process        
LISTEN   0        128              0.0.0.0:22                  0.0.0.0:*                                                   
LISTEN   0        128                    *:82                        *:*                          
LISTEN   0        128                 [::]:22                     [::]:*                          
[root@localhost /]# 

2.使用ansible galaxy部署角色

2.1.介绍ansible galaxy

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

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

2.2 获取Ansible Galaxy帮助

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

2.3 浏览Ansible Galaxy中的角色

通过Ansible Galaxy网站主页上左侧的Search标签,用户可以访问关于Ansible Galaxy上发布的角色的信息。用户可以使用标记通过角色的名称或通过其他角色属性来搜索Ansible角色。结果按照Best Match分数降序排列,此分数依据角色质量、角色受欢迎程度和搜索条件计算而得。
ansible-galaxy search子命令在Ansible Galaxy中搜索角色。如果以参数形式指定了字符串,则可用于按照关键字在Ansible Galaxy中搜索角色。用户可以使用–author、–platforms和–galaxy-tags选项来缩小搜索结果的范围。也可以将这些选项用作主要的搜索键。例如,命令ansible-galaxy search --author geerlingguy将显示由用户geerlingguy提交的所有角色。

结果按照字母顺序显示,而不是Best Match分数降序排列。下例显示了包含redis并且适用于企业Linux(EL)平台的角色的名称。

ansible-galaxy search 'redis' --platforms EL                                                                                                                                                                                                                                                             

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

ansible-galaxy info geerlingguy.redis

2.4 从Ansible Galaxy安装角色

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

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

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

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

ansible-galaxy install geerlingguy.redis -p roles/

2.5使用要求文件安装角色

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

- src: geerlingguy.redis
  version: "1.5.0"

src属性指定角色的来源,本例中为来自Ansible Galaxy的geerlingguy.redis角色。version属性是可选的,指定要安装的角色版本,本例中为1.5.0。

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

若要使用角色文件来安装角色,可使用-r REQUIREMENTS-FILE选项:

ansible-galaxy install -r roles/requirements.yml -p roles

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

[root@localhost project]# 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: 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@localhost project]# ansible-galaxy install -r roles/requirements.yml -p roles

2.5管理下载的角色

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

ansible-galaxy list

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

ansible-galaxy remove nginx-acme-ssh
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

k中使用下载并安装的角色的方式与任何其他角色都一样。在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

此playbook使不同版本的geerlingguy.redis角色应用到生产和开发服务器。借助这种方式可以对角色更改进行系统化测试和集成,然后再部署到生产服务器上。如果角色的近期更改造成了问题,则借助版本控制来开发角色,就能回滚到过去某一个稳定的角色版本。

网站文章

  • AopContext对象原理

    AopContext的是使用和原理

    2024-02-29 15:55:08
  • SDIO协议概述

    SDIO总线SDIO总线和USB总线类似,SDIO总线也有两端,其中一端是主机(HOST)端,另一端是设备端(DEVICE),采用HOST- DEVICE这样的设计是为了简化DEVICE的设计,所有的通信都是由HOST端发出命令开始的。在DEVICE端只要能解溪HOST的命令,就可以同HOST进行通信了。这个是同SD的总线一样的,其中有如下的几种信号1.CLK信号:HOST给DEVICE的时...

    2024-02-29 15:54:40
  • 【笔记】torch 乘法总结

    【笔记】torch 乘法总结 一、乘号(*) 和 torch.mul() element-wise 即对应元素相乘 例子: >>> a = torch.randn(2,3) >...

    2024-02-29 15:54:31
  • JUC多线程及高并发-CAS-ABA

    JUC多线程及高并发-CAS-ABA

    JUC多线程及高并发-CASCAS是什么atomicInteger.compareAndSetUnsafeCAS是什么CAS的全称为Compare-And-Swap,它是一条CPU并发原语。它的功能是...

    2024-02-29 15:54:23
  • 各省市各区中心点经纬度数据(更新至2021年)

    各省市各区中心点经纬度数据(更新至2021年)

    1、数据来源:高德地图API 2、时间跨度:2021年 3、区域范围:全国 4、指标说明: 包含如下指标: 省份 城市 经度 纬度 行政区划代码 5、部分数据截图: 相关研究: [1]李林, 丁艺, ...

    2024-02-29 15:53:52
  • Docker 容器时区问题

    docker 容器时区问题利用docker发布服务,发现程序用获取的系统时间比正常时间晚了8个小时进入容器docker exec -it 容器id /bin/sh查询时间date -R发现时区为0时区...

    2024-02-29 15:53:44
  • 自定义Flutter Lint插件实现自己的Dart语法规则(静态语法分析检测)

    自定义Flutter Lint插件实现自己的Dart语法规则(静态语法分析检测)

    摘要:本文实现了一个自定义的语法检查插件,功能是:当新写一个dart类,如果类名中包含ViewModel,那么必须添加前缀HDW。在vscode中效果如下:在网上搜索自定义Dart语法检查或自定义Da...

    2024-02-29 15:53:35
  • 数据结构-十大经典排序算法 第4关:希尔排序

    数据结构-十大经典排序算法 第4关:希尔排序

    数据结构-十大经典排序算法 第4关:希尔排序

    2024-02-29 15:53:09
  • html 点击隐藏特效代码,vueJS简单的点击显示与隐藏的效果(实现代码)

    下面小编就为大家带来一篇vueJS简单的点击显示与隐藏的效果【实现代码】。小编觉得挺不错的,现在分享给大家,一起跟随小编过来看看吧目前前端框架太多,接触过angular、ember,现在开始倒腾vue...

    2024-02-29 15:53:03
  • 首都师范大学计算机科学与技术双培计划,2019北京市市属院校最新“双培计划”名额分布及对接高校...

    从目前发布信息看各高校“双培计划”名额如下:北京工业大学265,北京信息科技大学264,北方工业大学224,首都师范大学158,北京联合大学144,北京建筑大学106,北京物资学院96,北京农学院80...

    2024-02-29 15:52:54