Skip to content

Commit

Permalink
add ingress part in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Anmol1696 committed Jan 10, 2024
1 parent 5dcc918 commit 9369ec4
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/pages/config/features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,35 @@ Available versions for the explorer can be found [here](https://github.com/cosmo
### Usage

After performing `port-forward`, open explorer at: http://localhost:8080

## Ingress
In order to get external traffic into Starship, one can use the `ingress` directive to
create ingress rules on the domain.

> NOTE: Prerequists include installing `cert-issuer` and `nginx-ingress` controller in the k8s cluster.
Domain specified, needs to be pointing to the k8s cluster in which Starship is deployed

### Syntax
```yaml
ingress:
enabled: true
type: nginx
# host must be a wildcard entry, so that we can use the wildcard to create
# service specific ingress rules.
host: "*.thestarship.io"
certManager:
issuer: "cert-issuer"
```

Above will create following endpoints with the domain, and valid certs:
* Explorer at: `https://explorere.<host>` (if enabled)
* Registry at: `https://registry.<host>` (if enabled)
* Chains at:
* RPC endpoint: `https://rpc.<chain-id>-genesis.<host>`
* Rest endpoint: `https://rest.<chain-id>-genesis.<host>`
* Chain exposer: `https://rest.<chain-id>-genesis.<host>/exposer`
* Chain faucet: `https://rest.<chain-id>-genesis.<host>/faucet`
* Relayers at:
* Rest endpoint: `https://rest.<relayer-type>-<relayer-name>.<host>`
* Exposer endpoint: `https://rest.<relayer-type>-<relayer-name>.<host>/exposer`

0 comments on commit 9369ec4

Please sign in to comment.