rucio/rucio-clients repository overview

⁠Rucio - Scientific Data Management

⁠(Clients Container)

Rucio is a software framework that provides functionality to organize, manage, and access large volumes of scientific data using customisable policies. The data can be spread across globally distributed locations and across heterogeneous data centers, uniting different storage and network technologies as a single federated entity. Rucio offers advanced features such as distributed data recovery or adaptive replication, and is highly scalable, modular, and extensible. Rucio has been originally developed to meet the requirements of the high-energy physics experiment ATLAS, and is continuously extended to support LHC experiments and other diverse scientific communities.

⁠Documentation

General information and latest documentation about Rucio can be found at readthedocs⁠ or on our webpage⁠.

⁠Developers

For information on how to contribute to Rucio, please refer and follow our CONTRIBUTING⁠ guidelines.

⁠Getting Started

This image provides the basic Rucio clients that can be used to communicate with any Rucio server. If you need to upload/download DIDs please check the experiment specific containers.

To run this container the Rucio server and authentication hosts and the credentials need to be configured. There are two ways to do it: either by using environment variables or by mounting a rucio.cfg file.

Starting the container using the environment with userpass authentication:

docker run \
  -e RUCIO_CFG_CLIENT_RUCIO_HOST=https://server.rucio:443 \
  -e RUCIO_CFG_CLIENT_AUTH_HOST=https://auth.rucio:443 \
  -e RUCIO_CFG_CLIENT_AUTH_TYPE=userpass \
  -e RUCIO_CFG_CLIENT_USERNAME=ddmlab \
  -e RUCIO_CFG_CLIENT_PASSWORD=secret \
  -e RUCIO_CFG_CLIENT_ACCOUNT=root \
  --name=rucio-client \
  -it -d rucio/rucio-clients

With X509 authentication:

docker run \
  -e RUCIO_CFG_CLIENT_RUCIO_HOST=https://server.rucio:443 \
  -e RUCIO_CFG_CLIENT_AUTH_HOST=https://auth.rucio:443 \
  -e RUCIO_CFG_CLIENT_AUTH_TYPE=x509 \
  -e RUCIO_CFG_CLIENT_CLIENT_CERT=/opt/rucio/etc/usercert.pem \
  -e RUCIO_CFG_CLIENT_CLIENT_KEY=/opt/rucio/etc/userkey.pem \
  -e RUCIO_CFG_CLIENT_ACCOUNT=root \
  -v /opt/rucio/etc/usercert.pem:/opt/rucio/etc/usercert.pem \
  -v /opt/rucio/etc/userkey.pem:/opt/rucio/etc/userkey.pem \
  --name=rucio-client \
  -it -d rucio/rucio-clients

If you already have a rucio.cfg you can also use that:

docker run \
  -v /tmp/rucio.cfg:/opt/rucio/etc/rucio.cfg \
  --name=rucio-client \
  -it -d rucio/rucio-clients

After the container is started you can attach to it and start using the rucio commands:

docker exec -it rucio-clients /bin/bash
$ rucio ping

⁠RUCIO_CFG configuration parameters:

Environment variables can be used to set values for the auto-generated rucio.cfg. The names are derived from the actual names in the configuration file. The available environment variables are:

• RUCIO_CFG_CLIENT_ACCOUNT
• RUCIO_CFG_CLIENT_AUTH_HOST
• RUCIO_CFG_CLIENT_AUTH_TYPE
• RUCIO_CFG_CLIENT_CA_CERT
• RUCIO_CFG_CLIENT_CLIENT_CERT
• RUCIO_CFG_CLIENT_CLIENT_KEY
• RUCIO_CFG_CLIENT_PASSWORD
• RUCIO_CFG_CLIENT_REQUEST_RETRIES
• RUCIO_CFG_CLIENT_RUCIO_HOST
• RUCIO_CFG_CLIENT_USERNAME
• RUCIO_CFG_CLIENT_VO
• RUCIO_CFG_CLIENT_X509_PROXY
• RUCIO_CFG_COMMON_MULTI_VO
• RUCIO_CFG_POLICY_LFN2PFN_ALGORITHM_DEFAULT
• RUCIO_CFG_POLICY_PACKAGE
• RUCIO_CFG_POLICY_PERMISSION
• RUCIO_CFG_POLICY_SCHEMA
• RUCIO_CFG_POLICY_SUPPORT
• RUCIO_CFG_POLICY_SUPPORT_RUCIO

⁠Getting Support

If you are looking for support, please contact our mailing list [email protected]⁠ or join us on our slack support⁠ channel.