Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added reference to helm chart usage on core,horizon install #216

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
37 changes: 36 additions & 1 deletion docs/run-api-server/installing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ To install Horizon, you have a few choices. You can...
- install prebuilt binaries [from our repositories](#package-manager) via your package manager if running a Debian-based system,
- download a [prebuilt release](https://github.com/stellar/go/releases/latest) of Horizon for your target architecture and operation system, or
- [build Horizon and Stellar Core yourself](#building) from scratch.
- use [horizon helm chart](https://github.com/stellar/helm-charts/blob/main/charts/horizon/README.md) which internally uses same prebuilt binary in the runtime image.

**The first method is recommended**: Not only do you ensure OS compatibility and dependency management, you'll also install some convenient wrappers that make running Horizon and Stellar Core in their respective environments much simpler.
**prebuilt binaries method is recommended**: Not only do you ensure OS compatibility and dependency management, you'll also install some convenient wrappers that make running Horizon and Stellar Core in their respective environments much simpler.
sreuland marked this conversation as resolved.
Show resolved Hide resolved

## Installation Methods

Expand All @@ -28,6 +29,40 @@ sudo apt install stellar-horizon stellar-core

</CodeExample>

## Helm Chart Installation

If the deployment can be done on Kubernetes, there is a [horizon helm chart](https://github.com/stellar/helm-charts/blob/main/charts/horizon) available.

<CodeExample>

```bash
$ git clone https://github.com/stellar/helm-charts; cd helm-charts
sreuland marked this conversation as resolved.
Show resolved Hide resolved
```

</CodeExample>

Edit the charts/horizon/values.yml and set the `image:horizon:tag` to a tag from the [stellar/stellar-horizon repo](https://hub.docker.com/r/stellar/stellar-horizon) for the image version you want to run.

Deploy Horizon to your kubernetes cluster using Helm cli tool:

<CodeExample>

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

</CodeExample>

If kubernetes is not an option, the manifests in those charts may still be good reference for showing how to configure and run horizon 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/horizon/values.yaml charts/horizon/
```

</CodeExample>

Next, you can jump to [Testing Your Installation](#completing-and-testing-your-installation).

### Building
Expand Down
36 changes: 35 additions & 1 deletion docs/run-core-node/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Installing
sidebar_position: 30
---

There are three ways to install Stellar Core: you can use a Docker image, use pre-built packages, or build from source. Using a Docker image is the quickest and easiest method, so it's a good choice for a lot of developers, but if you're running Stellar Core in production you may need to use packages or, if you want to sacrifice convenience for maximum control, build from source. Whichever method you use, you should make sure to install the latest [release](https://github.com/stellar/stellar-core/releases) since releases are cumulative and backwards compatible.
There are multiple ways to install Stellar Core: you can use a Docker image, pre-built packages, helm-chart, or build from source. Using the Docker image is the quickest and easiest method, so it's a good choice for a lot of developers, but if you're running Stellar Core in production you should consider the helm chart or packages, if you want to sacrifice convenience for maximum control, build from source. Whichever method you use, you should make sure to install the latest [release](https://github.com/stellar/stellar-core/releases) since releases are cumulative and backwards compatible.
sreuland marked this conversation as resolved.
Show resolved Hide resolved

## Docker-based installation

Expand Down Expand Up @@ -47,6 +47,40 @@ You may choose to install these packages individually, which offers the greatest

Most people, however, choose to install the [stellar-quickstart](https://github.com/stellar/packages/blob/master/docs/quickstart.md) package which configures a **Testnet** `stellar-core` and `stellar-horizon` both backed by a local PostgreSQL database. Once installed you can easily modify either the Stellar Core configuration if you want to connect to the public network.

## Helm Chart Installation

If the deployment can be done on Kubernetes, there is a [core helm chart](https://github.com/stellar/helm-charts/blob/main/charts/core) available.

<CodeExample>

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

</CodeExample>

Edit the charts/core/values.yml and set the `image:core:tag` to a tag from the [stellar/stellar-core repo](https://hub.docker.com/r/stellar/stellar-core) for the image version you want to run.

Deploy Core to your kubernetes cluster using Helm cli tool:

<CodeExample>

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

</CodeExample>

If kubernetes is not an option, the manifests in those charts may still be good reference for showing how to configure and run core 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/core/values.yaml charts/core/
```

</CodeExample>

## Installing from source

See the [install from source](https://github.com/stellar/stellar-core/blob/master/INSTALL.md) for build instructions.
Expand Down