Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miyabisun/conoha-cli
https://github.com/miyabisun/conoha-cli
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/miyabisun/conoha-cli
- Owner: miyabisun
- License: mit
- Created: 2017-10-28T13:16:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-23T12:08:36.000Z (over 6 years ago)
- Last Synced: 2024-07-31T21:52:55.246Z (4 months ago)
- Language: Go
- Size: 4.26 MB
- Stars: 15
- Watchers: 4
- Forks: 31
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ConoHa-cloud - github: ConoHa CLI @miyabisun
README
# Overview: 概要紹介
## これは何？
ConoHa で簡単な勉強用VPSを構築したい人向けのお手軽CLIです。
Go言語製で様々なOSに対応(予定)です。
このプラグインは非公式ですので、ConoHaのサポートなどへの問い合わせはご遠慮ください。
## なんで作ったの？
ConoHa CLI は既存プロジェクト [vagrant-conoha](https://github.com/hironobu-s/vagrant-conoha) のほぼ下位互換です。
従ってわざわざ使う必要はありません。
私もこのvagrant-conohaを愛用していましたが、色々と辛みが出てきた為に直接APIを叩こうと決意しました。
- [VagrantfileにAPIのログイン情報を載せる](https://qiita.com/hironobu_s/items/8422a427fd5571747196)ので一手間加えないとGitHub等へ上げられない
- [仕様変更で使えなくなった期間](https://twitter.com/hironobu_s/status/941213992252465152)があり超困った
- [スタートアップスクリプト](https://www.conoha.jp/guide/startupscript.php)のリリースでVagrantプロビジョンへの依存度が下がった
- 勉強用の開発環境は1ファイル1インスタンスで十分、[Dockerもドカドカ動かせる](https://www.conoha.jp/download/books/conoha-book-03-docker.pdf)からね
- そもそも依存元のVagrantがバギーでvagrant-conohaの人にゴルァするべきか判断つかない
vagrant-conohaのヘビーユーザーの内、幾人かは共感できたかと思います。
しかし、このConoHa CLIも私個人で管理しているので、ConoHaの仕様変更等であっさり使えなくなるかもしれません。
Vagrantを意識しながらシンプルな設計を心がけていき、フォークやプルリクを気軽に出来るように頑張ります。
## 日本語？マルチ言語対応は？
基本的には日本人しか使わないと思うのでガチガチな日本語にしました。
CLIも日本語で説明していくようにしたいです。
# Installation: インストール
バイナリファイルを[Releases](https://github.com/miyabisun/conoha-cli/releases)ページにて配布しています。
対応しているOSのアプリケーションをダウンロードした後、
手持ちの解凍ソフトでバイナリファイルを取り出し、
PATHの通ったディレクトリに設置してください。
# Usage
各種コマンドやサブコマンドにはヘルプが存在します。
困ったら`-h`オプションを付けて起動してください。
```Bash
$ conoha -h
This tool is a conoha cli.
Usage:
conoha [flags]
conoha [command]
Available Commands:
destroy VPSインスタンスの削除
help Help about any command
info APIからプランやイメージ一覧情報を取得
login ConoHa APIへのログイン
ssh VPSインスタンスへのSSH接続
ssh-config SSH接続情報の表示
status VPSインスタンスの状態を調べる
up VPSインスタンスの起動
version Print the version number of conoha-cli
Flags:
-h, --help help for conoha
Use "conoha [command] --help" for more information about a command.
```
## 全体的な流れ
1. ログインを行う
2. `spec.toml`を作成する
3. インスタンスを操作
4. SSH接続
### 1. ログインを行う
ConoHa APIは各種操作にトークンIDを要求します。
その有効期限は24時間しかありません。一度取得しても日を跨げば何度も取り直しになってしまいます。
ConoHa CLIでは`~/.config/conoha.toml`に設定ファイルを作成して、
ログイン情報やトークンIDを保存するという設計にしています。
初回の`~/.config/conoha.toml`作成にはログインコマンドを使用します。
コマンドライン引数で設定することも出来ますし、対話シェルで入力することも出来ます。
```Bash
$ conoha login -h
login to ConoHa API.
Usage:
conoha login [flags]
Flags:
-h, --help help for login
-p, --password string パスワード (9文字以上)
-t, --tenantid string テナントID (半角英数32文字)
-u, --username string ユーザー名 (gncu00000000)
# 足りない情報は対話シェルで聞かれます
$ conoha login
username: gncu00000000
password: Hogehoge-0
tenant_id: 1234567890abcdef1234567890abcdef
login successful.
```
### 2. `spec.toml`を作成する
[examples/vps-instance/spec.toml](examples/vps-instance/spec.toml)にサンプルを用意しました。
```TOML
name = "test_machine"
image = "vmi-docker-17.06-ubuntu-16.04-unified"
flavor = "g-1gb"
sshkey = "conoha-ssh-key-name"
```
- name: サーバーリストのネームタグで表示、ConoHa CLIでは一意な名称として扱う
- image: イメージ名
- flavor: プラン名
- sshkey: ConoHaに登録済のSSH Key名
イメージ名、プラン名の候補は下記のコマンドで表示することができます。
```Bash
$ conoha info -h
get Infomation from ConoHa API (require logged in).
Usage:
conoha info [flags]
conoha info [command]
Available Commands:
flavors get flavors ConoHa API.
images get images ConoHa API.
ssh get registed ssh keypair-name ConoHa API.
Flags:
-h, --help help for info
Use "conoha info [command] --help" for more information about a command.
$ conoha info images
vmi-drupal-8.4.2-centos-7.4-amd64-20gb
vmi-drupal-8.4.2-centos-7.4-amd64
vmi-minecraft-1.12.2-centos-7.4
vmi-centos-7.4-amd64-20gb
vmi-centos-7.4-amd64
...(他にも大量に表示される)
$ conoha info flavors
g-2gb
g-16gb
g-4gb
g-1gb
g-8gb
g-32gb
g-64gb
g-512mb
```
### 3. インスタンスを操作
ConoHa CLIのインスタンス操作は Vagrant を意識してつくられています。
カレントディレクトリに`spec.toml`があるフォルダで各種コマンドを実行することでインスタンスの状態確認・作成・削除を行います。
```Bash
# インスタンスの状態確認
$ conoha status
NONE
# インスタンスの作成
$ conoha up
$ conoha status
ACTIVE
# インスタンスの削除
$ conoha destroy
$ conoha status
NONE
```
### 4. SSHログイン
SSH接続を行うためにはホストマシンの秘密鍵ファイルと、
ConoHaのSSH-Keyの紐付けを行わなければ通信は行えません。
id_rsa決め打ちやspec.tomlで共有する案もありましたが、
複数環境で使う事を考慮してホストマシンに対応したファイルパスを利用する思想としました。
```Bash
$ conoha ssh set -h
ConoHaに登録済みのSSH Keyと秘密鍵ファイルパスの紐付け
Usage:
conoha ssh set
conoha ssh set -h
Args:
name: ConoHaに登録済みのSSH Key名
path: 対応する秘密鍵のファイルパス (例: ~/.ssh/id_rsa)
Help:
- ConoHaに登録済みのSSH Key名の一覧を表示
$ conoha info ssh
$ conoha info ssh
ssh-key-name1
ssh-key-name2
$ conoha set ssh-key-name1 ~/.ssh/id_rsa
```
続いて実際のSSH接続には、以下のモードを用意しています。
- ssh-configで`.ssh/config`で使えるフォーマットを出力
- sshコマンドを利用したSSH接続
- moshコマンドを利用した接続 (bash専用)
- Go言語の crypt パッケージを利用したSSH接続
```Bash
$ conoha ssh-config
Host test_machine
HostName 150.95.141.xxx
User root
IdentityFile /Users/xxxx/.ssh/id_rsa
# SSH 接続
# まずsshコマンドを検索し外部コマンドで実行、無ければcryptパッケージを利用してエミュレート
$ conoha ssh
# Mobile Shell 接続 (bash専用)
$ conoha ssh -m
```
# license: ライセンス
MIT Licenseを適用します。