martezr / packer-provisioner-puppet-bolt

Packer Puppet Bolt Local Provisioner

Packer Puppet Bolt Provisioner

This plugin has been superseded by the packer-plugin-bolt repository for newer versions of HashiCorp Packer

HashiCorp Packer plugin that provisions machines using Puppet Bolt

The bolt Packer provisioner runs Puppet Bolt tasks. It runs an SSH server, executes bolt task run, and marshals Bolt tasks through the SSH server to the machine being provisioned by Packer.

Note:: Any remote_user defined in tasks will be ignored. Packer will always connect with the user given in the json config for this provisioner.

Usage

Configuration Reference

required parameters

• bolt_task (string) - The bolt task to be run.

or

• bolt_plan (string) - The bolt plan to be run.

Optional Parameters:

Name	Type	Description
bolt_module_path	string	The path that Bolt should look for modules
bolt_params	json	The parameters to pass the Bolt Task or Plan.
install_modules	boolean	Whether to install modules from a Bolt project using the Puppetfile
inventory_file	string	The inventory file to use during provisioning. When unspecified, Packer will create a temporary inventory file and will use the host_alias.
local_port	uint	The port on which to attempt to listen for SSH connections. This value is a starting point. The provisioner will attempt listen for SSH connections on the first available of ten ports, starting at local_port. A system-chosen port is used when local_port is missing or empty.
log_level	string	The level of logging (debug, error, info, notice, warn, fatal, any)
project_path	string	The path that Bolt should look for a Bolt project directory
user	string	The bolt_user to use. Defaults to the user running packer.

SSH Settings

Name	Type	Description
ssh_host_key_file	string	The SSH key that will be used to run the SSH server on the host machine to forward commands to the target machine. Bolt connects to this server and will validate the identity of the server using the system known_hosts. The default behavior is to generate and use a onetime key.
ssh_authorized_key_file	string	The SSH public key of the Bolt ssh_user. The default behavior is to generate and use a onetime key. If this key is generated, the corresponding private key is passed to bolt with the --private-key-file option.
run_as	string	The user to run as for privilege escalation

WinRM Settings

Name	Type	Description
password	string	The password used to authenticate to the Windows machine
no_winrm_ssl_verify	boolean	Whether to verify that the target's certificate matches the cacert
no_winrm_ssl	boolean	Whether to use secure https connections for WinRM

License

Author:	Martez Reed ([email protected])
Copyright:	Copyright (c) 2018-2019 Green Reed Technology
License:	Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

packer-provisioner-puppet-bolt's Issues

SSH can not settle on compression_client algorithm

Is there a way to configure the server or client's compression_client algorithm? I'm getting errors like this:

    virtualbox-iso: Failed on ssh://127.0.0.1:37840:
    virtualbox-iso:   Failed to connect to ssh://127.0.0.1:37840: could not settle on compression_client algorithm
    virtualbox-iso:   Server compression_client preferences: none
    virtualbox-iso:   Client compression_client preferences: [email protected],zlib 
    virtualbox-iso: Failed on 1 target: ssh://127.0.0.1:37840                                                                       

Validate SSH Private Key Usage

Validate that a private SSH key file can specified for connecting to Linux nodes.

Add Windows support via WinRM (No-SSL)

Add support for provisioning Windows workloads using WinRM configured without SSL

Add Windows support via WinRM (SSL)

Add support for provisioning Windows workloads using WinRM configured with SSL

Develop build process

Develop a build and release process for the binaries

Submit to awesome-packer

Someone's started one of those "awesome" repos where resources are collected. Consider submitting to it here https://github.com/dawitnida/awesome-packer#custom-provisioners

PS: stumbled across this because I just started using bolt, but I also have quite a few packer builds in my infra.

Update README documentation

The current README needs to be updated to provide more robust detail

Add logic to validate a provided task or plan

Investigate the possibility of failing the build early if the provided task or plan is not available at the default path or provided module path.

Add support for installing Puppet modules

The ability to dynamically install Puppet modules from the Puppetfile of a Bolt project is necessary if external modules are required.

Update to latest bolt API

I didn't include this in my PR, but I think to use the latest bolt, there will be some changes required. Hopefully not too many:

https://puppetlabs.github.io/bolt/2020-01-09-new-year-new-bolt

Add support for Packer 1.7.0+

The plugin should be upgrade to support the changes made in Packer 1.7.0 to enable those using that version or later to use the plugin. Documentation on upgrade the plugin - https://www.packer.io/guides/1.7-plugin-upgrade

The protocol of this plugin (protocol version 4 and lower) was deprecated

Hi @martezr,

I would like to use this plugin with some newer plugins.
Sadly packer >= 1.7 refuses to load it.

Error: failed loading puppet-bolt

  on demo2.json.pkr.hcl line 15:
  (source code not available)

The protocol of this plugin (protocol version 4 and lower) was deprecated,
please use a newer version of this plugin. Or use an older version of Packer (pre
1.7) with this plugin.

Error: failed loading puppet-bolt

  on demo2.json.pkr.hcl line 20:
  (source code not available)

The protocol of this plugin (protocol version 4 and lower) was deprecated,
please use a newer version of this plugin. Or use an older version of Packer (pre
1.7) with this plugin.

==> Wait completed after 4 microseconds

==> Builds finished but no artifacts were created.

Do you plan to upgrade the plugin to work with newer packer releases?
I would really like to see puppet bolt with packer in action 😁

Best regards,

Semtyre

Add support for configurable log levels

Bolt 2.17.0 added support for the --log-level flag.

Add the ability to run as another user

The plugin should support the ability to run as another user for the purposes of command that require privilege escalation.

Add bolt variable support

Add support for passing variables to the Bolt commands being executed.