Skip to main content

Gets information about what is in an OpenStack tenant

Project description

Build Status codecov

OpenStack Info

Gets information about what is in an OpenStack tenant.

Installation

Prerequisites: - python >= 3.6

The tool can be installed from PyPi:

pip install openstackinfo

Bleeding edge versions can be installed directly from GitHub:

git clone https://github.com/wtsi-hgi/openstack-info.git
cd openstack-tenant-cleaner
python setup.py install

or using pip:

pip install git+https://github.com/wtsi-hgi/openstack-info.git@master#egg=openstackinfo

Usage

CLI

Set environment variables:

export OS_USERNAME=user
export OS_TENANT_NAME=tenant
export OS_AUTH_URL=http://example.com:5000/v2.0/
export OS_PASSWORD=password

Then call:

openstackinfo

The available options can be found with openstackinfo -h:

usage: openstackinfo [-h] [-i {type,id}] [--max-connections MAX_CONNECTIONS]
                     [--retries RETRIES] [--retry-wait RETRY_WAIT]
                     [--retry-wait-multiplier RETRY_WAIT_MULTIPLIER]

Openstack tenant information retriever

optional arguments:
  -h, --help            show this help message and exit
  -i {type,id}, --index {type,id}
                        What the OpenStack information should be index by
  --max-connections MAX_CONNECTIONS
                        Maximum number of simultaneous connections to make to
                        OpenStack
  --retries RETRIES     Number of times to retry getting information about a
                        particular tpye of OpenStack resource
  --retry-wait RETRY_WAIT
                        Initial amount of time (in seconds) to wait after a
                        failure before a retry
  --retry-wait-multiplier RETRY_WAIT_MULTIPLIER
                        Multiplier that is applied to the wait time after each
                        failure

Python

from openstackinfo.retriever.models import Credentials
from openstackinfo.retriever.retrievers import ShadeInformationRetriever
from openstackinfo.helpers import get_information, RunConfiguration
from openstackinfo.indexers import InformationIndexerByType

retriever = ShadeInformationRetriever(credentials=Credentials(username, password, auth_url, tenant))
configuration = RunConfiguration(retriever=retriever, indexer=InformationIndexerByType)
openstack_info = get_information(configuration)

Alternatives

  • shade (underlying library: no CLI, no re-indexing).
  • Nova CLI (does not return JSON).
  • Openstack CLI (does not return server metadata).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
openstackinfo-5.4.0.tar.gz (10.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page