Skip to content

Commit 40773f2

Browse files
committed
README: merge data handling vars into a single section
Signed-off-by: Roman Khimov <[email protected]>
1 parent 972b0aa commit 40773f2

File tree

1 file changed

+5
-19
lines changed

1 file changed

+5
-19
lines changed

README.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -58,35 +58,21 @@ and `NEOFS_HTTP_GATE` environment variables.
5858
| `STORE_OBJECTS_CID` | Container ID for your data. For example: 7gHG4HB3BrpFcH9BN3KMZg6hEETx4mFP71nEoNXHFqrv | **Yes** | N/A |
5959

6060

61-
### Workflow environment variables
61+
### Data handling environment variables
6262
The following variables must be passed as
6363
[GitHub Actions vars context](https://docs.github.com/en/actions/learn-github-actions/variables#using-the-vars-context-to-access-configuration-variable-values)
6464
or [GitHub Actions environment variables](https://docs.github.com/en/actions/learn-github-actions/variables).
6565

66+
These inputs control uploaded data. Attributes can be used to identify all objects for a given uploaded set. `LIFETIME`
67+
can be used to autodelete objects that don't need to be stored forever (like logs or test reports).
68+
6669
| Key | Value | Required | Default |
6770
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|
6871
| `PATH_TO_FILES_DIR` | Path to the directory with the files to be pushed | **Yes** | N/A |
72+
| `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 |
6973
| `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 |
7074
| `URL_PREFIX` | Prefix to the url address for each of the files(objects) | **No** | N/A |
7175

72-
### Expiration period environment variables
73-
The following variables must be passed as
74-
[GitHub Actions vars context](https://docs.github.com/en/actions/learn-github-actions/variables#using-the-vars-context-to-access-configuration-variable-values)
75-
or [GitHub Actions environment variables](https://docs.github.com/en/actions/learn-github-actions/variables).
76-
77-
These environment variables are responsible for the storage time of the results in the storage network in epochs
78-
(in the mainnet, an epoch is approximately equal to one hour, so we can assume that values are specified in HOURS).
79-
80-
After the period is over, the data will be deleted. They are convenient to use for log rotation or test reports.
81-
82-
They default to 0, in which case the data will be stored until they are manually deleted.
83-
We recommend setting a reasonable and convenient for work expiration period, for example, a month (744 hours).
84-
85-
86-
| Key | Value | Required | Default |
87-
|------------|-------------------------------------------|----------|---------|
88-
| `LIFETIME` | Number of epochs for object to stay valid | **No** | 0 |
89-
9076
## Output
9177

9278
| Key | Value | Required | Default |

0 commit comments

Comments
 (0)