Terrafrom Import機能をOCIで試してみました

id:aoonoです。今回は、TerraformにおいてImportの機能がOCIでも有効に利用できるか試してみました。Terraformの実行環境の構築については、当ブログの過去記事で解説がありますのでご確認ください。 cloudii.atomitech.jp

Terreformを用いての既存環境の管理

今回の記事では、任意のコンパートメントに簡単なリソースを作成して動作確認してみました。この例では単一のVCNを取り上げます。

f:id:a-oono:20180914083030p:plain

※この時点で作成したVCNのOCIDをメモしておきます。後のインポートコマンドで利用します。

Terraformのテンプレートファイルを準備します。

$cat terraform_example.tf

provider "oci" {
        tenancy_ocid = "${var.tenancy_ocid}"
        user_ocid = "${var.user_ocid}"
        fingerprint = "${var.fingerprint}"
        private_key_path = "${var.private_key_path}"
        region = "${var.region}"
}

variable "tenancy_ocid" {}
variable "user_ocid" {}
variable "fingerprint" {}
variable "private_key_path" {}
variable "compartment_id" {}
variable "region" {}
variable "vcn_cidr_block" {}
variable "vcn_display_name" {}

resource "oci_core_virtual_network" "test" {
# (resource arguments)
}

$cat variables.auto.tfvars
tenancy_ocid="テナントのOCID"
user_ocid="USERのOCID"
compartment_ocid="コンパートメントのOCID"
fingerprint="フィンガプリントの値"
private_key_path="API秘密鍵のパス"
region="リージョン"
vcn_cidr_block="10.60.0.0/16"
vcn_display_name="test"

上記ファイルの中で、resource "oci_core_virtual_network" "test"の箇所の内容は空にしておきます。インポート対象となるリソースの要件になります。

動作確認

以下のコマンドを実行します。

$ terraform init #未実行の場合

$ terraform import oci_core_virtual_network.test <ここにVCNのOCID>

以下、実行結果です。

$ terraform init 
Initializing provider plugins...

The following providers do not have any version constraints in configuration,
so the latest version was installed.

To prevent automatic upgrades to new major versions that may contain breaking
changes, it is recommended to add version = "..." constraints to the
corresponding provider blocks in configuration, with the constraint strings
suggested below.

* provider.oci: version = "~> 2.2"

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

$ terraform import oci_core_virtual_network.test ocid1.vcn.oc1.iad.xxxxxxxxxxxxxxx
oci_core_virtual_network.test: Importing from ID "ocid1.vcn.oc1.iad.xxxxxxxxxxxxxxx"...
oci_core_virtual_network.test: Import complete!
  Imported oci_core_virtual_network (ID: ocid1.vcn.oc1.iad.xxxxxxxxxxxxxxx)
oci_core_virtual_network.test: Refreshing state... (ID: ocid1.vcn.oc1.iad.xxxxxxxxxxxxxxx)

Import successful!

The resources that were imported are shown above. These resources are now in
your Terraform state and will henceforth be managed by Terraform.

terraform importの結果、terraform.tfstateに以下の結果が追加されました。

$ cat terraform.tfstate
{
    "version": 3,
    "terraform_version": "0.11.8",
    "serial": 1,
    "lineage": "821a2fad-4071-0df1-42de-d09639d199eb",
    "modules": [
        {
            "path": [
                "root"
            ],
            "outputs": {},
            "resources": {
                "oci_core_virtual_network.test": {
                    "type": "oci_core_virtual_network",
                    "depends_on": [],
                    "primary": {
                        "id": "ocid1.vcn.oc1.iad.yyyyyyyyyyyyyyyyyyyyyyyyy",
                        "attributes": {
                            "cidr_block": "10.60.0.0/16",
                            "compartment_id": "ocid1.compartment.oc1..xxxxxxxxxxxxxxxx",
                            "default_dhcp_options_id": "ocid1.dhcpoptions.oc1.iad.zzzzzzzzzzzzz",
                            "default_route_table_id": "ocid1.routetable.oc1.iad.xxxxxxxxxxxxxxxxxx",
                            "default_security_list_id": "ocid1.securitylist.oc1.iad.xxxxxxxxxxxxxxxx",
                            "defined_tags.%": "0",
                            "display_name": "test",
                            "dns_label": "test",
                            "freeform_tags.%": "0",
                            "id": "ocid1.vcn.oc1.iad.xxxxxxxxxxxxxxxxxxxxxxxxx",
                            "state": "AVAILABLE",
                            "time_created": "2018-09-09 01:42:58.381 +0000 UTC",
                            "vcn_domain_name": "test.oraclevcn.com"
                        },
                        "meta": {
                            "e2bfb730-ecaa-11e6-8f88-34363bc7c4c0": {
                                "create": 900000000000,
                                "delete": 900000000000,
                                "update": 900000000000
                            }
                        },
                        "tainted": false
                    },
                    "deposed": [],
                    "provider": "provider.oci"
                }
            },
            "depends_on": []
        }
    ]
}

terraform_example.tfファイルで、インポートしたリソースの箇所に必須パラメータのみを埋めて、terraform planを実行してみます。

(変更箇所を抜粋)
resource "oci_core_virtual_network" "test" {
    cidr_block = "${var.vcn_cidr_block}"
    compartment_id = "${var.compartment_id}"
    display_name = "${var.vcn_display_name}"
}

terraform planを実行してみます。すると、No changes. Infrastructure is up-to-date.の結果が出力されました。

$ terraform plan
var.compartment_id
  Enter a value: ocid1.compartment.oc1..xxxxxxxxxxxxxxxx

Refreshing Terraform state in-memory prior to plan...
The refreshed state will be used to calculate this plan, but will not be
persisted to local or remote state storage.

oci_core_virtual_network.test: Refreshing state... (ID: ocid1.vcn.oc1.iad.yyyyyyyyyyyyyyyyyyyyyyyyy)

------------------------------------------------------------------------

No changes. Infrastructure is up-to-date.

This means that Terraform did not detect any differences between your
configuration and real physical resources that exist. As a result, no
actions need to be performed.

今回作成したテンプレートファイル内のresource "oci_core_virtual_network" "test" がOCI(既存)のものと異なる場合はterraform planの結果、リソースの差分が発生する場合があります。今回No changes.と出力されているため事前作成したVCNとテンプレート内のリソースは同一として扱われていると考えられます。

最後に

このようにして、OCI上に作成した既存リソースについても、terraform importを用いて既存構成をコードに移していくことが可能そうであるということが検討がつきました。 この機能を用いれば、手動で作成したOCIのリソースでも、構成管理ができそうです。