OpenStack-Ansible CloudKitty¶

This Ansible role installs and configures OpenStack CloudKitty. This role will install the following Upstart services:

cloudkitty-api
cloudkitty-processor

Adding The Service to Your OpenStack-Ansible Deployment¶

To add a new service to your OpenStack-Ansible (OSA) deployment:

Define rating_hosts in your conf.d or openstack_user_config.yml. For example:

rating_hosts:
  infra1:
    ip: 172.20.236.111
  infra2:
    ip: 172.20.236.112
  infra3:
    ip: 172.20.236.113

Create respective LXC containers (skip this step for metal deployments):

openstack-ansible openstack.osa.containers_lxc_create --limit cloudkitty_all,rating_hosts

Run service deployment playbook:

openstack-ansible openstack.osa.cloudkitty

For more information, please refer to the OpenStack-Ansible project documentation.

Always verify that the integration is successful and that the service behaves correctly before using it in a production environment.

Default variables¶

## Verbosity Options
debug: false

# python venv executable
cloudkitty_venv_python_executable: "{{ openstack_venv_python_executable | default('python3') }}"

# Set the host which will execute the shade modules
# for the service setup. The host must already have
# clouds.yaml properly configured.
cloudkitty_service_setup_host: "{{ openstack_service_setup_host | default('localhost') }}"
cloudkitty_service_setup_host_python_interpreter: >-
  {{
    openstack_service_setup_host_python_interpreter | default(
      (cloudkitty_service_setup_host == 'localhost') | ternary(ansible_playbook_python, ansible_facts['python']['executable']))
  }}

# Set the package install state for distribution and pip packages
# Options are 'present' and 'latest'
cloudkitty_package_state: "{{ package_state | default('latest') }}"
cloudkitty_pip_package_state: "latest"

## Oslo Messaging info

# RPC
cloudkitty_oslomsg_rpc_host_group: "{{ oslomsg_rpc_host_group | default('rabbitmq_all') }}"
cloudkitty_oslomsg_rpc_setup_host: >-
  {{ (cloudkitty_oslomsg_rpc_host_group in groups) | ternary(groups[cloudkitty_oslomsg_rpc_host_group][0], 'localhost') }}
cloudkitty_oslomsg_rpc_transport: "{{ oslomsg_rpc_transport | default('rabbit') }}"
cloudkitty_oslomsg_rpc_servers: "{{ oslomsg_rpc_servers | default('127.0.0.1') }}"
cloudkitty_oslomsg_rpc_port: "{{ oslomsg_rpc_port | default('5672') }}"
cloudkitty_oslomsg_rpc_use_ssl: "{{ oslomsg_rpc_use_ssl | default(False) }}"
cloudkitty_oslomsg_rpc_userid: cloudkitty
cloudkitty_oslomsg_rpc_policies: []
# vhost name depends on value of oslomsg_rabbit_quorum_queues. In case quorum queues
# are not used - vhost name will be prefixed with leading `/`.
cloudkitty_oslomsg_rpc_vhost:
  - name: /cloudkitty
    state: "{{ cloudkitty_oslomsg_rabbit_quorum_queues | ternary('absent', 'present') }}"
  - name: cloudkitty
    state: "{{ cloudkitty_oslomsg_rabbit_quorum_queues | ternary('present', 'absent') }}"

cloudkitty_oslomsg_rpc_ssl_version: "{{ oslomsg_rpc_ssl_version | default('TLSv1_2') }}"
cloudkitty_oslomsg_rpc_ssl_ca_file: "{{ oslomsg_rpc_ssl_ca_file | default('') }}"
## RabbitMQ integration
cloudkitty_oslomsg_rabbit_quorum_queues: "{{ oslomsg_rabbit_quorum_queues | default(True) }}"
cloudkitty_oslomsg_rabbit_stream_fanout: "{{ oslomsg_rabbit_stream_fanout | default(cloudkitty_oslomsg_rabbit_quorum_queues) }}"
cloudkitty_oslomsg_rabbit_transient_quorum_queues: "{{ oslomsg_rabbit_transient_quorum_queues | default(cloudkitty_oslomsg_rabbit_stream_fanout) }}"
cloudkitty_oslomsg_rabbit_qos_prefetch_count: "{{ oslomsg_rabbit_qos_prefetch_count | default(cloudkitty_oslomsg_rabbit_stream_fanout | ternary(10, 0)) }}"
cloudkitty_oslomsg_rabbit_queue_manager: "{{ oslomsg_rabbit_queue_manager | default(cloudkitty_oslomsg_rabbit_quorum_queues) }}"
cloudkitty_oslomsg_rabbit_quorum_delivery_limit: "{{ oslomsg_rabbit_quorum_delivery_limit | default(0) }}"
cloudkitty_oslomsg_rabbit_quorum_max_memory_bytes: "{{ oslomsg_rabbit_quorum_max_memory_bytes | default(0) }}"

# Notify
cloudkitty_oslomsg_notify_configure: "{{ oslomsg_notify_configure | default(False) }}"
cloudkitty_oslomsg_notify_host_group: "{{ oslomsg_notify_host_group | default('rabbitmq_all') }}"
cloudkitty_oslomsg_notify_setup_host: >-
  {{ (cloudkitty_oslomsg_notify_host_group in groups) | ternary(groups[cloudkitty_oslomsg_notify_host_group][0], 'localhost') }}
cloudkitty_oslomsg_notify_transport: "{{ oslomsg_notify_transport | default('rabbit') }}"
cloudkitty_oslomsg_notify_servers: "{{ oslomsg_notify_servers | default('127.0.0.1') }}"
cloudkitty_oslomsg_notify_port: "{{ oslomsg_notify_port | default('5672') }}"
cloudkitty_oslomsg_notify_use_ssl: "{{ oslomsg_notify_use_ssl | default(False) }}"
cloudkitty_oslomsg_notify_userid: "{{ cloudkitty_oslomsg_rpc_userid }}"
cloudkitty_oslomsg_notify_password: "{{ cloudkitty_oslomsg_rpc_password }}"
cloudkitty_oslomsg_notify_vhost: "{{ cloudkitty_oslomsg_rpc_vhost }}"
cloudkitty_oslomsg_notify_ssl_version: "{{ oslomsg_notify_ssl_version | default('TLSv1_2') }}"
cloudkitty_oslomsg_notify_ssl_ca_file: "{{ oslomsg_notify_ssl_ca_file | default('') }}"
cloudkitty_oslomsg_notify_policies: []

cloudkitty_system_group_name: cloudkitty
cloudkitty_system_user_name: cloudkitty
cloudkitty_system_comment: meow
cloudkitty_system_shell: /bin/false
cloudkitty_system_home_folder: "/var/lib/{{ cloudkitty_system_user_name }}"

cloudkitty_pip_install_args: "{{ pip_install_options | default('') }}"

cloudkitty_venv_tag: "{{ venv_tag | default('untagged') }}"
cloudkitty_bin: "/openstack/venvs/cloudkitty-{{ cloudkitty_venv_tag }}/bin"

cloudkitty_git_repo: https://opendev.org/openstack/cloudkitty
cloudkitty_git_install_branch: master

cloudkitty_upper_constraints_url: >-
  {{ requirements_git_url | default('https://releases.openstack.org/constraints/upper/' ~ requirements_git_install_branch | default('master')) }}
cloudkitty_git_constraints:
  - "--constraint {{ cloudkitty_upper_constraints_url }}"

cloudkitty_notification_topics: notifications
cloudkitty_collector: gnocchi
cloudkitty_service_user_name: cloudkitty
cloudkitty_service_project_domain_id: default
cloudkitty_service_project_name: "service"
cloudkitty_service_user_domain_id: default
cloudkitty_service_in_ldap: "{{ service_ldap_backend_enabled | default(False) }}"
cloudkitty_service_role_names:
  - admin
  - rating
  - service
cloudkitty_service_token_roles_required: "{{ openstack_service_token_roles_required | default(True) }}"
cloudkitty_keystone_auth_plugin: password
cloudkitty_output_backend: cloudkitty.backend.file.FileBackend
cloudkitty_output_pipeline: osrf
cloudkitty_output_basepath: /var/cloudkitty/reports

# Please define a storage for CloudKitty data in as a nested dictionary.
# Keys `backend` and `version` are required. `config` contains extra
# configuration for the storage backend when applicable.
# For example:
# cloudkitty_storage:
#   backend: opensearch
#   version: 2
#   config:
#     host = http://localhost:9200
#     index_name = cloudkitty
cloudkitty_storage:
  backend: sqlalchemy
  version: 1

cloudkitty_db_setup_host: "{{ openstack_db_setup_host | default('localhost') }}"
cloudkitty_db_setup_python_interpreter: >-
  {{
    openstack_db_setup_python_interpreter | default(
      (cloudkitty_db_setup_host == 'localhost') | ternary(ansible_playbook_python, ansible_facts['python']['executable']))
  }}
cloudkitty_galera_address: "{{ galera_address | default('127.0.0.1') }}"
cloudkitty_galera_database: cloudkitty
cloudkitty_galera_user: cloudkitty
cloudkitty_galera_port: "{{ galera_port | default('3306') }}"
cloudkitty_galera_use_ssl: "{{ galera_use_ssl | default(False) }}"
cloudkitty_galera_ssl_ca_cert: "{{ galera_ssl_ca_cert | default('') }}"
cloudkitty_database_connection: >-
  mysql+pymysql://{{ cloudkitty_galera_user }}:{{ cloudkitty_container_mysql_password }}@{{ cloudkitty_galera_address }}:{{ cloudkitty_galera_port
  }}/{{ cloudkitty_galera_database }}?charset=utf8{%
    if cloudkitty_galera_use_ssl | bool -%}&ssl_verify_cert=true{%
      if cloudkitty_galera_ssl_ca_cert | length > 0 %}&ssl_ca={{ cloudkitty_galera_ssl_ca_cert }}{% endif -%}{%- endif %}

cloudkitty_db_max_overflow: "{{ openstack_db_max_overflow | default('50') }}"
cloudkitty_db_max_pool_size: "{{ openstack_db_max_pool_size | default('5') }}"
cloudkitty_db_pool_timeout: "{{ openstack_db_pool_timeout | default('30') }}"
cloudkitty_db_connection_recycle_time: "{{ openstack_db_connection_recycle_time | default('600') }}"

cloudkitty_wsgi_threads: 1
cloudkitty_wsgi_processes_max: 16
cloudkitty_wsgi_processes: >-
  {{ [[(ansible_facts['processor_vcpus'] // ansible_facts['processor_threads_per_core']) | default(1), 1] | max * 2, cloudkitty_wsgi_processes_max] | min }}
cloudkitty_uwsgi_bind_address: "{{ openstack_service_bind_address | default('0.0.0.0') }}"
cloudkitty_uwsgi_tls:
  crt: "{{ cloudkitty_ssl_cert }}"
  key: "{{ cloudkitty_ssl_key }}"

## Service Type and Data
cloudkitty_service_region: "{{ service_region | default('RegionOne') }}"
cloudkitty_service_name: cloudkitty
cloudkitty_service_type: rating
cloudkitty_service_description: "OpenStack Rating Service"
cloudkitty_service_port: 8089
cloudkitty_service_proto: http
cloudkitty_service_publicuri_proto: "{{ openstack_service_publicuri_proto | default(cloudkitty_service_proto) }}"
cloudkitty_service_adminuri_proto: "{{ openstack_service_adminuri_proto | default(cloudkitty_service_proto) }}"
cloudkitty_service_internaluri_proto: "{{ openstack_service_internaluri_proto | default(cloudkitty_service_proto) }}"
cloudkitty_service_publicuri: "{{ cloudkitty_service_publicuri_proto }}://{{ external_lb_vip_address }}:{{ cloudkitty_service_port }}"
cloudkitty_service_publicurl: "{{ cloudkitty_service_publicuri }}/"
cloudkitty_service_adminuri: "{{ cloudkitty_service_adminuri_proto }}://{{ internal_lb_vip_address }}:{{ cloudkitty_service_port }}"
cloudkitty_service_adminurl: "{{ cloudkitty_service_adminuri }}/"
cloudkitty_service_internaluri: "{{ cloudkitty_service_internaluri_proto }}://{{ internal_lb_vip_address }}:{{ cloudkitty_service_port }}"
cloudkitty_service_internalurl: "{{ cloudkitty_service_internaluri }}/"

cloudkitty_cloudkitty_conf_overrides: {}
cloudkitty_policy_overrides: {}
cloudkitty_api_paste_ini_overrides: {}
cloudkitty_metrics_overrides: {}

cloudkitty_api_init_overrides: {}
cloudkitty_processor_init_overrides: {}
cloudkitty_api_uwsgi_overrides: {}

## Service Name-Group Mapping
cloudkitty_services:
  cloudkitty-api:
    group: cloudkitty_all
    service_name: cloudkitty-api
    init_config_overrides: "{{ cloudkitty_api_init_overrides }}"
    start_order: 1
    wsgi_app: true
    wsgi: "cloudkitty.wsgi.api:application"
    uwsgi_overrides: "{{ cloudkitty_api_uwsgi_overrides }}"
    uwsgi_port: "{{ cloudkitty_service_port }}"
    uwsgi_bind_address: "{{ cloudkitty_uwsgi_bind_address }}"
    uwsgi_tls: "{{ cloudkitty_backend_ssl | ternary(cloudkitty_uwsgi_tls, {}) }}"
  cloudkitty-processor:
    group: cloudkitty_all
    service_name: cloudkitty-processor
    init_config_overrides: "{{ cloudkitty_processor_init_overrides }}"
    execstarts: "{{ cloudkitty_bin }}/cloudkitty-processor"
    start_order: 2

cloudkitty_pip_packages:
  - "git+{{ cloudkitty_git_repo }}@{{ cloudkitty_git_install_branch }}#egg=cloudkitty"
  - cryptography
  - msgpack-python
  - osprofiler
  - PyMySQL
  - pymemcache
  - python-memcached
  - SQLAlchemy>=1.0.10
  - systemd-python
  - tooz

# Memcached override
cloudkitty_memcached_servers: "{{ memcached_servers }}"

###
### Backend TLS
###

# Define if communication between haproxy and service backends should be
# encrypted with TLS.
cloudkitty_backend_ssl: "{{ openstack_service_backend_ssl | default(False) }}"

# Storage location for SSL certificate authority
cloudkitty_pki_dir: "{{ openstack_pki_dir | default('/etc/openstack_deploy/pki') }}"

# Delegated host for operating the certificate authority
cloudkitty_pki_setup_host: "{{ openstack_pki_setup_host | default('localhost') }}"

# cloudkitty server certificate
cloudkitty_pki_keys_path: "{{ cloudkitty_pki_dir ~ '/certs/private/' }}"
cloudkitty_pki_certs_path: "{{ cloudkitty_pki_dir ~ '/certs/certs/' }}"
cloudkitty_pki_intermediate_cert_name: "{{ openstack_pki_service_intermediate_cert_name | default('ExampleCorpIntermediate') }}"
cloudkitty_pki_regen_cert: ""
cloudkitty_pki_san: "{{ openstack_pki_san | default({'dns': [ansible_facts['hostname']], 'ip': [management_address]}) }}"
cloudkitty_pki_backend: "{{ openstack_pki_backend | default('standalone') }}"
cloudkitty_pki_certificates:
  - name: "cloudkitty_{{ ansible_facts['hostname'] }}"
    cn: "{{ ansible_facts['hostname'] }}"
    san: "{{ cloudkitty_pki_san }}"
    # standalone backend only
    provider: ownca
    signed_by: "{{ cloudkitty_pki_intermediate_cert_name }}"

# cloudkitty destination files for SSL certificates
cloudkitty_ssl_cert: /etc/cloudkitty/cloudkitty.pem
cloudkitty_ssl_key: /etc/cloudkitty/cloudkitty.key

# Installation details for SSL certificates
cloudkitty_pki_install_certificates:
  - name: "cloudkitty_{{ ansible_facts['hostname'] }}"
    type: "certificate_chain"
    dest: "{{ cloudkitty_ssl_cert }}"
    owner: "{{ cloudkitty_system_user_name }}"
    group: "{{ cloudkitty_system_user_name }}"
    # standalone backend only
    src: "{{ cloudkitty_user_ssl_cert | default(cloudkitty_pki_certs_path ~ 'cloudkitty_' ~ ansible_facts['hostname'] ~ '-chain.crt') }}"
  - name: "cloudkitty_{{ ansible_facts['hostname'] }}"
    type: "private_key"
    dest: "{{ cloudkitty_ssl_key }}"
    owner: "{{ cloudkitty_system_user_name }}"
    group: "{{ cloudkitty_system_user_name }}"
    # standalone backend only
    src: "{{ cloudkitty_user_ssl_key | default(cloudkitty_pki_keys_path ~ 'cloudkitty_' ~ ansible_facts['hostname'] ~ '.key.pem') }}"

# Define user-provided SSL certificates
cloudkitty_user_ssl_cert: ""
cloudkitty_user_ssl_key: ""

Required Variables¶

external_lb_vip_address: 172.16.24.1
internal_lb_vip_address: 192.168.0.1
cloudkitty_galera_address: "{{ internal_lb_vip_address }}"
cloudkitty_container_mysql_password: "SuperSecretePassword1"
cloudkitty_service_password: "SuperSecretePassword2"
cloudkitty_rabbitmq_password: "SuperSecretePassword3"

Example Playbook¶

- name: Install cloudkitty service
  hosts: cloudkitty_all
  user: root
  roles:
    - { role: "os_cloudkitty", tags: [ "os-cloudkitty" ] }
  vars:
    external_lb_vip_address: 172.16.24.1
    internal_lb_vip_address: 192.168.0.1
    cloudkitty_galera_address: "{{ internal_lb_vip_address }}"
    cloudkitty_container_mysql_password: "SuperSecretePassword1"
    cloudkitty_service_password: "SuperSecretePassword2"
    cloudkitty_oslomsg_rpc_password: "SuperSecretePassword3"
    cloudkitty_oslomsg_notify_password: "SuperSecretePassword4"

OpenStack-Ansible CloudKitty

OpenStack-Ansible CloudKitty¶

Adding The Service to Your OpenStack-Ansible Deployment¶

Default variables¶

Required Variables¶

Example Playbook¶

OpenStack-Ansible 0.1.0.dev399

Page Contents