Skip to content

Commit 84d879c

Browse files
author
Matt Burke
committed
Creates better readme
1 parent 93e872e commit 84d879c

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# OpenStack-Client
2-
A lightweight container with the openstack's CLI client (python-openstackclient) installed
2+
3+
A lightweight container with the openstack's CLI client (python-openstackclient) installed.
4+
5+
This container is a python-buster base with python3-openstackclient installed. For specific use of the OpenStack cli please check out the documentation on the official repo:
6+
7+
https://github.com/openstack/python-openstackclient
8+
9+
# Usage
10+
11+
To use the OpenStack CLI you need to configure your environment settings first. This can be done either with environment variables in docker or by setting flags on individual OpenStack CLI commands.
12+
13+
More info on using the flags or environment variables can be found on the official repo:
14+
15+
https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html
16+
17+
```
18+
docker run \
19+
-e OS_AUTH_URL=<url-to-openstack-identity> \
20+
-e OS_IDENTITY_API_VERSION=3 \
21+
-e OS_PROJECT_NAME=<project-name> \
22+
-e OS_PROJECT_DOMAIN_NAME=<project-domain-name> \
23+
-e OS_USERNAME=<username> \
24+
-e OS_USER_DOMAIN_NAME=<user-domain-name> \
25+
-e OS_PASSWORD=<password> \
26+
openstacktools/openstack-client
27+
```
28+
29+
Note: If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely. The -it flag is required on your run statements to interactively provide the password.

0 commit comments

Comments
 (0)