1
## 以降、行頭の ## はコメント行、$ はコマンド、コマンドの改行と空行以外はコマンドの出力となる
2
## また、コマンドの修正が必要な箇所は <変数名> で表示している
3

4
## WSL 環境に OCI CLI をインストールする
5
## Ubuntu 20.04 環境は以下スクリプトでインストールとなる
6
$ bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
7

8
## 確認する
9
$ oci --version
10
3.10.1
11

12
## アカウントと紐づける
13
$ oci setup config
14

15
## 途中で API キーの作成を聞かれるため、Y を選択する
16
## Do you want to generate a new API Signing RSA key pair?
17
## (If you decline you will be asked to supply the path to an existing key.) [Y/n]: Y
18

19
## 確認する (デフォルトで作成すると ~/.oci に保管される)
20
## ここで作成されたファイルは後の手順で必要となる
21
$ ls ~/.oci
22
config  oci_api_key.pem  oci_api_key_public.pem
23

24
## 出力された公開鍵ファイル (oci_api_key_public.pem) を OCI のコンソールから登録する
25
## ユーザーのプロファイル → API キー → API キーの追加 → 公開キーの貼り付け、または、公開キーファイルの選択

1
## カスタムイメージの一覧を取得する
2
## 以下コマンドは Oracle Linux 8 系のベースイメージ一覧を取得する手順となる
3
## <Compartment OCID>: カスタムイメージを作成するコンパートメントの OCID を入力する
4
## jq で Oracle Linux 8 系のインスタンス用に該当するイメージのみに絞っている
5
$ oci compute image list --all --compartment-id <Compartment OCID> \
6
  --operating-system "Oracle Linux" \
7
  --operating-system-version "8" \
8
  | jq -r '[.data[] | select (."display-name" | test("Oracle-Linux-8\\.\\d+-\\d+\\.\\d+\\.\\d+-\\d+"))][0] | ."display-name"'
9

10
Oracle-Linux-8.6-2022.05.31-0

1
## Packer のインストール
2
$ curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -
3
$ sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"
4
$ sudo apt-get update && sudo apt-get install packer
5

6
## 確認する
7
$ packer --version
8
1.8.1

1
## Packer 用のディレクトリーを作成する
2
$ cd ~/
3
$ mkdir ./packer/
4
$ cd ./packer/
5

6
## Packer のファイルを作成する
7
## 以下 <> で括られた変数は適宜、環境に合わせて変更
8
$ vim ./oci.pkr.hcl
9

10
## ---- oci.pkr.hcl ---- ##
11
## イメージを作成する環境の設定
12
## https://www.packer.io/docs/templates/hcl_templates/blocks/source
13
source "oracle-oci" "instance-image" {
14
  ## イメージ作成用インスタンスの設定
15
  ## 展開先コンパートメントの OCID (必須)
16
  compartment_ocid = "<Compartment OCID>"
17
  ## 展開先 Availability Domain (必須): ap-tokyo-1 の場合
18
  availability_domain = "xxxx:AP-TOKYO-1-AD-1"
19
  ## 展開先サブネット OCID (必須)
20
  subnet_ocid = "<Subnet OCID>"
21
  ## インスタンス名 (未指定の場合 instanceYYYYMMDDhhmmss になる)
22
  instance_name = "instance-for-custom-image-from-packer"
23
  ## インスタンスのシェイプ (必須)
24
  shape = "VM.Standard.E4.Flex"
25
  ## インスタンスシェイプのサイズ
26
  shape_config {
27
    ## OCPU のサイズ
28
    ocpus = "1"
29
    ## メモリーサイズ
30
    memory_in_gbs = "4"
31
  }
32
  ## インスタンスのディスクサイズ
33
  disk_size = 50
34
  ## インスタンスの接続ユーザー
35
  ssh_username = "opc"
36
  ## プライベート IP の利用
37
  ## 当社環境はプライベート IP でアクセスできるようになっているため、 true を指定
38
  use_private_ip = true
39
  ## ベースイメージは最新のイメージを探す
40
  base_image_filter {
41
    ## ベースイメージのコンパートメント OCID (未指定の場合、インスタンスの compartment_ocid と同じ)
42
    compartment_id = "<Compartment OCID>"
43
    ## ベースイメージ OS の名前
44
    operating_system = "Oracle Linux"
45
    ## ベースイメージ OS のバージョン
46
    operating_system_version = "8"
47
    ## イメージ名で正規表現の一致するもののみ取得
48
    ## 汎用の Oracle Linux 8 系は Oracle-Linux-8.x-YYYY.MM.DD-y のため、合致する正規表現を記載
49
    ## \ はエスケープする
50
    display_name_search = "^Oracle-Linux-8\\.\\d+-\\d{4}\\.\\d{2}\\.\\d{2}-\\d+$"
51
  }
52

53
  ## ユーザー認証情報
54
  ## リージョン: ap-tokyo-1
55
  region = "ap-tokyo-1"
56
  ## テナンシーの OCID
57
  tenancy_ocid = "<Tenancy OCID>"
58
  ## ユーザーの OCID (① で設定したユーザーの OCID)
59
  user_ocid = "<User OCID>"
60
  ## API キーのパス (① で作成した API キー)
61
  key_file = "~/.oci/oci_api_key.pem"
62
  ## API キーのフィンガープリント
63
  ## フィンガープリントは ① の config ファイルに記載されている
64
  fingerprint = "<API FingerPrint>"
65

66
  ## 出力イメージの設定
67
  ## イメージ配置先コンパートメントの OCID (未指定の場合、インスタンスの compartment_ocid と同じ)
68
  image_compartment_ocid = "<Compartment OCID>"
69
  ## 出力イメージ名
70
  image_name = "oracle-linux-8-customimage-for-instance"
71
}
72

73
## イメージの作成
74
## https://www.packer.io/docs/templates/hcl_templates/blocks/build
75
build {
76
  ## 上で設定した source を利用
77
  sources = [
78
    ## source "oracle-oci" "instance-image" の場合
79
    "source.oracle-oci.instance-image"
80
  ]
81

82
  ## provisioner にカスタムイメージで実行する内容を設定
83
  ## https://www.packer.io/docs/templates/hcl_templates/blocks/build/provisioner
84

85
  ## ファイルの配置
86
  ## 今回の要件としては不要、ファイルの配置ができることを確認するために実施
87
  provisioner "file" {
88
    ## コピー元 (ローカル)
89
    source = "./file/test.txt"
90
    ## コピー先 (リモートのカスタムイメージ作成用インスタンス)
91
    destination = "/home/opc/test.txt"
92
  }
93

94
  ## コマンドを実行
95
  ## 今回は例として、プロキシーの設定、git コマンドのインストールを実行、送信したテキスト内容の表示を実施する
96
  provisioner "shell" {
97
    inline = [
98
      ## プロキシーの設定
99
      "sudo touch /etc/environment",
100
      "echo \"http_proxy=<HTTPProxy>:<HTTPProxy Port>\" | sudo tee -a /etc/environment > /dev/null",
101
      "echo \"https_proxy=<HTTPSProxy>:<HTTPSProxy Port>\" | sudo tee -a /etc/environment > /dev/null",
102
      "echo \"no_proxy=<NoProxy>\" | sudo tee -a /etc/environment > /dev/null",
103
      "echo \"HTTP_PROXY=<HTTPProxy>:<HTTPProxy Port>\" | sudo tee -a /etc/environment > /dev/null",
104
      "echo \"HTTPS_PROXY=<HTTPSProxy>:<HTTPSProxy Port>\" | sudo tee -a /etc/environment > /dev/null",
105
      "echo \"NO_PROXY=<NoProxy>\" | sudo tee -a /etc/environment > /dev/null",
106
      ## ログアウトまでプロキシー設定が反映されないため、一時的にプロキシーを設定
107
      "export http_proxy=<HTTPProxy>:<HTTPProxy Port>",
108
      "export https_proxy=<HTTPSProxy>:<HTTPSProxy Port>",
109
      "export no_proxy=<NoProxy>",
110
      ## dnf のプロキシー除外設定
111
      "sudo ls /etc/yum.repos.d/*.repo | sudo xargs -i sed -i -e \"/^baseurl=https:\\/\\/yum\\$ociregion\\.\\$ocidomain\\//a proxy=_none_\" {}",
112

113
      ## git コマンドのインストール
114
      "sudo dnf install -y git",
115

116
      ## test.txt の内容を表示する
117
      ## 今回の要件としては不要、試験的に配置したファイルの内容を表示する
118
      "cat /home/opc/test.txt"
119
    ]
120
  }
121

122
  ## イメージ作成完了後に情報を出力する
123
  post-processor "manifest" {
124
    output = "./result.json"
125
    strip_path = true
126
  }
127
}
128
## ---- oci.pkr.hcl ---- ##
129

130
## 試験的に内容を表示するファイルを作成
131
$ mkdir ./file/
132
$ echo "this is test file." > ./file/test.txt
133

134
## ファイルの構文に問題がないか確認する
135
$ packer validate ./oci.pkr.hcl
136
The configuration is valid.

1
## packer コマンドを実行し、イメージを作成する
2
$ packer build ./oci.pkr.hcl
3
oracle-oci.instance-image: output will be in this color.
4
## インスタンスの作成
5
==> oracle-oci.instance-image: Creating temporary ssh key for instance...
6
==> oracle-oci.instance-image: Creating instance...
7
==> oracle-oci.instance-image: Created instance (ocid1.instance.oc1.ap-tokyo-1.xxxxxxxx...).
8
…
9
==> oracle-oci.instance-image: Connected to SSH!
10
## ファイル (test.txt) の送信
11
==> oracle-oci.instance-image: Uploading ./file/test.txt => /home/opc/test.txt
12
…
13
## コマンドの実行
14
==> oracle-oci.instance-image: Provisioning with shell script: /tmp/packer-shellxxxxxxxxxx
15
…
16
    oracle-oci.instance-image: Installed:
17
    oracle-oci.instance-image:   git-2.31.1-2.el8.x86_64               git-core-2.31.1-2.el8.x86_64
18
    oracle-oci.instance-image:   git-core-doc-2.31.1-2.el8.noarch      perl-Error-1:0.17025-2.el8.noarch
19
    oracle-oci.instance-image:   perl-Git-2.31.1-2.el8.noarch          perl-TermReadKey-2.37-7.el8.x86_64
20
    oracle-oci.instance-image: Complete!
21
    oracle-oci.instance-image: this is test file.
22
## イメージを作成
23
==> oracle-oci.instance-image: Creating image from instance...
24
==> oracle-oci.instance-image: Created image (ocid1.image.oc1.ap-tokyo-1.xxxxxxxx...).
25
## イメージが作成できたため、インスタンスを削除 (イメージの作成に失敗した場合も削除される)
26
==> oracle-oci.instance-image: Terminating instance (ocid1.instance.oc1.ap-tokyo-1.xxxxxxxx...)...
27
==> oracle-oci.instance-image: Terminated instance.
28
## 作成完了後の情報を出力
29
==> oracle-oci.instance-image: Running post-processor:  (type manifest)
30
Build 'oracle-oci.instance-image' finished after 5 minutes 27 seconds.
31
==> Builds finished. The artifacts of successful builds are:
32
--> oracle-oci.instance-image: An image was created: 'oracle-linux-8-customimage-for-instance' (OCID: ocid1.image.oc1.ap-tokyo-1.xxxxxxxx...) in region 'ap-tokyo-1'
33

34
## 結果は返却値からも確認できる (0: 成功、0 以外: 失敗)
35
$ echo $?
36
0

1
## 依存パッケージのインストール
2
$ sudo apt-get update && sudo apt-get install -y gnupg software-properties-common curl
3
## Terraform のインストール
4
$ curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -
5
$ sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"
6
$ sudo apt-get update && sudo apt-get install terraform
7

8
## 確認する
9
$ terraform --version
10
Terraform v1.2.3
11
on linux_amd64

1
## Terraform 用のディレクトリーを作成する
2
$ cd ~/
3
$ mkdir ./terraform/
4
$ cd ./terraform/
5

6
## SSH 鍵ファイルの作成
7
$ mkdir ./key/
8
$ cd ./key/
9
$ ssh-keygen
10
Generating public/private rsa key pair.
11
## カレントディレクトリーに配置するため、ファイルパスを指定する
12
Enter file in which to save the key (/home/<User>/.ssh/id_rsa): ./id_rsa
13
## パスフレーズは設定しないためそのまま Enter
14
Enter passphrase (empty for no passphrase): (Enter)
15
Enter same passphrase again: (Enter)
16
Your identification has been saved in ./id_rsa
17
Your public key has been saved in ./id_rsa.pub
18
…
19

20
## 生成されたことを確認する
21
## (id_rsa.pub をインスタンス生成時に渡して id_rsa で SSH アクセスできるようにする)
22
$ ls ./
23
id_rsa  id_rsa.pub
24

25
## 次の作業のために terraform ディレクトリーに戻っておく
26
$ cd ../
27

28
## Terraform でインスタンスを操作するユーザーの情報を記載する
29
## インスタンスの操作権限が必要なため、とくに分ける必要がなければ ① で作成した config ファイルと同じでよい
30
$ cat ~/.oci/config
31
[DEFAULT]
32
user=<User OCID>
33
fingerprint=<FingerPrint>
34
key_file=/home/<User>/.oci/oci_api_key.pem
35
tenancy=<Tenancy OCID>
36
region=ap-tokyo-1
37

38
## config ファイルから情報を渡す
39
$ vim ./provider.tf
40

41
## ---- provider.tf ---- ##
42
provider "oci" {
43
  tenancy_ocid = "<Tenancy OCID>"
44
  user_ocid = "<User OCID>"
45
  private_key_path = "/home/<User>/.oci/oci_api_key.pem"
46
  fingerprint = "<FingerPrint>"
47
  region = "ap-tokyo-1"
48
}
49
## ---- provider.tf ---- ##
50

51
## Terraform で作成するインスタンスの情報を記載する
52
$ vim ./compute.tf
53

54
## ---- compute.tf ---- ##
55
## カスタムイメージの OCID は変数化する (後述)
56
## コマンドで指定、または、オプションなしの場合はコンソールから入力
57
## terraform apply -var image_ocid="<Custom Imgae OCID>"
58
variable "image_ocid" {}
59

60
## インスタンスの情報
61
resource "oci_core_instance" "test_instance" {
62
  ## 試験用インスタンス名
63
  display_name = "test-for-custom-image-from-terraform"
64
  ## 試験用インスタンスの展開先コンパートメント OCID
65
  compartment_id  = "<Compartment OCID>"
66
  ## 試験用インスタンスの展開先 Availability Domain
67
  availability_domain = "xxxx:AP-TOKYO-1-AD-1"
68
  ## 試験用インスタンスのシェイプ
69
  shape = "VM.Standard.E4.Flex"
70
  ## 試験用インスタンスのシェイプのサイズ
71
  shape_config {
72
    ## OCPU のサイズ
73
    ocpus = "1"
74
    ## メモリーサイズ
75
    memory_in_gbs = "4"
76
  }
77

78
  ## 試験用インスタンスの VNIC 情報
79
  create_vnic_details {
80
    ## 展開先 VCN サブネットの OCID
81
    subnet_id = "<Subnet OCID>"
82
    ## Public IP の割り当て
83
    ## 当社環境はプライベート IP でアクセスできるようになっているため、false を設定する
84
    assign_public_ip = false
85
  }
86

87
  ## イメージの設定
88
  source_details {
89
    ## ソースタイプにイメージを指定
90
    source_type = "image"
91
    ## カスタムイメージの OCID
92
    ## 変数化しているため、コマンドから渡すことができる
93
    source_id = "${var.image_ocid}"
94
  }
95

96
  ## OCI のメタデータ
97
  metadata = {
98
    ## SSH アクセス用の公開鍵
99
    ssh_authorized_keys = file("./key/id_rsa.pub")
100
  }
101
}
102
## ---- compute.tf ---- ##

1
## Goss 用のディレクトリーを作成
2
$ mkdir ./goss/
3
$ cd ./goss/
4

5
## Goss の試験ファイルを作成
6
$ vim ./goss.yaml
7

8
## ---- goss.yaml ---- ##
9

10
## より詳細な設定やパラメーターは公式ドキュメントを参照
11
## https://github.com/aelsabbahy/goss/blob/master/docs/manual.md#available-tests
12

13
## コマンドを実行した返却値と出力から試験
14
## ここでは実行内容 (exec) を除く、全 19 項目が試験の項目数となる
15
command:
16
  ## http_proxy の設定
17
  http_proxy:
18
    ## 実行するコマンド
19
    exec: "echo $http_proxy"
20
    ## コマンドの返却値の試験
21
    exit-status: 0
22
    ## Packer で設定したプロキシーの情報と一致しているかどうか
23
    stdout:
24
      - "<HTTPProxy>:<HTTPProxy Port>"
25
  ## https_proxy の設定
26
  https_proxy:
27
    exec: "echo $https_proxy"
28
    exit-status: 0
29
    stdout:
30
      - "<HTTPSProxy>:<HTTPSProxy Port>"
31
  ## no_proxy の設定
32
  no_proxy:
33
    exec: "echo $no_proxy"
34
    exit-status: 0
35
    stdout:
36
      - "<NoProxy>"
37
  ## HTTP_PROXY の設定
38
  HTTP_PROXY:
39
    exec: "echo $HTTP_PROXY"
40
    exit-status: 0
41
    stdout:
42
      - "<HTTPProxy>:<HTTPProxy Port>"
43
  ## HTTPS_PROXY の設定
44
  HTTPS_PROXY:
45
    exec: "echo $HTTPS_PROXY"
46
    exit-status: 0
47
    stdout:
48
      - "<HTTPSProxy>:<HTTPSProxy Port>"
49
  ## NO_PROXY の設定
50
  NO_PROXY:
51
    exec: "echo $NO_PROXY"
52
    exit-status: 0
53
    stdout:
54
      - "<NoProxy>"
55
  ## dnf のリポジトリーのプロキシー除外設定
56
  dnf_no_proxy:
57
    ## ヘッダーを取り除いた repolist の数と yum.repo.d 配下のリポジトリーの proxy=_none_ 行の数が一致しているか
58
    exec: "test $(dnf repolist all | sed -e '1d' | wc -l) -eq $(grep 'proxy=_none_' /etc/yum.repos.d/* | wc -l)"
59
    ## 一致した場合は 0、しない場合は 0 以外
60
    exit-status: 0
61
  ## git コマンドの実行
62
  git:
63
    exec: "git --version"
64
    exit-status: 0
65
    ## バージョン情報が出力されれば OK とする
66
    stdout:
67
      - "/^git version [\\d]+\\.[\\d]+\\.[\\d]+$/"
68
## dnf のパッケージの情報
69
package:
70
  ## git のパッケージ
71
  git:
72
    ## インストールされているか
73
    installed: true
74
    ## バージョン指定の場合は versions も確認するとよい
75
    ## versions:
76
    ## - x.y.z
77
## サービスの稼働状況
78
service:
79
  ## ssh のサービス
80
  sshd:
81
    ## サービスが稼働しているか
82
    running: true
83
    ## インスタンス起動時の自動実行の設定
84
    enabled: true
85
## ポート設定
86
port:
87
  ## ssh のポート である tcp の 22 番があいているか (コロンが複数ありややこしいが、パラメーター名が tcp:22 となっている)
88
  tcp:22:
89
    ## ポートがあいているか
90
    listening: true
91
## ---- goss.yaml ---- ##

1
## Terraform のcompute.tf を修正して Goss を実行するよう変更
2
$ vim ./compute.tf
3

4
## ---- compute.tf ---- ##
5
  ## (途中まで省略)
6

7
  ## OCI のメタデータ
8
  metadata = {
9
    ## SSH アクセス用の公開鍵
10
    ssh_authorized_keys = file("./key/id_rsa.pub")
11
  }
12
}
13

14
## 以下を追記する
15
## SSH で接続して実行する
16
resource "null_resource" "remote-exec" {
17
  ## 依存関係
18
  depends_on = [
19
    ## 試験用インスタンスの作成が前提
20
    oci_core_instance.test_instance
21
  ]
22

23
  ## ファイルを配置する
24
  provisioner "file" {
25
    ## SSH SCP の情報
26
    connection {
27
      ## 当社環境はプライベート IP でアクセスできるため、接続先は上の試験用インスタンスのプライベート IP
28
      host = "${oci_core_instance.test_instance.private_ip}"
29
      ## SSH Agent は利用しない
30
      agent = false
31
      ## タイムアウトは 30 分
32
      timeout = "30m"
33
      ## 接続ユーザー
34
      user = "opc"
35
      ## SSH 鍵ファイルの配置先
36
      private_key = file("./key/id_rsa")
37
    }
38
    ## 送信するファイル (Goss の試験ファイル)
39
    source      = "./goss.yaml"
40
    ## 配置先 (ホームディレクトリーとする)
41
    destination = "/home/opc/goss.yaml"
42
  }
43

44
  ## SSH で実行する
45
  provisioner "remote-exec" {
46
    ## connection の説明は provisioner "file" と同じため省略
47
    connection {
48
      host = "${oci_core_instance.test_instance.private_ip}"
49
      agent = false
50
      timeout = "30m"
51
      user = "opc"
52
      private_key = file("./key/id_rsa")
53
    }
54
    ## コマンドを実行
55
    inline = [
56
      ## 作業ディレクトリーを移動
57
      "cd /home/opc",
58
      ## Goss のインストール (latest となっていますが、実施時は v0.3.18 を利用しています)
59
      "sudo curl -L https://github.com/aelsabbahy/goss/releases/latest/download/goss-linux-amd64 -o /usr/local/bin/goss",
60
      ## 実行権限を変更
61
      "sudo chmod +rx /usr/local/bin/goss",
62
      ## 試験を実施
63
      "goss validate"
64
    ]
65
  }
66
}
67
## ---- compute.tf ---- ##

1
## goss ディレクトリーから terraform ディレクトリーに移動
2
$ cd ../
3

4
## Terraform の初期設定を実施 (初回のみ)
5
$ terraform init
6

7
## 設定ファイルの確認 (apply でも実行されるため、なくてもよい)
8
$ terraform plan -var "image_ocid=<Custom Image OCID>"
9
…
10
Plan: 2 to add, 0 to change, 0 to destroy.
11

12
## 試験用インスタンスを展開する
13
$ terraform apply -auto-approve -var "image_ocid=<Custom Image OCID>"
14
…
15
Plan: 2 to add, 0 to change, 0 to destroy.
16
## 試験用インスタンスの作成
17
oci_core_instance.test_instance: Creating...
18
…
19
oci_core_instance.test_instance: Creation complete after 37s [id=ocid1.instance.oc1.ap-tokyo-1.xxxxxxxxxx]
20
null_resource.remote-exec: Creating...
21
## Goss 設定ファイルの送信
22
null_resource.remote-exec: Provisioning with 'file'...
23
…
24
## コマンド実行
25
null_resource.remote-exec: Provisioning with 'remote-exec'...
26
…
27
## Goss の試験結果 (OK の場合は緑色の . が出力され、NG の場合は赤字で F が出力される)
28
## 試験結果が一つでも F だった場合、コマンドが失敗扱いとなり、Terraform の構築も失敗とみなされる
29
null_resource.remote-exec (remote-exec): ..................
30
null_resource.remote-exec (remote-exec): .
31
## Goss の試験時間と結果
32
null_resource.remote-exec (remote-exec): Total Duration: 0.735s
33
null_resource.remote-exec (remote-exec): Count: 19, Failed: 0, Skipped: 0
34

35
Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
36

37
## 実行結果を確認する
38
## 構築に失敗した場合は 0 以外を返す (＝試験に失敗した場合も 0 以外を返す)
39
$ echo $?
40
0

1
## Terraform で展開したリソースの削除
2
## -var image_ocid の値は空でよい
3
$ terraform apply -destroy -auto-approve -var "image_ocid="
4
…
5
Plan: 0 to add, 0 to change, 2 to destroy.
6
…
7
## インスタンスの削除
8
oci_core_instance.test_instance: Destroying... [id=ocid1.instance.oc1.ap-tokyo-1.xxxxxxxxxx]
9
…
10
oci_core_instance.test_instance: Destruction complete after 1m21s
11
## 削除完了
12
Apply complete! Resources: 0 added, 0 changed, 2 destroyed.