ranchhand

README

RanchHand

Deploy Rancher in HA mode onto existing hardware.

Design

This tool aims to automate the steps listed in Rancher's official HA Install documentation in a reproducable manner. It also enforces many of the recommendations given inside Rancher's hardening guide.

Usage

1. Download the latest release from GitHub.
2. Execute ranchhand run -h to see all of the available options.

Terraform

Using the Terraform module, you can leverage Ranchhand to create a Rancher cluster on a specific set of nodes.

module "ranchhand" {
  source = "github.com/dominodatalab/ranchhand/terraform"

  node_ips         = ["..."]
  distro           = "darwin"
  release          = "latest"
  working_dir      = "..."
  cert_dnsnames    = ["..."]
  cert_ipaddresses = ["..."]

  ssh_username   = "..."
  ssh_key_path   = "..."
  ssh_proxy_user = "..."
  ssh_proxy_host = "..."
}

Development

Please submit any feature enhancements, bug fixes, or ideas via pull requests or issues. If you need to test local changes e2e, you can do so using Vagrant and Virtualbox. Here are the recommended steps:

1. Make sure you have Vagrant and VirtualBox installed.

   brew cask install vagrant virtualbox

2. Create one or more VMs. For convenience, a pre-configured Vagrantfile is available.

   cd test/
   NODE_COUNT=N NODE_DISTRO="ubuntu_xenial|ubuntu_bionic|centos|rhel" vagrant up
   

3. Use go to launch a Ranchhand run against your VM(s) and verify your changes.

   go run main.go run -u vagrant -i ~/.ssh/id_rsa -n 192.168.50.10,...

Contribute

Contributions are always welcome! Please submit any questions, bugs or changes via an issue or PR. Thank you.