openstack/python-observabilityclient
Code Issues Proposed changes

Merge pull request #3 from infrawatch/basic_docs

Browse Source 
Basic set of docs
This commit is contained in:
Leif Madsen
2022-12-02 14:25:15 -05:00
committed by GitHub
parent 60463d6737 58975106f8
commit 17a148d931
2 changed files with 59 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
README.md Normal file
View File

@@ -0,0 +1,59 @@
# python-observabilityclient
observabilityclient is an OpenStackClient (OSC) plugin implementation that
implements commands for management of OpenStack observability components such
as Prometheus, collectd and Ceilometer.
## Development
Install your OpenStack environment and patch your `openstack` client application using python.
```
# if using standalone, the following commands come after 'sudo dnf install -y python3-tripleoclient'
su - stack
# clone and install observability client plugin
git clone https://github.com/infrawatch/python-observabilityclient
cd python-observabilityclient
sudo python setup.py install --prefix=/usr
# clone and install observability playbooks and roles
git clone https://github.com/infrawatch/osp-observability-ansible
sudo mkdir /usr/share/osp-observability
sudo ln -s `pwd`/osp-observability-ansible/playbooks /usr/share/osp-observability/playbooks
sudo ln -s `pwd`/osp-observability-ansible/roles/spawn_container /usr/share/ansible/roles/spawn_container
sudo ln -s `pwd`/osp-observability-ansible/roles/osp_observability /usr/share/ansible/roles/osp_observability
```
Create a THT environment file to enable the write_prometheus plugin for the collectd service. Then redeploy your overcloud and include this new file:
```
mkdir -p ~/templates/observability
cat <EOF >> templates/observability/collectd-write-prometheus.yaml
resource_registry:
OS::TripleO::Services::Collectd: /usr/share/openstack-tripleo-heat-templates/deployment/metrics/collectd-container-puppet.yaml
# TEST
# parameter_merge_strategies:
# CollectdExtraPlugins: merge
parameter_defaults:
CollectdExtraPlugins:
- write_prometheus
EOF
```
After deployment of your cloud you can discover endpoints available for scraping:
```
source stackrc
openstack observability discover --stack-name=standalone
```
Deploy prometheus:
```
echo "prometheus_remote_write: ['http://someurl', 'http://otherurl']" > test_params.yaml
openstack observability setup prometheus_agent --config ./test_params.yaml
```

6
README.rst
View File

@@ -1,6 +0,0 @@
General information
-------------------
**observabilityclient** is an OpenStackClient (OSC) plugin implementation that
implements commands for management of OpenStack observability components
such as Prometheus, collectd and Ceilometer.