开发者实验室教程—— Ansible如何高效管理云资源

教程简介

Ansible 是一个开源的用于自动执行资源的配置管理和应用程序部署产品。云命令行已经为您安装、配置完成 Ansible v2.8.5，您可以直接使用。同时阿里云提供了 Ansible 的 阿里云模块。

利用该该模块您可以通过 Ansible 非常方便管理您的阿里云资源，同时，您还可以使用 Ansible 在环境中自动配置资源和部署应用。

本教程就介绍了如何使用 Ansible 来管理阿里云资源以及部署应用。

您可以在 tutorial-cli-ansible 中查看本文中对应的 Ansible 配置代码，并通过 git clone 下载到本地执行。

您也可以直接去往 Cloud Shell 体验更直观的交互式教程：使用 Ansible 管理云资源。通过 Cloud Shell 编辑器来查看代码，并在 Cloud Shell 直接执行，而不需要繁琐的本地配置过程。

配置 Ansible

在 Cloud Shell 中，您可以直接使用 Ansible 来管理您的云资源。Cloud Shell 为您内置了授权，并且默认配置好了阿里云模块，您无需进行额外配置。默认 Cloud Shell 会使用临时 AK 帮您配置好 AK 信息，同时默认 region 为cn-hangzhou。

您也可以如下方式自行配置阿里云模块。

export ALICLOUD_ACCESS_KEY="your_accesskey"

export ALICLOUD_SECRET_KEY="your_accesskey_secret"

export ALICLOUD_REGION="your_region"

如果您需要在 Cloud Shell 的环境外配置 Ansible，请参考安装和配置Ansible。

创建资源

在本文中，您会通过 Ansible 编排创建 VPC、VSwitch、安全组和 ECS。其中 create.yml playbook 声明了编排配置信息。

- name: Create Resources
  hosts: localhost
  remote_user: root

  roles:
    - vpc
    - vswitch
    - security_group
    - ecs

其中，各资源的详细的配置如下：

• 变量定义：group_vars/all，定义了 Ansible playbook 部署资源所需要的变量信息，包括 VPC 名称、ECS 镜像等等。

  # common parameters
  alicloud_region: "cn-hangzhou"
  alicloud_zone: "cn-hangzhou-i"
  
  # create vpc parameters
  vpc_cidr: "172.16.0.0/12"
  vpc_name: "Cloudshell_Tutorial_Cli_Ansible"
  vpc_description: "Create a new VPC resource via Ansible example."
  
  # create vswitch parameters
  vswitch_cidr: "172.16.1.0/24"
  vswitch_name: "Cloudshell_Tutorial_Cli_Ansible"
  vswitch_description: "Create a new VSwitch resource via Ansible example."
  
  # create security parameters
  group_name: "Cloudshell_Tutorial_Cli_Ansible"
  group_description: "Create a new security group resource via Ansible example."
  group_inboundRules:
    - ip_protocol: tcp
      port_range: 22/22
      source_cidr_ip: 0.0.0.0/0
      priority: 1
  
    - ip_protocol: tcp
      port_range: 80/80
      source_cidr_ip: 0.0.0.0/0
      priority: 1
  
  # create ECS instance parameters
  image_id: "centos_7_06_64_20G_alibase_20190711.vhd"
  instance_type: "ecs.t5-lc2m1.nano"
  instance_name: "Cloudshell_Tutorial_Cli_Ansible"
  instance_description: "Create a new ECS instance resource via Ansible example."
  host_name: "my-instance-from-ansible"
  password: "Test12345"
  
  allocate_public_ip: True
  internet_charge_type: "PayByTraffic"
  max_bandwidth_in: 200
  max_bandwidth_out: 50
  instance_tags: {created_from: cloudshell-tutorial-cli-ansible}
  
  system_disk_category: "cloud_ssd"
  system_disk_size: 20
  
  number_of_instances: 2

• VPC：roles/vpc/tasks/main.yml，这里会先查询是否已经存在同名的 VPC，如果已经存在，则不会创建。

  - name: Get the existing vpc
    ali_vpc_facts:
      region: '{{alicloud_region}}'
      vpc_name: '{{vpc_name}}'
    register: vpcs
  
  - name: Create a new alicloud VPC resource
    ali_vpc:
      alicloud_region: '{{ alicloud_region }}'
      state: 'present'
      cidr_block: '{{ vpc_cidr }}'
      vpc_name: '{{ vpc_name }}'
      description: '{{ vpc_description }}'
    when: not vpcs.vpcs
    register: vpc

• VSwitch：roles/vswitch/tasks/main.yml。VSwitch 创建依赖 VPC，这里会先根据定义的 vpc_name 获取对应 VPC。

  - name: Get the existing vpc
    ali_vpc_facts:
      region: '{{alicloud_region}}'
      vpc_name: '{{vpc_name}}'
    register: vpcs
  
  - name: Create a new alicloud VSwitch resource
    ali_vswitch:
      alicloud_region: '{{ alicloud_region }}'
      alicloud_zone: '{{ alicloud_zone }}'
      state: 'present'
      cidr_block: '{{ vswitch_cidr }}'
      vswitch_name: '{{ vswitch_name }}'
      description: '{{ vswitch_description }}'
      vpc_id: '{{vpcs.vpcs.0.id}}'
    register: vswitch

• 安全组：roles/security_group/tasks/main.yml

  - name: Get the existing vpc
    ali_vpc_facts:
      region: '{{alicloud_region}}'
      vpc_name: '{{vpc_name}}'
    register: vpcs
  
  - name: Get the existing groups
    ali_security_group_facts:
      region: '{{alicloud_region}}'
      group_name: '{{ group_name }}'
      filters:
        vpc_id: '{{vpcs.vpcs.0.id}}'
    register: sgs
  
  - name: Creating security group
    ali_security_group:
      alicloud_region: '{{ alicloud_region }}'
      state: 'present'
      name: '{{ group_name }}'
      description: '{{ group_description }}'
      vpc_id: '{{vpcs.vpcs.0.id}}'
      rules: '{{ group_inboundRules }}'
    when: not sgs.groups
    register: group

• ECS：roles/ecs/tasks/main.yml

  - name: Get the existing groups
    ali_security_group_facts:
      region: '{{alicloud_region}}'
      group_name: '{{ group_name }}'
      filters:
        vpc_id: '{{vpcs.vpcs.0.id}}'
    register: sgs
  
  - name: Creating an ECS instance
    ali_instance:
      alicloud_region: '{{ alicloud_region }}'
      alicloud_zone: '{{ alicloud_zone }}'
      image: '{{ image_id }}'
      type: '{{ instance_type }}'
      instance_name: '{{ instance_name }}'
      description: '{{ instance_description }}'
      host_name: '{{ host_name }}'
      password: '{{ password }}'
  
      allocate_public_ip: '{{ allocate_public_ip }}'
      internet_charge_type: '{{ internet_charge_type }}'
      max_bandwidth_in: '{{ max_bandwidth_in }}'
      max_bandwidth_out: '{{ max_bandwidth_out }}'
      instance_tags: '{{ instance_tags }}'
  
      security_groups: ['{{ sgs.groups.0.id }}']
      vswitch_id: '{{ vswitch.vswitch.id }}'
  
      system_disk_category: '{{ system_disk_category }}'
      system_disk_size: '{{ system_disk_size }}'
  
      state: 'present'
      count: '{{ number_of_instances }}'
    when: sgs.groups
    register: instance

更多 Ansible Playbook 的配置，您可以参考 Ansible 的 Working With Playbooks

然后，您就可以执行 create.yml 一键配置好您编排的资源。

ansible-playbook create.yml

执行完后，您可以在对应产品的控制台看到编排创建的资源。比如该示例中默认为您创建了两台 ECS：

如果出现错误，请检查您的所需服务是否开通，以及您的账户是否实名认证同时账户余额大于 100 元。

动态 Inventory

当您需要配置资源、部署应用的时候，就需要配置 Ansible Inventory。Ansible 可同时操作属于一个组的多台主机。组和主机之间的关系通过 Inventory 文件配置。Ansible Inventory 分为静态 Inventory 和动态 Inventory。当被管理主机比较少的情况下，直接在静态 Inventory 的 host 文件中管理即可；当主机越来越多，不断变化时，可以通过动态 Inventory 来管理。

阿里云提供了动态 Inventory，您可以直接使用，通过阿里云动态 Inventory 动态获取指定过滤条件的主机信息。

环境准备

目前阿里云的动态 Inventory 还在被官方集成的过程中，您需要手动安装依赖。

pip install ansible_alicloud_module_utils

下载与验证

首先您需要下载阿里云动态 Inventory 文件，并赋予其可执行权限

wget https://raw.githubusercontent.com/alibaba/ansible-provider/master/contrib/inventory/alicloud.py;

chmod +x alicloud.py

同时，下载配套的配置文件

wget https://raw.githubusercontent.com/alibaba/ansible-provider/master/contrib/inventory/alicloud.ini

您可以执行 Inventory 文件来验证配置。

./alicloud.py --list

执行完后，会返回所有地域的 Inventory 信息。其中对应的配置文件为 alicloud.ini，你可以编辑 alicloud.ini 文件获取指定 Region 的信息。除此之外，还可通过 alicloud.ini 文件中的 instance_filters 过滤所有的主机信息。

需要注意的是，默认的 alicloud.ini 配置中，是使用 ECS 的 instance_id 作为 hostname 的，在 Ansible 使用时，会出现这个 hostname unreachable 的问题，因此您可以手动将 alicloud.ini 中 hostname_variable = instance_id 这一行注释掉，注释掉后，会使用 ECS ip 作为 hostname

您可以通过 Ansible ping 模块来验证和您创建的两台 ECS 实例的连通性

ansible -i ./alicloud.py tag_created_from_cloudshell_tutorial_cli_ansible -m ping -u root -k

其中 tag_created_from_cloudshell_tutorial_cli_ansible 表示我们根据 created_from_cloudshell_tutorial_cli_ansible 的 tag 的过滤 ecs。执行命令后提示您输入 SSH 密码，编排资源时，示例中默认设置的密码为：Test12345。结果如下所示：

部署应用

通过 Ansible 您可以配置资源并部署应用，本教程会部署 Nginx 到前文您创建的 ECS 中。deploy.yml playbook 声明了部署配置信息。

- name: Deploy
  hosts: tag_created_from_cloudshell_tutorial_cli_ansible
  remote_user: root
  tasks:
      - name: install nginx
        yum: name=nginx state=present
      - name: start nginx
        service: name=nginx state=started

其中 tasks 中会安装并启动 Nginx，同时配置 hosts: tag_created_from_cloudshell_tutorial_cli_ansible，根据 created_from_cloudshell_tutorial_cli_ansible 的 tag 来过滤 ecs。执行命令后提示您输入 SSH 密码，编排资源时，示例中默认设置的密码为：Test12345。

ansible-playbook -i ./alicloud.py deploy.yml -u root -k

执行结果如下所示：

执行完后，Nginx 已经成功在您的 ECS 实例上安装并启动，其实你可以访问该 ECS 的公网 IP 查看。

销毁资源

通过 Ansible 您也可以销毁资源。其中 destory.yml playbook 声明了销毁资源的配置信息。

- name: Destroy Resources
  hosts: localhost
  remote_user: root

  tasks:
    - name: Get the existing instances
      ali_instance_info:
        alicloud_region: '{{ alicloud_region }}'
        alicloud_zone: '{{ alicloud_zone }}'
        instance_names:
          - '{{ instance_name }}'
      register: instances

    - name: Delete the existing instances
      ali_instance:
        alicloud_region: '{{ alicloud_region }}'
        alicloud_zone: '{{ alicloud_zone }}'
        instance_ids: '{{ instances.ids }}'
        force: true
        state: absent
      when: instances.ids

    - name: Get the existing vpc
      ali_vpc_facts:
        region: '{{alicloud_region}}'
        vpc_name: '{{vpc_name}}'
      register: vpcs

    - name: Get the existing groups
      ali_security_group_facts:
        region: '{{alicloud_region}}'
        filters:
          vpc_id: '{{vpcs.vpcs.0.id}}'
      when: vpcs.vpcs
      register: sgs

    - name: Delete the existing security groups
      ali_security_group:
        region: '{{ alicloud_region }}'
        group_name: '{{ group_name }}'
        state: absent
      when: sgs.ids

    - name: Get the existing vswitches
      ali_vswitch_facts:
        region: '{{alicloud_region}}'
        filters:
          vpc_id: '{{vpcs.vpcs.0.id}}'
      when: vpcs.vpcs
      register: vsws

    - name: Delete the existing vswitch
      ali_vswitch:
        alicloud_region: '{{ alicloud_region }}'
        alicloud_zone: '{{ alicloud_zone }}'
        cidr_block: '{{ vswitch_cidr }}'
        vpc_id: '{{vpcs.vpcs.0.id}}'
        state: absent
      when: vsws.vswitches

    - name: Delete the existing vpc
      ali_vpc:
        alicloud_region: '{{ alicloud_region }}'
        vpc_name: '{{ vpc_name }}'
        cidr_block: '{{ vpc_cidr }}'
        state: absent
      when: vpcs.vpcs

您可以执行以下命令来销毁前文创建的资源。

ansible-playbook destory.yml

总结

以上就是如何利用 Ansible 方便的管理阿里云资源的全部教程，欢迎大家进入开放平台开发者实验室体验更多实验案例！

开发者实验室提供了各种交互式教程，涵盖解决方案、资源管控等多种场景。实验室教程基于 Cloud Shell 提供的真实环境，您可以通过在线 Web IDE、命令行以及步骤式的教程指引，完成所需教程的学习和实验。同时您也可以访问 Cloud shell 帮助文档获取更多信息。