https://github.com/nttcom/eclcli
Enterprise Cloud CLI
https://github.com/nttcom/eclcli
Last synced: about 2 months ago
JSON representation
Enterprise Cloud CLI
- Host: GitHub
- URL: https://github.com/nttcom/eclcli
- Owner: nttcom
- License: apache-2.0
- Created: 2016-08-31T03:57:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-08-28T07:45:27.000Z (7 months ago)
- Last Synced: 2025-11-27T17:54:46.377Z (4 months ago)
- Language: Python
- Size: 837 KB
- Stars: 22
- Watchers: 16
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Enterprise Cloud CLI
======================
Enterprise Cloud CLI (a.k.a eclcli) is an `OpenStackClient `_ based command-line client for NTT DOCOMO BUSINESS' Enterprise Cloud 2.0 that brings the command set for Baremetal, Compute, SSS, Image, Network, Block Storage and various other APIs together in a single shell with a uniform command structure.
The primary goal is to provide a unified user experience for various services provide in ECL2.0 through a uniform command structure.
Getting Started
------------------
Enterprise Cloud CLI can be installed from PyPI using pip.
.. code-block:: bash
$ pip install eclcli
Yet it is strongly advised to use `virtualenv `_ to avoid conflicts with system packages, in short:
.. code-block:: bash
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install --upgrade eclcli
For experienced users we suggest using `pyenv `_ with pyenv-virtualenv plugin:
Configuration
--------------
Before you are able to use CLI you must configure it.
The CLI is configured via command-line, environment variables and `~/.config/ecl/clouds.yaml` file.
Authentication using username/password is most commonly used.
.. code-block:: bash
$ export OS_USERNAME=
$ export OS_PASSWORD=
$ export OS_TENANT_ID=
$ export OS_AUTH_URL=
$ export OS_PROJECT_DOMAIN_ID=default
$ export OS_USER_DOMAIN_ID=default
In certain cases it may be more convenient to use file based configuration using file `~/.config/ecl/clouds.yaml`.
For more information see `ECL tutorial page `_.
Notice, though, that you may need to use `--os-cloud` option parameter to specify which credentials to use from the file.
Listing command references
--------------------------
There are a few variants on getting help.
A list of global options are supported with ``--help``.
.. code-block:: bash
$ ecl --help
There is also a ``help`` command that can be used to get help text for a specific command.
.. code-block:: bash
$ ecl help baremetal server create
Usage
--------
.. code-block:: bash
$ ecl command list
# Returns all available commands
$ ecl baremetal server list
# Returns list of baremetal servers
$ ecl help baremetal
# Returns help for any command
Documentation
----------------
Please find more usage documentation on `official site `_.
Support
-----------
ECL2.0 users can raise requests via NTT DOCOMO BUSINESS' ticket portal.
Contributing
-------------
Please contribute using `Github Flow `_ Create a branch, add commits, and `open a pull request `_.
License
-----------
* Apache 2.0