From 40773f23e765097c7de9b6ad2252a649e60c43d6 Mon Sep 17 00:00:00 2001 From: Roman Khimov Date: Wed, 15 May 2024 12:39:15 +0300 Subject: [PATCH 1/3] README: merge data handling vars into a single section Signed-off-by: Roman Khimov --- README.md | 24 +++++------------------- 1 file changed, 5 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 942223d..830b28d 100644 --- a/README.md +++ b/README.md @@ -58,35 +58,21 @@ and `NEOFS_HTTP_GATE` environment variables. | `STORE_OBJECTS_CID` | Container ID for your data. For example: 7gHG4HB3BrpFcH9BN3KMZg6hEETx4mFP71nEoNXHFqrv | **Yes** | N/A | -### Workflow environment variables +### Data handling environment variables The following variables must be passed as [GitHub Actions vars context](https://docs.github.com/en/actions/learn-github-actions/variables#using-the-vars-context-to-access-configuration-variable-values) or [GitHub Actions environment variables](https://docs.github.com/en/actions/learn-github-actions/variables). +These inputs control uploaded data. Attributes can be used to identify all objects for a given uploaded set. `LIFETIME` +can be used to autodelete objects that don't need to be stored forever (like logs or test reports). + | Key | Value | Required | Default | |---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------| | `PATH_TO_FILES_DIR` | Path to the directory with the files to be pushed | **Yes** | N/A | +| `LIFETIME` | Number of epochs (for mainnet 1 epoch is ~1 hour) for object to stay valid (it's deleted afterwards), "0" means "unlimited" | **No** | 0 | | `NEOFS_ATTRIBUTES` | User attributes in form of Key1=Value1,Key2=Value2. By default, each object contains attributes of relative path to the file and MIME type of the file. | **No** | N/A | | `URL_PREFIX` | Prefix to the url address for each of the files(objects) | **No** | N/A | -### Expiration period environment variables -The following variables must be passed as -[GitHub Actions vars context](https://docs.github.com/en/actions/learn-github-actions/variables#using-the-vars-context-to-access-configuration-variable-values) -or [GitHub Actions environment variables](https://docs.github.com/en/actions/learn-github-actions/variables). - -These environment variables are responsible for the storage time of the results in the storage network in epochs -(in the mainnet, an epoch is approximately equal to one hour, so we can assume that values are specified in HOURS). - -After the period is over, the data will be deleted. They are convenient to use for log rotation or test reports. - -They default to 0, in which case the data will be stored until they are manually deleted. -We recommend setting a reasonable and convenient for work expiration period, for example, a month (744 hours). - - -| Key | Value | Required | Default | -|------------|-------------------------------------------|----------|---------| -| `LIFETIME` | Number of epochs for object to stay valid | **No** | 0 | - ## Output | Key | Value | Required | Default | From a7068719a1d1e3178ea40258c85bb7b4fb1e9aca Mon Sep 17 00:00:00 2001 From: Roman Khimov Date: Wed, 15 May 2024 13:00:57 +0300 Subject: [PATCH 2/3] README: fix URL_PREFIX description Signed-off-by: Roman Khimov --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 830b28d..cea53d8 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ can be used to autodelete objects that don't need to be stored forever (like log | `PATH_TO_FILES_DIR` | Path to the directory with the files to be pushed | **Yes** | N/A | | `LIFETIME` | Number of epochs (for mainnet 1 epoch is ~1 hour) for object to stay valid (it's deleted afterwards), "0" means "unlimited" | **No** | 0 | | `NEOFS_ATTRIBUTES` | User attributes in form of Key1=Value1,Key2=Value2. By default, each object contains attributes of relative path to the file and MIME type of the file. | **No** | N/A | -| `URL_PREFIX` | Prefix to the url address for each of the files(objects) | **No** | N/A | +| `URL_PREFIX` | Prefix added to the URL address in OUTPUT_CONTAINER_URL | **No** | N/A | ## Output From 45fc46bb2cd785d2d31cbf2c536ba5c402016dcc Mon Sep 17 00:00:00 2001 From: Roman Khimov Date: Wed, 15 May 2024 13:20:52 +0300 Subject: [PATCH 3/3] README: add missing settings Signed-off-by: Roman Khimov --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index cea53d8..7010451 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,9 @@ can be used to autodelete objects that don't need to be stored forever (like log | `PATH_TO_FILES_DIR` | Path to the directory with the files to be pushed | **Yes** | N/A | | `LIFETIME` | Number of epochs (for mainnet 1 epoch is ~1 hour) for object to stay valid (it's deleted afterwards), "0" means "unlimited" | **No** | 0 | | `NEOFS_ATTRIBUTES` | User attributes in form of Key1=Value1,Key2=Value2. By default, each object contains attributes of relative path to the file and MIME type of the file. | **No** | N/A | +| `REPLACE_OBJECTS` | Boolean controlling object replacement by path, with "false" objects are uploaded and old ones are kept even if they have the same "FilePath" | **No** | true | +| `REPLACE_CONTAINER_CONTENTS` | Boolean controlling complete container contents replacement, when "true" all old container objects are deleted | **No** | false | +| `STRIP_PREFIX` | Boolean controlling FilePath attribute of uploaded objects, when "true" PATH_TO_FILES_DIR is stripped from file path | **No** | false | | `URL_PREFIX` | Prefix added to the URL address in OUTPUT_CONTAINER_URL | **No** | N/A | ## Output