Forge Home

wormhole

The wormhole module lets you use Puppet / Bolt / Choria to manage magic wormhole and transfer files between nodes

2,572 downloads

190 latest version

4.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 3.0.0 (latest)
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.0.0
released Jul 5th 2023
This version is compatible with:
  • Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • ,
Tasks:
  • receive
  • send

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'opuscodium-wormhole', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add opuscodium-wormhole
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install opuscodium-wormhole --version 3.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

opuscodium/wormhole — version 3.0.0 Jul 5th 2023

wormhole

Build Status Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores License

Table of Contents

Module Description

The wormhole module lets you use Puppet / Bolt / Choria to manage magic wormhole and transfer files between nodes.

Setup

Beginning with wormhole

Including the wormhole class should be enought to get started:

class { 'wormhole':
}

Usage

Sending a file from a remote host

user@host ~ % bolt task run wormhole::send -t source.example.com filename=/etc/motd
Started on source.example.com...
Finished on source.example.com:
  {
    "code": "6-resistor-puppy"
  }
Successful on 1 target: source.example.com
Ran on 1 target in 6.3 sec

Receiving a file from a remote host

user@host ~ % bolt task run wormhole::receive -t target.example.com filename=/tmp/source-motd code=6-resistor-puppy

Sending a file from the local host

user@host ~ % wormhole send /etc/motd
Sending 322 Bytes file named 'motd'
Wormhole code is: 9-article-escape
On the other computer, please run:

wormhole receive 9-article-escape

Receiving a file on the local host

user@host ~ % wormhole receive
Enter receive wormhole code: