././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1725029534.8946266 python-vitrageclient-5.1.1/0000775000175000017500000000000000000000000015720 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/.coveragerc0000664000175000017500000000011200000000000020033 0ustar00zuulzuul00000000000000[run] branch = True source = vitrageclient [report] ignore_errors = True ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/.mailmap0000664000175000017500000000013100000000000017334 0ustar00zuulzuul00000000000000# Format is: # # ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/.stestr.conf0000664000175000017500000000006500000000000020172 0ustar00zuulzuul00000000000000[DEFAULT] test_path=./vitrageclient/tests/ top_dir=./././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/.zuul.yaml0000664000175000017500000000033300000000000017660 0ustar00zuulzuul00000000000000- project: templates: - check-requirements - openstack-python3-jobs - openstackclient-plugin-jobs - publish-openstack-docs-pti - release-notes-jobs-python3 - openstack-cover-jobs ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029534.0 python-vitrageclient-5.1.1/AUTHORS0000664000175000017500000000434300000000000016774 0ustar00zuulzuul0000000000000098k <18552437190@163.com> Alexey Alexey Weyl Alfredo Moralejo Andreas Jaeger Anna Anna Reznikov Cao Xuan Hoang Corey Bryant Deepak Dmitriy Rabotyagov Doug Hellmann Elod Illes Eyal Eyal Eyal Flavio Percoco Ghanshyam Mann HeroicHitesh Hervé Beraud Idan Hefetz Idan Kinory Ifat Afek Luong Anh Tuan M V P Nitesh Nguyen Hai Niv Oppenhaim Noam Bloom OpenStack Release Bot Q.hongtao Q.hongtao Sean McGinnis ShangXiao Sharat Sharma Thomas Goirand Tyler Smith Vieri <15050873171@163.com> XinxinShen Yujun Zhang ZhijunWei ZhongShengping avnish dongwenjuan gengchc2 idan kinory jacky06 kangyufei kavithahr liathartal lvxianguo maaoyu melissaml mgrosz pengyuesheng qinchunhua qingszhao rajat29 wangqi wangzihao wu.chunyang wu.shiming zhang.lei zhangboye ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/CONTRIBUTING.rst0000664000175000017500000000123100000000000020356 0ustar00zuulzuul00000000000000If you would like to contribute to the development of OpenStack, you must follow the steps in this page: https://docs.openstack.org/infra/manual/developers.html If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool: https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on Storyboard, not GitHub: https://storyboard.openstack.org/#!/board/89 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029534.0 python-vitrageclient-5.1.1/ChangeLog0000664000175000017500000002453100000000000017477 0ustar00zuulzuul00000000000000CHANGES ======= 5.1.1 ----- * Reorder DOT\_DATA 5.1.0 ----- * Support networkx 3.x * reno: Update master for unmaintained/zed * Update master for stable/2024.1 * reno: Update master for unmaintained/xena * reno: Update master for unmaintained/wallaby * reno: Update master for unmaintained/victoria 5.0.0 ----- * reno: Update master for unmaintained/yoga * Test python 3.11 * Update master for stable/2023.2 * Add oslo.log as runtime requirement 4.8.0 ----- * Update master for stable/2023.1 4.7.0 ----- * Fix tox 4 changes * Add Python3 antelope unit tests * Update master for stable/zed 4.6.0 ----- * Add Python3 zed unit tests * Drop lower-constraints.txt and its testing * Update master for stable/yoga 4.5.0 ----- * Add Python3 yoga unit tests * Update master for stable/xena 4.4.0 ----- * setup.cfg: Replace dashes with underscores * Follow-up patch for fixing coverage issue * Use py3 as the default runtime for tox * Migrate from testr to stestr * Add Python3 xena unit tests * Update master for stable/wallaby 4.3.0 ----- * Revert "remove py37" * remove py37 * Remove unicode from client 4.2.0 ----- * Update TOX\_CONSTRAINTS\_FILE * Remove the unused coding style modules * Remove six * Remove install unnecessary packages * Add Python3 wallaby unit tests * Update master for stable/victoria 4.1.1 ----- * Fix pygments style * Remove translation sections from setup.cfg 4.1.0 ----- * drop mock from lower-constraints * Stop to use the \_\_future\_\_ module * Switch to newer openstackdocstheme and reno versions * Fix hacking min version to 3.0.1 * Bump default tox env from py37 to py38 * Add py38 package metadata * Use unittest.mock instead of third party mock * Add Python3 victoria unit tests * Update master for stable/ussuri 4.0.1 ----- * Cleanup py27 support 4.0.0 ----- * Fix requirements * Update hacking and fix warning * Drop python 2.7 support and testing * Switch to Ussuri jobs * Update the constraints url * Update master for stable/train 3.0.0 ----- * Add Python 3 Train unit tests * Blacklist sphinx 2.1.0 (autodoc bug) * Add Python 3 Train unit tests * Add new api vitrage status * Template show in cli should be by default in yaml * fixed help message for add and delete * Add release notes for the wait flag * Add new api to list template versions supported * Add option to overwrite when adding template * Add option to wait for add and delete template * Support using name in show and delete templates * Constraint networkx to <2.3 for Python 2 * Replace git.openstack.org URLs with opendev.org URLs * OpenDev Migration Patch * Support python 3.6 and 3.7 * Dropping the py35 testing * Update master for stable/stein 2.7.0 ----- * Bugfix in add template: the new template\_str argument must be last * Allow calling template validate and template add with a string * add python 3.7 unit test job 2.6.0 ----- * Support parameters in Vitrage templates * add a new service list api 2.5.0 ----- * support graphml format * support dot format * Update the bugs link to storyboard * client support for resource api changes * Update hacking version * Use template for lower-constraints * Change openstack-dev to openstack-discuss * Add Python 3.6 classifier to setup.cfg * add python 3.6 unit test job 2.4.0 ----- * fix osc entry point path * Using storyboard to collect project bugs * add python 3.6 unit test job * switch documentation job to new PTI * import zuul job settings from project-config * using default mutable argument is wrong * update bash completion with new commands * Update reno for stable/rocky 2.3.0 ----- * support for alarm and RCA history * Bugfix: support vitrage alarm list for alarm with no resource * Add release notes for updating the osc with latest commands * Update the home-page for python-vitrageclient * Fixed the template add cli documentation * update osc with latest commands * Remove mox3 from lower-constraints * Template delete-validate uuid format * fix tox python3 overrides 2.2.0 ----- * add logger instance to be used * add lower-constraints job * Update the old doc links * Follow the new PTI for document build * Updated from global requirements * Updated from global requirements * Updated from global requirements * Update links in README * Updated from global requirements * modify the error url * Update reno for stable/queens * Updated from global requirements 2.0.0 ----- * template add,delete,list,validate CLI description * Webhook release notes * template crud release notes * Fixed the Vitrage CLI help * allow multiple template deletion * template add validate fix client * add template type to template list cli * Updated from global requirements * Updated from global requirements * Updated from global requirements * Order output, add docs, add support for 'all\_tenants' flag * pass the namespace to cliff CommandManager * support template add and delete * add support for webhooks * Update CLI documentation * add alarm show to client * nicer cli tables for resource list and alarm list * Updated from global requirements * Updated from global requirements * Updated from global requirements * Avoid tox\_install.sh for constraints support * Added client release notes for alarm-counts-api * Updated from global requirements * Updated from global requirements * Update .coveragerc after the removal of openstack directory * Removed unnecessary utf-8 encoding * safe\_load doesnt have parameter Loader * Updated from global requirements * Updated from global requirements * Display original result for healthcheck instead of crafting one * Updated from global requirements * add keycloak use documentation * Updated from global requirements * Changes to support new alarm counts api in vitrage * Add blank line to separate osprofiler prompt from results * Update reno for stable/pike 1.3.0 ----- * Added OSProfiler release notes * Updated from global requirements * Replaces yaml.load() with yaml.safe\_load() * Move osprofiler help message to the end of output * Doc Migration: move the developer guide docs under contributor folder * Create a folder for the contributor docs * some exceptions refactoring * Switch from oslosphinx to openstackdocstheme * get verify option from session secure option * fix import argparse for cliff 2.8.0 * fix import argparse for cliff 2.8.0 * roles are supplied by keycloak * supprt keycloak first stage * fix the condition to print for the osprofiler * Add option --profile to trigger profiling * Add command for healthcheck * Update bash completion * Fix bug in registering noauth options * fix the post event without time argument * post event paramters fix * make the import not relative * Updated from global requirements * add option to connect without authentication * Updated from global requirements * add validation for topology and post event for cli * Updated from global requirements 1.2.0 ----- * add release note about resource-list and resource-show * Vertex properties refactoring * Updated from global requirements * Updated from global requirements * Updated from global requirements * Updated from global requirements * Add 'rm -f .testrepository/times.dbm' command in testenv * Add 'rm -f .testrepository/times.dbm' command in testenv * fix rst typo * fix missing parameter in docstring * fix typo * Add a 'metadata' column to show resource optional properties * Updated from global requirements * Optimize the link address * implement the resource show API * support multi-tenants for resource list API * add @propery to format method * add @propery to format method * change alarm\_id in the rca api to alarm\_vitrage\_id * Updated from global requirements * create an python object from json string * Remove support for py34 * Update to a newer hacking library * Updated from global requirements * use upper constraints * Updated from global requirements * some doc fixes * use bool type for all\_tenants param * Updated from global requirements * Update reno for stable/ocata 1.1.1 ----- * Ocata release notes 1.1.0 ----- * Support post event API * Updated from global requirements * Updated from global requirements * Updated from global requirements * Added the releasenotes * Jenkins Job \*-docs-ubuntu-xenial * Make method import\_versioned\_module work * support osc * add vitrage client to osc * Show team and repo badges on README * Updated from global requirements * update vitrage bash completion * Show vitrage-id for alarms in alarm list cli * Remove white space between print () in exc.py * all\_tenants flag default value to false * Multi tenancy support - all tenants * Updated from global requirements * TrivialFix: Remove logging import unused * Clean imports in code 1.0.1 ----- * removed unused log 1.0.0 ----- * Updated from global requirements * change api syntax for alarms list * Add Python 3.5 classifier and venv * Remove discover from test-requirements * Updated from global requirements * add template show api * template list - client side * optimizations of get topology check * add the response msg as input to the ClientException * add some check about query condition to get topology show API * Template Validate API - validation of several templates * Template Validate API - support more then one returned result * Template Validate API - client side * change states fields * update tox version 0.2.1 ----- * change allow\_abbrev to be false for argparse * add endpoint override option * change severity to normalized\_severity * fix link in docs * fix link in docs * fix link in docs * fixed the style * fixed the link from README.rst to cli.rst * split README.rst to two separate files * fix readme file * add documentation * add documentation and py34 * change alarms cli * remove redundant code * change alarms cli * make the import more readable * cosmetic change * fix query to the rca * change alarms cli * cosmetic change * change alarms cli * change alarms cli * add rca api * add columns to alarms cli response * add alarms api * add alarms api * add show resource and list resources * work with no query * fix parameter limit * fix parameter limit * change topology api to get complex query * add graph type option for get topology * add .iml to git ignore * add parameters for get topology * fix doc * remove redundant mainfest.in file * fix client to work * make cliff return data as json * initialize the client field * removed topology-list * add more api * small refactoring * add more boilerplate files * add initial files for shell * change folder name * initial skeleton * python-vitrageclient project init * Added .gitreview ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/HACKING.rst0000664000175000017500000000024200000000000017514 0ustar00zuulzuul00000000000000python-vitrageclient Style Commandments ======================================= Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/LICENSE0000664000175000017500000002363700000000000016740 0ustar00zuulzuul00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1725029534.8946266 python-vitrageclient-5.1.1/PKG-INFO0000664000175000017500000000661700000000000017027 0ustar00zuulzuul00000000000000Metadata-Version: 1.2 Name: python-vitrageclient Version: 5.1.1 Summary: Vitrage Client API Library Home-page: https://docs.openstack.org/python-vitrageclient/latest/ Author: OpenStack Author-email: openstack-discuss@lists.openstack.org License: UNKNOWN Description: ======================== Team and repository tags ======================== .. image:: https://governance.openstack.org/tc/badges/python-vitrageclient.svg :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on .. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, 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. Python bindings to the Vitrage API ================================== This is a client library for Vitrage built to interface with the Vitrage API . It provides a Python API (the ``vitrageclient`` module) and a command-line tool (``vitrage``). .. contents:: Contents: :local: Ubuntu Install -------------- At the moment only manual install is available Manual Install Steps: - cd to your python-vitrageclient repo - sudo pip install -r requirements.txt - python setup.py install Building and Packaging ---------------------- Install the tool dependencies :: sudo apt-get install python-pip python-virtualenv In the python-vitrageclient source directory :: virtualenv --no-site-packages .venv source ./.venv/bin/activate pip install wheel python setup.py bdist_wheel pip install $(ls -1rt dist/*.whl | tail -1) --upgrade References ---------- Detailed documentation for the CLI see `CLI Spec `_ Platform: UNKNOWN Classifier: Environment :: OpenStack Classifier: Intended Audience :: Information Technology Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: Apache Software License Classifier: Operating System :: POSIX :: Linux Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: 3 :: Only Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Requires-Python: >=3.8 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/README.rst0000664000175000017500000000355200000000000017414 0ustar00zuulzuul00000000000000======================== Team and repository tags ======================== .. image:: https://governance.openstack.org/tc/badges/python-vitrageclient.svg :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on .. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, 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. Python bindings to the Vitrage API ================================== This is a client library for Vitrage built to interface with the Vitrage API . It provides a Python API (the ``vitrageclient`` module) and a command-line tool (``vitrage``). .. contents:: Contents: :local: Ubuntu Install -------------- At the moment only manual install is available Manual Install Steps: - cd to your python-vitrageclient repo - sudo pip install -r requirements.txt - python setup.py install Building and Packaging ---------------------- Install the tool dependencies :: sudo apt-get install python-pip python-virtualenv In the python-vitrageclient source directory :: virtualenv --no-site-packages .venv source ./.venv/bin/activate pip install wheel python setup.py bdist_wheel pip install $(ls -1rt dist/*.whl | tail -1) --upgrade References ---------- Detailed documentation for the CLI see `CLI Spec `_ ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1725029534.8786151 python-vitrageclient-5.1.1/doc/0000775000175000017500000000000000000000000016465 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/doc/requirements.txt0000664000175000017500000000045600000000000021756 0ustar00zuulzuul00000000000000# The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. sphinx>=2.0.0,!=2.1.0 # BSD openstackdocstheme>=2.2.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0 ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1725029534.8786151 python-vitrageclient-5.1.1/doc/source/0000775000175000017500000000000000000000000017765 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/doc/source/conf.py0000775000175000017500000000502200000000000021266 0ustar00zuulzuul00000000000000# Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # 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. import os import sys sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', 'openstackdocstheme' ] # openstackdocstheme options openstackdocs_repo_name = 'openstack/python-vitrageclient' openstackdocs_use_storyboard = True # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable # The suffix of source filenames. source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = 'python-vitrageclient' copyright = '2016, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). add_module_names = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] html_theme = 'openstackdocs' # html_static_path = ['static'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ ('index', '%s.tex' % project, '%s Documentation' % project, 'OpenStack Foundation', 'manual'), ] # Example configuration for intersphinx: refer to the Python standard library. #intersphinx_mapping = {'http://docs.python.org/': None} ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1725029534.882618 python-vitrageclient-5.1.1/doc/source/contributor/0000775000175000017500000000000000000000000022337 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1725029489.0 python-vitrageclient-5.1.1/doc/source/contributor/cli.rst0000664000175000017500000013433600000000000023652 0ustar00zuulzuul00000000000000.. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, 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. ================ Command-line API ================ Installing this distribution gets you a shell command, ``vitrage``, that you can use to interact with the Vitrage API server. Usage: vitrage vitrage help vitrage help Environmental Variables ----------------------- Environmental variables can be sourced, or optionally passed in as CLI arguments. It is easiest to source them first and then use the CLI. When using Keystone to obtain the token and endpoint:: export OS_USERNAME= export OS_PASSWORD= export OS_USER_DOMAIN_NAME= export OS_PROJECT_NAME= export OS_AUTH_URL= export OS_REGION_NAME= When OS_USER_DOMAIN_NAME is not set, then 'Default' is assumed. Alternatively IDs can be used instead of names. When using Keycloak instead of Keystone use the os-auth-type ``vitrage-keycloak`` and supply username, password, realm_name, endpoint, auth_url, openid_client_id. The parameters can be supplied in command line e.g --username,--realm-name or as environment variables with the prefix ``VITRAGE_`` e.g ``VITRAGE_REALM_NAME`` You'll find complete documentation on the shell by running ``vitrage help``:: vitrage help usage: vitrage [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] [--vitrage-api-version VITRAGE_API_VERSION] [--profile HMAC_KEY] [--os-region-name ] [--os-interface ] [--insecure] [--os-cacert ] [--os-cert ] [--os-key ] [--timeout ] [--os-auth-type ] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-default-domain-id OS_DEFAULT_DOMAIN_ID] [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME] [--os-user-id OS_USER_ID] [--os-username OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--endpoint ENDPOINT] Vitrage command line interface optional arguments: --version show program's version number and exit -v, --verbose Increase verbosity of output. Can be repeated. -q, --quiet Suppress output except warnings and errors. --log-file LOG_FILE Specify a file to log output. Disabled by default. -h, --help Show help message and exit. --debug Show tracebacks on errors. --vitrage-api-version VITRAGE_API_VERSION Defaults to env[VITRAGE_API_VERSION] or 1. --profile HMAC_KEY HMAC key to use for encrypting context data for performance profiling of request. This key should be the value of the HMAC key configured for the osprofiler middleware in Vitrage api; it is specified in the Vitrage configuration file at"/etc/vitrage/vitrage.conf". Without the key, profiling will not be triggered even if osprofiler is enabled on the server side. --os-region-name Authentication region name (Env: OS_REGION_NAME) --os-interface Select an interface type. Valid interface types: [admin, public, internal]. (Env: OS_INTERFACE) --os-auth-type , --os-auth-plugin Authentication type to use --endpoint ENDPOINT Vitrage endpoint (Env: VITRAGE_ENDPOINT) API Connection Options: Options controlling the HTTP API Connections --insecure Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution. --os-cacert Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]. --os-cert Defaults to env[OS_CERT]. --os-key Defaults to env[OS_KEY]. --timeout Set request timeout (in seconds). Authentication Options: Options specific to the password plugin. --os-auth-url OS_AUTH_URL Authentication URL --os-domain-id OS_DOMAIN_ID Domain ID to scope to --os-domain-name OS_DOMAIN_NAME Domain name to scope to --os-project-id OS_PROJECT_ID, --os-tenant-id OS_PROJECT_ID Project ID to scope to --os-project-name OS_PROJECT_NAME, --os-tenant-name OS_PROJECT_NAME Project name to scope to --os-project-domain-id OS_PROJECT_DOMAIN_ID Domain ID containing project --os-project-domain-name OS_PROJECT_DOMAIN_NAME Domain name containing project --os-trust-id OS_TRUST_ID Trust ID --os-default-domain-id OS_DEFAULT_DOMAIN_ID Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. --os-default-domain-name OS_DEFAULT_DOMAIN_NAME Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. --os-user-id OS_USER_ID User id --os-username OS_USERNAME, --os-user-name OS_USERNAME Username --os-user-domain-id OS_USER_DOMAIN_ID User's domain id --os-user-domain-name OS_USER_DOMAIN_NAME User's domain name --os-password OS_PASSWORD User's password Commands: alarm count Show a count of all alarms alarm list List all alarms alarm show Show an alarm complete print bash completion command (cliff) event post Post an event to Vitrage healthcheck Check api health status help print detailed help for another command (cliff) rca show Show the Root Cause Analysis for a certain alarm resource count Show a count of all resources resource list List resources resource show Show a resource service list List all services template add Add a template template delete Delete a template template list List all templates template show Show a template template validate Validate a template file topology show Show the topology of the system webhook add Add a new webhook to the database webhook delete Delete a webhook webhook list List all webhooks in the database webhook show Show a webhook Bash Completion --------------- Basic command tab completion can be enabled by sourcing the bash completion script. :: source /usr/local/share/vitrage.bash_completion Topology Example ---------------- Note: To see complete usage: 'vitrage help' and 'vitrage help ' topology show ^^^^^^^^^^^^^ :: vitrage topology show { "directed": true, "graph": {}, "nodes": [ { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-8", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "20d12a8a-ea9a-89c6-5947-83bea959362e", "vitrage_id": "RESOURCE:nova.instance:20d12a8a-ea9a-89c6-5947-83bea959362e" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-2", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "dc35fa2f-4515-1653-ef6b-03b471bb395b", "vitrage_id": "RESOURCE:nova.instance:dc35fa2f-4515-1653-ef6b-03b471bb395b" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-13", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "9879cf5a-bdcf-3651-3017-961ed887ec86", "vitrage_id": "RESOURCE:nova.instance:9879cf5a-bdcf-3651-3017-961ed887ec86" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-10", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "fe124f4b-9ed7-4591-fcd1-803cf5c33cb1", "vitrage_id": "RESOURCE:nova.instance:fe124f4b-9ed7-4591-fcd1-803cf5c33cb1" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-11", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "f2e48a97-7350-061e-12d3-84c6dc3e67c0", "vitrage_id": "RESOURCE:nova.instance:f2e48a97-7350-061e-12d3-84c6dc3e67c0" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "host-2", "update_timestamp": "2015-12-01T12:46:41Z", "state": "available", "type": "nova.host", "id": "host-2", "vitrage_id": "RESOURCE:nova.host:host-2" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "host-3", "update_timestamp": "2015-12-01T12:46:41Z", "state": "available", "type": "nova.host", "id": "host-3", "vitrage_id": "RESOURCE:nova.host:host-3" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "host-0", "update_timestamp": "2015-12-01T12:46:41Z", "state": "available", "type": "nova.host", "id": "host-0", "vitrage_id": "RESOURCE:nova.host:host-0" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "host-1", "update_timestamp": "2015-12-01T12:46:41Z", "state": "available", "type": "nova.host", "id": "host-1", "vitrage_id": "RESOURCE:nova.host:host-1" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-9", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "275097cf-954e-8e24-b185-9514e24b8591", "vitrage_id": "RESOURCE:nova.instance:275097cf-954e-8e24-b185-9514e24b8591" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-1", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "a0f0805f-c804-cffe-c25a-1b38f555ed68", "vitrage_id": "RESOURCE:nova.instance:a0f0805f-c804-cffe-c25a-1b38f555ed68" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-14", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "56af57d2-34a4-19b1-5106-b613637a11a7", "vitrage_id": "RESOURCE:nova.instance:56af57d2-34a4-19b1-5106-b613637a11a7" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "zone-1", "update_timestamp": "2015-12-01T12:46:41Z", "state": "available", "type": "nova.zone", "id": "zone-1", "vitrage_id": "RESOURCE:nova.zone:zone-1" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-3", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "16e14c58-d254-2bec-53e4-c766e48810aa", "vitrage_id": "RESOURCE:nova.instance:16e14c58-d254-2bec-53e4-c766e48810aa" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-7", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "f35a1e10-74ff-7332-8edf-83cd6ffcb2de", "vitrage_id": "RESOURCE:nova.instance:f35a1e10-74ff-7332-8edf-83cd6ffcb2de" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-4", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "ea8a450e-cab1-2272-f431-494b40c5c378", "vitrage_id": "RESOURCE:nova.instance:ea8a450e-cab1-2272-f431-494b40c5c378" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-6", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "6e42bdc3-b776-1b2c-2c7d-b7a8bb98f721", "vitrage_id": "RESOURCE:nova.instance:6e42bdc3-b776-1b2c-2c7d-b7a8bb98f721" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-5", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "8c951613-c660-87c0-c18b-0fa3293ce8d8", "vitrage_id": "RESOURCE:nova.instance:8c951613-c660-87c0-c18b-0fa3293ce8d8" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "zone-0", "update_timestamp": "2015-12-01T12:46:41Z", "state": "available", "type": "nova.zone", "id": "zone-0", "vitrage_id": "RESOURCE:nova.zone:zone-0" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-0", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "78353ce4-2710-49b5-1341-b8cbb6000ebc", "vitrage_id": "RESOURCE:nova.instance:78353ce4-2710-49b5-1341-b8cbb6000ebc" },TODO { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "vm-12", "update_timestamp": "2015-12-01T12:46:41Z", "state": "ACTIVE", "project_id": "0683517e1e354d2ba25cba6937f44e79", "type": "nova.instance", "id": "35bf479a-75d9-80a9-874e-d3b50fb2dd2e", "vitrage_id": "RESOURCE:nova.instance:35bf479a-75d9-80a9-874e-d3b50fb2dd2e" }, { "category": "RESOURCE", "is_placeholder": false, "is_deleted": false, "name": "openstack.node", "type": "openstack.node", "id": "openstack.node", "vitrage_id": "RESOURCE:openstack.node" } ], "links": [ { "relationship_name": "contains", "is_deleted": false, "target": 3, "key": "contains", "source": 5 }, { "relationship_name": "contains", "is_deleted": false, "target": 1, "key": "contains", "source": 5 }, { "relationship_name": "contains", "is_deleted": false, "target": 16, "key": "contains", "source": 5 }, { "relationship_name": "contains", "is_deleted": false, "target": 11, "key": "contains", "source": 5 }, { "relationship_name": "contains", "is_deleted": false, "target": 13, "key": "contains", "source": 6 }, { "relationship_name": "contains", "is_deleted": false, "target": 4, "key": "contains", "source": 6 }, { "relationship_name": "contains", "is_deleted": false, "target": 14, "key": "contains", "source": 6 }, { "relationship_name": "contains", "is_deleted": false, "target": 20, "key": "contains", "source": 7 }, { "relationship_name": "contains", "is_deleted": false, "target": 0, "key": "contains", "source": 7 }, { "relationship_name": "contains", "is_deleted": false, "target": 19, "key": "contains", "source": 7 }, { "relationship_name": "contains", "is_deleted": false, "target": 15, "key": "contains", "source": 7 }, { "relationship_name": "contains", "is_deleted": false, "target": 9, "key": "contains", "source": 8 }, { "relationship_name": "contains", "is_deleted": false, "target": 10, "key": "contains", "source": 8 }, { "relationship_name": "contains", "is_deleted": false, "target": 2, "key": "contains", "source": 8 }, { "relationship_name": "contains", "is_deleted": false, "target": 17, "key": "contains", "source": 8 }, { "relationship_name": "contains", "is_deleted": false, "target": 6, "key": "contains", "source": 12 }, { "relationship_name": "contains", "is_deleted": false, "target": 8, "key": "contains", "source": 12 }, { "relationship_name": "contains", "is_deleted": false, "target": 5, "key": "contains", "source": 18 }, { "relationship_name": "contains", "is_deleted": false, "target": 7, "key": "contains", "source": 18 }, { "relationship_name": "contains", "is_deleted": false, "target": 18, "key": "contains", "source": 21 }, { "relationship_name": "contains", "is_deleted": false, "target": 12, "key": "contains", "source": 21 } ], "multigraph": true } RCA Example ----------- Note: To see complete usage: 'vitrage help' and 'vitrage help ' rca show ^^^^^^^^ :: vitrage rca show { "directed": true, "graph": { }, "nodes": [ { "category": "ALARM", "type": "nagios", "name": "CPU load", "state": "Active", "severity": "WARNING", "update_timestamp": "2015-12-01T12:46:41Z", "info": "WARNING - 15min load 1.66 at 32 CPUs", "resource_type": "nova.host", "resource_name": "host-0", "resource_id": "host-0", "id": 0, "vitrage_id": "ALARM:nagios:host0:CPU load" }, { "category": "ALARM", "type": "vitrage", "name": "Machine Suboptimal", "state": "Active", "severity": "WARNING", "update_timestamp": "2015-12-01T12:46:41Z", "resource_type": "nova.instance", "resource_name": "vm0", "resource_id": "20d12a8a-ea9a-89c6-5947-83bea959362e", "id": 1, "vitrage_id": "ALARM:vitrage:vm0:Machine Suboptimal" }, { "category": "ALARM", "type": "vitrage", "name": "Machine Suboptimal", "state": "Active", "severity": "WARNING", "update_timestamp": "2015-12-01T12:46:41Z", "resource_type": "nova.instance", "resource_name": "vm1", "resource_id": "275097cf-954e-8e24-b185-9514e24b8591", "id": 2, "vitrage_id": "ALARM:vitrage:vm1:Machine Suboptimal" } ], "links": [ { "source": 0, "target": 1, "relationship": "causes" }, { "source": 0, "target": 2, "relationship": "causes" } ], "multigraph": false, "inspected_index": 0 } Resources Examples ------------------ Note: To see complete usage: 'vitrage help' and 'vitrage help ' resource list ^^^^^^^^^^^^^ :: vitrage resource list +--------------------------------------+-------------------+--------------------------------------+------------+-------------------------------------------------------------------------------------------------------------------------------+ | ID | Type | Data Source ID | State | Metadata | +--------------------------------------+-------------------+--------------------------------------+------------+-------------------------------------------------------------------------------------------------------------------------------+ | 786efe03-55ff-41b2-bdc1-6cd94bc355ad | nova.instance | f3d6819a-5b52-4fae-93d4-ce58c263510b | SUBOPTIMAL | {'project_id': '4437e14f56904650af9eef83dff35263', 'name': 'vm-0', 'update_timestamp': '2018-01-03 09:06:06.339099+00:00'} | | d019ee2b-df2a-4c8f-bc59-f28a2296b0db | neutron.network | dafa8864-a04c-4688-bab2-c6dc3ce5c31b | OK | {'project_id': '4437e14f56904650af9eef83dff35263', 'name': 'public', 'update_timestamp': '2017-11-09T09:49:49Z'} | | 772d627f-90d7-4c5e-8c18-6587fa5b88ee | neutron.port | 75ff8ce5-26d9-4d77-875f-8d297918374c | OK | {'project_id': '4437e14f56904650af9eef83dff35263', 'update_timestamp': '2017-11-28T11:50:23Z'} | | 4ac47cef-419f-4e4b-9590-22c10bbd21fd | nova.host | compute-0-0 | OK | {'name': 'compute-0-0', 'update_timestamp': '2018-01-03 09:06:06.851229+00:00'} | | 99920528-2757-4fde-a2a0-3063bf0c4020 | openstack.cluster | OpenStack Cluster | OK | {'name': 'openstack.cluster'} | | 374203a6-e7bc-4bd6-bc32-1137f4f3d234 | nova.zone | nova | OK | {'name': 'nova', 'update_timestamp': '2018-01-03 09:06:07.628148+00:00'} | +--------------------------------------+-------------------+--------------------------------------+------------+-------------------------------------------------------------------------------------------------------------------------------+ resource show ^^^^^^^^^^^^^ :: vitrage resource show 786efe03-55ff-41b2-bdc1-6cd94bc355ad +---------------------------+--------------------------------------+ | Field | Value | +---------------------------+--------------------------------------+ | host_id | compute-0-0 | | id | f3d6819a-5b52-4fae-93d4-ce58c263510b | | is_real_vitrage_id | True | | name | vm-0 | | project_id | 4437e14f56904650af9eef83dff35263 | | state | ACTIVE | | update_timestamp | 2018-01-03 09:06:06.339099+00:00 | | vitrage_aggregated_state | SUBOPTIMAL | | vitrage_category | RESOURCE | | vitrage_id | 786efe03-55ff-41b2-bdc1-6cd94bc355ad | | vitrage_is_deleted | False | | vitrage_is_placeholder | False | | vitrage_operational_state | SUBOPTIMAL | | vitrage_sample_timestamp | 2018-01-03 09:06:06.339099+00:00 | | vitrage_state | SUBOPTIMAL | | vitrage_type | nova.instance | +---------------------------+--------------------------------------+ resource count ^^^^^^^^^^^^^^ :: vitrage resource count { "nova.instance": 394, "openstack.cluster": 1, "cinder.volume": 405, "nova.host": 16, "neutron.network": 7, "neutron.port": 1127, "nova.zone": 3, "tripleo.controller": 3 } vitrage resource count --type nova.instance --group-by state { "ACTIVE": 359, "ERROR": 27, "SUBOPTIMAL": 8 } Service Examples ---------------- Note: To see complete usage: 'vitrage help' and 'vitrage help ' service list ^^^^^^^^^^^^ A list of all vitrage services and their status:: vitrage service list +----------------------------------+------------+--------------+---------------------------+ | Name | Process Id | Hostname | Created At | +----------------------------------+------------+--------------+---------------------------+ | ApiWorker worker(0) | 23161 | controller-1 | 2019-02-10T11:07:15+00:00 | | EvaluatorWorker worker(0) | 23153 | controller-1 | 2019-02-10T11:07:15+00:00 | | EvaluatorWorker worker(1) | 23155 | controller-1 | 2019-02-10T11:07:15+00:00 | | EvaluatorWorker worker(2) | 23157 | controller-1 | 2019-02-10T11:07:15+00:00 | | EvaluatorWorker worker(3) | 23158 | controller-1 | 2019-02-10T11:07:15+00:00 | | MachineLearningService worker(0) | 23366 | controller-1 | 2019-02-10T11:07:33+00:00 | | PersistorService worker(0) | 23475 | controller-1 | 2019-02-10T11:07:35+00:00 | | SnmpParsingService worker(0) | 23164 | controller-1 | 2019-02-10T11:07:15+00:00 | | vitrageuWSGI worker 1 | 25698 | controller-1 | 2019-02-10T11:14:30+00:00 | | vitrageuWSGI worker 2 | 25699 | controller-1 | 2019-02-10T11:14:30+00:00 | | VitrageNotifierService worker(0) | 23352 | controller-1 | 2019-02-10T11:07:32+00:00 | +----------------------------------+------------+--------------+---------------------------+ Alarms Examples --------------- Note: To see complete usage: 'vitrage help' and 'vitrage help ' alarm list ^^^^^^^^^^ A list of all alarms (default limit of 1000 alarms):: vitrage alarm list +--------------------------------------+---------+----------------------------------------+---------------+--------------------------------------+----------+----------------------+ | ID | Type | Name | Resource Type | Resource ID | Severity | Update Time | +--------------------------------------+---------+----------------------------------------+---------------+--------------------------------------+----------+----------------------+ | f85ed0d2-3e28-47f9-9231-6fa72d6c882d | vitrage | VM network problem 3 | nova.instance | 786efe03-55ff-41b2-bdc1-6cd94bc355ad | CRITICAL | 2018-01-03T07:52:06Z | | 868b252a-4053-431c-a6d3-7cdabd91edd8 | zabbix | Lack of free swap space on compute-0-0 | nova.host | 4ac47cef-419f-4e4b-9590-22c10bbd21fd | WARNING | 2017-11-09T11:24:30Z | | c1ab17d4-8b6b-4d12-a4ec-3150bb89a5a5 | zabbix | Too many processes on compute-0-0 | nova.host | 4ac47cef-419f-4e4b-9590-22c10bbd21fd | WARNING | 2017-11-09T11:25:12Z | | 7468b7f5-5a89-49ee-b408-3cfafd68290a | zabbix | Public interface down on compute-0-0 | nova.host | 4ac47cef-419f-4e4b-9590-22c10bbd21fd | CRITICAL | 2017-12-13T07:34:08Z | | 608366ed-a737-4aab-a58f-8673a589e3aa | vitrage | VM network problem 2 | nova.instance | 786efe03-55ff-41b2-bdc1-6cd94bc355ad | CRITICAL | 2018-01-03T07:52:06Z | +--------------------------------------+---------+----------------------------------------+---------------+--------------------------------------+----------+----------------------+ A list of all alarms on the given resource:: vitrage alarm list 52b466ba-ef98-4bf5-93d8-5c3ca680fe01 +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------+ | ID | Type | Name | Resource Type | Resource ID | Severity | Update Time | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------+ | 3c1dda08-2c95-49f1-9155-35e5512a6f38 | vitrage | Instance down | nova.instance | 52b466ba-ef98-4bf5-93d8-5c3ca680fe01 | CRITICAL | 2018-07-22T11:42:57Z | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------+ A list of ``limit`` number of alarms:: vitrage alarm list --limit 2 +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+ | ID | Type | Name | Resource Type | Resource ID | Severity | Update Time | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+ | f85ed0d2-3e28-47f9-9231-6fa72d6c882d | vitrage | Instance down | nova.instance | 52b466ba-ef98-4bf5-93d8-5c3ca680fe01 | CRITICAL | 2018-07-19 14:53:24.741108 | | 868b252a-4053-431c-a6d3-7cdabd91edd8 | vitrage | Instance down | nova.instance | 4ac47cef-419f-4e4b-9590-22c10bbd21fd | CRITICAL | 2018-07-19 14:53:24.773490 | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+ Paging. Get next alarms, from ``marker`` which is a vitrage_id:: vitrage alarm list --limit 2 --marker 868b252a-4053-431c-a6d3-7cdabd91edd8 +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+ | ID | Type | Name | Resource Type | Resource ID | Severity | Update Time | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+ | c1ab17d4-8b6b-4d12-a4ec-3150bb89a5a5 | vitrage | Instance down | nova.instance | 52b466ba-ef98-4bf5-93d8-5c3ca680fe01 | CRITICAL | 2018-07-19 14:53:24.801490 | | 7468b7f5-5a89-49ee-b408-3cfafd68290a | vitrage | Instance down | nova.instance | 4ac47cef-419f-4e4b-9590-22c10bbd21fd | CRITICAL | 2018-07-19 14:53:24.828359 | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+ alarm history ^^^^^^^^^^^^^ A list of all alarms that were active during the time frame of ``start`` and ``end``:: vitrage alarm history --start '2018-07-22 14:10:40.087709' --end '2018-07-23 16:10:41.354102' --limit 3 +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+----------------------------+ | ID | Type | Name | Resource Type | Resource ID | Severity | Start Time | End Time | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+----------------------------+ | f85ed0d2-3e28-47f9-9231-6fa72d6c882d | vitrage | Instance down | nova.instance | 4ac47cef-419f-4e4b-9590-22c10bbd21fd | CRITICAL | 2018-07-19 14:53:24.741108 | 2018-07-22 14:53:24.741108 | | 868b252a-4053-431c-a6d3-7cdabd91edd8 | vitrage | Instance down | nova.instance | 786efe03-55ff-41b2-bdc1-6cd94bc355ad | CRITICAL | 2018-07-19 14:53:24.773490 | | | c1ab17d4-8b6b-4d12-a4ec-3150bb89a5a5 | vitrage | Instance down | nova.instance | 52b466ba-ef98-4bf5-93d8-5c3ca680fe01 | CRITICAL | 2018-07-23 02:10:41.354102 | +--------------------------------------+---------+---------------+---------------+--------------------------------------+----------+----------------------------+----------------------------+ alarm show ^^^^^^^^^^ :: vitrage alarm show f85ed0d2-3e28-47f9-9231-6fa72d6c882d +------------------------------+--------------------------------------+ | Field | Value | +------------------------------+--------------------------------------+ | name | VM network problem 3 | | resource_id | 786efe03-55ff-41b2-bdc1-6cd94bc355ad | | severity | critical | | state | Active | | update_timestamp | 2018-01-03T07:52:06Z | | vitrage_aggregated_severity | CRITICAL | | vitrage_category | ALARM | | vitrage_id | f85ed0d2-3e28-47f9-9231-6fa72d6c882d | | vitrage_is_deleted | False | | vitrage_is_placeholder | False | | vitrage_operational_severity | CRITICAL | | vitrage_resource_id | 786efe03-55ff-41b2-bdc1-6cd94bc355ad | | vitrage_resource_type | nova.instance | | vitrage_sample_timestamp | 2018-01-03 07:52:06.306507+00:00 | | vitrage_type | vitrage | +------------------------------+--------------------------------------+ alarm count ^^^^^^^^^^^ :: vitrage alarm count { "WARNING": 2, "SEVERE": 0, "CRITICAL": 7, "OK": 0, "N/A": 0 } Template Examples ----------------- **Note:** for templates version 2 --type