Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): initial readme #46

Merged
merged 1 commit into from
Dec 12, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
# Ansible Collection - blinklabs.cardano

Ansible playbooks and roles to install Cardano services of various types
Ansible playbooks and roles to install Cardano services of various types. To
start, this will use Docker images for managing and orchestrating the services.

## Usage

This playbook is published to Ansible Galaxy. The best way to consume it is
using normal methods, documented under
[installing collections](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html).

Inside this collection are several roles.

- `blinklabs.cardano.cardano_db_sync`
- `blinklabs.cardano.cardano_node`
- `blinklabs.cardano.cardano_node_api`
- `blinklabs.cardano.kupo`
- `blinklabs.cardano.ogmios`
- `blinklabs.cardano.snek`
- `blinklabs.cardano.tx_submit_api`

Each role is documented independently under the roles directory.

While not explicitly required as dependencies, we recommend installing Docker
and the `docker` python module using the roles from `geerlingguy` on Galaxy.

```yaml
- name: nodePlaybook | Include geerlingguy.pip role
ansible.builtin.include_role:
name: geerlingguy.pip
apply:
tags:
- pip
vars:
pip_install_packages:
- name: docker
tags:
- always

- name: nodePlaybook | Include geerlingguy.docker role
ansible.builtin.include_role:
name: geerlingguy.docker
apply:
tags:
- docker
vars:
docker_install_compose: false
docker_apt_arch: "{{ { 'aarch64': 'arm64', 'x86_64': 'amd64' }[ansible_facts.architecture] }}"
docker_users: "{{ DOCKER_USERS | default(ansible_user) }}"
docker_daemon_options:
log-driver: "local"
tags:
- always
```
Loading