release: 1.0.0

README.rst

@@ -1,6 +1,6 @@
-==============================
+==========================
 REANA Authentication Rucio
-==============================
+==========================
 
 .. image:: https://github.com/reanahub/reana-auth-rucio/workflows/CI/badge.svg
    :target: https://github.com/reanahub/reana-auth-rucio/actions
@@ -14,25 +14,29 @@ REANA Authentication Rucio
 About
 =====
 
-``reana-auth-rucio`` provides a container image for creating the right Rucio configuration.
-The container image includes no additional logic or libraries,
-just the bare minimum to support Rucio. The image is configured to support authentication
-for the four experiments at CERN's Large Hadron Collider (ALICE, ATLAS, CMS, LHCb),
-as well as `ESCAPE <https://projectescape.eu/>`_ Virtual Organization.
+``reana-auth-rucio`` provides a container image for creating the right Rucio
+configuration for REANA workflow jobs. The container image includes no
+additional logic or libraries, just the bare minimum to support Rucio. The
+image is configured to support authentication for the four experiments at
+CERN's Large Hadron Collider (ALICE, ATLAS, CMS, LHCb), as well as `ESCAPE
+<https://projectescape.eu/>`_ Virtual Organization.
 
 ``reana-auth-rucio`` was developed for use in the `REANA
 <http://www.reana.io/>`_ reusable research data analysis platform.
 
 Usage
 =====
 
-You can use ``reana-auth-rucio`` as a base image, however it was built
-to be used as a sidecar container with the single purpose of creating the right Rucio configuration.
-Once obtained, the configuration files are shared with the main container using common namespaces.
+You can use ``reana-auth-rucio`` as a base image, however it was built to be
+used as a sidecar container with the single purpose of creating the right Rucio
+configuration. Once obtained, the configuration files are shared with the main
+container using common namespaces.
 
-The end users can ask for Rucio support by means of declaring `rucio: true`. Currently, the container
-requires VOMS authentication meaning that `voms_proxy: true` has also to be declared, enabling the
-`reana-auth-vomsproxy <https://github.com/reanahub/reana-auth-vomsproxy>`_ sidecar container.
+The end users can ask for Rucio support by means of declaring ``rucio: true``.
+Currently, the container requires VOMS authentication meaning that
+``voms_proxy: true`` has also to be declared, enabling the
+`reana-auth-vomsproxy <https://github.com/reanahub/reana-auth-vomsproxy>`_
+sidecar container.
 
 Inside the container Rucio commands can be executed, for example via:
 
@@ -43,30 +47,34 @@ Inside the container Rucio commands can be executed, for example via:
 Dependencies
 =============
 
-Running the container and successfully obtaining Rucio configuration requires additional information:
+Building the container and successfully obtaining Rucio configuration requires
+additional files present in this repository:
 
-- ``CERN-bundle.pem``, downloaded from `Rucio GitLab repo <https://gitlab.cern.ch/plove/rucio/-/tree/master/etc/web>`_
-- ``EGI-trustanchors.repo``, curled from `EGI Community repository <https://repository.egi.eu/sw/production/cas/1/current/repo-files/EGI-trustanchors.repo>`_
+- ``files/CERN-bundle.pem`` downloaded from `Rucio GitLab repository
+  <https://gitlab.cern.ch/plove/rucio/-/tree/master/etc/web>`_;
+
+- ``files/rucio.cfg.j2`` Rucio configuration template.
 
 Changes
 =======
 
-Version 1.0.0 (UNRELEASED)
+Version 1.0.0 (2022-10-13)
 --------------------------
 
-- Initial release
+- Initial release.
 
 Development
 ===========
 
-You can build the ``reana-auth-rucio`` image by optionally passing the build arguments
-``BASETAG`` in order to specify the tag of ``rucio/rucio-clients``.
+You can build the ``reana-auth-rucio`` image by optionally passing the build
+arguments ``BASETAG`` in order to specify the tag of ``rucio/rucio-clients``.
 
 More information
 ================
 
 For more information about `REANA <https://www.reana.io/>`_ reusable research
-data analysis platform, please see `its documentation <https://docs.reana.io/>`_.
+data analysis platform, please see `its documentation
+<https://docs.reana.io/>`_.
 
 Contributors
 ============