Skip to content

Commit 67a3637

Browse files
Update documentation
1 parent 41d92bb commit 67a3637

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -402,15 +402,15 @@ ray job submit --runtime-env ray-runtime-env.local.yml --working-dir . -- python
402402

403403
### Cluster (Helm/Kubernetes)
404404

405-
Running the Archive Query Log on a cluster is recommended for large-scale crawls. We provide a Helm chart that automatically starts crawling and parsing jobs for you and stores the results in an Elasticsearch cluster.
405+
Running the Archive Query Log on a cluster is recommended for large-scale crawls. We provide a [Helm chart](https://github.com/webis-de/archive-query-log/pkgs/container/archive-query-log%2Fcharts%2Farchive-query-log) that automatically starts crawling and parsing jobs for you and stores the results in an Elasticsearch cluster.
406406

407407
#### Installation
408408

409409
Just install [Helm](https://helm.sh/docs/intro/quickstart/) and configure `kubectl` for your cluster.
410410

411411
#### Cluster configuration
412412

413-
Crawling the Archive Query Log requires access to an Elasticsearch cluster and some S3 block storage. Configure the Elasticsearch and S3 credentials in a `values.override.yaml` file like this:
413+
Crawling the Archive Query Log requires access to an Elasticsearch cluster and some S3 block storage. Configure the Elasticsearch and S3 credentials in a `values.yaml` file like this:
414414

415415
```yaml
416416
elasticsearch:
@@ -430,11 +430,18 @@ s3:
430430
Let us deploy the Helm chart on the cluster (we are testing first with `--dry-run` to see if everything works):
431431

432432
```shell
433-
helm upgrade --install --values ./helm/values.override.yaml --dry-run archive-query-log ./helm
433+
helm install archive-query-log --values values.yaml --version X.Y.Z oci://ghcr.io/webis-de/archive-query-log/charts/archive-query-log --dry-run
434434
```
435435

436+
Replace `X.Y.Z` with the latest version of the chart, as found on [GitHub Packages](https://github.com/webis-de/archive-query-log/pkgs/container/archive-query-log%2Fcharts%2Farchive-query-log)
436437
If everything works and the output looks good, you can remove the `--dry-run` flag to actually deploy the chart.
437438

439+
To upgrade the chart, use:
440+
441+
```shell
442+
helm upgrade --install archive-query-log --values values.yaml --version X.Y.Z oci://ghcr.io/webis-de/archive-query-log/charts/archive-query-log --dry-run
443+
```
444+
438445
#### Uninstall
439446

440447
If you no longer need the chart, you can uninstall it:

0 commit comments

Comments
 (0)