Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 3.59 KB

README.md

File metadata and controls

88 lines (59 loc) · 3.59 KB
Raw

Ansible project for installing RunOnFlux nodes

commit frequency

This Ansible project aims to replace the current Bash script used for installing RunOnFlux nodes with a more efficient and effective method using Ansible.

Requirements

  • Ansible (version >= v2.14.3)
  • Python (version >= v3.10.6)
  • Ubuntu (version >= v22.04)
    • You may need Ubuntu 22.04 or later to install Ansible v2.14.3 or later.

Prerequisites

1. Ansible Galaxy Modules

You will need to run the following command to install the Ansible Galaxy modules used in this project:

ansible-galaxy install -r requirements.yml

2. user.yml file with filled in variables

You will need to create a user.yml file with the variables filled in. You can use the user.yml file as a template.

If you are not using an optional variable, please remove the line from the user.yml file. Do not leave a blank variable definition.

If you want to use the script to generate a user.yml file for you, you can run the following command:

./scripts/setup.sh

This will generate a user.yml file that you will need to move to the root of the project.

mv ./scripts/user.yml user.yml -f

Usage

  1. Clone this repository onto the Ansible control node.
  2. Create an inventory file with the IP addresses of the nodes you want to install RunOnFlux onto.
  3. Run the ansible-playbook command passing in the inventory file and the playbook file.
ansible-playbook flux.yml

Playbook Contents

  • vars: contains variables such as package names and version numbers needed to install RunOnFlux.
  • tasks: contains the tasks needed to install and configure RunOnFlux.
  • handlers: contains handlers for when certain tasks are executed.
  • templates: contains configuration files necessary for RunOnFlux.

Getting Started

See the Getting Started guide for more information on how to get started with this project.

Contributing

Please read CONTRIBUTING.md for details and the processes for submitting pull requests to us.

Code of Conduct

Please read CODE_OF_CONDUCT.md for details on our code of conduct. By participating in this GitHub repository, you are agreeing to abide by this code of conduct.

Authors

License

This project is licensed under the MIT License.