Skip to content

Commit

Permalink
fix: Add missing README.md files (#11)
Browse files Browse the repository at this point in the history
* fix: Add missing README.md files

* chore: Update default hermes version
  • Loading branch information
kayano authored Sep 18, 2023
1 parent cfba78d commit d6cb4a3
Show file tree
Hide file tree
Showing 8 changed files with 114 additions and 7 deletions.
2 changes: 1 addition & 1 deletion charts/chainpulse/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ apiVersion: v2
name: chainpulse
description: A Helm chart for chainpulse
type: application
version: 0.1.0
version: 0.1.1
appVersion: 0.3.2
54 changes: 54 additions & 0 deletions charts/chainpulse/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Chainpulse

Monitoring tool for IBC relayers by Informal Systems -
[chainpulse](https://github.com/informalsystems/chainpulse)

## Prerequisites

Kubernetes 1.16+

## Get Repository Info

```console
helm repo add archway-network https://archway-network.github.io/helm-charts
helm repo update
```

_See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._

## Install Chart

```console
helm install [RELEASE_NAME] archway-network/chainpulse
```

_See [configuration](#configuration) below._

_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._

## Uninstall Chart

```console
helm uninstall [RELEASE_NAME]
```

This removes all the Kubernetes components associated with the chart and deletes the release.

_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._

## Upgrading Chart

```console
helm upgrade [RELEASE_NAME] [CHART] --install
```

_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._

## Configuration

See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:

```console
helm show values archway-network/chainpulse
```
2 changes: 1 addition & 1 deletion charts/endpoint-controller/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ apiVersion: v2
name: endpoint-controller
description: A Helm chart for Kubernetes
type: application
version: 1.0.0
version: 1.0.1
appVersion: 1.0.1
2 changes: 1 addition & 1 deletion charts/endpoint-controller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Kubernetes 1.16+
## Get Repository Info

```console
helm repo add prometheus-community https://archway-network.github.io/helm-charts
helm repo add archway-network https://archway-network.github.io/helm-charts
helm repo update
```

Expand Down
4 changes: 2 additions & 2 deletions charts/hermes-relayer/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ apiVersion: v2
name: hermes-relayer
description: A Helm chart for Kubernetes
type: application
version: 1.3.1
appVersion: 1.5.1
version: 1.3.2
appVersion: 1.6.0
2 changes: 1 addition & 1 deletion charts/hermes-relayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Kubernetes 1.16+
## Get Repository Info

```console
helm repo add arhcway-network https://archway-network.github.io/helm-charts
helm repo add archway-network https://archway-network.github.io/helm-charts
helm repo update
```

Expand Down
2 changes: 1 addition & 1 deletion charts/relayer-exporter/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ apiVersion: v2
name: relayer-exporter
description: A Helm chart for relayer_exporter
type: application
version: 0.2.1
version: 0.2.2
appVersion: 0.6.0
53 changes: 53 additions & 0 deletions charts/relayer-exporter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Relayer Exporter

Prometheus exporter for ibc metrics - [relayer_exporter](https://github.com/archway-network/relayer_exporter)

## Prerequisites

Kubernetes 1.16+

## Get Repository Info

```console
helm repo add archway-network https://archway-network.github.io/helm-charts
helm repo update
```

_See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._

## Install Chart

```console
helm install [RELEASE_NAME] archway-network/relayer-exporter
```

_See [configuration](#configuration) below._

_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._

## Uninstall Chart

```console
helm uninstall [RELEASE_NAME]
```

This removes all the Kubernetes components associated with the chart and deletes the release.

_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._

## Upgrading Chart

```console
helm upgrade [RELEASE_NAME] [CHART] --install
```

_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._

## Configuration

See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:

```console
helm show values archway-network/relayer-exporter
```

0 comments on commit d6cb4a3

Please sign in to comment.