diff --git a/docs/pages/config/features.mdx b/docs/pages/config/features.mdx index d36ad1ba..c5385203 100644 --- a/docs/pages/config/features.mdx +++ b/docs/pages/config/features.mdx @@ -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.` (if enabled) +* Registry at: `https://registry.` (if enabled) +* Chains at: + * RPC endpoint: `https://rpc.-genesis.` + * Rest endpoint: `https://rest.-genesis.` + * Chain exposer: `https://rest.-genesis./exposer` + * Chain faucet: `https://rest.-genesis./faucet` +* Relayers at: + * Rest endpoint: `https://rest.-.` + * Exposer endpoint: `https://rest.-./exposer` +