Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Commit

Permalink
suggest helm chart usage on rpc install (#554)
Browse files Browse the repository at this point in the history
  • Loading branch information
sreuland authored Aug 25, 2023
1 parent 7cb69db commit c15ebea
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion docs/reference/rpc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,43 @@ These providers host an publicly available RPC endpoint that you can connect to.
| :---------------------------- | ----------------------------------- | ----------------------------------------- |
| [SDF](http://www.stellar.org) | `https://rpc-futurenet.stellar.org` | `https://friendbot-futurenet.stellar.org` |

You can configure Soroban CLI to use this RPC endpoint:
## Deploy your own RPC instance

If you have access to Kubernetes infrastructure, there is a [soroban rpc helm chart](https://github.com/stellar/helm-charts/tree/main/charts/soroban-rpc) available. Checkout the chart locally:

<CodeExample>

```bash
$ git clone https://github.com/stellar/helm-charts; cd helm-charts
```

</CodeExample>

Edit the charts/soroban-rpc/values.yml and set the `image:sorobanRpc:tag` to a tag from the [soroban rpc dockerhub repo](https://hub.docker.com/r/stellar/soroban-rpc) for the image version you want to run. Refer to [Soroban Releases](https://soroban.stellar.org/docs/reference/releases) to find the correct tag to use for the soroban release you are running.

Deploy RPC to your kubernetes cluster using Helm cli tool:

<CodeExample>

```bash
helm-charts$ helm install --namespace my-rpc-namespace-on-cluster -f charts/soroban-rpc/values.yaml myrpc charts/soroban-rpc/
```

</CodeExample>

If kubernetes is not an option, the manifests in those charts may still be good reference for showing how to configure and run soroban rpc as docker container. Just run the helm command with `template` to print the container config to screen:

<CodeExample>

```bash
helm-charts$ helm template -f charts/soroban-rpc/values.yaml charts/soroban-rpc/
```

</CodeExample>

## Use the RPC Instance

You can configure Soroban CLI to use remote RPC endpoint:

soroban config network add --global futurenet \
--rpc-url https://rpc-futurenet.stellar.org:443 \
Expand Down

0 comments on commit c15ebea

Please sign in to comment.