From bfec3bb478304bbb18899ebd7cb44c7ea934c429 Mon Sep 17 00:00:00 2001 From: Andres Tanasijczuk Date: Tue, 8 Oct 2024 13:39:51 +0200 Subject: [PATCH] Update variable names when passing rucio configuration options via docker environment variables --- docs/rucio.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/rucio.md b/docs/rucio.md index c84d8c1..79a448b 100644 --- a/docs/rucio.md +++ b/docs/rucio.md @@ -163,7 +163,7 @@ A default Rucio `/opt/rucio/etc/rucio.cfg` file is incorporated into the image a The -v option is a volume mount, which mounts your certificates from your local directory into the docker container. Make sure to specify the correct origin folder for the certificates, otherwise the command will generate an empty directory inside the container! -**To UPLOAD data from the local machine where the Docker container is running to the Rucio Data Lake, you will need to add that directory as a volume mount (with the -v tag) to the container for it to be accessible inside the container. Follow the commands that below.** +**To UPLOAD data from the local machine where the Docker container is running to the Rucio Data Lake, you will need to add that directory as a volume mount (with the -v option) to the container for it to be accessible inside the container. Follow the commands below.** To see whether you initialized the Docker container correctly, refer to the [Docker documentation](https://docs.docker.com/get-started/). For example, you could run: @@ -177,7 +177,7 @@ The command should show the `rucio-client` container running. Have your certificate ready and divided into two files named ~/.globus/userkey.pem and ~/.globus/usercert.pem. ```bash -docker run --user root -e RUCIO_CFG_CLIENT_X509_PROXY=/tmp/x509up -e RUCIO_CFG_AUTH_TYPE=x509_proxy -e RUCIO_CFG_ACCOUNT= -v ~/.globus/usercert.pem:/opt/rucio/etc/client.crt -v ~/.globus/userkey.pem:/opt/rucio/etc/client.key -v ./:/home/ -it --name=rucio-client ghcr.io/vre-hub/vre-rucio-client +docker run --user root -e RUCIO_CFG_CLIENT_CLIENT_X509_PROXY=/tmp/x509up -e RUCIO_CFG_CLIENT_AUTH_TYPE=x509_proxy -e RUCIO_CFG_CLIENT_ACCOUNT= -v ~/.globus/usercert.pem:/opt/rucio/etc/client.crt -v ~/.globus/userkey.pem:/opt/rucio/etc/client.key -v ./:/home/ -it --name=rucio-client ghcr.io/vre-hub/vre-rucio-client ``` Take the `--user root` option away if you encounter problems. If you cannot log in as root and you get permission errors, add your user account to the docker group: @@ -202,16 +202,17 @@ $ voms-proxy-init --voms escape --cert /opt/rucio/etc/client.crt --key /opt/ruci After having run it, run `rucio whoami` to check you are authenticated against the server. -## b. Run with token authentication +### b. Run with token authentication + You only need to run the container specifying that you want to be authenticated with tokens. You will need to click on a link that authenticates you against the server and you are set to go. ``` -docker run --user root -e RUCIO_CFG_AUTH_TYPE=oidc -e RUCIO_CFG_ACCOUNT= -v ./:/home/ -it --name=rucio-client ghcr.io/vre-hub/vre-rucio-client +docker run --user root -e RUCIO_CFG_CLIENT_AUTH_TYPE=oidc -e RUCIO_CFG_CLIENT_ACCOUNT= -v ./:/home/ -it --name=rucio-client ghcr.io/vre-hub/vre-rucio-client ``` -## c. Run with userpass authentication +### c. Run with userpass authentication ```bash -$ docker run -e RUCIO_CFG_ACCOUNT= -e RUCIO_CFG_AUTH_TYPE=userpass -e RUCIO_CFG_USERNAME= -e RUCIO_CFG_PASSWORD= -v ./:/home/ -it --name=rucio-client ghcr.io/vre-hub/vre-rucio-client +$ docker run -e RUCIO_CFG_CLIENT_ACCOUNT= -e RUCIO_CFG_CLIENT_AUTH_TYPE=userpass -e RUCIO_CFG_CLIENT_USERNAME= -e RUCIO_CFG_CLIENT_PASSWORD= -v ./:/home/ -it --name=rucio-client ghcr.io/vre-hub/vre-rucio-client ``` **General note:** To access the rucio-client Docker container in the future, always use this command from the machine where you have Docker installed: