This is an automated email from the ASF dual-hosted git repository.
eamonford pushed a commit to branch bug_fixes
in repository https://gitbox.apache.org/repos/asf/incubator-sdap-nexus.git
The following commit(s) were added to refs/heads/bug_fixes by this push:
new 405ad68 Readme
405ad68 is described below
commit 405ad68a9617b0e3b69690b91e52cf5cf03b1b6a
Author: Eamon Ford <[email protected]>
AuthorDate: Thu Dec 3 14:18:48 2020 -0800
Readme
---
helm/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
helm/values.yaml | 4 ++--
2 files changed, 52 insertions(+), 2 deletions(-)
diff --git a/helm/README.md b/helm/README.md
index b8b0a1c..28f64ba 100644
--- a/helm/README.md
+++ b/helm/README.md
@@ -30,6 +30,7 @@ The helm chart deploys all the required components of the
NEXUS application (Spa
- [Restricting Pods to Specific Nodes](#restricting-pods-to-specific-nodes)
- [Persistence](#persistence)
- [Ingesting Granules Stored on S3](#ingesting-granules-stored-on-s3)
+ - [Ingesting Granules Stored on an NFS
Host](#ingesting-granules-stored-on-an-nfs-host)
## Prerequisites
@@ -411,4 +412,53 @@ collections:
time: 1
lat: 60
lon: 60
+```
+
+### Ingesting Granules Stored on an NFS Host
+
+SDAP supports ingesting granules that are stored on an NFS host. To enable
this, you must provide the NFS host url, and the path to the directory on the
NFS server host the granules are located.
+
+The following is an example configuration that enables ingestion from an NFS
host:
+
+```yaml
+ingestion:
+ granules:
+ nfsServer: nfsserver.example.com
+ path: /share/granules
+ mountPath: /data
+```
+
+When ingesting from either NFS or the local filesystem, the `path` property of
all collection entries in the collections config should have the value of
`ingestion.granules.mountPath` as the root.
+This is because granules on the NFS host will be mounted into the SDAP
ingestion pods at `ingestion.granules.mountPath`, and the `path` property of
collections in the collections config tells those
+ingestion pods where to find the granules on these pods.
+The following is an example of a collections config to be used with the NFS
ingestion configuration above:
+
+```yaml
+collections:
+ - id: "CSR-RL06-Mascons_LAND"
+ path: "/data/CSR-RL06-Mascons-land/CSR_GRACE_RL06_Mascons_v01-land.nc"
+ priority: 1
+ projection: Grid
+ dimensionNames:
+ latitude: lat
+ longitude: lon
+ time: time
+ variable: lwe_thickness
+ slices:
+ time: 1
+ lat: 60
+ lon: 60
+ - id: "TELLUS_GRAC-GRFO_MASCON_CRI_GRID_RL06_V2_LAND"
+ path: "/data/grace-fo-land/"
+ priority: 1
+ projection: Grid
+ dimensionNames:
+ latitude: lat
+ longitude: lon
+ time: time
+ variable: lwe_thickness
+ slices:
+ time: 1
+ lat: 60
+ lon: 60
```
\ No newline at end of file
diff --git a/helm/values.yaml b/helm/values.yaml
index 102e304..936ff2e 100644
--- a/helm/values.yaml
+++ b/helm/values.yaml
@@ -55,7 +55,7 @@ ingestion:
## mountPath is the path in the Collection Manager and Granule Ingester
pods
## where the granule files will be mounted.
## IMPORTANT: the `path` property on all collections in the Collections
Config file
- ## should match this value.
+ ## should have mountPath as the root.
## Example: if mountPath is set to /data, then every collection in the
Collections
## Config file should have something like
## path: /data/<some-directory>/<some-file-pattern>
@@ -68,7 +68,7 @@ ingestion:
## path is the path on either local filesystem or NFS mount at which
## the granule files are stored.
- path: /var/lib/sdap/granules
+ path:
s3:
bucket: