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

docs: include new prerequisites section #119

Merged
merged 1 commit into from
Aug 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
# hedera-the-graph
<div align="center">

# Hedera The Graph

</div>

Tools for hosting a graph node for the Hedera community.

### hedera-the-graph helm chart
## Prerequisites

- [`helm`](https://helm.sh/)
- [`kubectl`](https://kubernetes.io/docs/reference/kubectl/)

Also it is recommended to get familiar with `graphman` CLI to manipulate Graph Node instances.
See <https://thegraph.com/docs/en/operating-graph-node> for more information.

## `hedera-the-graph` Helm chart

This project contains an umbrella helm charts that can be used to deploy an Hedera optimized graph node to a Kubernetes cluster with all the necessary architecture and configuration.
For more information see the [Hedera-The-Graph Chart Documentation](https://github.com/hashgraph/hedera-the-graph/tree/main/charts/hedera-the-graph)

Expand All @@ -13,27 +27,31 @@ All features should see a feature branch created and a PR taking the changes fro
Periodically, release branches e.g. `release/0.1` will be created.

## Helm Charts

This repo contains a `charts` directory that contains the various charts that are used to deploy the Hedera-The-Graph node to a Kubernetes cluster. To get started first install the helm repo:
```

```sh
helm repo add hedera-the-graph https://hashgraph.github.io/hedera-the-graph/charts
helm repo update
```

Then you can install the chart with the following command:
```

```sh
helm install [RELEASE_NAME] hedera-the-graph/[CHART_NAME] -f [VALUES_FILE]
```

**CHART_NAME** is the name of the chart you want to install. The available charts are:
**CHART_NAME** is the name of the chart you want to install.
The available charts are:

- **hedera-the-graph:** An umbrella chart that installs all the necessary components to run the Hedera-The-Graph node. More information [here](https://github.com/hashgraph/hedera-the-graph/tree/main/charts/hedera-the-graph)
- **hedera-the-graph-node:** An optimized graph node for the Hedera network.
- **hedera-the-graph-auth-layer:** An umbrella chart that installs both the `auth-layer-proxy` and the `auth-layer-server`. More information [here](https://github.com/hashgraph/hedera-the-graph/tree/main/charts/hedera-the-graph-auth-layer)
- **hedera-the-graph-auth-layer:** An umbrella chart that installs both the `auth-layer-proxy` and the `auth-layer-server`. More information [here](https://github.com/hashgraph/hedera-the-graph/tree/main/charts/hedera-the-graph-auth-layer)
- **auth-layer-proxy:** An EnvoyProxy that acts as a reverse proxy that forwards requests to the configured index node, and also verifies the JWT token using the configured authentication server. More informoation: [here](https://github.com/hashgraph/hedera-the-graph/tree/main/charts/auth-layer-proxy)
- **auth-layer-server:** A KeyCloak server that is pre-configured to work with the `auth-layer-proxy` to generate and verify JWT tokens used for protecting the index node. More information [here](https://github.com/hashgraph/hedera-the-graph/tree/main/charts/auth-layer-server)

**VALUES_FILE** is the path to the values file that you want to use to configure the chart. The values file should be a yaml file that contains the configuration for the chart. The available configuration options for each chart can be found in the chart's README file of the respective chart, linked above.


## Support

If you have a question on how to use the product, please see our
Expand All @@ -56,6 +74,7 @@ to [[email protected]](mailto:[email protected]).

[Apache License 2.0](LICENSE)

# 🔐 Security
## 🔐 Security

Please do not file a public ticket mentioning the vulnerability. Refer to the security policy defined in the [SECURITY.md](https://github.com/hashgraph/hedera-sourcify/blob/main/SECURITY.md).
Please do not file a public ticket mentioning the vulnerability.
Refer to the security policy defined in the [SECURITY.md](https://github.com/hashgraph/hedera-sourcify/blob/main/SECURITY.md).
Loading