Skip to content

Commit

Permalink
Add relayers directive syntax, add info around what the config file is (
Browse files Browse the repository at this point in the history
  • Loading branch information
Anmol1696 committed Jun 30, 2023
1 parent ea0064e commit ec150b3
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/pages/Infra/_meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"index": "Introduction",
"chains": "Chains Syntax"
"chains": "Chains Directive Syntax",
"relayers": "Relayers Directive Syntax"
}
5 changes: 4 additions & 1 deletion docs/pages/Infra/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Configuration

In Starship one can define the infra required with a simple config file. Each of the configuration directive.
In Starship one can define the infra required with a simple config file.
The config file one specifies is merged with the default [`values.yaml`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml)
file before the infra is spun up. All supported directives are present in the default `values.yaml`. We will go over most used ones here.

Here is a basic example that will spin up:
* 2 chains with 2 validators each
* Hermes relayer between them (by default will create the IBC-transfer ports and channels)
Expand Down
86 changes: 86 additions & 0 deletions docs/pages/Infra/relayers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Relayers YAML Syntax

We will go into details of the `relayers` top level directive in the Starship config file.

> Note: By default the `relayers` will open up a `transfer` port
## `name`
Name of the relayer, this is used as a unique identifier for the relayer.
```yaml
relayers:
- name: hermes-osmo-juno
...
```
## `type`
Type of the relayer to spin up. Currently we support:
* [hermes](https://github.com/informalsystems/hermes)
* [ts-relayer](https://github.com/confio/ts-relayer)

```yaml
relayers:
- name: hermes-osmo-juno
type: hermes
...
- name: ts-relayer-cosmos-juno
type: ts-relayer
...
```

## `image` (optional)
If one wants to use a specific version of the relayer we support,
then it can be mentioned via this image directive.

Supported version of relayers can be found:
* [`hermes` versions](https://github.com/cosmology-tech/starship/pkgs/container/starship%2Fhermes/versions?filters%5Bversion_type%5D=tagged)
* [`ts-relayer` versions](https://github.com/cosmology-tech/starship/pkgs/container/starship%2Fts-relayer/versions?filters%5Bversion_type%5D=tagged)

```yaml
relayers:
- name: hermes-osmo-juno
type: hermes
image: ghcr.io/cosmology-tech/starship/hermes:1.5.1
...
- name: ts-relayer-cosmos-juno
type: ts-relayer
image: ghcr.io/cosmology-tech/starship/ts-relayer:0.9.0
...
```

## `replicas`
Number of relayers to spin up. Currently we just support 1 replica for now.
```yaml
relayers:
- name: hermes-osmo-juno
type: hermes
replicas: 1
...
```

## `chains`
List of chains to connect to each other, via the Relayer.
Must be `name` of chains defined in the `chains` directive.

```yaml
chains:
- name: osmosis-1
...
- name: juno-2
...
- name: gaia-4
...
relayers:
- name: hermes-osmo-juno
type: hermes
replicas: 1
chains:
- osmosis-1
- juno-2
- name: ts-relayer-osmo-gaia
type: ts-relayer
replicas: 1
chains:
- osmosis-1
- gaia-4
```

0 comments on commit ec150b3

Please sign in to comment.