Skip to content

Commit

Permalink
tidying up the comments
Browse files Browse the repository at this point in the history
  • Loading branch information
PhillipsOwen committed Oct 28, 2022
1 parent de21098 commit 35bd581
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ Archives file created by the various APSViz applications and processes.
[![Build and push the Docker image](https://github.com/RENCI/APSVIZ-Archiver/actions/workflows/image-push.yml/badge.svg)](https://github.com/RENCI/APSVIZ-Archiver/actions/workflows/image-push.yml)

## Description
This product is designed to perform copy/move/remove operations on file or directory entities within a Kubernetes CronJob. Additional functionality
is implemented to sweep through all file/directory entities located within a directory.
This product is designed to perform copy/move/remove operations on file or directory entities. Additional functionality
is implemented to sweep through all file/directory entities located within a directory. This product is intended to be run within a Kubernetes CronJob.

This product is rule based./ Each Rule is defined in file in json format. A Rule can contain 1 or more Rule sets which can in turn specify
This product is rule based. Each Rule is defined within file in json format. A Rule can contain 1 or more Rule sets which can in turn specify
1 or more atomic Rule operations.

Atomic rules can optionally specify query criteria (age, etc.) that is paired with a predicate (equals, greater than, etc.). These query criteria are used to
Expand Down Expand Up @@ -72,15 +72,27 @@ A simple Rule example shown below has specified:
"data_type": "FILE",
"source": "/dest/some-new-data-location/some-data-file.ext",
"destination": "/dest/some-newer-data-location"
},
{
"name": "Test - Sweep copy test",
"description": "This test copies the directory contents of source to destination.",
"query_criteria_type": "BY_AGE",
"query_data_type": "INTEGER",
"query_data_value": 2,
"predicate_type": "GREATER_THAN_OR_EQUAL_TO",
"action_type": "SWEEP_COPY",
"data_type": "DIRECTORY",
"source": "/source/root_directory",
"destination": "/dest/new_directory"
}
]
}
]
}
```

There are GitHub actions to manage the code in this repo:
- Pylint (minimum score of 9.95 to pass),
There are GitHub actions to maintain code quality in this repo:
- Pylint (minimum score of 10/10 to pass),
- Pytest (with code coverage),
- Build/publish a Docker image.

Expand Down

0 comments on commit 35bd581

Please sign in to comment.