Skip to content

Commit aec6bc6

Browse files
committed
fix readme
1 parent 9f8017e commit aec6bc6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ If you are familiar with Ansible, you can just re-use the modules in the way
2222
that fits you best. Otherwise follow these steps:
2323

2424
- Fill in `inventory.yml` and place the hostnames of your nodes under the `[ipfs]` and `[ipfs-cluster]` groups.
25-
- Edit the `group_vars/ipfs.yml` and `group_vars/ipfs_cluster.yml` files setting the right configuration values including generating an [IPFS Cluster secret](https://cluster.ipfs.io/documentation/guides/security/#the-cluster-secret) with `od -vN 32 -An -tx1 /dev/urandom | tr -d ' \n' ; echo`
26-
- Add a file for each hostname (filename is the hostname), to the `host_vars` folder as outlined in [`Host Vars`](#host-vars), containing the necessary host-specific variables (example in the `molecule/default/molecule.yml` file).
25+
- Create `group_vars/ipfs.yml` and `group_vars/ipfs_cluster.yml` files setting the right configuration values including generating an [IPFS Cluster secret](https://cluster.ipfs.io/documentation/guides/security/#the-cluster-secret) with `od -vN 32 -An -tx1 /dev/urandom | tr -d ' \n' ; echo`. More details in the [Group Vars](#group-vars) section.
26+
- Add a file for each hostname (filename is the hostname), to the `host_vars` folder as outlined in [Host Vars](#host-vars), containing the necessary host-specific variables (example in the `molecule/default/molecule.yml` file).
2727

2828
Upon successful execution, both `go-ipfs` and `ipfs-cluster` should be running in the nodes (they are installed under `/usr/local/bin` and run by a created `ipfs` system user).
2929

@@ -95,13 +95,13 @@ You can also define `ipfs_cluster_peername` to name your cluster peer for convin
9595
9696
The `group_vars` file can be used to set variables to control the common configuration for of all ipfs and ipfs-cluster peers.
9797
98-
Edit the `ipfs.yml` file in this folder and set the appropiate values for the variables.
98+
Create `ipfs.yml` and `ipfs-cluster.yml` files in this folder and set the appropiate values for the variables.
9999
100100
Note the cluster `service.json` template can be fully customized by defining the appropiate variables, and otherwise they will take sensisble defaults.
101101
102102
## Running the tests
103103
104-
Assumes you have a working molecule setup with docker, running `molecule test` should spin up a docker container and execute the test playbook declared in `molecule/default/converge.yml`.
104+
Assumes you have a working molecule setup with docker, running `molecule test` should spin up a docker container and execute the test playbook declared in `molecule/default/converge.yml` as well as the verifications in `molecule/default/verify.yml`
105105
106106
```console
107107
python 3 -m molecule test

0 commit comments

Comments
 (0)