Ansible 简明教程

Ansible - Roles

角色为完全独立或相互依赖的变量、任务、文件、模板和模块集提供了一个框架。

Roles provide a framework for fully independent, or interdependent collections of variables, tasks, files, templates, and modules.

在 Ansible 中，角色是将剧本分成多个文件的主要机制。这简化了编写 complex playbooks ，并使其更容易重用。通过分解剧本，您可以将剧本合理分解为可重用的组件。

In Ansible, the role is the primary mechanism for breaking a playbook into multiple files. This simplifies writing complex playbooks, and it makes them easier to reuse. The breaking of playbook allows you to logically break the playbook into reusable components.

每个角色基本上仅限于特定功能或期望的输出，所有必要的步骤都在该角色本身或者在依赖关系中列出的其他角色中提供该结果。

Each role is basically limited to a particular functionality or desired output, with all the necessary steps to provide that result either within that role itself or in other roles listed as dependencies.

角色不是剧本。角色是小功能，可以独立使用，但必须在剧本中使用。无法直接执行角色。角色没有明确的设置，用来说明角色将应用于哪个主机。

Roles are not playbooks. Roles are small functionality which can be independently used but have to be used within playbooks. There is no way to directly execute a role. Roles have no explicit setting for which host the role will apply to.

顶级剧本是桥梁，将清单文件中的主机与应该应用于这些主机的角色联系起来。

Top-level playbooks are the bridge holding the hosts from your inventory file to roles that should be applied to those hosts.

Creating a New Role

角色的目录结构对于创建新角色至关重要。

The directory structure for roles is essential to create a new role.

Role Structure

角色在文件系统上具有结构化的布局。默认结构可以更改，但现在我们坚持默认设置。

Roles have a structured layout on the file system. The default structure can be changed but for now let us stick to defaults.

每个角色本身都是一个目录树。角色名称是 /roles 目录内的目录名称。

Each role is a directory tree in itself. The role name is the directory name within the /roles directory.

$ ansible-galaxy -h

Usage

ansible-galaxy [delete|import|info|init|install|list|login|remove|search|setup] [--help] [options] ...

Options

-h, --help − Show this help message and exit.
-v, --verbose − Verbose mode (-vvv for more, -vvvv to enable connection debugging)
--version − Show program’s version number and exit.

Creating a Role Directory

以上命令创建了角色目录。

The above command has created the role directories.

$ ansible-galaxy init vivekrole
ERROR! The API server (https://galaxy.ansible.com/api/) is not responding, please try again later.

$ ansible-galaxy init --force --offline vivekrole
- vivekrole was created successfully

$ tree vivekrole/
vivekrole/
├── defaults
│   └── main.yml
├── files ├── handlers
│   └── main.yml
├── meta
│   └── main.yml
├── README.md ├── tasks
│   └── main.yml
├── templates ├── tests │   ├── inventory
│   └── test.yml
└── vars
    └── main.yml

8 directories, 8 files

并非所有目录都将在示例中使用，我们将在示例中展示其中一些目录的使用。

Not all the directories will be used in the example and we will show the use of some of them in the example.

Utilizing Roles in Playbook

这是我们为演示目的编写的剧本的代码。此代码属于剧本 vivek_orchestrate.yml。我们定义了主机： tomcat-node ，并调用了两个角色 - install-tomcat 和 start-tomcat 。

This is the code of the playbook we have written for demo purpose. This code is of the playbook vivek_orchestrate.yml. We have defined the hosts: tomcat-node and called the two roles – install-tomcat and start-tomcat.

问题陈述是，我们有一场战争，我们需要通过 Ansible 部署到一台机器上。

The problem statement is that we have a war which we need to deploy on a machine via Ansible.

---
- hosts: tomcat-node
roles:
   - {role: install-tomcat}
   - {role: start-tomcat}

从我们运行剧本的目录结构的内容。

Contents of our directory structure from where we are running the playbook.

$ ls
ansible.cfg  hosts  roles  vivek_orchestrate.retry vivek_orchestrate.yml

每个目录下都有一个任务目录，其中包含一个 main.yml。install-tomcat 的 main.yml 内容为：

There is a tasks directory under each directory and it contains a main.yml. The main.yml contents of install-tomcat are −

---
#Install vivek artifacts
-
   block:
      - name: Install Tomcat artifacts
         action: >
            yum name = "demo-tomcat-1" state = present
         register: Output

   always:
      - debug:
         msg:
            - "Install Tomcat artifacts task ended with message: {{Output}}"
            - "Installed Tomcat artifacts - {{Output.changed}}"

start tomcat 的 main.yml 的内容为：

The contents of main.yml of the start tomcat are −

#Start Tomcat
-
   block:
      - name: Start Tomcat
      command: <path of tomcat>/bin/startup.sh"
      register: output
      become: true

   always:
      - debug:
         msg:
            - "Start Tomcat task ended with message: {{output}}"
            - "Tomcat started - {{output.changed}}"

将剧本分解为角色的优点是，任何想要使用 Install tomcat 功能的人都可以调用 Install Tomcat 角色。

The advantage of breaking the playbook into roles is that anyone who wants to use the Install tomcat feature can call the Install Tomcat role.

Breaking a Playbook into a Role

如果没有角色，则各个角色的 main.yaml 的内容可以复制到剧本 yml 文件中。但要具有模块化，创建了角色。

If not for the roles, the content of the main.yml of the respective role can be copied in the playbook yml file. But to have modularity, roles were created.

任何可作为可重用函数重复使用的逻辑实体，该实体可以移动到角色。上文给出了示例

Any logical entity which can be reused as a reusable function, that entity can be moved to role. The example for this is shown above

运行了运行剧本的命令。

Ran the command to run the playbook.

-vvv option for verbose output – verbose output
$ cd vivek-playbook/

这是运行剧本的命令

This is the command to run the playbook

$ sudo ansible-playbook -i hosts vivek_orchestrate.yml –vvv
-----------------------------------------------------------------
-----------------------------------------------------------------------

Output

生成的输出在屏幕上可见，如下所示：

The generated output is as seen on the screen −

使用 /users/demo/vivek-playbook/ansible.cfg 作为配置文件。

Using /users/demo/vivek-playbook/ansible.cfg as config file.

PLAYBOOK: vivek_orchestrate.yml *********************************************************
***********************************************************
1 plays in vivek_orchestrate.yml

PLAY [tomcat-node] **********************************************************************
******** *************************************************

TASK [Gathering Facts] *************************************************
****************************** *********************************************
Tuesday 21 November 2017  13:02:05 +0530 (0:00:00.056) 0:00:00.056 ******
Using module file /usr/lib/python2.7/sitepackages/ansible/modules/system/setup.py
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: root
<localhost> EXEC /bin/sh -c 'echo ~ && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo
   /root/.ansible/tmp/ansible-tmp-1511249525.88-259535494116870 `" &&
   echo ansible-tmp-1511249525.88-259535494116870="`
   echo /root/.ansible/tmp/ansibletmp-1511249525.88-259535494116870 `" ) && sleep 0'
<localhost> PUT /tmp/tmpPEPrkd TO
   /root/.ansible/tmp/ansible-tmp-1511249525.88259535494116870/setup.py
<localhost> EXEC /bin/sh -c 'chmod u+x
   /root/.ansible/tmp/ansible-tmp1511249525.88-259535494116870/
   /root/.ansible/tmp/ansible-tmp-1511249525.88259535494116870/setup.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python
   /root/.ansible/tmp/ansible-tmp1511249525.88-259535494116870/setup.py; rm -rf
   "/root/.ansible/tmp/ansible-tmp1511249525.88-259535494116870/" > /dev/null 2>&1 && sleep 0'
ok: [server1]
META: ran handlers

TASK [install-tomcat : Install Tomcat artifacts] ***********************************
***************************************************************
task path: /users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:5
Tuesday 21 November 2017  13:02:07 +0530 (0:00:01.515)       0:00:01.572 ******
Using module file /usr/lib/python2.7/sitepackages/ansible/modules/packaging/os/yum.py
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: root
<localhost> EXEC /bin/sh -c 'echo ~ && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo
   /root/.ansible/tmp/ansible-tmp-1511249527.34-40247177825302 `" && echo
   ansibletmp-1511249527.34-40247177825302="` echo
   /root/.ansible/tmp/ansible-tmp1511249527.34-40247177825302 `" ) && sleep 0'
<localhost> PUT /tmp/tmpu83chg TO
   /root/.ansible/tmp/ansible-tmp-1511249527.3440247177825302/yum.py
<localhost> EXEC /bin/sh -c 'chmod u+x
   /root/.ansible/tmp/ansible-tmp1511249527.34-40247177825302/
   /root/.ansible/tmp/ansible-tmp-1511249527.3440247177825302/yum.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python
   /root/.ansible/tmp/ansible-tmp1511249527.34-40247177825302/yum.py; rm -rf
   "/root/.ansible/tmp/ansible-tmp1511249527.34-40247177825302/" > /dev/null 2>
   &1 && sleep 0'
changed: [server1] => {
   "changed": true,
   "invocation": {
      "module_args": {
         "conf_file": null,
         "disable_gpg_check": false,
         "disablerepo": null,
         "enablerepo": null,
         "exclude": null,
         "install_repoquery": true,
         "installroot": "/",
         "list": null,
         "name": ["demo-tomcat-1"],
         "skip_broken": false,
         "state": "present",
         "update_cache": false,
         "validate_certs": true
      }
   },
   "msg": "",
   "rc": 0,
   "results": [
      "Loaded plugins: product-id,
      search-disabled-repos,
      subscriptionmanager\nThis system is not registered to Red Hat Subscription Management.
      You can use subscription-manager to register.\nResolving Dependencies\n-->
      Running transaction check\n--->
      Package demo-tomcat-1.noarch 0:SNAPSHOT-1 will be installed\n--> Finished Dependency
      Resolution\n\nDependencies Resolved\n
      \n================================================================================\n
      Package Arch Version Repository
      Size\n==================================================================\nInstalling:\n
      demo-tomcat-1 noarch SNAPSHOT-1 demo-repo1 7.1 M\n\nTransaction
      Summary\n==================================================================\nInstall  1
      Package\n\nTotal download size: 7.1 M\nInstalled size: 7.9 M\nDownloading
         packages:\nRunning transaction
      check\nRunning transaction test\nTransaction test succeeded\nRunning transaction\n  Installing :
      demotomcat-1-SNAPSHOT-1.noarch 1/1 \n  Verifying  :
      demo-tomcat-1-SNAPSHOT-1.noarch 1/1 \n\nInstalled:\n
      demo-tomcat-1.noarch 0:SNAPSHOT-1 \n\nComplete!\n"
   ]
}

TASK [install-tomcat : debug] **********************************************************
***************************************************************************
task path: /users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:11
Tuesday 21 November 2017  13:02:13 +0530 (0:00:06.757) 0:00:08.329 ******
ok: [server1] => {
   "changed": false,
   "msg": [
      "Install Tomcat artifacts task ended with message: {
         u'msg': u'', u'changed': True, u'results':
         [u'Loaded plugins: product-id,
         search-disabledrepos,
         subscription-manager\\nThis system is not registered to Red Hat Subscription Management.
         You can use subscription-manager to register.\\nResolving Dependencies\\n-->
         Running transaction check\\n--->
         Package demo-tomcat-1.noarch 0:SNAPSHOT-1 will be installed\\n-->
         Finished Dependency Resolution\\n
         \\nDependencies
         Resolved\\n\\n==================================================================\\n
         Package Arch Version Repository
         Size\\n========================================================================
         =====\\nInstalling:\\n demo-tomcat-1 noarch SNAPSHOT-1 demo-repo1 7.1 M\\n\\nTransaction
         Summary\\n=========================================================\\nInstall  1
         Package\\n\\nTotal download size: 7.1 M\\nInstalled size: 7.9 M\\nDownloading
            packages:\\nRunning
         transaction check\\nRunning transaction test\\nTransaction test succeeded\\nRunning
            transaction\\n
         Installing : demo-tomcat-1-SNAPSHOT-1.noarch 1/1 \\n  Verifying  :
         demo-tomcat-1-SNAPSHOT-1.noarch
         1/1 \\n\\nInstalled:\\n  demo-tomcat-1.noarch 0:SNAPSHOT-1  \\n\\nComplete!\\n'], u'rc': 0
      }",
      "Installed Tomcat artifacts - True"
   ]
}

TASK [install-tomcat : Clean DEMO environment] ****************************************
************************************************************
task path: /users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:19
Tuesday 21 November 2017  13:02:13 +0530 (0:00:00.057) 0:00:08.387 ******
[WARNING]: when statements should not include jinja2 templating delimiters such as {{ }} or
   {% %}. Found: {{installationOutput.changed}}

Using module file /usr/lib/python2.7/sitepackages/ansible/modules/files/file.py
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: root
<localhost> EXEC /bin/sh -c 'echo ~ && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo
   /root/.ansible/tmp/ansible-tmp-1511249534.13-128345805983963 `" && echo
   ansible-tmp-1511249534.13-128345805983963="` echo
   /root/.ansible/tmp/ansibletmp-1511249534.13-128345805983963 `" ) && sleep 0'
<localhost> PUT /tmp/tmp0aXel7 TO
   /root/.ansible/tmp/ansible-tmp-1511249534.13128345805983963/file.py
<localhost> EXEC /bin/sh -c 'chmod u+x
   /root/.ansible/tmp/ansible-tmp1511249534.13-128345805983963/
   /root/.ansible/tmp/ansible-tmp-1511249534.13128345805983963/file.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python
   /root/.ansible/tmp/ansible-tmp1511249534.13-128345805983963/file.py; rm -rf
   "/root/.ansible/tmp/ansible-tmp1511249534.13-128345805983963/" > /dev/null 2>&1
   && sleep 0'
changed: [server1] => {
   "changed": true,
      "diff": {
         "after": {
            "path": "/users/demo/DEMO",
            "state": "absent"
      },
      "before": {
         "path": "/users/demo/DEMO",
         "state": "directory"
      }
   },

   "invocation": {
      "module_args": {
         "attributes": null,
         "backup": null,
         "content": null,
         "delimiter": null,
         "diff_peek": null,
         "directory_mode": null,
         "follow": false,
         "force": false,
         "group": null,
         "mode": null,
         "original_basename": null,
         "owner": null,
         "path": "/users/demo/DEMO",
         "recurse": false,
         "regexp": null,
         "remote_src": null,
         "selevel": null,
         "serole": null,
         "setype": null,
         "seuser": null,
         "src": null,
         "state": "absent",
         "unsafe_writes": null,
         "validate": null
      }
   },
   "path": "/users/demo/DEMO",
   "state": "absent"
}

TASK [install-tomcat : debug] ********************************************************
*************************************************************
task path: /users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:29
Tuesday 21 November 2017  13:02:14 +0530 (0:00:00.257)       0:00:08.645 ******
ok: [server1] => {
   "changed": false,
   "msg": [
      "Clean DEMO environment task ended with message:{u'diff': {u'after': {u'path':
         u'/users/demo/DEMO', u'state': u'absent'},
      u'before': {u'path': u'/users/demo/DEMO', u'state': u'directory'}}, u'state': u'absent',
         u'changed': True, u'path': u'/users/demo/DEMO'}",
      "check value  :True"
   ]
}

TASK [install-tomcat : Copy Tomcat to user home] *************************************
********************************************************
task path: /users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:37
Tuesday 21 November 2017  13:02:14 +0530 (0:00:00.055)       0:00:08.701 ******
[WARNING]: when statements should not include jinja2 templating delimiters such as {{ }} or
   {% %}. Found: {{installationOutput.changed}}

Using module file /usr/lib/python2.7/sitepackages/ansible/modules/commands/command.py
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: root
<localhost> EXEC /bin/sh -c 'echo ~ && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo
   /root/.ansible/tmp/ansible-tmp-1511249534.43-41077200718443 `" && echo
   ansibletmp-1511249534.43-41077200718443="` echo
   /root/.ansible/tmp/ansible-tmp1511249534.43-41077200718443 `" ) && sleep 0'
<localhost> PUT /tmp/tmp25deWs TO
   /root/.ansible/tmp/ansible-tmp-1511249534.4341077200718443/command.py
<localhost> EXEC /bin/sh -c 'chmod u+x
   /root/.ansible/tmp/ansible-tmp1511249534.43-41077200718443/
   /root/.ansible/tmp/ansible-tmp-1511249534.4341077200718443/command.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python
   /root/.ansible/tmp/ansible-tmp1511249534.43-41077200718443/command.py; rm -rf
   "/root/.ansible/tmp/ansibletmp-1511249534.43-41077200718443/" > /dev/null 2>&1
   && sleep 0'
changed: [server1] => {
   "changed": true,
   "cmd": [
      "cp",
      "-r",
      "/opt/ansible/tomcat/demo",
      "/users/demo/DEMO/"
   ],
   "delta": "0:00:00.017923",
   "end": "2017-11-21 13:02:14.547633",
   "invocation": {
      "module_args": {
         "_raw_params": "cp -r /opt/ansible/tomcat/demo /users/demo/DEMO/",
         "_uses_shell": false,
         "chdir": null,
         "creates": null,
         "executable": null,
         "removes": null,
         "warn": true
      }
   },
   "rc": 0,
   "start": "2017-11-21 13:02:14.529710",
   "stderr": "",
   "stderr_lines": [],
   "stdout": "",
   "stdout_lines": []
}

TASK [install-tomcat : debug] ********************************************************
**********************************************************
task path: /users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:47
Tuesday 21 November 2017  13:02:14 +0530 (0:00:00.260)       0:00:08.961 ******
ok: [server1] => {
   "changed": false,
   "msg": "Copy Tomcat to user home task ended with message {
      'stderr_lines': [], u'changed': True, u'end': u'2017-11-21 13:02:14.547633', u'stdout':
      u'', u'cmd': [u'cp', u'-r', u'/opt/ansible/tomcat/demo', u'/users/demo/DEMO/'], u'rc': 0,
      u'start': u'2017-11-21 13:02:14.529710', u'stderr': u'', u'delta': u'0:00:00.017923',
      'stdout_lines': []}"
}

TASK [start-tomcat : Start Tomcat] **************************************************
**********************************************************
task path: /users/demo/vivek-playbook/roles/start-tomcat/tasks/main.yml:5
Tuesday 21 November 2017  13:02:14 +0530 (0:00:00.044)       0:00:09.006 ******
Using module file /usr/lib/python2.7/sitepackages/ansible/modules/commands/command.py
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: root
<localhost> EXEC /bin/sh -c 'echo ~ && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo
   /root/.ansible/tmp/ansible-tmp-1511249534.63-46501211251197 `" && echo
   ansibletmp-1511249534.63-46501211251197="` echo
   /root/.ansible/tmp/ansible-tmp1511249534.63-46501211251197 `" ) && sleep 0'
<localhost> PUT /tmp/tmp9f06MQ TO
   /root/.ansible/tmp/ansible-tmp-1511249534.6346501211251197/command.py
<localhost> EXEC /bin/sh -c 'chmod u+x
   /root/.ansible/tmp/ansible-tmp1511249534.63-46501211251197/
   /root/.ansible/tmp/ansible-tmp-1511249534.6346501211251197/command.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python
   /root/.ansible/tmp/ansible-tmp1511249534.63-46501211251197/command.py; rm -rf
   "/root/.ansible/tmp/ansibletmp-1511249534.63-46501211251197/" > /dev/null 2>&1
   && sleep 0'
changed: [server1] => {
   "changed": true,
   "cmd": [ "/users/demo/DEMO/bin/startup.sh" ],
   "delta": "0:00:00.020024",
   "end": "2017-11-21 13:02:14.741649",
   "invocation": {
      "module_args": {
         "_raw_params": "/users/demo/DEMO/bin/startup.sh",
         "_uses_shell": false,
         "chdir": null,
         "creates": null,
         "executable": null,
         "removes": null,
         "warn": true
      }
   },
   "rc": 0,
   "start": "2017-11-21 13:02:14.721625",
   "stderr": "",
   "stderr_lines": [],
   "stdout": "Tomcat started.",
   "stdout_lines": [ "Tomcat started." ]
}

TASK [start-tomcat : debug] *************************************************
**********************************************************************
task path: /users/demo/vivek-playbook/roles/start-tomcat/tasks/main.yml:10
Tuesday 21 November 2017  13:02:14 +0530 (0:00:00.150)       0:00:09.156 ******
ok: [server1] => {
   "changed": false,
   "msg": [
      "Start Tomcat task ended with message: {'
         stderr_lines': [], u'changed': True, u'end': u'2017-11-21 13:02:14.741649', u'stdout':
         u'Tomcat started.', u'cmd': [u'/users/demo/DEMO/bin/startup.sh'], u'rc': 0, u'start':
         u'2017-11-21 13:02:14.721625', u'stderr': u'', u'delta': u'0:00:00.020024',
         'stdout_lines': [u'Tomcat started.']}",
      "Tomcat started - True"
   ]
}
META: ran handlers
META: ran handlers

PLAY RECAP *******************************************************************************
*********************************************************
server1  : ok = 9    changed = 4    unreachable = 0    failed = 0

Tuesday 21 November 2017  13:02:14 +0530 (0:00:00.042)       0:00:09.198 ******
===============================================================================
install-tomcat : Install Tomcat artifacts ------------------------------- 6.76s
/users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:5 --------------
Gathering Facts --------------------------------------------------------- 1.52s
 ------------------------------------------------------------------------------
install-tomcat : Copy Tomcat to user home ------------------------------- 0.26s
/users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:37 -------------

install-tomcat : Clean DEMO environment --------------------------------- 0.26s
/users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:19 -------------

start-tomcat : Start Tomcat --------------------------------------------- 0.15s
/users/demo/vivek-playbook/roles/start-tomcat/tasks/main.yml:5 ----------------

install-tomcat : debug -------------------------------------------------- 0.06s
/users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:11 -------------

install-tomcat : debug -------------------------------------------------- 0.06s
/users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:29 -------------

install-tomcat : debug -------------------------------------------------- 0.04s
/users/demo/vivek-playbook/roles/install-tomcat/tasks/main.yml:47 -------------

start-tomcat : debug ---------------------------------------------------- 0.04s
/users/demo/vivek-playbook/roles/start-tomcat/tasks/main.yml:10 ---------------

点击以下 URL，您将访问如下图所示的页面 - * [role="bare"] [role="bare"]http://10.76.0.134:11677/HelloWorld/HelloWorld*

Hit the following URL and you will be directed to a page as shown below − * [role="bare"]http://10.76.0.134:11677/HelloWorld/HelloWorld*

刚部署的 war 仅具有显示“Hello World”的服务。详细输出显示每个任务所花费的时间，因为在 ansible.cfg 文件中添加了条目 -

The deployed war just has a servlet which displays “Hello World”. The detailed output shows the time taken by each and every task because of the entry added in ansible.cfg file −

[defaults]
callback_whitelist = profile_tasks