README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: "Cardano Node Ansible role"

# Short description of this project
description: |-
  Ansible role to install Cardano binaries from source. This is a best practice guide on how to install a Cardano for people who are interested to run a professional ADA Staking Pool.


# Canonical GitHub repo
github_repo: osodevops/ansible-role-cardano-node

# How to use this project
usage: |-
    ## Requirements

    None.

    ## Role Variables

    The following variables are also availble with defaults:
    ```yaml
        ### Server settings
        #  Cardano username (cannot be 'admin' or 'root')
        server_username: cardano
        server_hostname: cardano-eu-central-1

        # Cabal
        cabal_install_version: 3.2.0.0
        cabal_base_url: "https://downloads.haskell.org"
        cabal_install_url: "{{ cabal_base_url }}/~cabal/cabal-install-{{ cabal_install_version }}/cabal-install-{{ cabal_install_version }}-x86_64-unknown-linux.tar.xz"

        # GHC
        ghc_install_version: 8.6.5
        ghc_install_url: "https://downloads.haskell.org/~ghc/{{ ghc_install_version }}/ghc-{{ ghc_install_version }}-x86_64-deb9-linux.tar.xz"

        # Libsodium
        libsodium_github_url: "https://github.com/input-output-hk/libsodium"
        libsodium_version_tag:  "66f017f1"

        # Cardano
        cardano_github_url: "https://github.com/input-output-hk/cardano-node.git"
        cardano_version: "1.14.2"
        cardano_install_dir: "/opt/cardano/cnode"
        cardano_config_dir: "{{ cardano_install_dir }}/configuration"
        cardano_scripts_dir: "{{ cardano_install_dir }}/scripts"
        cardano_default_port: "3000" # Amend if running relay and producer on same box

        # Shelly Testnet Configuration
        cardano_shelly_test_config: "https://hydra.iohk.io/build/3246637/download/1/shelley_testnet-config.json"
        cardano_shelly_test_genesis: "https://hydra.iohk.io/build/3246637/download/1/shelley_testnet-genesis.json"
        cardano_shelly_test_topology: "https://hydra.iohk.io/build/3246637/download/1/shelley_testnet-topology.json"
    ```

    ## Dependencies

    None.

# Example usage
examples: |-
    Follow this example Playbook
    ```yaml
        ---
        - hosts: all
          become: yes
          gather_facts: yes
          vars:
            # Cordano build tag
            cardano_version: "1.14.2"
          roles:
            - role: sionsmith.cardano_node
    ```

related:
  - name: "Cardano Stake pool Terraform module for AWS"
    description: "A Terraform module to deploy a HA Cardano Stake Pool on AWS"
    url: "https://github.com/osodevops/aws-terraform-module-cardano-stake-pool"

# References
references:
  - name: "Mylo Staking"
    description: 'We at OSO are supporting the decentralised movement by running our own stake pool.'
    url: "https://mylo.me"