What is resource manager?

[更新日:2019年7月18日]

Overview

リソースマネージャーは、テンプレートを記述することでさくらのクラウド上のリソースを一括して作成・更新・削除できる機能です。本機能は HashiCorp が提供する Terraform の構成情報と一部に互換性があり、既存の構成情報の活用や学習コストを最小限に利用することが可能です。

利点

よく利用するインフラ構成など、繰り返し行う操作をテンプレートに記述して自動化することができます。例えば、グループやプロジェクトでクラウド上にシステムを構築する場合、チームやグループ内で定型的な初期構成パターン(フロント用のサーバが○台、バックエンド用のサーバが○台、これらをローカルネットワークで接続しVPC ルータの下で構築…など)をテンプレート化することで、

  • 作業ミスなく迅速に構築できる
  • 何度でも再利用できる
  • Changes in information of resource can be managed through template changes instead of reports and manuals.
  • 不要なリソースが作成されてしまうことが無く、より効率的にリソースを管理できる

といったメリットがあります。

Note

テンプレート化の例については 構成例 を参照ください。

Differences between Terraform and Terraform Enterprise

リソースマネージャーのシステム内部では、Terraform(オープンソース版)およびTerraform for さくらのクラウド・プロバイダを使用しています。さくらのクラウドはTerraformを用いて操作できますが、コマンドライン・ツールのダウンロードや環境変数の設定など、コマンドライン操作の習熟が必要です。

リソースマネージャーはコントロールパネル上で操作できます。Terraformをセットアップしなくても、コントロールパネルを操作するだけで、テンプレートの確認・編集と、クラウド上への反映を行えます。また、複数人でインフラを管理している場合は、常に1つのテンプレートを通して編集するため、設定情報の競合や矛盾の発生を抑制するのに役立ちます。

For detailed information on differences, please refer to Differences between resource manager and Terraform.

List of resources supported by resource manager

リソースマネージャーで操作可能なリソースは以下の通りです(記載の無い機能はご利用いただけません)。

For details on supported resources and methods for writing to tffile, please refer to SAKURA Cloud for Terraform document .

Usage procedures

リソースマネージャーでは実際のリソースの操作にAPIキーを使用するため、事前に APIキー の作成が必要です。その後テンプレートを作成し、構成情報の計画・反映を行います。

1. Preparation

リソースマネージャーでは、「作成・削除」の権限を持つ APIキー が必要です。作成していない場合は、ホーム画面のメニューから「APIキー」を選択し、対象アカウントごとにAPIキーを作成します。詳しくは APIキー のページを参照ください。

2. Creating a template in resource manager

コントロールパネル上部の「オプション」をクリックし、表示されたメニューから「リソースマネージャー」をクリックします。作成済みのテンプレートが一覧表示されます。新たに作成する場合は画面右上の「追加」をクリックします。

テンプレート作成画面で必要事項を選択・入力します。

各項目は以下の通りです。

構成先ゾーン(※) リソースを作成するゾーンを選択します。
実行環境バージョン テンプレートを実行する際のバージョンを選択します。
※詳細は Terraform実行環境バージョンについて を参照ください。
APIキー(※) テンプレートに沿ってサーバを構成する際、クラウドのリソース操作に使用するAPIキーを選択します。
※作成・削除の権限を付与されたAPIキーが選択可能となります
名前 / 説明 / タグ / アイコン 作成したテンプレートを分かりやすく管理することができます。

(※)は必須項目です

各項目を入力後、「作成」ボタンををクリックします。

Attention

When logged in as a SAKURA Cloud user, it is not possible to use Resource Manager. To use Resource Manager, please log in as a SAKURA internet member.

After creation, click [Resource Manager] from the left menu. Then, select the created template name and proceed to detailed settings.

3. Create/edit a template

Immediately after creating a template, there is no configuration information, so registration is necessary. Display the screen for template information of resource manager and then click [Change tffile].

Next, enter template configuration information in the tffile form, or select an existing template from [Template]. In the latter case, click [Template], click the desired configuration, and then click [Select] at the bottom-right of the screen.

Also, by entering the character string ### for template creation/editing, it is possible to separate by tabs for display. Tab display can be switched by clicking the [Separate/Merge Tab] button on the edit screen.

Once editing is finished, click [Change].

Note

For details on how to write configuration information, please refer to information provided by the link in reference (planned addition).

4. Plan/update commands

[Command] must be executed in order to update the template contents. Be sure to execute the [Plan] command before actually creating a resource.

Plan and update

Click [Command] → [Update].

Compare the template content and cloud configuration, and display changes to be performed on the screen. Normally, when creating a new template, all resources are newly created.

Click [Plan] at the confirmation screen. At this stage, resources have not been created. Compare template conditions and cloud resources, and display changes to be performed on the screen (equivalent to terraform plan).

If there are no problems, click [Next]. If there is an error in the template script, it will be displayed on the screen. Confirm the error details, edit the template, and perform plan again.

Confirm the cautions and then click [Update] (equivalent to terraform appry ).

Attention

  • After updating, automatically creates resources. After each resource is created, billing starts.
  • Billing for created resources is not cancelled even if an error occurs or update processing is interrupted due to the browser being closed.
  • Processing is interrupted if there is no space in the resource. Before updating, please confirm whether or not the required resource can be used.

Attention

  • When adding/deleting template configuration information and updating it, resources are added/deleted in conjunction with template contents. Please be careful during editing.

Afterwards, wait for work to end at the [Log] tab. Click [Update to Latest Information] and wait for processing to finish.

5. Discard

To delete all environments created using a template, select [Discard] from [Command]. This is deletion of all created resources, not discarding of the template. Please be careful during operation.

Attention

  • Resources deleted using discard cannot be restored. If there is required data, before discarding, be sure to copy the data to another archive/disk or register settings information. Even if planning and updating is performed again using a template, only a new resource is recreated; the contents are not retained.

Cautions

Template restrictions

  • Templates for this function are based on the format of the resource manager file for Terraform. However, the resource specification listed below are not supported.

    • provider
    • provisioner
    • module

For more detailed information, please refer to Differences between resource manager and Terraform.

Terraform実行バージョンについて

テンプレート作成時、「実行環境バージョン」のポップアップメニューでTerraform実行バージョンを選択可能です。Terraformの記法による構成情報の記述を行う場合は構文バージョンに合わせて選択してください。