Skip to content

Commit

Permalink
Correction to example usage of the data-access harvester CLI for co…
Browse files Browse the repository at this point in the history
…nfig override
  • Loading branch information
rconway committed Apr 8, 2024
1 parent f1a68bf commit f0aefd5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
11 changes: 8 additions & 3 deletions docs/eoepca/data-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,13 +395,18 @@ The harvester can either do one-off harvests via the CLI or listen on a redis qu
##### One-off harvests via the CLI

In order to start a harvest from the CLI, the operator first needs to connect to the kubernetes pod of the harvester. Within that pod, the harvest can be executed like this...

```bash
python3 -m harvester harvest --config-file /config-run.yaml Sentinel2
```

This will invoke the `Sentinel2` harvester with default arguments. When some values are to be overridden, the --values switch can be used to pass override values. These values must be a JSON string. The following example adjusts the begin and end times of the query parameters...
This will invoke the `Sentinel2` harvester with default arguments. When some values are to be overridden, the `-co` or `--config-override` switch can be used to pass override values - using the same yaml paths as per the config file.<br>
The following example adjusts the begin and end times of the query parameters...

```bash
python3 -m harvester harvest --config-file /config-run.yaml Sentinel2 --values '{"resource": {"query": {"time": {"begin": "2020-09-10T00:00:00Z", "end": "2020-09-11T00:00:00Z"}}}}'
python3 -m harvester harvest --config-file /config-run.yaml Sentinel2 \
-co harvesters.Sentinel2.resource.opensearch.query.time.begin=2020-09-10T00:00:00Z \
-co harvesters.Sentinel2.resource.opensearch.query.time.end=2020-09-11T00:00:00Z
```

##### Harvests via the harvest daemon
Expand Down Expand Up @@ -616,7 +621,7 @@ At deployment time the `harvester` helm values include configuration that popula
The Data Access and Resource Catalogue services are configured to properly interpret harvested data via these values specified in the instantiation of the helm release. See section [Data-layer Configuration](#data-layer-configuration).

The harvesting of data can be triggered (post deployment), in accordance with this default configuration, by connecting to the `rm/harvester` service and executing the command...
```
```bash
python3 -m harvester harvest --config-file /config-run.yaml Sentinel2
```

Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

The following provides a summary of changes since the last release (v1.4)...

* **08/04/2023** - Correction to example usage of the data-access `harvester` CLI - in particular use of `-co, --config-override` for values override
* **03/04/2024** - Update Identity Gatekeeper to chart version `1.0.12` with an alternative approach to establishing 'open' access to select request paths (e.g. for docs etc.), to simplify proxying to the backend resource server.
* **03/04/2024** - Update Data Access to chart `1.4.1` to introduce variables to remedy hard-coded harvester values for access to Creodias eodata. Ref. - `CREODIAS_EODATA_S3_ENDPOINT`, `CREODIAS_EODATA_S3_ACCESS_KEY`, `CREODIAS_EODATA_S3_ACCESS_SECRET` and `CREODIAS_EODATA_S3_REGION`.
* **20/03/2024** - Correction to chart path for helm deployment of `eoepca-portal`
Expand Down
3 changes: 2 additions & 1 deletion docs/quickstart/creodias-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Once the file `creodias-options` has been well populated for your environment, t
## Harvest CREODIAS Data

The harvester can be [deployed with a default configuration](../eoepca/data-access.md#harvester-helm-configuration) file at `/config.yaml`. As described in the [Data Access section](../eoepca/data-access.md#starting-the-harvester), harvesting according to this configuration can be triggered with...
```

```bash
kubectl -n rm exec -it deployment.apps/data-access-harvester -- python3 -m harvester harvest --config-file /config.yaml Sentinel2
```

Expand Down

0 comments on commit f0aefd5

Please sign in to comment.