2. Install

The install script does the following steps (in a slightly different order). See Quick Start for details about the script.

2.1. Get Code

The code is delivered by zip file with a sha256sum to validate contents. These are in github under the releases tab for the Digital Rebar Provision project.

There are at least 3 releases to choose from:

  • tip - This is the most recent code. This is the latest build of master. It is bleeding edge and while the project attempts to be very stable with master, it can have issues.
  • stable - This is the most recent stable code. This is a tag that tracks the version-based tag.
  • v3.0.0 - There will be a set of Semantic Versioning (aka semver) named releases.

Previous releases will continue to be available in tag/release history. For additional information, see Releases.

When using the install.sh script, the version can be specified by the –drp-version flag, e.g. –drp-version=v3.0.0.

An example command sequence for Linux would be:

mkdir dr-provision-install
cd dr-provision-install
curl -fsSL https://github.com/digitalrebar/provision/releases/download/tip/dr-provision.zip -o dr-provision.zip
curl -fsSL https://github.com/digitalrebar/provision/releases/download/tip/dr-provision.sha256 -o dr-provision.sha256
sha256sum -c dr-provision.sha256
unzip dr-provision.zip

At this point, the install.sh script is available in the tools directory. It can be used to continue the process or continue following the steps in the next sections. tools/install.sh –help will provide help and context information.

2.2. Configuration Options

Using dr-provision --help will provide the most complete list of configuration options. The following common items are provided for reference.

--version                Print Version and exit
--disable-provisioner    Disable provisioner
--disable-dhcp           Disable DHCP
--static-port=           Port the static HTTP file server should listen on (default: 8091)
--tftp-port=             Port for the TFTP server to listen on (default: 69)
--api-port=              Port for the API server to listen on (default: 8092)
--dhcp-port=             Port for the DHCP server to listen on (default: 67)
--backend=               Storage backend to use. Can be either 'consul' or 'directory' (default: directory)
--data-root=             Location we should store runtime information in (default: /var/lib/dr-provision)
--static-ip=             IP address to advertise for the static HTTP file server (default: 192.168.124.11)
--file-root=             Root of filesystem we should manage (default: /var/lib/tftpboot)
--dhcp-ifs=              Comma-seperated list of interfaces to listen for DHCP packets
--debug-bootenv=         Debug level for the BootEnv System - 0 = off, 1 = info, 2 = debug (default: 0)
--debug-dhcp=            Debug level for the DHCP Server - 0 = off, 1 = info, 2 = debug (default: 0)
--debug-renderer=        Debug level for the Template Renderer - 0 = off, 1 = info, 2 = debug (default: 0)
--tls-key=               The TLS Key File (default: server.key)
--tls-cert=              The TLS Cert File (default: server.crt)

2.3. Prerequisites

dr-provision requires two applications to operate correctly, bsdtar and 7z. These are used to extract the contents of iso and tar images to be served by the file server component of dr-provision.

For Linux, the bsdtar and p7zip packages are required.

ubuntu

sudo apt-get install -y bsdtar p7zip-full

centos/redhat

sudo yum install -y bsdtar p7zip

Darwin

The new package, p7zip is required, and tar must also be updated. The tar program on Darwin is already bsdtar

  • 7z - install from homebrew: brew install p7zip
  • libarchive - update from homebrew to get a functional tar: brew install libarchive

At this point, the server can be started.

2.4. Running The Server

Additional support materials in FAQ / Troubleshooting.

The install.sh script provides two options for running dr-provision.

The default values install the server and cli in /usr/local/bin. It will also put a service control file in place. Once that finishes, the appropriate service start method will run the daemon. The install.sh script prints out the command to run and enable the service. The method described in the Quick Start can be used to deploy this way if the –isolated flag is removed from the command line. Look at the internals of the install.sh script to see what is going on.

Alternatively, the install.sh script can be provided the –isolated flag and it will setup the current directory as an isolated “test drive” environment. This will create a symbolic link from the bin directory to the local top-level directory for the appropriate OS/platform, create a set of directories for data storage and file storage, and display a command to run. This is what the Quick Start method describes.

The default username & password is rocketskates:r0cketsk8ts.

Please review –help for options like disabling services, logging or paths.

Note

sudo may be required to handle binding to the TFTP and DHCP ports.

Once running, the following endpoints are available:

The API, File Server, DHCP, and TFTP ports can be configured, but DHCP and TFTP may not function properly on non-standard ports.

If the SSL certificate is not valid, then follow the Generate Certificate steps.

Note

On MAC DARWIN there are two additional steps. First, use the --static-ip= flag to help the service understand traffic targets. Second, you may have to add a route for broadcast addresses to work. This can be done with the following comand. The 192.168.100.1 is the IP address of the interface that you want to send messages through. The install script will make suggestions for you.

sudo route add 255.255.255.255 192.168.100.1

2.5. Production Deployments

The following items should be considered for production deployments. Recommendations may be missing so operators should use their best judgement.

2.5.1. System Logs

The Digital Rebar Provision service logs by sending output to standard error. To capture system logs, SystemD (or Docker) should be configured to direct this output to the desired log management infrastructrure.

2.5.2. Job Log Rotation

If you are using the jobs system, Digital Rebar Provision stores job logs based on the directory configuration of the system. This data is considered compliance related information; consequently, the system does not automatically remove these records.

Operators should set up a job log rotation mechanism to ensure that these logs to not exhaust available disk space.