Skip to content

Commit 4026c4e

Browse files
seunghun1eeseunghun1ee
authored
Add RADOS gateway usage exporter support (#1082)
Add playbook for deploying radosgw usage exporter
1 parent 6ca4114 commit 4026c4e

File tree

5 files changed

+198
-0
lines changed

5 files changed

+198
-0
lines changed

‎etc/kayobe/ansible/deploy-radosgw-usage-exporter.yml

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
- name: Deploy RADOS gateway usage exporter
3+
hosts: monitoring
4+
gather_facts: false
5+
tags: radosgw_usage_exporter
6+
vars:
7+
venv: "{{ virtualenv_path }}/openstack"
8+
tasks:
9+
- name: Deploy RADOS gateway usage exporter
10+
when: stackhpc_enable_radosgw_usage_exporter
11+
block:
12+
- name: Set up openstack cli virtualenv
13+
ansible.builtin.pip:
14+
virtualenv: "{{ venv }}"
15+
virtualenv_command: "/usr/bin/python3 -m venv"
16+
name:
17+
- python-openstackclient
18+
state: latest
19+
extra_args: "{% if pip_upper_constraints_file %}-c {{ pip_upper_constraints_file }}{% endif %}"
20+
run_once: true
21+
delegate_to: "{{ groups['controllers'][0] }}"
22+
vars:
23+
ansible_host: "{{ hostvars[groups['controllers'][0]].ansible_host }}"
24+
25+
- name: Read admin-openrc credential file
26+
ansible.builtin.command:
27+
cmd: "cat {{ lookup('ansible.builtin.env', 'KOLLA_CONFIG_PATH') }}/admin-openrc.sh"
28+
delegate_to: localhost
29+
register: credential
30+
changed_when: false
31+
32+
- name: Set facts for admin credentials
33+
ansible.builtin.set_fact:
34+
openstack_auth_env:
35+
OS_PROJECT_DOMAIN_NAME: "{{ credential.stdout_lines | select('match', '.*OS_PROJECT_DOMAIN_NAME*.') | first | split('=') | last | replace(\"'\", '') }}"
36+
OS_USER_DOMAIN_NAME: "{{ credential.stdout_lines | select('match', '.*OS_USER_DOMAIN_NAME*.') | first | split('=') | last | replace(\"'\", '') }}"
37+
OS_PROJECT_NAME: "{{ credential.stdout_lines | select('match', '.*OS_PROJECT_NAME*.') | first | split('=') | last | replace(\"'\", '') }}"
38+
OS_USERNAME: "{{ credential.stdout_lines | select('match', '.*OS_USERNAME*.') | first | split('=') | last | replace(\"'\", '') }}"
39+
OS_PASSWORD: "{{ credential.stdout_lines | select('match', '.*OS_PASSWORD*.') | first | split('=') | last | replace(\"'\", '') }}"
40+
OS_AUTH_URL: "{{ credential.stdout_lines | select('match', '.*OS_AUTH_URL*.') | first | split('=') | last | replace(\"'\", '') }}"
41+
OS_INTERFACE: "{{ credential.stdout_lines | select('match', '.*OS_INTERFACE*.') | first | split('=') | last | replace(\"'\", '') }}"
42+
OS_IDENTITY_API_VERSION: "{{ credential.stdout_lines | select('match', '.*OS_IDENTITY_API_VERSION*.') | first | split('=') | last | replace(\"'\", '') }}"
43+
OS_CACERT: "{{ '/etc/ssl/certs/ca-certificates.crt' if os_distribution == 'ubuntu' else '/etc/pki/tls/certs/ca-bundle.crt' }}"
44+
45+
- name: Check ec2 credential for ceph_rgw
46+
ansible.builtin.command: >
47+
{{ venv }}/bin/openstack
48+
ec2 credentials list --user ceph_rgw
49+
--format json
50+
environment: "{{ openstack_auth_env }}"
51+
register: credential_check
52+
delegate_to: "{{ groups['controllers'][0] }}"
53+
changed_when: false
54+
vars:
55+
ansible_host: "{{ hostvars[groups['controllers'][0]].ansible_host }}"
56+
run_once: true
57+
58+
- name: Create ec2 credential if there's none
59+
ansible.builtin.command: >
60+
{{ venv }}/bin/openstack
61+
ec2 credentials create --user ceph_rgw --project service
62+
--format json
63+
environment: "{{ openstack_auth_env }}"
64+
delegate_to: "{{ groups['controllers'][0] }}"
65+
changed_when: true
66+
vars:
67+
ansible_host: "{{ hostvars[groups['controllers'][0]].ansible_host }}"
68+
run_once: true
69+
when: credential_check.stdout == []
70+
71+
- name: Query ec2 credential for ceph_rgw
72+
ansible.builtin.command: >
73+
{{ venv }}/bin/openstack
74+
ec2 credentials list --user ceph_rgw
75+
--format json
76+
environment: "{{ openstack_auth_env }}"
77+
delegate_to: "{{ groups['controllers'][0] }}"
78+
changed_when: false
79+
vars:
80+
ansible_host: "{{ hostvars[groups['controllers'][0]].ansible_host }}"
81+
register: credential
82+
run_once: true
83+
84+
- name: Get object storage endpoint
85+
ansible.builtin.command: >
86+
{{ venv }}/bin/openstack
87+
endpoint list --service object-store --interface internal
88+
--format json
89+
environment: "{{ openstack_auth_env }}"
90+
delegate_to: "{{ groups['controllers'][0] }}"
91+
changed_when: false
92+
vars:
93+
ansible_host: "{{ hostvars[groups['controllers'][0]].ansible_host }}"
94+
register: endpoint
95+
run_once: true
96+
97+
- name: Process object storage endpoint
98+
ansible.builtin.set_fact:
99+
radosgw_server: "{{ scheme + '://' + hostname + ':' + radosgw_port }}"
100+
vars:
101+
swift: "{{ endpoint.stdout | from_json | first }}"
102+
hostname: "{{ swift.URL | urlsplit('hostname') }}"
103+
scheme: "{{ swift.URL | urlsplit('scheme') }}"
104+
radosgw_port: "{{ swift.URL | urlsplit('port') }}"
105+
run_once: true
106+
107+
- name: Ensure radosgw_usage_exporter container is running
108+
community.docker.docker_container:
109+
name: radosgw_usage_exporter
110+
image: ghcr.io/stackhpc/radosgw_usage_exporter:v0.1.1
111+
network_mode: host
112+
env:
113+
RADOSGW_SERVER: "{{ radosgw_server }}"
114+
ADMIN_ENTRY: admin
115+
ACCESS_KEY: "{{ ec2.Access }}"
116+
SECRET_KEY: "{{ ec2.Secret }}"
117+
VIRTUAL_PORT: "{{ stackhpc_radosgw_usage_exporter_port | string }}"
118+
entrypoint: "{{ ['python', '-u', './radosgw_usage_exporter.py', '--insecure'] if not stackhpc_radosgw_usage_exporter_verify else omit }}"
119+
vars:
120+
ec2: "{{ credential.stdout | from_json | first }}"
121+
become: true
122+
123+
- name: Ensure that the internal TLS certificate is trusted by the exporter
124+
when: stackhpc_radosgw_usage_exporter_cacert | length > 0
125+
block:
126+
- name: Create radosgw-usage-exporter directory
127+
ansible.builtin.file:
128+
path: /opt/kayobe/radosgw-usage-exporter/
129+
state: directory
130+
mode: 0755
131+
132+
- name: Copy CA certificate to RADOS gateway usage exporter nodes
133+
ansible.builtin.copy:
134+
src: "{{ stackhpc_radosgw_usage_exporter_cacert }}"
135+
dest: "/opt/kayobe/radosgw-usage-exporter/{{ stackhpc_radosgw_usage_exporter_cacert | basename }}"
136+
mode: 0644
137+
register: copy_to_node_result
138+
139+
- name: Copy CA certificate to RADOS gateway usage exporter container
140+
community.docker.docker_container_copy_into:
141+
container: radosgw_usage_exporter
142+
path: "{{ copy_to_node_result.dest }}"
143+
container_path: "/usr/local/share/ca-certificates/{{ copy_to_node_result.dest | basename }}"
144+
become: true
145+
146+
- name: Update CA certificate of RADOS gateway usage exporter container
147+
community.docker.docker_container_exec:
148+
container: radosgw_usage_exporter
149+
command: update-ca-certificates
150+
user: root
151+
become: true

‎etc/kayobe/hooks/overcloud-service-deploy/post.d/deploy-radosgw-usage-exporter.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../ansible/deploy-radosgw-usage-exporter.yml

‎etc/kayobe/kolla/config/prometheus/prometheus.yml.d/80-radosgw-exporter.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# yamllint disable-file
2+
---
3+
{% if stackhpc_enable_radosgw_usage_exporter | bool %}
4+
{% raw %}
5+
scrape_configs:
6+
- job_name: ceph_radosgw_usage_exporter
7+
honor_labels: true
8+
scrape_interval: 15s
9+
metric_relabel_configs:
10+
- replacement: ${1}
11+
source_labels: [owner,user]
12+
target_label: tenant_id
13+
separator: ""
14+
regex: (.+)
15+
static_configs:
16+
- targets:
17+
{% for host in groups['monitoring'] %}
18+
- "{{ 'api' | kolla_address(host) | put_address_in_context('url') }}:{% endraw %}{{ stackhpc_radosgw_usage_exporter_port }}{% raw %}"
19+
{% endfor %}
20+
{% endraw %}
21+
{% endif %}

‎etc/kayobe/stackhpc-monitoring.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,19 @@ redfish_exporter_default_password: "{{ ipmi_password }}"
5353
redfish_exporter_target_address: "{{ ipmi_address }}"
5454

5555
###############################################################################
56+
57+
# Whether the RADOS gateway usage exporter is enabled.
58+
# Enabling this will result in templating radosgw_usage_exporter endpoint as
59+
# Prometheus scrape targets during deployment.
60+
stackhpc_enable_radosgw_usage_exporter: false
61+
62+
# Port to expose RADOS gateway usage exporter. Default is 9242
63+
stackhpc_radosgw_usage_exporter_port: 9242
64+
65+
# Path to a certificate for internal TLS in the RADOS gateway usage exporter.
66+
stackhpc_radosgw_usage_exporter_cacert: ""
67+
68+
# Whether TLS certificate verification is enabled for the RADOS gateway usage
69+
# exporter for querying Ceph RADOS gateway APIs. Default follows the condition
70+
# of kolla_enable_tls_internal
71+
stackhpc_radosgw_usage_exporter_verify: "{{ kolla_enable_tls_internal }}"

‎releasenotes/notes/add-radosgw-usage-exporter-support-93d55c544418b05a.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
features:
3+
- |
4+
Adds RADOS Gateway usage exporter support.
5+
6+
To deploy the exporter, set the variable ``stackhpc_enable_radosgw_usage_exporter``
7+
to true. Then run playbook ``deploy-radosgw-usage-exporter.yml``.
8+
A certificate path needs to be set to ``stackhpc_radosgw_usage_exporter_cacert``
9+
if internal TLS is enabled.

0 commit comments

Comments
 (0)