python-openstackclient

python-openstackclient
Name	python-openstackclient
Developer	OpenStack Foundation
Released	2013
Programming language	Python
Operating system	Cross-platform
License	Apache License 2.0

python-openstackclient

python-openstackclient is a command-line interface (CLI) client for interacting with OpenStack OpenStack services, providing unified access to compute, networking, storage, and identity resources. It serves as the canonical user-facing tool for cloud operators and developers working with Nova, Neutron, Cinder, and Keystone across public and private clouds. Originating from collaborative development within the OpenStack community, it complements orchestration projects such as Heat and management tools like Horizon.

Overview

python-openstackclient functions as a client program implemented in Python that exposes commands to manage resources in Nova, Neutron, Cinder, Swift, and Glance. It is maintained under the governance of the OpenStack community, developed by contributors affiliated with corporations such as Red Hat, IBM, Canonical, HP Inc., and Mirantis. The project coordinates with related initiatives including OpenStack SDK, OSClient community, OpenStack-Ansible, and integrations for cloud platforms like Amazon Web Services, Google Cloud Platform, and Microsoft Azure through hybrid tooling.

Features and Architecture

python-openstackclient provides extensible command modules, consistent CLI semantics, and pluggable authentication against Keystone endpoints. Its architecture relies on core client libraries such as requests, stevedore, and the os-client-config family, interacting with service-specific SDKs like python-novaclient, python-neutronclient, and python-glanceclient. The design emphasizes backward compatibility with older releases and forward compatibility through a stable CLI interface, supporting plugin extension points used by vendors such as Red Hat, SUSE, and Canonical. Features include unified resource listing, JSON/YAML output via YAML libraries, shell completion, and role-based access controls coordinated with Keystone policies and RBAC frameworks.

Installation and Configuration

Installation typically uses pip within virtualenv environments or system packaging provided by distributions like Ubuntu, Debian, Fedora, and Red Hat Enterprise Linux. Configuration requires environment variables and configuration files for endpoints defined by Keystone and may integrate with distribution-specific packaging managed by Debian maintainers and RPM packagers at Red Hat. Authentication workflows often reference projects such as OpenID Connect, SAML 2.0, and enterprise identity providers including LDAP directories maintained by organizations like Oracle or Microsoft. For enterprise deployments, operators coordinate with OpenStack-Ansible, Kolla, and TripleO for consistent client configuration and lifecycle management.

Command-line Usage

Users invoke top-level commands that map to services like Compute, Networking, and Block Storage, with subcommands for operations on servers, networks, volumes, and images. Output formats can be switched to JSON or YAML for integration with automation tools such as Ansible, Terraform, and SaltStack; teams in enterprises like Canonical, Red Hat, and SUSE automate workflows using these integrations. The CLI supports filtered queries, paging, and machine-readable outputs to interoperate with CI/CD systems from vendors such as Jenkins, GitLab, GitHub, and Atlassian. Command completion and help text align with standards promoted by communities around PSF and tooling such as argparse and Click.

Development and Contribution

Development follows OpenStack governance, using gerrit and git for code review and contribution management, and continuous integration pipelines powered by Zuul and Jenkins. Contributors include engineers from Red Hat, Canonical, IBM, Mirantis, and independent developers collaborating in OpenStack Summit events and on mailing lists moderated by the OpenStack. The project uses coding guidelines consistent with PEP 8 and automated testing frameworks like pytest and mock libraries. Organizations often sponsor work through programs such as community grants and corporate open-source programs from Intel, Huawei, and Oracle.

Compatibility and Releases

Releases are coordinated with OpenStack release cycles such as Rocky, Stein, Train, and Victoria, with source distribution on PyPI and package builds for Debian and RHEL. Compatibility matrices reference supported Python versions and interoperable client libraries like python-novaclient and python-neutronclient, and vendors certify interoperability in conjunction with platforms such as OpenStack IaaS deployments by Rackspace. Security advisories are coordinated through the security channels and tracked across distributions and clouds maintained by organizations like SUSE and Canonical.

Category:OpenStack