Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominodatalab/ranchhand
:cow: Create a Rancher HA installation
https://github.com/dominodatalab/ranchhand
ansible kubernetes rancher terraform
Last synced: 29 days ago
JSON representation
:cow: Create a Rancher HA installation
- Host: GitHub
- URL: https://github.com/dominodatalab/ranchhand
- Owner: dominodatalab
- License: apache-2.0
- Created: 2019-02-25T23:11:51.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-22T18:00:05.000Z (2 months ago)
- Last Synced: 2024-11-16T02:12:57.502Z (about 1 month ago)
- Topics: ansible, kubernetes, rancher, terraform
- Language: HCL
- Homepage:
- Size: 4.8 MB
- Stars: 9
- Watchers: 15
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# RanchHand
[](https://github.com/dominodatalab/ranchhand/releases/latest)
[](https://circleci.com/gh/dominodatalab/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. Ensure that the Rancher version is >= 2.6.
1. Download the [latest release][] from GitHub.
1. [Install Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (version >=2.8) locally
1. (optional) To update the Rancher default password, set the `RANCHER_PASSWORD` environment variable:
`export RANCHER_PASSWORD=`
1. (required) Configure ansible for proper output:
`export ANSIBLE_COW_SELECTION=random`
1. Execute `ansible-galaxy install -r ansible/requirements.yml` to install dependencies
1. Execute `ansible-playbook -i '1.2.4.5,...,10.20.30.40,' --private-key=~/.ssh/id_rsa --user=ubuntu ansible/prod.yml --diff --check` to perform a dry run of all the changes.
### Example
This example shows a manual run of the production playbook (prod.yml) from a local machine imaging a cluster behind a bastion/proxy server.
```
ansible-playbook -i '10.0.1.6,10.0.1.51,10.0.1.94,' --private-key=/Users/myhost/.ssh/id_rsa --user=ubuntu --ssh-common-args='-o StrictHostKeyChecking=no -o StrictHostKeyChecking=no -o ProxyCommand="ssh -o StrictHostKeyChecking=no -W %h:%p -q [email protected]"' ansible/prod.yml --diff
```
In the example above, only the bastion server, 54.190.1.95, is publicly accessible. However, including the Terraform module should be sufficient for most users.
## Terraform
Using the Terraform module, you can leverage Ranchhand to create a Rancher cluster on a specific set of nodes.
```hcl
module "ranchhand" {
source = "github.com/dominodatalab/ranchhand"
node_ips = ["..."]
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`
1. 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
```
1. Use `ansible` to launch a Ranchhand run against your VM(s) and verify your changes.
```
ansible-galaxy install -r ansible/requirements.yml
ansible-playbook -i '192.168.50.10,' \
--private-key=~/.ssh/id_rsa \
--ssh-common-args='-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null' \
--user=vagrant \
-e "cert_names=DNS:localhost" \
-e "node_count=1" \
ansible/prod.yml \
--diff
```
_Note the trailing comma (",") in the host/ip list._
### Ansible References
Here are some helpful Ansible references for getting started with Ansible.
1. [Ansible Overview](https://docs.ansible.com/ansible/latest/index.html)
1. [Installation Guide](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
1. [Project Directory Layout](https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html#content-organization)
1. [Roles](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)
1. [Best Practices](https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html#best-practices)
## Contribute
Contributions are always welcome! Please submit any questions, bugs or changes via an issue or PR. Thank you.
[vagrantfile]: test/Vagrantfile
[rke]: https://github.com/rancher/rke
[ha install]: https://rancher.com/docs/rancher/v2.x/en/installation/ha/
[hardening guide]: https://releases.rancher.com/documents/security/latest/Rancher_Hardening_Guide.pdf
[latest release]: https://github.com/dominodatalab/ranchhand/releases/latest