创建角色、Ansible-Galaxy的简单使用

秦毅
2023-12-01

创建角色、Ansible-Galaxy的简单使用

创建角色

创建角色首先我们要创建角色框架,创建角色框架可以用Linux的标准命令创建,也可以用ansible提供的命令自动创建角色框架

第一种:用linux标准命令自创建

// 手动创建角色
[root@master2 playbook]# mkdir roles
[root@master2 playbook]# cd roles
[root@master2 roles]# ls
[root@master2 roles]# mkdir -p nginx/{defaults,vars,files,templates,tasks,handlers,test}
[root@master2 roles]# tree nginx
nginx
|-- defaults
|-- files
|-- handlers
|-- tasks
|-- templates
|-- test
`-- vars

7 directories, 0 files
[root@master2 roles]# touch nginx/{defaults/main.yml,tasks/main.yml,vars/main.yml}
[root@master2 roles]# tree nginx
nginx
|-- defaults
|   `-- main.yml
|-- files
|-- handlers
|-- tasks
|   `-- main.yml
|-- templates
|-- test
`-- vars
    `-- main.yml

7 directories, 3 files

第二种:使用ansible-galaxy命令创建

// 通过ansible-galaxy创建角色:
ansible-galaxy init/初始化 httpd

[root@master2 roles]# ansible-galaxy init httpd
- Role httpd was created successfully
[root@master2 roles]# tree httpd/
httpd/
|-- README.md
|-- defaults
|   `-- main.yml
|-- files
|-- handlers
|   `-- main.yml
|-- meta
|   `-- main.yml
|-- tasks
|   `-- main.yml
|-- templates
|-- tests
|   |-- inventory  // 给别人使用需要添加meta,任务说明以及帮助文档的README.md

|   `-- test.yml
`-- vars
    `-- main.yml

8 directories, 8 files
[root@master2 roles]# 

1 通过角色yum安装appache

1.1 在tasks写任务

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

- name: service for apache
  service:
    name: httpd
    state: started 

1.2 在templates传输模板:

模板文件:
// 检查主机是否安装apache
[root@master2 roles]# 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               [::]:22             [::]:*                                                                   
[root@master2 roles]# cd httpd/templates/
[root@master2 templates]# ls
[root@master2 templates]# cat /etc/hosts
127.0.0.1   localhost localhost.localdomain localhost4 localhost4.localdomain4
::1         localhost localhost.localdomain localhost6 localhost6.localdomain6
192.168.91.134 centos1
[root@master2 templates]# scp centos1:/etc/httpd/conf/httpd.conf httpd.conf.j2
httpd.conf                   100%   12KB   3.3MB/s   00:00    // 现在被控机安装HTTPD,把配置文件传输过来再去删除
[root@master2 templates]# ls
httpd.conf.j2
[root@centos1 ~]# rm -rf /etc/httpd
[root@centos1 ~]# yum -y remove httpd // 删除

1.3 修改tasks任务

修改tasks:
[root@master2 roles]# vim httpd/tasks/main.yml 
[root@master2 roles]# cat httpd/tasks/main.yml 
---
# tasks file for httpd
- name: install apache
  yum:
    name: httpd
    state: present

- name: config apache
  template:
    src: templates/httpd.conf.j2
    dest: /etc/httpd/conf/httpd.conf
    
- name: service for apache
  service:
    name: httpd
    state: started 

1.4 在templates子目录修改模板配置文件,给端口号设置变量:

[root@master2 roles]# cd httpd/
[root@master2 httpd]# vim templates/httpd.conf.j2 
#Listen 12.34.56.78:80
Listen {{ PORT }}

1.5 在defaults子目录里定义默认变量:

root@master2 httpd]# vim defaults/main.yml 
[root@master2 httpd]# cat defaults/main.yml 
---
# defaults file for httpd
PORT: 80

定义完成:
[root@master2 roles]# tree httpd/
httpd/
|-- README.md
|-- defaults
|   `-- main.yml
|-- files
|-- handlers
|   `-- main.yml
|-- meta
|   `-- main.yml
|-- tasks
|   `-- main.yml
|-- templates
|   `-- httpd.conf.j2
|-- tests
|   |-- inventory
|   `-- test.yml
`-- vars
    `-- main.yml

8 directories, 9 files

1.6 写playbokk,角色代入:

[root@master2 roles]# cd /opt/project/
[root@master2 project]# ls
ansible.cfg  group_vars  inventory
feiliao      host_vars   playbook
[root@master2 project]# ls playbook/
roles查看:
[root@centos1 ~]# 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                  *:80                *:*                                                                   
LISTEN 0       32                   *:21                *:*                                                                   
LISTEN 0       128               [::]:22             [::]:*    
[root@master2 project]# vim playbook/httpd.yml
[root@master2 project]# cat playbook/httpd.yml
---
- hosts: centos1
  roles:
    - httpd

1.7 playbook开始执行:

[root@master2 project]# ansible-playbook playbook/httpd.yml 
TASK [httpd : service for apache] **********************************************
changed: [centos1]

PLAY RECAP *********************************************************************
centos1                    : ok=4    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

查看:
[root@centos1 ~]# 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                  *:80                *:*                                                                   
LISTEN 0       32                   *:21                *:*                                                                   
LISTEN 0       128               [::]:22             [::]:*    

2. 修改端口号

2.1 修改端口号

[root@master2 project]# cat playbook/httpd.yml
---
- hosts: centos1
  vars:
    PORT: 82 
  roles:
    - httpd

// 服务未重启,82无法实现
[root@centos1 ~]# grep 80 /etc/httpd/conf/httpd.conf 
#Listen 12.34.56.78:80
Listen 80
#ServerName www.example.com:80

2.2 重新设置需要重新启动才有效:

[root@master2 httpd]# vim tasks/main.yml 
[root@master2 httpd]# cat tasks/main.yml 
---
# tasks file for httpd
- name: install apache
  yum:
    name: httpd
    state: present

- name: config apache
  template:
    src: templates/httpd.conf.j2
    dest: /etc/httpd/conf/httpd.conf
  notify:
    - restart httpd
    
- name: service for apache
  service:
    name: httpd
    state: started 

2.3 设置handlers:

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

2.4 // 再次修改端口号,改为83,重新play

[root@master2 project]# cat playbook/httpd.yml
---
- hosts: centos1
  vars:
    PORT: 83
  roles:
    - httpd

2.5 检查是否会触发处理程序,是否成功变为83:

[root@master2 project]# vim playbook/httpd.yml
[root@master2 project]# ansible-playbook playbook/httpd.yml 

PLAY [centos1] *****************************************************************

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

TASK [httpd : install apache] **************************************************
ok: [centos1]

TASK [httpd : config apache] ***************************************************
changed: [centos1]

TASK [httpd : service for apache] **********************************************
ok: [centos1]

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

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

[root@centos1 ~]# 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                  *:83                *:*                                                                   
LISTEN 0       32                   *:21                *:*                                                                   
LISTEN 0       128               [::]:22             [::]:*                                                                   
[root@centos1 ~]# grep 83 /etc/httpd/conf/httpd.conf 
Listen 83

2.6 判断selinux:

[root@centos1 ~]# semanage port -l | grep http
http_cache_port_t              tcp      8080, 8118, 8123, 10001-10010
http_cache_port_t              udp      3130
http_port_t                    tcp      80, 81, 443, 488, 8008, 8009, 8443, 9000 //selinux打开了这里加82,83端口号
pegasus_http_port_t            tcp      5988
pegasus_https_port_t           tcp      5989
// selinux打开了加判断,没有打开直接重启

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提交的所有角色。

结果按照字母顺序显示,而不是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.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选项,指定具体的目录来安装角色。

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

ansible-galaxy install geerlingguy.redis -p roles/

2.3 使用要求文件安装角色

可以使用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@master2 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@master2 project]# ansible-galaxy install -r roles/requirements.yml -p roles

2.4 管理下载的角色

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@master2 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角色应用到生产和开发服务器。借助这种方式可以对角色更改进行系统化测试和集成,然后再部署到生产服务器上。如果角色的近期更改造成了问题,则借助版本控制来开发角色,就能回滚到过去某一个稳定的角色版本。

 类似资料: