Digital Rebar Provision

https://docs.rackn.io/stable
Admin
Digital Rebar Provision is a flexible infrastructure automation platform for data center...
Tokens:746,539
Snippets:6,742
Trust Score:5.1
Update:7 months ago
Show doc for...
Tokens:
Raw
### Display Digital Rebar Installation Help

Source: https://docs.rackn.io/stable/getting-started

Displays the help documentation for the Digital Rebar installation script, detailing available flags and configuration options.

```bash
curl -fsSL get.rebar.digital/stable | bash -s -- --help
```

--------------------------------

### OpenShift Installer URL Template and Example (Bash)

Source: https://docs.rackn.io/stable/resources/objects/params/openshift-installer-url

This snippet shows the default URL template for downloading the OpenShift installer binary using the DRP provisioner and the 'openshift/version' parameter. It also provides a concrete example with a specific version.

```Bash
# Default format
{{.ProvisionerURL}}/files/redhat/openshift/openshift-install-linux-{{.ParamExpand "openshift/version"}}.tar.gz

# Example with version 4.20.8
https://drp.example.com/files/redhat/openshift/openshift-install-linux-4.20.8.tar.gz
```

--------------------------------

### Manage ESXi ISOs and Profiles

Source: https://docs.rackn.io/stable/operators/provisioning/os/esxi/esxi-getting-started

Commands to list existing ESXi profiles, inspect profile documentation for ISO requirements, and upload installation ISOs to the DRP endpoint.

```bash
drpcli profiles list | jq -r '.[].Name | select( . | contains("esxi9"))'
drpcli profiles show esxi-9.0-24755229 | jq -r '.Documentation'
drpcli isos upload VMware-VMvisor-Installer-9.0.0.0.24755229.x86_64.iso
```

--------------------------------

### Assign Machine Parameters and Deploy

Source: https://docs.rackn.io/stable/operators/provisioning/os/esxi/esxi-getting-started

Configures machine-specific parameters and applies profiles to initiate the automated ESXi 9 installation workflow.

```bash
drpcli machines addprofile Name:esxi-node1 universal-application-esxi9-install
drpcli machines addprofile Name:esxi-node1 esxi9-config
drpcli machines addprofile Name:esxi-node1 esxi9-machine1-settings
drpcli machines workflow Name:esxi-node1 universal-discover
```

--------------------------------

### Install Digital Rebar Platform

Source: https://docs.rackn.io/stable/getting-started

Downloads and installs the stable version of Digital Rebar with universal workflows. This script verifies system prerequisites and sets up the necessary directory structures.

```bash
curl -fsSL get.rebar.digital/stable | bash -s -- install --universal
```

--------------------------------

### Install DRP using install.sh Script (Bash)

Source: https://docs.rackn.io/stable/getting-started/install/install

This command downloads and executes the install.sh script to perform a universal installation of DRP. It's a quick way to get started with a production-ready setup.

```bash
curl -fsSL get.rebar.digital/stable | bash -s -- install --universal

```

--------------------------------

### Start Linux Install Workflow (Bash)

Source: https://docs.rackn.io/stable/resources/kb/kb-00061

Initiates the 'universal-linux-install' workflow on a specified machine. This command starts the automated OS installation process defined by the associated Universal Application profile. It can target machines by name or UUID.

```Bash
# you can select machines by Name:[NAME] or replace it with the Machines UUID value
drpcli machines workflow Name:mach-01.example.org universal-linux-install
```

--------------------------------

### Install KVM and Libvirt dependencies on CentOS

Source: https://docs.rackn.io/stable/getting-started/envs/kvm

Installs necessary virtualization packages including qemu-kvm, libvirt, and associated tools required for managing KVM guests on a CentOS host.

```text
yum makecache
yum install qemu-kvm libvirt libvirt-python libguestfs-tools bridge-utils iptables iptables-services util-linux unbound curl wget jq
```

--------------------------------

### Kernel Network Options Example

Source: https://docs.rackn.io/stable/operators/deployment/contents/vmware

This example demonstrates how to pass network configuration values directly to the kernel at initial load time using the `kernel-options` parameter. These settings are crucial for the initial boot process, especially when the provisioning network is isolated from the initial DHCP/PXE services.

```bash
ip=10.10.10.10 netmask=255.255.255.0 gateway=10.10.10.1 vlan=10
```

--------------------------------

### Install VMware Plugin

Source: https://docs.rackn.io/stable/operators/provisioning/os/esxi/esxi-getting-started

Installs the necessary VMware plugin for Digital Rebar to manage ESXi resources.

```bash
drpcli catalog item install vmware
```

--------------------------------

### Example: Passing Container Runtime Startup Flags (Array of Strings)

Source: https://docs.rackn.io/stable/resources/objects/params/docker-context-startup-options

This example demonstrates how to pass startup flags to the container runtime. The parameter expects a direct array of strings, where each string is a separate argument or a quoted argument. For instance, to pass `--foo bar --baz "a b"`, the value should be `["--foo", "bar", "--baz", "a b"]`. The default value is an empty array.

```json
["--foo", "bar", "--baz", "a b"]
```

--------------------------------

### Verify ESXi Agent Context

Source: https://docs.rackn.io/stable/operators/provisioning/os/esxi/esxi-getting-started

Validates that the required Docker context for ESXi installation is present and the image file exists on the DRP endpoint.

```bash
drpcli contexts list | jq -r '.[] | select (.Name == "esxi-agent-runner")' | jq .Image
drpcli files list contexts/docker-context/ | grep <image-tag>
```

--------------------------------

### Start Backstage Development Server

Source: https://docs.rackn.io/stable/operators/integrations/backstage

Command to initialize the Backstage development environment to test and register the newly created templates.

```bash
yarn dev
```

--------------------------------

### Example Provisioning Template Endpoints

Source: https://docs.rackn.io/stable/resources/kb/kb-00031

A collection of example URLs for different operating systems, demonstrating the structure for accessing seed, autoinstall, and kickstart files.

```text
# ubuntu/debian
http://10.10.10.10:8091/machines/7f65279a-7e5c-4e69-af40-dd01af4c5667/seed

# ubuntu 20.04 and newer
http://10.10.10.10:8091/machines/7f65279a-7e5c-4e69-af40-dd01af4c5667/autoinstall/user-data

# centos/redhat
http://10.10.10.10:8091/machines/7f65279a-7e5c-4e69-af40-dd01af4c5667/compute.ks
```

--------------------------------

### Define BootEnv and Configuration Profiles

Source: https://docs.rackn.io/stable/operators/provisioning/os/esxi/esxi-getting-started

YAML definitions for custom BootEnv overrides and system configuration profiles. These define installation parameters like disk options, serial console settings, and shell access.

```yaml
Name: esxi-9.0-24755229-custom
Description: Custom ESXi 9.0 BootEnv override
Params:
  bootenv-customize:
    esxi9-install:
      OS:
        Name: esxi-9.0-24755229-custom
        SupportedArchitectures:
          amd64:
            IsoFile: VMware-VMvisor-Installer-9.0.0.0.24755229.x86_64.iso
            Sha256: 5d83e96c16f901cd59fd7d8c8c7c46000e11326eb11f9d1a42f5cfb36c1fc2b9
        Version: "900"

---

Name: esxi9-config
Params:
  esxi/disk-install-options: --firstdisk --overwritevmfs
  esxi/serial-console: gdbPort=none logPort=none tty2Port=com1
  esxi/shell-local: true
  esxi/shell-remote: true
  esxi/skip-notify: false
  esxi/skip-reboot: false
  esxi/skip-tools: true
```

--------------------------------

### Example Generated Kickstart File Structure

Source: https://docs.rackn.io/stable/operators/deployment/contents/vmware

This text output represents a sample Kickstart file generated by Digital Rebar Provision, incorporating default statements, network configuration, custom kickstart directives, stock sections, and user-defined %pre, %post, and %firstboot scripts.

```text
# DRP provided kickstart opening statements
<template default statements go here>

# DRP provided network configuration template
<esxi-network-ks.tmpl>

# example "kickstart" customization template
<my-kickstart-chunk1.ks.tmpl>

# DRP provided kickstart template pre/post/firstboot "stock" sections
<esxi-notify-drp-py3.tmpl>
<esxi-preserve-logs.tmpl>
<esxi-enable-shells.tmpl>

# example custom sections to add
# firstboot-busybox
%pre --interpreter=busybox
<my-firstboot-busybox-chunk1.ks.tmpl>

# post-python
%pre --interpreter=python
<my-post-python3-chunk2.ks.tmpl>

# pre-busybox
%pre --interpreter=busybox
<my-pre-busybox-chunk1.ks.tmpl>
<my-pre-busybox-chunk2.ks.tmpl>

```

--------------------------------

### NTP Configuration Template Example

Source: https://docs.rackn.io/stable/operators/deployment/contents/vmware

This example shows a basic NTP configuration template. It restricts access and allows specifying NTP servers using the `ntp-servers` parameter. This template can be customized and used with the `esxi-ntp-conf` parameter to override default NTP settings.

```go-template
restrict default kod nomodify notrap noquerynopeer
restrict 127.0.0.1
{{range $key, $ntp := .Param "ntp-servers" -}}
server {{ $ntp }} iburst
{{end -}}

```

--------------------------------

### Install oc-mirror Plugin for Image Mirroring

Source: https://docs.rackn.io/stable/operators/provisioning/application/openshift/advanced-features/airgapped-install

This snippet guides you through downloading and installing the `oc-mirror` plugin, a tool used for mirroring OpenShift images to your private registry. It fetches the plugin from Red Hat's latest client releases and places it in the system's PATH.

```Bash
# Get the oc-mirror plugin
curl -O https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/oc-mirror.tar.gz
tar -xvf oc-mirror.tar.gz
sudo mv oc-mirror /usr/local/bin/
```

--------------------------------

### Basic drpcli Command Examples

Source: https://docs.rackn.io/stable/operators/deployment/cli

Demonstrates fundamental drpcli commands for interacting with Digital Rebar Provision. These examples show how to list boot environments, retrieve subnet information, and set preferences.

```bash
drpcli bootenvs list

```

```bash
drpcli subnets get mysubnet

```

```bash
drpcli preferences set defaultBootEnv discovery

```

--------------------------------

### Deploy and Test Application on OpenShift (Bash)

Source: https://docs.rackn.io/stable/operators/deployment/contents/openshift

This script demonstrates how to deploy a simple test application ('hello-openshift') to an OpenShift cluster and then test its accessibility. It uses `oc` and `kubectl` commands to create a project, deployment, and expose the service.

```Bash
# Create a new project
oc new-project hello-openshift

# Create the deployment
kubectl create deployment hello-node --image=registry.k8s.io/e2e-test-images/agnhost:2.43 -- /agnhost serve-hostname

# Expose the service
oc expose deployment hello-node --port=9376
oc expose service hello-node

# Test the deployment
curl hello-node-hello-openshift.apps.demo.k8s.local
```

--------------------------------

### Add XFS Tools for Image Deployment

Source: https://docs.rackn.io/stable/resources/kb/kb-00058

This example demonstrates how to include the `xfsprogs` package when building an image using the `image-builder/additional-packages` parameter. This is crucial for ensuring that the deployed system has the necessary tools to handle XFS filesystems.

```json
"image-builder/additional-packages": [
  "xfsprogs"
]
```

--------------------------------

### Manual Digital Rebar Installation via CLI

Source: https://docs.rackn.io/stable/getting-started/install/install-cloud

This script automates the installation of Digital Rebar on a Linux instance. It retrieves the public IP address from cloud metadata services and executes the universal installation script.

```bash
#!/usr/bin/env bash
# AWS specific API call
value=$(curl -sfL http://169.254.169.254/latest/meta-data/public-ipv4)
# Google: value=$(curl -sfL -H "Metadata-Flavor: Google" http://metadata/computeMetadata/v1/instance/network-interfaces/0/access-configs/0/external-ip)
# Azure: value=$(curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/network/interface/0/ipv4/ipAddress/0/publicIpAddress?api-version=2021-05-01&format=text")
# Digital Ocean: value=$(curl -sfL http://169.254.169.254/metadata/v1/interfaces/public/0/ipv4/address)
curl -fsSL get.rebar.digital/stable | sudo bash -s -- install --universal --version=tip --ipaddr=$value
```

--------------------------------

### Alternative OS Installation (Alma Linux 9) - YAML

Source: https://docs.rackn.io/stable/resources/objects/params/apache-base-install-os

Specifies an alternative operating system installation pipeline for Apache nodes using Alma Linux 9. This example uses the 'alma-9-min-install' profile for a minimal installation.

```yaml
apache/base-install-os: alma-9-min-install
```

--------------------------------

### RHSM Additional Options Example

Source: https://docs.rackn.io/stable/resources/objects/params/redhat-rhsm-additional

Provides an example of how to specify additional Red Hat Subscription Network (RHSM) options within a kickstart configuration. These options are free-form command-line arguments used to supplement organization and activation details during system registration.

```text
--connect-to-insights --proxy=https://proxy.local:8080
```

--------------------------------

### Install Digital Rebar Platform

Source: https://docs.rackn.io/stable/getting-started/envs/kvm

Downloads and executes the Digital Rebar installation script in production mode to set up the DRP endpoint.

```bash
curl -s get.rebar.digital/stable | bash -s -- install --universal
```

--------------------------------

### Install Digital Rebar with Azure Public IP

Source: https://docs.rackn.io/stable/resources/labs/1000

This script installs Digital Rebar on an Azure instance, obtaining the public IP address from the instance metadata. It's suitable for automated setups within Azure.

```sh
value=$(curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/network/interface/0/ipv4/ipAddress/0/publicIpAddress?api-version=2021-05-01&format=text")
# install Digital Rebar
curl -fsSL get.rebar.digital/stable | sudo bash -s -- install --universal --ipaddr=$value
```

--------------------------------

### Install KVM-Test Plugin and EFI Firmware

Source: https://docs.rackn.io/stable/getting-started/envs/kvm

Installs the kvm-test plugin via the DRP CLI and extracts required EFI firmware artifacts for virtual machine UEFI support.

```bash
drpcli catalog item install kvm-test
wget https://s3-us-west-2.amazonaws.com/get.rebar.digital/artifacts/fw.tar.gz -O /tmp/fw.tar.gz
cd /
tar -xzvf /tmp/fw.tar.gz
```

--------------------------------

### Start, Stop, and Console Operations for VMs

Source: https://docs.rackn.io/stable/operators/deployment/contents/openshift-cluster-ocpv

Demonstrates using the `virtctl` command-line tool to manage the lifecycle of a virtual machine. It includes starting a VM, stopping a VM with a merge strategy, and connecting to a VM's console for interactive access.

```bash
virtctl start vm-simple -n vm-workloads
virtctl stop  vm-simple -n vm-workloads -p '{"spec":{"running":false}}' --type=merge
virtctl console vm-simple -n vm-workloads
```

--------------------------------

### Create Virtual Machine with virt-install

Source: https://docs.rackn.io/stable/getting-started/envs/kvm

This command provisions a new virtual machine using the virt-install utility. It configures hardware specifications, disk images, and network settings to enable PXE booting for Sledgehammer discovery.

```bash
virt-install \
   --name=winders --ram=4096 --cpu host --hvm --vcpus=2 \
   --os-type=windows --os-variant=win10 \
   --disk /var/lib/libvirt/images/winders.qcow2,size=80,bus=virtio \
   --pxe --network bridge=kvm-test,model=virtio \
   --graphics vnc,listen=127.0.0.1,password=foobar --check all=off &
```

--------------------------------

### Remove Installed DRP (Bash)

Source: https://docs.rackn.io/stable/home/esg

This command removes an installed Digital Rebar Provision (DRP) instance using a curl script. It's used to uninstall the DRP environment from the system.

```bash
curl -fssl get.rebar.digital/stable | bash -s -- remove #
```

--------------------------------

### Setup Golang and Build Plugin (Bash)

Source: https://docs.rackn.io/stable/developers/plugins/plugin

This snippet demonstrates setting up Golang on an Alma 9 system, fetching the Digital Rebar Provision plugins source code, and compiling a specific plugin (cmds/ipmi). It includes steps for installation, environment variable configuration, and verification.

```bash
sudo yum -y install git
mkdir $HOME/go
wget https://dl.google.com/go/go1.23.2.linux-amd64.tar.gz
tar -xzvf go1.23.2.linux-amd64.tar.gz
sudo mv go /usr/local/
export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export PATH=$GOPATH/bin:$GOROOT/bin:$PATH

go version

mkdir -p "$HOME/src/rackn"
cd "$HOME/src/rackn"
git clone https://gitlab.com/rackn/provision-plugins
cd provision-plugins
git checkout v4

tools/build-one.sh cmds/ipmi
```

--------------------------------

### OpenShift Root Device Hints JSON Example

Source: https://docs.rackn.io/stable/resources/objects/params/openshift-install-rootDeviceHints

This snippet shows an example of the JSON structure used to define root device hints for OpenShift node installations. It specifies the model of the boot controller.

```json
{
  "model": "HPE NS204i-u Gen11 Boot Controller"
}
```

--------------------------------

### Configure Custom Kickstart Sections with YAML

Source: https://docs.rackn.io/stable/operators/deployment/contents/vmware

This YAML configuration demonstrates how to specify custom Kickstart sections for ESXi installations using the 'esxi/ks-custom-sections' parameter. It lists templates to be injected into the %pre, %post, and %firstboot phases.

```yaml
- "pre-busybox"
  - "my-pre-busybox-chunk1.ks.tmpl"
  - "my-pre-busybox-chunk2.ks.tmpl"
- "post-python"
  - "my-post-python3-chunk2.ks.tmpl"
- "firstboot-busybox"
  - "my-fistboot-busybox-chunk1.ks.tmpl"

```

--------------------------------

### Configure Internal Alert Management

Source: https://docs.rackn.io/stable/operators/provisioning/application/openshift/monitoring

AlertmanagerConfig setup for routing alerts to an internal webhook endpoint.

```yaml
apiVersion: monitoring.coreos.com/v1
kind: AlertmanagerConfig
metadata:
  name: internal-alerts
spec:
  route:
    receiver: internal-webhook
  receivers:
  - name: internal-webhook
    webhookConfigs:
    - url: "http://internal-alert-manager.example.com/webhook"
```

--------------------------------

### Install and Configure drpcli

Source: https://docs.rackn.io/stable/developers/automation/contents/convert-to-bundle

Provides steps to install the `drpcli` command-line tool if it's not found in the system's PATH. It involves downloading the binary, making it executable, and moving it to a standard location.

```Bash
which drpcli
# If not found:
curl -fsSL https://rackn-sledgehammer.s3.amazonaws.com/drpcli -o drpcli
chmod +x drpcli
sudo mv drpcli /usr/local/bin/

```

--------------------------------

### Install HAProxy using Universal Application Workflow (YAML)

Source: https://docs.rackn.io/stable/resources/objects/blueprints/haproxy-install

This snippet demonstrates how to integrate the haproxy-install blueprint into a universal-application workflow using YAML. It's typically used during initial system setup or can be run independently.

```yaml
universal/runbook-during-flexiflow:
  - haproxy-install
```
Tokens:
Raw