Skip to content
Snippets Groups Projects

Add installation instructions

2 files
+ 274
0
Compare changes
  • Side-by-side
  • Inline
Files
2
+ 28
0
@@ -7,6 +7,34 @@ The relavent [documentation is available from IBM](https://www.ibm.com/docs/en/s
This project focuses on scheduled execution of lifecyle policies to gather and process data about
file system objects and issue actions against those objects based on policy.
## Getting Started
### Gitlab Registry Authentication
To download from Gitlab's package repo, create a `~/.pypirc` file and add the following entry:
```text
[gitlab]
repository = https://gitlab.rc.uab.edu/api/v4/projects/2550/packages/pypi
username = __token__
password = <personal_access_token>
```
Go to your [Access Tokens](https://gitlab.rc.uab.edu/-/user_settings/personal_access_tokens) page and create a new token with `api` privileges. After the token is created, copy its value to the password field
### Installation
Package dependencies should be installed through `conda` due to some compilation errors on Cheaha when installed through PyPi. Use the following commands to create the environment.
```bash
module load Anaconda3
conda env create -n gpfs -f deps.yml
conda activate gpfs
pip install --index-url https://gitlab.rc.uab.edu/api/v4/projects/2550/packages/pypi/simple --no-deps rc-gpfs===<version>
```
`pip` by default will install the latest development version (based on the current version format) if a specific version isn't given. Be sure to include the version number if you would like a stable release as opposed to a development release. As well, be sure to `===` instead of `==` for simple version string matching.
## Applying Policies
Applying a policy to filesets is done through the `mmapplypolicy` command at a base level. This repo contains wrapper scripts to call that command with a specified policy file on a given fileset where each wrapper has different levels of functionality meant for different groups of users in RC. All scripts are stored in `src/run-policy`
Loading