Руководство по CloudStack

Введение

Цель этого раздела — объяснить, как объединить модули Ansible для использования Ansible в контексте CloudStack. Дополнительные примеры использования вы найдете в разделе подробного описания каждого модуля.

Ansible содержит ряд дополнительных модулей для взаимодействия с облаками на основе CloudStack. Все модули поддерживают режим проверки, разработаны для идемпотентности, созданы и протестированы, а также поддерживаются сообществом.

Предварительные требования

Предварительные требования для использования модулей CloudStack минимальны. Помимо самого Ansible, все модули требуют библиотеку python cs https://pypi.python.org/pypi/cs.

Вам необходимо установить этот модуль Python на хост выполнения, обычно на вашей рабочей станции.

$ pip install cs

Или, как альтернативу, начиная с Debian 9 и Ubuntu 16.04:

$ sudo apt install python-cs

Ограничения и известные проблемы

Поддержка VPC улучшена с Ansible 2.3, но все еще не полностью реализована. Сообщество работает над интеграцией VPC.

Файл учетных данных

Вы можете передавать учетные данные и конечную точку вашего облака в качестве аргументов модуля, однако в большинстве случаев гораздо проще хранить ваши учетные данные в файле cloudstack.ini.

Библиотека Python cs ищет файл учетных данных в следующем порядке (последний имеет приоритет):

• Файл .cloudstack.ini (обратите внимание на точку) в домашнем каталоге.
• Переменная окружения CLOUDSTACK_CONFIG, указывающая на файл .ini.
• Файл cloudstack.ini (без точки) в текущей рабочей директории, в той же директории, где расположены ваши playbooks.

Структура файла ini должна быть такой:

$ cat $HOME/.cloudstack.ini
[cloudstack]
endpoint = https://cloud.example.com/client/api
key = api key
secret = api secret
timeout = 30

Переменные среды поддерживают CLOUDSTACK_* так, как описано в документации библиотеки cs, как, например CLOUDSTACK_TIMEOUT, CLOUDSTACK_METHOD, и т.д. было реализовано в Ansible. Возможно даже иметь неполную конфигурацию в cloudstack.ini:

$ cat $HOME/.cloudstack.ini
[cloudstack]
endpoint = https://cloud.example.com/client/api
timeout = 30

и заполнить недостающие данные, установив переменные среды или параметры задач:

---
- name: provision our VMs
  hosts: cloud-vm
  connection: local
  tasks:
    - name: ensure VMs are created and running
      cs_instance:
        api_key: your api key
        api_secret: your api secret
        ...

Регионы

Если вы используете более одного региона CloudStack, вы можете определить любое количество разделов и назвать их как угодно, например:

$ cat $HOME/.cloudstack.ini
[exoscale]
endpoint = https://api.exoscale.ch/compute
key = api key
secret = api secret

[exmaple_cloud_one]
endpoint = https://cloud-one.example.com/client/api
key = api key
secret = api secret

[exmaple_cloud_two]
endpoint = https://cloud-two.example.com/client/api
key = api key
secret = api secret

Передав аргумент api_region с модулями CloudStack, будет выбран нужный регион.

- name: ensure my ssh public key exists on Exoscale
  local_action: cs_sshkeypair
    name: my-ssh-key
    public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    api_region: exoscale

Или, перебирая список регионов, если вы хотите выполнить задачу в каждом регионе:

- name: ensure my ssh public key exists in all CloudStack regions
  local_action: cs_sshkeypair
    name: my-ssh-key
    public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    api_region: "{{ item }}"
    loop:
      - exoscale
      - exmaple_cloud_one
      - exmaple_cloud_two

Переменные окружения

С Ansible 2.3 возможно использовать переменные окружения для домена (CLOUDSTACK_DOMAIN), учетной записи (CLOUDSTACK_ACCOUNT), проекта (CLOUDSTACK_PROJECT), VPC (CLOUDSTACK_VPC) и зоны (CLOUDSTACK_ZONE). Это упрощает задачи, не повторяя аргументы для каждой задачи.

Ниже приведен пример того, как это можно использовать в сочетании с блоком Ansible:

- hosts: cloud-vm
  tasks:
    - block:
        - name: ensure my ssh public key
          local_action:
            module: cs_sshkeypair
            name: my-ssh-key
            public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

        - name: ensure my ssh public key
          local_action:
            module: cs_instance:
              display_name: "{{ inventory_hostname_short }}"
              template: Linux Debian 7 64-bit 20GB Disk
              service_offering: "{{ cs_offering }}"
              ssh_key: my-ssh-key
              state: running

      environment:
        CLOUDSTACK_DOMAIN: root/customers
        CLOUDSTACK_PROJECT: web-app
        CLOUDSTACK_ZONE: sf-1

Примеры использования

Следующее должно дать вам некоторые идеи о том, как использовать модули для развертывания виртуальных машин в облаке. Как и всегда, существует не только один способ сделать это. Но, как всегда: для начала сохраняйте все просто.

Пример использования: развертывание в облаке CloudStack с продвинутой сетью

В нашем облаке CloudStack используется продвинутая конфигурация сети. Мы хотим развернуть веб-серверы, которые получат статический NAT и откроют порты 80 и 443 для брандмауэра. Кроме того, мы развертываем серверы базы данных, которым мы не предоставляем доступ. Для доступа к виртуальным машинам по SSH мы используем SSH-шлюз.

Вот как выглядит наш инвентарь:

[cloud-vm:children]
webserver
db-server
jumphost

[webserver]
web-01.example.com  public_ip=198.51.100.20
web-02.example.com  public_ip=198.51.100.21

[db-server]
db-01.example.com
db-02.example.com

[jumphost]
jump.example.com  public_ip=198.51.100.22

Как видите, общедоступные IP-адреса для наших веб-серверов и шлюза были назначены как переменная public_ip непосредственно в инвентаре.

Чтобы настроить шлюз, веб-серверы и серверы базы данных, мы используем group_vars. Каталог group_vars содержит 4 файла для настройки групп: cloud-vm, jumphost, webserver и db-server. cloud-vm служит для указания параметров нашей облачной инфраструктуры.

# file: group_vars/cloud-vm
---
cs_offering: Small
cs_firewall: []

Наши серверы базы данных должны получить больше процессорного времени и оперативной памяти, поэтому мы определяем использование предложения Large для них.

# file: group_vars/db-server
---
cs_offering: Large

Веб-серверы должны получить предложение Small, так как мы будем масштабировать их горизонтально, что также является нашим предложением по умолчанию. Мы также обеспечиваем открытие известных портов веб-серверов для мира.

# file: group_vars/webserver
---
cs_firewall:
  - { port: 80 }
  - { port: 443 }

Далее мы развертываем шлюз, который открывает только порт 22 для доступа к виртуальным машинам из нашей офисной IPv4-сети.

# file: group_vars/jumphost
---
cs_firewall:
  - { port: 22, cidr: "17.17.17.0/24" }

Теперь самое интересное. Мы создаем playbook для создания нашей инфраструктуры, который мы называем infra.yml:

# file: infra.yaml
---
- name: provision our VMs
  hosts: cloud-vm
  connection: local
  tasks:
    - name: ensure VMs are created and running
      cs_instance:
        name: "{{ inventory_hostname_short }}"
        template: Linux Debian 7 64-bit 20GB Disk
        service_offering: "{{ cs_offering }}"
        state: running

    - name: ensure firewall ports opened
      cs_firewall:
        ip_address: "{{ public_ip }}"
        port: "{{ item.port }}"
        cidr: "{{ item.cidr | default('0.0.0.0/0') }}"
      loop: "{{ cs_firewall }}"
      when: public_ip is defined

    - name: ensure static NATs
      cs_staticnat: vm="{{ inventory_hostname_short }}" ip_address="{{ public_ip }}"
      when: public_ip is defined

В данном play мы определили 3 задачи и используем группу cloud-vm в качестве целевой группы для обработки всех виртуальных машин в облаке, но вместо SSH к этим виртуальным машинам мы используем connection=local для выполнения вызовов API локально с нашей рабочей станции.

В первой задаче мы убеждаемся, что создана и запущена виртуальная машина с шаблоном Debian. Если виртуальная машина уже создана, но остановлена, она просто запустится. Если вы хотите изменить предложение для существующей виртуальной машины, вы должны добавить force: yes в задачу, которая остановит виртуальную машину, изменит предложение и снова запустит виртуальную машину.

Во второй задаче мы убеждаемся, что порты открыты, если мы предоставляем виртуальной машине общедоступный IP-адрес.

В третьей задаче мы добавляем статический NAT для виртуальных машин, имеющих определенный общедоступный IP-адрес.

Пример использования: развертывание на облаке CloudStack с базовой сетью

Настройка облака CloudStack с базовой сетью немного отличается: каждой виртуальной машине напрямую назначается общедоступный IP-адрес, а для ограничения доступа используются группы безопасности.

Вот как выглядит наш инвентарь:

[cloud-vm:children]
webserver

[webserver]
web-01.example.com
web-02.example.com

Настройки по умолчанию для ваших виртуальных машин выглядят так:

# file: group_vars/cloud-vm
---
cs_offering: Small
cs_securitygroups: [ 'default']

Наш веб-сервер также будет в группе безопасности web:

# file: group_vars/webserver
---
cs_securitygroups: [ 'default', 'web' ]

Playbook выглядит следующим образом:

# file: infra.yaml
---
- name: cloud base setup
  hosts: localhost
  connection: local
  tasks:
  - name: upload ssh public key
    cs_sshkeypair:
      name: defaultkey
      public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

  - name: ensure security groups exist
    cs_securitygroup:
      name: "{{ item }}"
    loop:
      - default
      - web

  - name: add inbound SSH to security group default
    cs_securitygroup_rule:
      security_group: default
      start_port: "{{ item }}"
      end_port: "{{ item }}"
    loop:
      - 22

  - name: add inbound TCP rules to security group web
    cs_securitygroup_rule:
      security_group: web
      start_port: "{{ item }}"
      end_port: "{{ item }}"
    loop:
      - 80
      - 443

- name: install VMs in the cloud
  hosts: cloud-vm
  connection: local
  tasks:
  - name: create and run VMs on CloudStack
    cs_instance:
      name: "{{ inventory_hostname_short }}"
      template: Linux Debian 7 64-bit 20GB Disk
      service_offering: "{{ cs_offering }}"
      security_groups: "{{ cs_securitygroups }}"
      ssh_key: defaultkey
      state: Running
    register: vm

  - name: show VM IP
    debug: msg="VM {{ inventory_hostname }} {{ vm.default_ip }}"

  - name: assign IP to the inventory
    set_fact: ansible_ssh_host={{ vm.default_ip }}

  - name: waiting for SSH to come up
    wait_for: port=22 host={{ vm.default_ip }} delay=5

В первом play мы настраиваем группы безопасности, во втором play виртуальные машины будут созданы и назначены этим группам. Кроме того, вы видите, что мы назначаем общедоступный IP-адрес, возвращаемый модулем, в инвентарь хоста. Это необходимо, так как мы не знаем заранее, какие IP-адреса мы получим. На следующем шаге вы бы настроили DNS-серверы с этими IP-адресами для доступа к виртуальным машинам по их имени DNS.

В последней задаче мы ждем, пока SSH станет доступным, чтобы любой последующий play мог получить доступ к виртуальной машине по SSH без сбоев.