openstack
/
monasca-ceilometer
Code Issues Proposed changes

Update the README 

This updates the README. Following work has been done:

* Indent some lines (there is a rendering issue on github)

* Remove the "Edit entry_points.txt" step. (This file doesn't exist anymore
  in any of Ceilometer's upstream branches.)

* Update some parts of "Edit setup.cfg" step: the 'ceilometer.publisher' section
  doesn't exist anymore.

* Remove 'storage/impl_monasca.py' from files to copy step

* Add opts.py and monasca_ceilometer_opts.py to copy step

* Wrap lines > 80 chars

* Made relevant files a bullet list

* Update branch from stable/liberty to stable/pike

Change-Id: I77820547df9cc1514896f56a567db779ed00e1f8
This commit is contained in:
Luka Peschke 2018-02-13 11:32:30 +01:00
parent 4a2c73685f
commit 294ff4f53f
1 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -16,7 +16,8 @@ See devstack/README.md
### Installation Instructions for setting up Ceilosca manually
*To set up ceilosca automatically, read the instructions in devstack/README.md or use the included Vagrantfile*
*To set up ceilosca automatically, read the instructions in devstack/README.md
or use the included Vagrantfile*
Assumes that an active monasca-api server is running.
@ -24,62 +25,62 @@ Assumes that an active monasca-api server is running.
2. Install python-monascaclient
pip install python-monascaclient
pip install python-monascaclient
3. Clone monasca-ceilometer from github.com.
Copy the following files from *ceilosca/ceilometer* to devstack's ceilometer location typically at /opt/stack/ceilometer
Copy the following files from *ceilosca/ceilometer* to devstack's
ceilometer location typically at /opt/stack/ceilometer
monasca_client.py
storage/impl_monasca.py
tests/* (skipping the init.py files)
publisher/monasca_data_filter.py
publisher/monclient.py
ceilosca_mapping/*
opts.py
monasca_ceilometer_opts.py
4. Edit entry_points.txt
4. Edit setup.cfg (used at the time of installation)
Under [ceilometer.publisher] section add the following line:
Under 'ceilometer.sample.publisher =' section add the following line:
monasca = ceilometer.publisher.monclient:MonascaPublisher
Under [ceilometer.metering.storage] section add the following line:
5. Configure /etc/ceilometer/pipeline.yaml to send the metrics to the monasca
publisher. Use the included monasca-ceilometer/etc/ceilometer/pipeline.yaml
file as an example.
monasca = ceilometer.storage.impl_monasca:Connection
6. Configure /etc/ceilometer/ceilometer.conf for setting up storage driver for
ceilometer API. Use the included
monasca-ceilometer/etc/ceilometer/ceilometer.conf file as an example.
5. Edit setup.cfg (used at the time of installation)
7. Copy the included monasca_field_definitions.yml and monasca_pipeline.yaml
files from monasca-ceilometer/etc/ceilometer to /etc/ceilometer.
Under 'ceilometer.publisher =' section add the following line:
This monasca_field_definitions.yaml file contains configuration how to treat
each field in ceilometer sample object on per meter basis.
The monasca_data_filter.py uses this file and only stores the fields that
are specified in this config file.
monasca = ceilometer.publisher.monclient:MonascaPublisher
Under 'ceilometer.metering.storage =' section add the following line
monasca = ceilometer.storage.impl_monasca:Connection
6. Configure /etc/ceilometer/pipeline.yaml to send the metrics to the monasca publisher.
Use the included monasca-ceilometer/etc/ceilometer/pipeline.yaml file as an example.
7. Configure /etc/ceilometer/ceilometer.conf for setting up storage driver for ceilometer API.
Use the included monasca-ceilometer/etc/ceilometer/ceilometer.conf file as an example.
8. Copy the included monasca_field_definitions.yml and monasca_pipeline.yaml files from monasca-ceilometer/etc/ceilometer to /etc/ceilometer.
This monasca_field_definitions.yaml file contains configuration how to treat each field in ceilometer sample object on per meter basis.
The monasca_data_filter.py uses this file and only stores the fields that are specified in this config file.
9. Make sure the user specified under service_credentials in ceilometer.conf has *monasca_user role* added.
8. Make sure the user specified under service_credentials in ceilometer.conf
has *monasca_user role* added.
### Other info
Since we don't have full repo of ceilometer, we setup the ceilometer repo in venv and copy monasca integration files in there,
and run the unit tests over that code. At present this is tested against ceilometer stable/liberty branch, if you need to test
against different branch you can change it in test-requirements.txt
Since we don't have full repo of ceilometer, we setup the ceilometer repo in
venv and copy monasca integration files in there, and run the unit tests over
that code. At present this is tested against ceilometer stable/pike branch,
if you need to test against different branch you can change it in
test-requirements.txt
Relevant files are:
monasca_test_setup.py - determines the ceilometer venv path and copies the relevant files over
tox.ini - calls the commands for setup and runs the tests
test-requirements.txt - contains the dependencies required for testing
* monasca_test_setup.py - determines the ceilometer venv path and copies the
relevant files over
* tox.ini - calls the commands for setup and runs the tests
* test-requirements.txt - contains the dependencies required for testing
# License
@ -97,4 +98,3 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.