celestia_node

A role to configure and deploy a celestia node in a docker container.

:warning: This project is still a work in progress: The role is still being worked on and developed. Please use with caution if you already have a node deployed or existing data that you do not want to lose.

Role Variables

Dependencies

• Debian based operating system
• Ansible 2.9 or higher
• A user with sudo access on the target host
• Docker Engine on the target host: Install manually or use an ansible role like geerlingguy.docker

  ansible-galaxy install geerlingguy.docker
  

• Python Docker module on the target host: Install manually with python3 -m pip install docker or use an ansible role like geerlingguy.pip

  ansible-galaxy install geerlingguy.pip
  

Installation

Installing the role is as simple as running the following

ansible-galaxy install ecadlabs.celestia_node

OR

ansible-galaxy install ecadlabs.celestia_node --force

Quickstart

:information_source: If you already have ansible and docker setup: start at point 2. and change the value of install_docker to false at point 4.

This quickstart guide will configure and run a light node on your local debian based operating system. The quickstart guide assumes that you do not have ansible, docker, or the docker python module installed.

1. Install ansible

   sudo apt-get update && sudo apt-get install -y python3-pip
   python3 -m pip install --user ansible
   export PATH=$PATH:$HOME/.local/bin
   

2. Clone the repository and change to the tests directory

   cd "$HOME"
   rm -rf ansible-role-celestia-node
   git clone https://github.com/ecadlabs/ansible-role-celestia-node.git
   cd ansible-role-celestia-node/tests
   

3. Install the celestia_node and supporting roles using the ansible-galaxy command.

   ansible-galaxy install --role-file ./requirements.yml --force
   

   The command will install all roles in the requirements.yml file. To make things simpler there are two supporting roles to install docker and the docker module for python.
4. Run the playbook

   ansible-playbook ./celestia-deploy.yml \
     --inventory ./inventory.yml --diff \
     --extra-vars "ansible_python_interpreter=/usr/bin/python3" \
     --extra-vars "node_store_path=$PWD/celestia-light-blockspacerace" \
     --extra-vars "node_user_id=$(id -u)" \
     --extra-vars "install_docker=true"
   

5. Check that the container is running using docker ps. The container name should be celestia-light-blockspacerace-0 and it should be running and not in a restart loop.
6. Check the container logs for more information and to make sure that the node is syncing.

   docker logs --follow --tail 100 celestia-light-blockspacerace-0
   

7. Test to make sure that you can reach the node gateway.

   curl localhost:26659/head
   

8. The playbook will create the required directories and docker volume mounts to persist the node data, keys, etc. Check that the files are available in "$PWD/celestia-light-blockspacerace-0".

:warning: There can sometimes be an issue when deploying locally where the python modules are not found. Ensure that the modules are installed for your user and that the correct ansible_python_interpreter has been set.

Example Playbooks

Using this playbook as is will not work, please adjust the variables to your needs.

- name: Celestia node
  hosts: servers
  become: true

  tasks:
    - name: Celestia full node
      ansible.builtin.include_role:
        name: ansible-role-celestia-node
  vars:
    node_keyring_backend: test
    node_keyring_accname: test_account
    node_type: full
    node_version: v0.10.0
    p2p_network: blockspacerace-0
    core_ip: https://rpc-2.celestia.nodes.guru
    node_gateway_address: 0.0.0.0
    node_gateway: true
    node_metrics: true
    node_metrics_endpoint: otel.celestia.tools:4318
    node_additional_options:
      - "--metrics.tls=false"
    node_keys_source_dir: /home/user/keys

In the example playbook we add an additional option --metrics.tls=false so that our metrics get pushed to an HTTP port and the node expects an HTTP response.

Because the keys directory is frequently backed up and used by custom keys we can also specify a source directory for these custom keys that will be copied to the target.

License

Apache License 2.0