packer-builder-sakuracloud

A builder plugin of packer for SakuraCloud

さくらのクラウド用Packerプラグイン

概要

packer-builder-sakuracloudはさくらのクラウドでのアーカイブ(構築済みOSのテンプレート)をPackerで作成するためのPackerプラグインです。

使い方(セットアップ)

packer-builder-sakuracloudを実行するには、さくらのクラウドAPIキーが必要です。

あらかじめコントロールパネルからAPIキーを発行しておいてください。

セットアップは以下のような方法があります。お好きな方をご利用ください。

ローカルマシンにインストール
Dockerを利用する
(macOS + Homebrew)homebrewでインストール

ローカルマシンへのインストール

リリースページから各プラットフォーム用のバイナリをダウンロードし、以下の何れかのディレクトリへ展開、実行権を付与してください。

1. packerコマンドが格納されているディレクトリ
1. Unix系OSの場合 ~/.packer.d/plugins , Windows系OSの場合%APPDATA%/packer.d/plugins

Dockerを利用する場合

Dockerを利用する場合、packer-builder-sakuracloudの事前のインストール作業は不要です。 DockerHubでイメージを公開していますので、以下のように実行できます。

docker run -it --rm sacloud/packer:latest [packerサブコマンド] [packerオプション]

APIキーを環境変数で指定する場合、-eオプションなどを適切に指定して実行してください。

# APIキーを環境変数で指定、カレントディレクトリのexample.jsonをテンプレートとして指定してビルドする例
$ docker run -it --rm \
         -e SAKURACLOUD_ACCESS_TOKEN \
         -e SAKURACLOUD_ACCESS_TOKEN_SECRET \
         -v $PWD:/work \
         sacloud/packer:latest build example.json

`homebrew`を利用する場合(macOSでHomebrewをご利用の場合)

以下のコマンドでインストール可能です。

brew tap sacloud/homebrew-packer-builder-sakuracloud; brew install packer-builder-sakuracloud

インストール後は画面に表示される指示にしたがってコマンドを実行し、~/.packer.d/plugins配下にシンボリックリンクを作成します。

使い方(アーカイブ作成)

APIキーの設定

APIキーを環境変数に設定しておきます。 (APIキーは以下で作成するjsonファイルに記載することも可能です)

$ export SAKURACLOUD_ACCESS_TOKEN=[APIトークン]
$ export SAKURACLOUD_ACCESS_TOKEN_SECRET=[APIシークレット]

アーカイブ定義ファイル(json)の作成

Packerでのビルド用に以下のようなjsonファイルを作成します。以下の例は、石狩第2ゾーン(is1b)に、CentOSパブリックアーカイブをベースとしたアーカイブを作成します。プロビジョニングとして、shellにてdockerのインストールを行なっています。

packer用jsonファイルの例

$ cat <<EOF > example.json
{
    "builders": [{
        "type": "sakuracloud",
        "zone": "is1b",
        "os_type": "centos",
        "password": "TestUserPassword01"
    }],
    "provisioners":[
    {
        "type": "shell",
        "inline": [
            "yum update -y",
            "curl -fsSL https://get.docker.com/ | sh",
            "systemctl enable docker.service"
        ]
    }]
}
EOF

作成したら以下のようにpacker buildを実行すると、さくらのクラウド上にアーカイブが作成されます。

$ packer build example.json

さくらのクラウド上のパブリックアーカイブだけでなく、ISOイメージからの構築も可能です。詳細はテンプレートのサンプルを参照してください。

オプション一覧

jsonファイルで指定できるオプションの一覧は以下の通りです。

必須項目

access_token(string): APIトークン。この値は環境変数SAKURACLOUD_ACCESS_TOKENで指定することも可能です。
access_token_secret(string): APIシークレット。この値は環境変数SAKURACLOUD_ACCESS_TOKEN_SECRETで指定することも可能です。
zone(string): 対象ゾーン。tk1a(東京)又はis1b(石狩第2)を指定
os_type(string): ベースとするアーカイブの種別。以下の値が指定可能です。

値	説明
`centos`	CentOS 7
`ubuntu`	Ubuntu 16.04
`debian`	Debian
`vyos`	VyOS
`coreos`	CoreOS
`rancheros`	RancherOS
`kusanagi`	Kusanagi(CentOS7)
`plesk`	Plesk(CentOS7)
`freebsd`	FreeBSD
`windows2012`	Windows 2012
`windows2012-rds`	Windows 2012(RDS)
`windows2012-rds-office`	Windows 2012(RDS + Office)
`windows2016`	Windows 2016
`windows2016-rds`	Windows 2016(RDS)
`windows2016-rds-office`	Windows 2016(RDS + Office)
`windows2016-sql-web`	Windows 2016 SQLServer(Web)
`windows2016-sql-standard`	Windows 2016 SQLServer(Standard)
`windows2016-sql-standard-all`	Windows 2016 SQLServer(RDS+Office)
`custom`	任意のアーカイブID/ディスクIDを指定する場合
`iso`	さくらのクラウド上のISOイメージ、またはURLを指定してISOイメージをダウンロードする場合

os_typeがcustomの場合、source_archive 又は source_diskの何れかの指定が必須です。

os_typeがisoの場合、iso_id、または以下のISOイメージ関連の値の指定が必須です。

iso_urlまたはiso_urls : ISOイメージのURL
iso_checksum/iso_checksum_url: ISOイメージのチェックサム、またはチェックサムを記載したファイルのURL
iso_checksum_type: チェックサムの形式(none, md5, sha1, sha256, or sha512のいずれか)

isoの場合の詳細はISOイメージ関連項目の指定についてを参照ください。

オプション項目

user_name(string): SSH/WinRM接続時のユーザー名

os_typeにWindows系を指定した場合のデフォルト値:Administrator

os_typeがWindows系以外の場合のデフォルト値:root

password(string): SSH/WinRM接続時のパスワード
us_keyboard(bool): ISOイメージからのインストール時、コマンド送信にUSキーボードレイアウトを利用するか、デフォルト値:false
disk_size(int): 作成するディスクのサイズ(GB単位)、デフォルト値:20
disk_connection(string): ディスク接続方法、以下の値が指定可能です。デフォルト値:virtio
- ide: IDE接続
- virtio: 準仮想モード(virtio)
disk_plan(string): ディスクプラン、以下の値が指定可能です。デフォルト値:ssd
- ssd: SSDプラン
- hdd: 通常プラン(ハードディスク)
core(int): CPUコア数。デフォルト値:1
memory_size(int): メモリサイズ(GB単位)、デフォルト値:1
disable_virtio_net(bool): trueの場合、NICでの仮想化ドライバ利用を無効化します。デフォルト値:false
source_archive(int64): 元となるアーカイブのID、os_typeがwindows、又はcustomの場合に指定可能です。
source_disk(int64): 元となるディスクのID、os_typeがcustomの場合のみ指定可能です。
iso_size(int): アップロードするISOファイルのサイズ、5または10が指定可能(GB単位)、デフォルト値: 5
iso_name(string): アップロードするISOファイルの名前、デフォルト値: iso_checksumが空でない場合はiso_checksum、以外はタイムスタンプから自動生成
archive_name(string): 作成されるアーカイブの名前
archive_tags([]string): 作成されるアーカイブに付与するタグ、デフォルト値:なし(空の場合、かつ祖先にパブリックアーカイブが存在する場合は祖先となったパブリックアーカイブからタグを引き継ぐ)
archive_description(string): 作成されるアーカイブに付与する説明
boot_wait(duration): 仮想マシンのプロビジョニング開始までの起動からの待ち時間。10s、1mのように指定する。デフォルト値:0s
boot_command([]string): 仮想マシン作成後にVNC経由で仮想マシンに送信するキーボード入力。デフォルト値:なし

boot_commandはPackerのVMWare Builder(from ISO)やQemu Builderと互換性があります。

api_client_timeout(duration): ディスクのコピーやアーカイブ作成待ちなどの、さくらのクラウドAPI呼び出しで利用するタイムアウト時間。10s、1mのように指定する。デフォルト値:20m

ISOイメージ関連項目の指定について

ISOイメージからの構築を行う場合、以下の項目を指定してください。

さくらのクラウド上のISOイメージを利用する場合

os_typeにisoを指定
iso_idに利用したいISOイメージのIDを指定

例:

        "os_type": "iso",
        "iso_id": 123456789012,

ISOイメージをダウンロードして利用する場合

ダウンロード元のURLなどを以下のように指定します。 PackerがISOイメージのダウンロードを行い、さくらのクラウド上へアップロードを行います。

os_typeにisoを指定
iso_urlまたはiso_urls にISOイメージのURLを指定
iso_checksum/iso_checksum_url: ISOイメージのチェックサム、またはチェックサムを記載したファイルのURLを指定
iso_checksum_type: チェックサムの形式(none, md5, sha1, sha256, or sha512のいずれか)を指定

例:

        "os_type": "iso",
        "iso_url": "http://ftp.tsukuba.wide.ad.jp/software/vyos/iso/release/1.1.7/vyos-1.1.7-amd64.iso",
        "iso_checksum": "c40a889469e0eea43d92c73149f1058e3650863b",
        "iso_checksum_type": "sha1",

boot_commandについて

boot_commandには通常の文字に加え、以下の特殊キーが指定可能です。

<bs> - バックスペース
<del> - デリート
<enter> <return> - エンター(リターン)キー
<esc> - エスケープ
<tab> - タブ
<f1> - <f12> - ファンクションキー(F1〜F12)
<up> <down> <left> <right> - 矢印キー
<spacebar> - スペース
<insert> - インサート
<home> <end> - ホーム、エンド
<pageUp> <pageDown> - ページアップ、ページダウン
<leftAlt> <rightAlt> - 左右それぞれのオルト
<leftCtrl> <rightCtrl> - 左右それぞれのコントロール
<leftShift> <rightShift> - 左右それぞれのシフト
<leftAltOn> <rightAltOn> - オルトを押下している状態にする
<leftCtrlOn> <rightCtrlOn> - コントロールを押下している状態にする
<leftShiftOn> <rightShiftOn> - シフトを押下している状態にする
<leftAltOff> <rightAltOff> - オルトを押下解除する
<leftCtrlOff> <rightCtrlOff> - コントロールを押下解除する
<leftShiftOff> <rightShiftOff> - シフトを押下解除する
<wait> <wait5> <wait10> - 指定秒数待機
<waitXX> - 指定時間待機する。待機数量 + 単位で指定する。例: <wait10s> <wait1m>

使用例

この例は以下ののキー入力を行うものです。

1. Ctrl+Alt+Delを送信
1. 10秒待機
1. パスワード文字列("put-your-password") + Enterキーを送信

"boot_command": [
    "<leftAltOn><leftCtrlOn><del><leftAltOff><leftCtrlOff>",
    "<wait10>",
    "put-your-password<enter>"
]

その他の利用例や詳細は以下のテンプレートサンプルを参照してください。

テンプレートサンプル

以下のサンプルを用意しています。

パブリックアーカイブからの構築サンプル

[CentOS]: CentOSパブリックアーカイブからの構築
[CoreOS]: CoreOSパブリックアーカイブからの構築
[Ubuntu]: Ubuntuパブリックアーカイブからの構築
[VyOS]: VyOSパブリックアーカイブからboot_commandでSSHを有効にする構成

VyOSパブリックアーカイブからサーバーを作成した場合、デフォルトの状態ではSSH接続ができないため、boot_commandにてSSHを有効化しています。
[Windows]: Windows Server 2012パブリックアーカイブから、boot_commandでWinRMを有効にする構成
[Windows2016]: Windows Server 2016パブリックアーカイブから、boot_commandでWinRMを有効にする構成

Windowsパブリックアーカイブから構築したサーバーに対し、boot_commandにて初回ログイン〜WinRMの有効化までを行います。

WinRMの有効化にはAnsibleが公開しているPowerShellスクリプトを用いています。

WinRMでの接続後にPowerShellでのプロビジョニングを行います。

ISOイメージからの構築サンプル

[CentOS Atomic Host] : CentOS Atomic Host ISOイメージのダウンロード〜最小構成での構築
[CentOS]: さくらのクラウド上のCentOS ISOイメージからの構築(ISOイメージをダウンロードするサンプルもあります)
[Scientific Linux]: さくらのクラウド上のScienfitic Linux ISOイメージからの構築
[Ubuntu]: さくらのクラウド上のUbuntu ISOイメージからの構築
[VyOS]: VyOSISOイメージのダウンロード〜構築(参考元:https://github.com/higebu/packer-templates)

License

This project is published under MPL-2.0.

Author

Kazumichi Yamamoto (@yamamoto-febc)

Name		Name	Last commit message	Last commit date
Latest commit History 54 Commits
examples		examples
sakuracloud		sakuracloud
scripts		scripts
vendor		vendor
.gitignore		.gitignore
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
docker-compose.yml		docker-compose.yml
main.go		main.go

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

packer-builder-sakuracloud

概要

使い方(セットアップ)

ローカルマシンへのインストール

Dockerを利用する場合

`homebrew`を利用する場合(macOSでHomebrewをご利用の場合)

使い方(アーカイブ作成)

APIキーの設定

アーカイブ定義ファイル(json)の作成

packer用jsonファイルの例

オプション一覧

必須項目

オプション項目

ISOイメージ関連項目の指定について

さくらのクラウド上のISOイメージを利用する場合

ISOイメージをダウンロードして利用する場合

boot_commandについて

使用例

テンプレートサンプル

パブリックアーカイブからの構築サンプル

ISOイメージからの構築サンプル

License

Author

About

Releases

Packages

Languages

License

yamamoto-febc/packer-plugin-sakuracloud

Folders and files

Latest commit

History

Repository files navigation

packer-builder-sakuracloud

概要

使い方(セットアップ)

ローカルマシンへのインストール

Dockerを利用する場合

homebrewを利用する場合(macOSでHomebrewをご利用の場合)

使い方(アーカイブ作成)

APIキーの設定

アーカイブ定義ファイル(json)の作成

packer用jsonファイルの例

オプション一覧

必須項目

オプション項目

ISOイメージ関連項目の指定について

さくらのクラウド上のISOイメージを利用する場合

ISOイメージをダウンロードして利用する場合

boot_commandについて

使用例

テンプレートサンプル

パブリックアーカイブからの構築サンプル

ISOイメージからの構築サンプル

License

Author

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

`homebrew`を利用する場合(macOSでHomebrewをご利用の場合)

Packages