{"id":21881031,"url":"https://github.com/wtsi-hgi/openstack-info","last_synced_at":"2025-03-22T00:43:36.520Z","repository":{"id":57449245,"uuid":"101867677","full_name":"wtsi-hgi/openstack-info","owner":"wtsi-hgi","description":"Gets information about what is in an OpenStack tenant","archived":false,"fork":false,"pushed_at":"2018-04-16T14:16:55.000Z","size":63,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-28T04:59:57.642Z","etag":null,"topics":["cli","openstack"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wtsi-hgi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-30T10:16:24.000Z","updated_at":"2023-02-14T02:23:39.000Z","dependencies_parsed_at":"2022-09-14T07:22:09.685Z","dependency_job_id":null,"html_url":"https://github.com/wtsi-hgi/openstack-info","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Fopenstack-info","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Fopenstack-info/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Fopenstack-info/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Fopenstack-info/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wtsi-hgi","download_url":"https://codeload.github.com/wtsi-hgi/openstack-info/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244890107,"owners_count":20527031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","openstack"],"created_at":"2024-11-28T09:17:30.937Z","updated_at":"2025-03-22T00:43:36.490Z","avatar_url":"https://github.com/wtsi-hgi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/wtsi-hgi/openstack-info.svg?branch=master)](https://travis-ci.org/wtsi-hgi/openstack-info)\n[![codecov](https://codecov.io/gh/wtsi-hgi/openstack-info/branch/master/graph/badge.svg)](https://codecov.io/gh/wtsi-hgi/openstack-info)\n\n# OpenStack Info\n_Gets information about what is in an OpenStack tenant._\n\n\n## Installation\nPrerequisites:\n- python \u003e= 3.6\n\nThe tool can be installed from PyPi:\n```bash\npip install openstackinfo\n```\n\nBleeding edge versions can be installed directly from GitHub:\n```bash\ngit clone https://github.com/wtsi-hgi/openstack-info.git\ncd openstack-tenant-cleaner\npython setup.py install\n```\nor using pip:\n```bash\npip install git+https://github.com/wtsi-hgi/openstack-info.git@master#egg=openstackinfo\n```\n\n\n## Usage\n### CLI\nSet environment variables:\n```bash\nexport OS_USERNAME=user\nexport OS_TENANT_NAME=tenant\nexport OS_AUTH_URL=http://example.com:5000/v2.0/\nexport OS_PASSWORD=password\n```\n\nThen call:\n```bash\nopenstackinfo\n```\n\nThe available options can be found with `openstackinfo -h`:\n```\nusage: openstackinfo [-h] [-i {type,id}] [--max-connections MAX_CONNECTIONS]\n                     [--retries RETRIES] [--retry-wait RETRY_WAIT]\n                     [--retry-wait-multiplier RETRY_WAIT_MULTIPLIER]\n\nOpenstack tenant information retriever\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -i {type,id}, --index {type,id}\n                        What the OpenStack information should be index by\n                        (default: type)\n  --max-connections MAX_CONNECTIONS\n                        Maximum number of simultaneous connections to make to\n                        OpenStack. Configured automatically if not set\n                        (default: None)\n  --retries RETRIES     Number of times to retry getting information about a\n                        particular tpye of OpenStack resource (default: 3)\n  --retry-wait RETRY_WAIT\n                        Initial amount of time (in seconds) to wait after a\n                        failure before retrying (default: 1.0)\n  --retry-wait-multiplier RETRY_WAIT_MULTIPLIER\n                        Multiplier that is applied to the wait time after each\n                        failure. e.g. An initial wait time of 1.0s, a wait\n                        multiplier of 5.0, and a maximum of 3 retries will\n                        result in the waits between retries of [1.0s, 5.0s,\n                        25.0s] (default: 5.0)\n  --retry-wait-deviation RETRY_WAIT_DEVIATION\n                        To minimise collisions, the wait time before retrying\n                        a request is randomised to plus or minus the value of\n                        this parameter as a percentage of the total wait time.\n                        e.g. A wait time of 1.0s and max deviation percentage\n                        of 10.0 will result in an actual wait between 0.9s and\n                        1.1s (default: 10.0)\n```\n\n### Python\n```python\nfrom openstackinfo.retriever.models import Credentials\nfrom openstackinfo.retriever.retrievers import ShadeInformationRetriever\nfrom openstackinfo.helpers import get_information, RunConfiguration\nfrom openstackinfo.indexers import InformationIndexerByType\n\nretriever = ShadeInformationRetriever(credentials=Credentials(username, password, auth_url, tenant))\nconfiguration = RunConfiguration(retriever=retriever, indexer=InformationIndexerByType)\nopenstack_info = get_information(configuration)\n```\n\n\n## Alternatives\n- [shade](https://pypi.python.org/pypi/shade/) (underlying library: no CLI, no re-indexing).\n- [Nova CLI](https://docs.openstack.org/python-novaclient/latest/cli/nova.html) (does not return JSON).\n- [Openstack CLI](https://docs.openstack.org/python-openstackclient/latest/cli/) (does not return server metadata).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwtsi-hgi%2Fopenstack-info","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwtsi-hgi%2Fopenstack-info","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwtsi-hgi%2Fopenstack-info/lists"}