Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sacloud/packer-plugin-sakuracloud
:package:A builder plugin of packer for SakuraCloud:cherry_blossom:
https://github.com/sacloud/packer-plugin-sakuracloud
packer sakuracloud sakuracloud-packer
Last synced: about 2 months ago
JSON representation
:package:A builder plugin of packer for SakuraCloud:cherry_blossom:
- Host: GitHub
- URL: https://github.com/sacloud/packer-plugin-sakuracloud
- Owner: sacloud
- License: mpl-2.0
- Created: 2016-10-02T12:31:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T00:44:58.000Z (7 months ago)
- Last Synced: 2024-06-19T01:59:14.593Z (7 months ago)
- Topics: packer, sakuracloud, sakuracloud-packer
- Language: Go
- Homepage:
- Size: 9.88 MB
- Stars: 16
- Watchers: 3
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
packer-plugin-sakuracloud
===
[](https://discord.gg/yUEDN8hbMf)
[](LICENSE)
[](https://github.com/sacloud/packer-plugin-sakuracloud/releases/latest)
A plugin of packer for SAKURA Cloud / さくらのクラウド用Packerプラグイン
## 概要
`packer-plugin-sakuracloud`は[さくらのクラウド](http://cloud.sakura.ad.jp)での
アーカイブ(構築済みOSのテンプレート)を[Packer](https://packer.io)で作成するためのPackerプラグインです。
## 必要なもの
- `packer` v1.7+
- さくらのクラウド APIキー
> :warning: `packer-plugin-sakuracloud` v0.7以降では`packer` v1.7以降が必要となります。
> 1.7以前の`packer`を利用したい場合はv0.7より古いバージョンをご利用ください。
## 実行方法
以下の何かの方法でプラグインをインストールして`packer`コマンドを実行します。
- `packer init`を利用(HCLテンプレートのみ)
- プラグインの手動インストール
### `packer init`を利用
HCLテンプレートでのみ利用可能です。
テンプレートに以下のような`required_plugin`ブロックを記載し`packer init`でプラグインをインストールします。
```hcl
packer {
required_plugins {
sakuracloud = {
version = ">= 0.7.0"
source = "github.com/sacloud/sakuracloud"
}
}
}
```
### プラグインの手動インストール
[リリースページ](https://github.com/sacloud/packer-plugin-sakuracloud/releases/latest)から各プラットフォーム用のバイナリをダウンロードし、
以下のドキュメントに記載されている所定のディレクトリに配置します。
https://www.packer.io/docs/plugins
## Dockerでの実行
Dockerで実行する場合、以下のように実行します。
docker run -it --rm ghcr.io/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 \
-w /work \
ghcr.io/sacloud/packer:latest build example.pkr.hcl
> :bulb: `ghcr.io/sacloud/packer`にはプラグインが手動インストール済みです。このため`packer init`は不要です。
### `homebrew`を利用する場合(macOSでHomebrewをご利用の場合)
v0.7以降`homebrew`はサポートされなくなりました。
`packer init`、またはプラグインの手動インストールにてご利用ください。
## 使い方(アーカイブ作成)
#### APIキーの設定
APIキーを環境変数に設定しておきます。
(APIキーは以下で作成するjsonファイルに記載する方法もあります)
$ export SAKURACLOUD_ACCESS_TOKEN=[APIトークン]
$ export SAKURACLOUD_ACCESS_TOKEN_SECRET=[APIシークレット]
#### テンプレートファイルの作成(HCL)
Packer 1.5以降で利用できるHCLテンプレートに対応しています。
> :bulb: JSONテンプレートを利用したい場合は次節`テンプレートファイルの作成(JSON)`を参照してください。
以下の様なファイルを作成し拡張子を`.pkr.hcl`とすることで`packer build`が実行できます。
```hcl
# Dockerから利用、またはプラグインの手動インストールを行う場合は以下のブロックをコメントアウトしてください。
packer {
required_plugins {
sakuracloud = {
version = ">= 0.7.0"
source = "github.com/sacloud/sakuracloud"
}
}
}
source "sakuracloud" "example" {
zone = "is1b" # アーカイブを作成する対象ゾーン
zones = ["is1a", "is1b", "tk1a", "tk1v"] # 作成したアーカイブを転送する宛先ゾーン
os_type = "centos7"
password = "TestUserPassword01"
disk_size = 20
disk_plan = "ssd"
core = 2
memory_size = 4
archive_name = "packer-example-centos"
archive_description = "description of archive"
}
build {
sources = [
"source.sakuracloud.example"
]
provisioner "shell" {
inline = [
"yum update -y",
"curl -fsSL https://get.docker.com/ | sh",
"systemctl enable docker.service",
]
}
}
```
#### テンプレートファイルの作成(JSON)
以下の例は石狩第2ゾーン(`is1b`)に、CentOSパブリックアーカイブをベースとしたアーカイブを作成します。
プロビジョニングとして、`shell`にてdockerのインストールを行なっています。
#### packer用jsonファイルの例
```sh
$ cat < example.json
{
"builders": [{
"type": "sakuracloud",
"zone": "is1b",
"os_type": "centos7",
"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): 対象ゾーン。以下の値が指定可能です。
- `is1a`: 石狩第1ゾーン
- `is1b`: 石狩第2ゾーン
- `tk1a`: 東京第1ゾーン
- `tk1b`: 東京第2ゾーン
- `os_type`(string): ベースとするアーカイブの種別。以下の値が指定可能です
| 値 | 説明 |
|---------------|-------------------------------------------------------|
| `centos` | CentOS(最新安定板) |
| `centos7` | CentOS 7 |
| `almalinux` | Alma Linux(最新安定板) |
| `almalinux9` | Alma Linux 9 |
| `almalinux8` | Alma Linux 8 |
| `rockylinux` | Rocky Linux(最新安定板) |
| `rockylinux9` | Rocky Linux 9 |
| `rockylinux8` | Rocky Linux 8 |
| `miracle` | MIRACLE LINUX(最新安定板) |
| `miracle8` | MIRACLE LINUX 8 |
| `ubuntu` | Ubuntu(最新安定板) |
| `ubuntu2204` | Ubuntu 22.04 |
| `ubuntu2004` | Ubuntu 20.04 |
| `ubuntu1804` | Ubuntu 18.04 |
| `debian` | Debian(最新安定板) |
| `debian11` | Debian11 |
| `debian10` | Debian10 |
| `kusanagi` | Kusanagi(CentOS7) |
| `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イメージ関連項目の指定について](#isoイメージ関連項目の指定について)を参照ください。
### オプション項目
- `zones`: 作成したアーカイブを転送する宛先ゾーン名のリスト。以下のいずれかの値を指定(複数指定可)
- `is1a`: 石狩第1ゾーン
- `is1b`: 石狩第2ゾーン
- `tk1a`: 東京第1ゾーン
- `tk1b`: 東京第2ゾーン
- `tk1v`: サンドボックス
- `user_name`(string): SSH/WinRM接続時のユーザー名
- `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`が`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)](https://www.packer.io/docs/builders/vmware-iso.html)や[Qemu Builder](https://www.packer.io/docs/builders/qemu.html)と
互換性があります。
- `api_client_timeout`(duration): ディスクのコピーやアーカイブ作成待ちなどの、さくらのクラウドAPI呼び出しで利用するタイムアウト時間。`10s`、`1m`のように指定する。デフォルト値:`20m`
- SSH関連オプション: SSHキー関連の挙動を指定します。
- `disable_generate_public_key`: trueの場合、秘密鍵に対応する公開鍵の生成/さくらのクラウドAPIを通じての公開鍵アップロードを行いません
- `ssh_private_key_file`: 秘密鍵ファイルのパス
Note: `ssh_private_key_file`が未指定の場合、`packer build`実行時に秘密鍵/公開鍵が生成されます。
`ssh_private_key_file`を指定した場合、指定された秘密鍵から公開鍵を生成します。
生成されたSSH公開鍵は作成するサーバが[ディスクの修正 API](https://manual.sakura.ad.jp/cloud/storage/modifydisk/about.html)に対応している場合はディスクの修正APIを通じてサーバに登録されます。
この挙動は`disable_generate_public_key`オプションで制御可能です。
### ISOイメージ関連項目の指定について
ISOイメージから構築する場合、以下の項目を指定してください。
#### さくらのクラウド上のISOイメージを利用する場合
- `os_type`に`iso`を指定
- `iso_id`に利用したいISOイメージのIDを指定
例:
```json
"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`のいずれか)を指定
例:
```json
"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`には通常の文字に加え、以下の特殊キーが指定可能です。
- `` - バックスペース
- `` - デリート
- `` `` - エンター(リターン)キー
- `` - エスケープ
- `` - タブ
- `` - `` - ファンクションキー(F1〜F12)
- `` `` `` `` - 矢印キー
- `` - スペース
- `` - インサート
- `` `` - ホーム、エンド
- `` `` - ページアップ、ページダウン
- `` `` - 左右それぞれのオルト
- `` `` - 左右それぞれのコントロール
- `` `` - 左右それぞれのシフト
- `` `` - オルトを押下している状態にする
- `` `` - コントロールを押下している状態にする
- `` `` - シフトを押下している状態にする
- `` `` - オルトを押下解除する
- `` `` - コントロールを押下解除する
- `` `` - シフトを押下解除する
- `` `` `` - 指定秒数待機
- `` - 指定時間待機する。待機数量 + 単位で指定する。例: `` ``
#### 使用例
この例は以下のキーを入力します。
- 1) Ctrl+Alt+Delを送信
- 2) 10秒待機
- 3) パスワード文字列("put-your-password") + Enterキーを送信
```json
"boot_command": [
"",
"",
"put-your-password"
]
```
####
その他の利用例や詳細は以下のテンプレートサンプルを参照してください。
## テンプレートサンプル
以下のサンプルを用意しています。
### パブリックアーカイブからの構築サンプル
- [[CentOS]](examples/centos): CentOSパブリックアーカイブからの構築
- [[Ubuntu]](examples/ubuntu): Ubuntuパブリックアーカイブからの構築
### ISOイメージからの構築サンプル
- [[CentOS]](examples/centos_iso): さくらのクラウド上のCentOS ISOイメージからの構築(ISOイメージをダウンロードするサンプルもあります)
- [[Scientific Linux]](examples/scientific_linux): さくらのクラウド上のScienfitic Linux ISOイメージからの構築
- [[Ubuntu]](examples/ubuntu_iso): さくらのクラウド上のUbuntu ISOイメージからの構築
## License
`packer-plugin-sakuracloud` Copyright (C) 2016-2023 [The packer-plugin-sakuracloud Authors](AUTHORS).
This project is published under [MPL-2.0](LICENSE).