1.1. ECL CLI のインストール

1.1.1. 前提ソフトウェアのインストール

ECL CLI は OpenStack Client を基に作成されているため、前提となるソフトウェアは OpenStack Client に準拠します。 以下の表は、 ECL CLI をインストールするために必要なソフトウェアとその説明の一覧です。

前提ソフトウェア 説明
Python 2.7.x もしくは Python 3.7 以降
Python 2.7.9 以降をインストールいただくと、下記の setuptools および pip は自動でインストールされます。
setuptools パッケージ
Linux ディストリビューションの多くは、setuptools を簡単にインストールするためのパッケージを提供しています。
お使いのパッケージマネージャーで setuptools を検索してインストレーションパッケージを見つけてください。
見つからない場合は、こちら から直接 setuptools パッケージをダウンロードしてください。
Mac OS X には標準でインストールされています。
Microsoft Windows に setuptools をインストールする場合、こちら にあるドキュメントを参照ください。
pip パッケージ
Linux、 Mac OS X、 Microsoft Windows システムに ECL CLI をインストールする場合、 pip を使用します。
pip により、 Python パッケージを簡単に追加、更新、削除することが可能です。
インストール中にソースファイルをコンパイルするため、お使いのオペレーティングシステム環境に応じた、関連する Python 開発パッケージが必要になります。
お使いのシステムのパッケージマネージャーから pip をインストールします。

Mac OS X
# easy_install pip

Ubuntu or Debian
# apt-get install python-dev python-pip

Red Hat Enterprise Linux or CentOS or Fedora
# yum install python-devel python-pip

Microsoft Windows
Python2.7 の場合は C:\Python27\Scripts ディレクトリーが、Python3.7 の場合は C:\Python37\Scripts ディレクトリーが、環境変数 PATH に定義されていることを確認し、setuptools パッケージの easy_install コマンドを使用します。
C:\>easy_install pip

1.1.2. ECL CLI のインストール

前提ソフトウェアがインストールされている場合、以下の各コマンドにより ECL CLI をインストールすることができます。

$ pip install eclcli

注釈

Windows で Python 2.7 をご利用の場合、インストール時に以下のようなエラーが発生する場合があります。 その場合、エラーの指示に従って Microsoft Visual C++ Compiler for Python 2.7 をインストール後、再試行してください。

error: Microsoft Visual C++ 9.0 is required. Get it from http://aka.ms/vcpython27

1.1.3. 環境変数の設定

インストールした ECL CLI を用いて各サービスをコマンドラインから操作する場合、ユーザ名やパスワード等の認証情報を環境変数に設定する必要があります。 コマンドのオプションで認証情報を指定することもできますが、環境変数とその設定値を記述した環境ファイルを作成する方法が簡単です。 環境変数の設定手順は以下の通りです。

1. clouds.yaml という名前のファイルを ~/.config/ecl に配置してください。 <テナント ID> <API 鍵> <API 秘密鍵> <リージョン> については、こちら のページを参考に取得してください。 OS_AUTH_URL はトークンを取得するための認証用 URL になります。

clouds.yaml の作成 ( Linux / Unix の場合 )
$ mkdir -p ~/.config/ecl/
$ touch ~/.config/ecl/clouds.yaml
clouds.yaml の内容 ( Linux / Unix の場合 )
clouds:
  jp1: # この部分はどのような文字列でもかまいません。下記設定を用いる場合 --os-cloud jp1 と指定します。
    auth:
      auth_url: https://keystone-<リージョン>-ecl.api.ntt.com/v3/
      tenant_id: <テナント ID>
      username: <API 鍵>
      password: <API 秘密鍵>
    project_domain_id: default
    user_domain_id: default
  jp2: # 下記設定を用いる場合 --os-cloud jp2 と指定します。
    auth:
      auth_url: https://keystone-<リージョン>-ecl.api.ntt.com/v3/
      tenant_id: <テナント ID>
      username: <API 鍵>
      password: <API 秘密鍵>
    project_domain_id: default
    user_domain_id: default
  us1:
    ...

2. ecl コマンド実行時に –os-cloud オプションを指定してください。 上記のような clouds.yaml を作成した場合、

コマンドの実行 ( Linux / Unix の場合 )
ecl --os-cloud jp1

のように --os-cloud を指定することで、yaml に記載されているテナントに対してコマンドを実行します。

また、以下の手順でもユーザ名やパスワード等の認証情報を環境変数に設定できます。

1. テキストエディタで以下の様な環境設定用ファイルを作成してください。 <テナント ID> <API 鍵> <API 秘密鍵> <リージョン> については、こちら のページを参考に取得してください。 OS_AUTH_URL はトークンを取得するための認証用 URL になります。

eclrc.sh ( Linux / Unix の場合 )
export OS_TENANT_ID=<テナント ID>
export OS_USERNAME=<API 鍵>
export OS_PASSWORD=<API 秘密鍵>
export OS_AUTH_URL=https://keystone-<リージョン>-ecl.api.ntt.com/v3/
export OS_USER_DOMAIN_ID=default
export OS_PROJECT_DOMAIN_ID=default
eclrc.bat ( Windows の場合 )
@echo off
setx OS_TENANT_ID <テナント ID>
setx OS_USERNAME <API 鍵>
setx OS_PASSWORD <API 秘密鍵>
setx OS_AUTH_URL https://keystone-<リージョン>-ecl.api.ntt.com/v3/
setx OS_USER_DOMAIN_ID default
setx OS_PROJECT_DOMAIN_ID default
  1. 作成した環境ファイルをコマンドラインで読み込んでください。
環境変数の設定 ( Linux / Unix の場合 )
$ source eclrc.sh
環境変数の設定 ( Windows の場合 )
> eclrc.bat

注釈

Windows の場合は、コマンドプロンプトを立ち上げ直すことで環境変数が反映されます。