Skip to content

Commit

Permalink
Update installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@lmangani
lmangani authored Aug 31, 2024
1 parent b23aa6e commit b5c8eee
Showing 1 changed file with 115 additions and 115 deletions.
230 changes: 115 additions & 115 deletions docs/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,121 @@ Get an instant [qryn polyglot demo](https://github.com/metrico/qryn-oss-demo) w/
?> That's it - demo logs included! Just access your stack using [qryn-view or Grafana](getting-started)


#### ** K8s **
<a id=k8s name=k8s></a>

![image](https://user-images.githubusercontent.com/1423657/184507942-cb195a16-b6d1-451a-9d80-00550f261048.png ':size=100')

## Requirements
- Kubernetes 1.19+
- Helm 3.7+

## Install Chart Repository

```bash
helm repo add qryn-helm https://metrico.github.io/qryn-helm/
helm repo update
```

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

## 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

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

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

## Common parameters

| Parameter | Value |
|----------------------------------------|---------------|
| nameOverride | "" |
| fullnameOverride | "" |
| imageCredentials | {} |
| replicas | 1 |
| service.type | ClusterIP |
| service.port | 3100 |
| podAnnotations | {} |
| podLabels | qryn |
| nodeSelector | {} |
| tolerations | [] |
| affinity | {} |
| resources.limits.cpu | 200m |
| resources.limits.memory | 256Mi |
| resources.requests.cpu | 100m |
| resources.requests.memory | 128Mi |
| autoscaling.enabled | true |
| autoscaling.minReplicas | 1 |
| autoscaling.maxReplicas | 5 |
| autoscaling.targetCPUUtilizationPercentage | 80 |
| autoscaling.targetMemoryUtilizationPercentage | 80 |
| securityContext | {} |
| ingress.enabled | false |
| ingress.className | "" |
| ingress.annotations | {} |
| ingress.hosts | [] |
| ingress.tls | [] |

## Qryn image parameters

| Environment Variable | Default | Usage |
|---------------------------------|----------------|-------------------------------------------|
| CLICKHOUSE_SERVER | localhost | Clickhouse Server address |
| CLICKHOUSE_PORT | 8123 | Clickhouse Server port |
| CLICKHOUSE_DB | qryn | Clickhouse Database Name |
| CLICKHOUSE_AUTH | default: | Clickhouse Authentication (user:password)|
| CLICKHOUSE_PROTO | http | Clickhouse Protocol (http, https) |
| CLICKHOUSE_TIMEFIELD | record_datetime| Clickhouse DateTime column for native queries|
| CLUSTER_NAME | undefined | Clickhouse Cluster name |
| BULK_MAXAGE | 2000 | Max Age for Bulk Inserts |
| BULK_MAXSIZE | 5000 | Max Size for Bulk Inserts |
| BULK_MAXCACHE | 50000 | Max Labels in Memory Cache |
| LABELS_DAYS | 7 | Max Days before Label rotation |
| SAMPLES_DAYS | 7 | Max Days before Timeseries rotation |
| HOST | 0.0.0.0 | HTTP API IP |
| PORT | 3100 | HTTP API PORT |
| QRYN_LOGIN | undefined | Basic HTTP Username |
| QRYN_PASSWORD | undefined | Basic HTTP Password |
| READONLY | false | Readonly Mode, no DB Init |
| OMIT_CREATE_TABLES | false | Omit database provisioning on startup. Dangerous.|
| FASTIFY_BODYLIMIT | 5242880 | API Maximum payload size in bytes |
| FASTIFY_REQUESTTIMEOUT | 0 | API Maximum Request Timeout in ms |
| FASTIFY_MAXREQUESTS | 0 | API Maximum Requests per socket |
| FASTIFY_METRICS | false | API /metrics exporter |
| ADVANCED_PROMETHEUS_MAX_SAMPLES | 5000000 | Max samples per a promql request |
| CORS_ALLOW_ORIGIN | * | CORS Allow Origin, default to any |
| TEMPO_SPAN | 24 | Default span for Tempo queries in hours |
| TEMPO_TAGTRACE | false | Optional tagging of TraceID (expensive) |
| DEBUG | false | Debug Mode (for backwards compatibility) |
| LOG_LEVEL | info | Log Level |
| HASH | xxhash64 | Hash function using for fingerprints. Currently supported short-hash and xxhash64 (xxhash64 function)|
| ALERTMAN_URL | false | Alertmanager API URL, i.e., http://my_alertmanager_url:1234|
| ADVANCED_SAMPLES_ORDERING | timestamp_ns | Specify the 'ORDER BY' your samples table should use (for multiple use comma-separated list fingerprint,timestamp_ns)|

## ENV Settings
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



#### ** NPM **
<a id=npm name=npm></a>

Expand Down Expand Up @@ -306,121 +421,6 @@ qryn

?> That's it! You are ready to access the stack using qryn-view or Grafana


#### ** K8s **
<a id=k8s name=k8s></a>

![image](https://user-images.githubusercontent.com/1423657/184507942-cb195a16-b6d1-451a-9d80-00550f261048.png ':size=100')

## Requirements
- Kubernetes 1.19+
- Helm 3.7+

## Install Chart Repository

```bash
helm repo add qryn-helm https://metrico.github.io/qryn-helm/
helm repo update
```

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

## 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

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

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

## Common parameters

| Parameter | Value |
|----------------------------------------|---------------|
| nameOverride | "" |
| fullnameOverride | "" |
| imageCredentials | {} |
| replicas | 1 |
| service.type | ClusterIP |
| service.port | 3100 |
| podAnnotations | {} |
| podLabels | qryn |
| nodeSelector | {} |
| tolerations | [] |
| affinity | {} |
| resources.limits.cpu | 200m |
| resources.limits.memory | 256Mi |
| resources.requests.cpu | 100m |
| resources.requests.memory | 128Mi |
| autoscaling.enabled | true |
| autoscaling.minReplicas | 1 |
| autoscaling.maxReplicas | 5 |
| autoscaling.targetCPUUtilizationPercentage | 80 |
| autoscaling.targetMemoryUtilizationPercentage | 80 |
| securityContext | {} |
| ingress.enabled | false |
| ingress.className | "" |
| ingress.annotations | {} |
| ingress.hosts | [] |
| ingress.tls | [] |

## Qryn image parameters

| Environment Variable | Default | Usage |
|---------------------------------|----------------|-------------------------------------------|
| CLICKHOUSE_SERVER | localhost | Clickhouse Server address |
| CLICKHOUSE_PORT | 8123 | Clickhouse Server port |
| CLICKHOUSE_DB | qryn | Clickhouse Database Name |
| CLICKHOUSE_AUTH | default: | Clickhouse Authentication (user:password)|
| CLICKHOUSE_PROTO | http | Clickhouse Protocol (http, https) |
| CLICKHOUSE_TIMEFIELD | record_datetime| Clickhouse DateTime column for native queries|
| CLUSTER_NAME | undefined | Clickhouse Cluster name |
| BULK_MAXAGE | 2000 | Max Age for Bulk Inserts |
| BULK_MAXSIZE | 5000 | Max Size for Bulk Inserts |
| BULK_MAXCACHE | 50000 | Max Labels in Memory Cache |
| LABELS_DAYS | 7 | Max Days before Label rotation |
| SAMPLES_DAYS | 7 | Max Days before Timeseries rotation |
| HOST | 0.0.0.0 | HTTP API IP |
| PORT | 3100 | HTTP API PORT |
| QRYN_LOGIN | undefined | Basic HTTP Username |
| QRYN_PASSWORD | undefined | Basic HTTP Password |
| READONLY | false | Readonly Mode, no DB Init |
| OMIT_CREATE_TABLES | false | Omit database provisioning on startup. Dangerous.|
| FASTIFY_BODYLIMIT | 5242880 | API Maximum payload size in bytes |
| FASTIFY_REQUESTTIMEOUT | 0 | API Maximum Request Timeout in ms |
| FASTIFY_MAXREQUESTS | 0 | API Maximum Requests per socket |
| FASTIFY_METRICS | false | API /metrics exporter |
| ADVANCED_PROMETHEUS_MAX_SAMPLES | 5000000 | Max samples per a promql request |
| CORS_ALLOW_ORIGIN | * | CORS Allow Origin, default to any |
| TEMPO_SPAN | 24 | Default span for Tempo queries in hours |
| TEMPO_TAGTRACE | false | Optional tagging of TraceID (expensive) |
| DEBUG | false | Debug Mode (for backwards compatibility) |
| LOG_LEVEL | info | Log Level |
| HASH | xxhash64 | Hash function using for fingerprints. Currently supported short-hash and xxhash64 (xxhash64 function)|
| ALERTMAN_URL | false | Alertmanager API URL, i.e., http://my_alertmanager_url:1234|
| ADVANCED_SAMPLES_ORDERING | timestamp_ns | Specify the 'ORDER BY' your samples table should use (for multiple use comma-separated list fingerprint,timestamp_ns)|

## ENV Settings
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


#### ** ECS **
<a id=aws name=aws></a>

Expand Down

0 comments on commit b5c8eee

Please sign in to comment.