Skip to content

Commit

Permalink
Update installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lmangani authored Aug 31, 2024
1 parent a6d476a commit f57b3aa
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,15 @@ Get an instant [qryn polyglot demo](https://github.com/metrico/qryn-oss-demo) w/

![image](https://github.com/user-attachments/assets/9d041e13-9b2a-4f03-89bb-f9e208525e7e ':size=400')

Get started in seconds using **qryn** with Docker - _batteries included!_

Each _qryn_ release is automatically pushed to [docker hub](https://hub.docker.com/r/qxip/qryn/tags) and [ghcr](ghcr.io/metrico/qryn:latest)

## Requirements
### Requirements
- Kubernetes 1.19+
- Helm 3.7+

## Install Chart Repository
### Install Chart Repository

```bash
helm repo add qryn-helm https://metrico.github.io/qryn-helm/
Expand All @@ -127,29 +130,29 @@ helm repo update

See [helm repository](https://helm.sh/docs/helm/helm_repo/) for command documentation.

## Install Chart
### Install Chart
To deploy [qryn](https://github.com/metrico/qryn) using this Helm chart, use the following command:

```bash
helm repo add qryn-helm https://metrico.github.io/qryn-helm/
helm install [RELEASE_NAME] qryn-helm/qryn-helm --version 0.1.1
```

## Documentation
#### Documentation

See [helm install](https://helm.sh/docs/helm/helm_install/) for further documentation.

For customization, you can provide a `values.yaml` file or use `--set` flags to override specific configurations during installation.

Feel free to modify the configurations based on your requirements and environment.

## Global parameters
### Global parameters

| Parameter | Value |
|--------------------------|---------------|
| kubernetesClusterDomain | cluster.local |

## Common parameters
## global parameters

| Parameter | Value |
|----------------------------------------|---------------|
Expand Down Expand Up @@ -180,7 +183,7 @@ Feel free to modify the configurations based on your requirements and environmen
| ingress.hosts | [] |
| ingress.tls | [] |

## Qryn image parameters
### qryn container parameters

| Environment Variable | Default | Usage |
|---------------------------------|----------------|-------------------------------------------|
Expand Down Expand Up @@ -220,7 +223,7 @@ Feel free to modify the configurations based on your requirements and environmen
For more information about qryn environment variables, visit [qryn Environments](https://qryn.metrico.in/#/env).


?> That's it - demo logs included! Just access your stack using qryn-view or Grafana
?> That's it - you're ready to run qryn in Kubernetes! Access your stack using qryn-view or Grafana



Expand Down

0 comments on commit f57b3aa

Please sign in to comment.