puppet bolt のディレクトリ構成

$ tree -a -L 3
.
├── .modules
│   ├── chocolatey
│   └── ...
├── .resource_types
│   └── ...
├── Puppetfile
├── README.md
├── bolt-debug.log
├── bolt-project.yaml
├── data
│   ├── common.yaml
│   ├── local.yaml
│   ├── production.yaml
│   └── staging.yaml
├── hiera.yaml
├── inventory.yaml
├── site-modules
│   └── mymodule
│       ├── files
│       │   ├── motd.txt
│       │   └── check_server.sh
│       ├── plans
│       │   ├── planA.yaml
│       │   └── planB.yaml
│       └── templates
│           └── env.epp
└── tasks
    ├── download_from_gcs.json
    └── download_from_gcs.rb

# This Puppetfile is managed by Bolt. Do not edit.
# For more information, see https://pup.pt/bolt-modules

# The following directive installs modules to the managed moduledir.
moduledir '.modules'

mod "puppetlabs-chocolatey", "5.1.1"
・・・

2020-12-02T18:44:46.273566 INFO   [event-publisher] [Bolt::Outputter::Logger] Starting: plan mymodule::planA
2020-12-02T18:44:46.291736 INFO   [event-publisher] [Bolt::Outputter::Logger] Finished: plan mymodule::planA in 0.02 sec

# bolt project の作成（ project_name に、ハイフンは含められない。）
$ bolt project init myproject

$ ls
bolt-project.yaml

$ cat bolt-project.yaml
---
name: myproject

# staging.yaml
---
gcp_project_id: "gcp_project_staging"

# production.yaml
---
gcp_project_id: "gcp_project_production"

---
version: 5 # hiera の ver 指定する。bolt は ver 5のみ対応している。
defaults:
  datadir: data # 変数ファイルを、hiera.yaml ファイルからみた相対パスで指定する
  data_hash: yaml_data # 変数ファイルの形式を指定する。e.g. yaml, json, HOCON

hierarchy:
  # bolt 実行時に、env を渡すとそれぞれの変数ファイルを読み込む
  # 上から優先順位が高い。そのため基本的には、最後に、common.yamlとかを記載することが多い。
  - name: "environment data"
    path: "%{env}.yaml"
  - name: "common data"
    path: "common.yaml"

# 引数 env=staging -> data/staging.yaml を読み込む
$ bolt plan run mymodule::planA env=staging --targets webservers

# 引数 env=production -> data/production.yaml を読み込む
$ bolt plan run mymodule::planA env=production --targets webservers

groups:
  # e.g. linux の webserver via ssh
  - name: ssh_nodes
    groups:
      - name: webservers
        targets:
          - 192.168.100.179
          - 192.168.100.180
      - name: memcached
        targets:
          - 192.168.101.50
        config:
          ssh:
            user: root
    config:
      transport: ssh
      ssh:
        user: centos
        private-key: ~/.ssh/id_rsa
        host-key-check: false
  # e.g. windows の webservers via winrm
  - name: win_nodes
    groups:
      - name: apiservers
        targets:
          - 192.168.110.10
      - name: testservers
        targets:
          - 172.16.219.20
    config:
      transport: winrm
      winrm:
        user: DOMAIN\opsaccount
        password: S3cretP@ssword
        ssl: true

# ssh_nodes,win_nodes 両方に実行する場合
$ bolt command run 'echo hello' --targets ssh_nodes,win_nodes

# ssh_nodes のみに実行する場合
$ bolt command run 'echo hello' --targets ssh_nodes

# webservers,testservers のみに実行する場合
$ bolt command run 'echo hello' --targets webservers,testservers

# ref. https://forge.puppet.com/modules/puppetlabs/aws_inventory

# inventory.yaml
---
groups:
  - name: aws
    targets:
      - _plugin: aws_inventory
        profile: user1
        region: us-west-1
        filters:
          - name: tag:Owner
            values: [Devs]
          - name: instance-type
            values: [t2.micro, c5.large]
        target_mapping:
          name: public_dns_name
          uri: public_ip_address
          config:
            ssh:
              host: public_dns_name
    config:
      ssh:
        user: ec2-user
        private-key: ~/.aws/private-key.pem
        host-key-check: false

$ bolt task show

apt                                 Allows you to perform apt functions
facts                               Gather system facts
http_request                        Make a HTTP or HTTPS request.
package                             Manage and inspect the state of packages
pkcs7::secret_createkeys            Create a key pair
pkcs7::secret_decrypt               Encrypt sensitive data with pkcs7
pkcs7::secret_encrypt               Encrypt sensitive data with pkcs7
puppet_agent::install               Install the Puppet agent package
puppet_agent::version               Get the version of the Puppet agent package installed. Returns nothing if none present.
puppet_conf                         Inspect puppet agent configuration settings
reboot                              Reboots a machine
reboot::last_boot_time              Gets the last boot time of a Linux or Windows system
service                             Manage and inspect the state of services
terraform::apply                    Apply an HCL manifest
terraform::destroy                  Destroy resources managed with Terraform
terraform::initialize               Initialize a Terraform project directory
terraform::output                   JSON representation of Terraform outputs

bolt task run package action=status name=apache2 --targets webservers

・・・
└── tasks
    ├── download_from_gcs.json # タスクのメタデータ
    └── download_from_gcs.rb   # タスクを定義する実行スクリプト

// download_from_gcs.json
{
  "description": "Download file from google cloud storage locally", // タスクの説明
  "input_method": "stdin", // タスクのインプット方法 e.g. environment（環境変数）, stdin（標準入力）, powershell（？？）
  "parameters": {
    "bucket_name": {
      "description": "Bucket of google cloud storage", // パラメータの説明
      "type": "String[1]" // パラメータのデータ型の指定 e.g. 空ではない文字列
    },
    "object_path": {
      "description": "Object path of google cloud storage",
      "type": "String[1]"
    },
    "tmp_dir": {
      "description": "tmp path",
      "type": "String[1]"
    }
  },
  "files": ["ruby_task_helper/files/task_helper.rb"] // タスク実行時に利用するファイルの指定。基本、ヘルパーライブラリが多いかも。
}

#!/usr/bin/env ruby

require_relative '../../ruby_task_helper/files/task_helper'
require 'google/cloud/storage'

class DownloadFileFromGCS < TaskHelper
  # GCSの指定バケット・オブジェクトパスを指定tmpディレクトリにダウンロードするタスク
  def task(bucket_name: nil, object_path: nil, tmp_dir: nil, **_kwargs)
    storage = Google::Cloud::Storage.new
    bucket = storage.bucket bucket_name
    object = bucket.file object_path
    object.download tmp_dir + '/' + object_path

    puts "Success to download #{object.name} to #{tmp_dir}"
  end
end

DownloadFileFromGCS.run if __FILE__ == $0

$ bolt task show myproject::download_from_gcs

myproject::download_from_gcs - Download file from google cloud storage locally

USAGE:
bolt task run --targets <node-name> myproject::download_from_gcs bucket_name=<value> object_path=<value> tmp_dir=<value>

PARAMETERS:
- bucket_name: String[1]
    Bucket of google cloud storage
- object_path: String[1]
    Object path of google cloud storage
- tmp_dir: String[1]
    tmp path

MODULE:
/Users/jkkitakita/myproject

# puppet bolt の site-modules のディレクトリ構成
...
├── site-modules
│   └── mymodule
│       ├── files
│       ├── plans
│       └── templates
...

# ref. ansible の場合の roles のディレクトリ構成
...
├── roles
│   └── myrole
│       ├── files
│       ├── tasks
│       └── templates
...

# puppet bolt の site-modules のディレクトリ構成
...
├── site-modules
│   └── mymodule
│       └── plans
│           ├── planA.yaml
│           └── planB.yaml
...

# planA を実行したい場合
$ bolt plan run mymodule::planA --targets webservers
# planB を実行したい場合
$ bolt plan run mymodule::planB --targets webservers

steps:
  # motd.txt を対象ホストに upload する
  - upload: mymodule/motd.txt # ref. site-modules/mymodule/files/motd.txt
    destination: /etc/motd
    targets: $targets
    description: "Upload motd to the webservers"
  # check_server.sh を対象ホスト上で実行する
  # e.g. ./check_server.sh /index.html 60
  - script: mymodule/check_server.sh
    targets: $targets
    description: "Run mymodule/files/check_server.sh on the webservers"
    arguments: # Optional
      - "/index.html"
      - 60

# mymodules/templates/env.epp
<%- | String  $env,
      String  $gcp_project_id,
| -%>
ENV=<%= $env %>
GCP_PROJECT_ID=<%= $gcp_project_id %>

# mymodules/plans/planB.pp
#
#/tmp/.env ファイルを更新する plan
# @param targets The targets to configure
# @param env The environment
# @param tmp_dir The tmp directory for download destination
plan mymodule::planB(
  TargetSpec $targets,
  String[1] $env,
  String[1] $tmp_dir = '/tmp'
) {
  apply($targets) {
    file { "${tmp_dir}/.env":
      content => epp('mymodules/env.epp', {
        'env'            => $env,
        'gcp_project_id' => lookup('gcp_project_id'), # hiera の data を取得
      }),
    }
  }
}

bolt plan run mymodules::planB env=staging --targets webservers

centos@192.168.100.179$ cat /tmp/.env

ENV=staging
GCP_PROJECT_ID=gcp_project_staging

# yaml の場合（site-modules/mymodule/plans/planA.yaml）
parameters:
  targets:
    type: TargetSpec
  bucket_name:
    type: String[1]
  object_path:
    type: String[1]
  tmp_dir:
    type: String[1]
    default: "/tmp"

steps:
  # motd.txt を対象ホストに upload する
  - upload: mymodule/motd.txt # ref. site-modules/mymodule/files/motd.txt
    destination: /etc/motd
    targets: $targets
    description: "Upload motd to the webservers"
  # check_server.sh を対象ホスト上で実行する
  # e.g. ./check_server.sh /index.html 60
  - script: mymodule/check_server.sh
    targets: $targets
    description: "Run mymodule/files/check_server.sh on the webservers"
    arguments: # Optional
      - "/index.html"
      - 60
  - task: myproject::download_from_gcs
    targets: $targets
    description: "Download file from gcs"
    parameters:
      bucket_name: $bucket_name
      object_path: $object_path
      tmp_dir: $tmp_dir

# puppuet の場合（site-modules/mymodule/plans/planA.pp）

# @param targets The targets to configure
# @param bucket_name The bucket name
# @param object_path The object path
# @param tmp_dir The tmp directory for download destination
plan mymodule::planA(
  TargetSpec $targets,
  String[1] $bucket_name,
  String[1] $object_path,
  String[1] $tmp_dir = '/tmp'
) {
  upload_file(
    'mymodule/motd.txt',
    '/etc/motd',
    $targets,
    "Upload motd to the webservers"
  )
  run_script(
    'mymodule/check_server.sh',
    $targets,
    "Run mymodule/files/check_server.sh on the webservers",
    {
      'arguments' => ["/index.html", 60]
    }
  )
  run_task(
    'myproject::download_from_gcs',
    $targets,
    'Download file from gcs',
    {
      'bucket_name' => $bucket_name,
      'object_path' => $object_path,
      'tmp_dir'     => $tmp_dir,
    },
  )
}

bolt plan run mymodule::planA env=staging bucket_name=mybucket object_path=myobject.txt --targets webservers

bolt plan convert site-modules/mymodule/plans/planA.yaml