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

Commit

Permalink
Update RPC helm chart example to use published repo (#558)
Browse files Browse the repository at this point in the history
  • Loading branch information
sreuland authored Sep 1, 2023
1 parent 20b0098 commit 9901fff
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions docs/reference/rpc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,34 +120,47 @@ These providers host an publicly available RPC endpoint that you can connect to.

## 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:
If your target deployment environment includes Kubernetes infrastructure, you can utilize [soroban rpc helm chart](https://github.com/stellar/helm-charts/blob/main/charts/soroban-rpc) for an automated deployment on the cluster. Install the [Helm cli tool](https://helm.sh/docs/intro/install/), minimum of version 3 if you haven't already on your workstation. Next, add the Stellar repo to the helm client's list of repos, update it to the latest published versions, and then install, including `--devel` enables using the latest development version published of the chart:

<CodeExample>

```bash
$ git clone https://github.com/stellar/helm-charts; cd helm-charts
helm repo add stellar https://helm.stellar.org/charts
helm repo update stellar
helm install myrpc stellar/soroban-rpc \
--namespace my-rpc-namespace-on-cluster \
--set global.image.sorobanRpc.tag=0.9.2 \
--set sorobanRpc.ingress.host=myrpc.mydomain.com \
--devel
```

</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.
Set the `global.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:
This example helm chart usage accepts all defaults currently defined on [values.yaml](https://github.com/stellar/helm-charts/blob/main/charts/soroban-rpc/values.yaml) which defines network configuration specific to `futurenet`. If you want to use a different network config, you can download other network specific `values.yaml` which have been published, for example, there is the [testnet-values.yaml](https://github.com/stellar/helm-charts/blob/main/charts/soroban-rpc/testnet-values.yaml) for configuring deployment on `testnet`.

Or you can download the [values.yaml](https://github.com/stellar/helm-charts/blob/main/charts/soroban-rpc/values.yaml) and update settings under `sorobanRpc.sorobanRpcConfig` and `sorobanRpc.coreConfig` to align to the network you want. Then pass your local values.yaml to `helm install`:

<CodeExample>

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

</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:
If kubernetes is not an option, the manifests generated by the 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/
helm template myrpc stellar/soroban-rpc \
-f values.yaml \
--devel
```

</CodeExample>
Expand Down

0 comments on commit 9901fff

Please sign in to comment.