Commit 54f86590 authored by Andrii Salnikov's avatar Andrii Salnikov

Merge branch 'migrate_doc_typos' into 'master'

Various small typo and English fixes

See merge request !7
parents aac21c9a 9518a6f6
Pipeline #5518 passed with stages
in 4 minutes and 1 second
...@@ -4,20 +4,20 @@ ARC5 to ARC6 Migration Guide ...@@ -4,20 +4,20 @@ ARC5 to ARC6 Migration Guide
ARC 6 comes with major re-engineering in the code base leading to improvements in the deployment, configuration, maintenance and scalability of ARC CE. ARC 6 comes with major re-engineering in the code base leading to improvements in the deployment, configuration, maintenance and scalability of ARC CE.
It introduces new features while some legacy interfaces, components and features have been obsoleted and removed. It introduces new features while some legacy interfaces, components and features have been obsoleted and removed.
Despite all the code changes the supported ARC 6 CE interfaces are unchanged as well as the structure of control directory, session directory, accounting logs, etc. Despite all the code changes the supported ARC 6 CE interfaces are unchanged as well as the structure of the control directory, session directory, accounting logs, etc.
This makes it possible to upgrade ARC5 to ARC6 without a complete re-installation "from scratch". The upgrade was tested during release candidates roll-out. This makes it possible to upgrade ARC5 to ARC6 without a complete re-installation "from scratch".
.. note:: .. note::
Despite we haven't observed any issues during normal package upgrades it is recommended to do "from scratch" clean install wherever possible to eliminate hidden bugs and ARC5 leftovers. Despite the fact that we haven't observed any issues during normal package upgrades it is recommended to perform a clean install "from scratch" wherever possible in order to eliminate hidden bugs and ARC5 leftovers.
Following sections provides you the necessary info about the major steps of ARC5 to ARC6 migration. Following sections provides you with the necessary info about the major steps of an ARC5 to ARC6 migration.
Quick reference Quick reference
--------------- ---------------
Here is a quick **6 steps** checklist what to do: Here is a quick **6 step** checklist for what to do:
#. Rewrite your ``arc.conf``: you can send your configuration to us and we will help to rework it for ARC6. #. Rewrite your ``arc.conf``: you can :ref:`send your configuration to us <contact_us>`and we will help to rework it for ARC6.
#. Learn the ARC6 :ref:`packages <arc6_packages>` and :ref:`services <arc6_services>` names. #. Learn the ARC6 :ref:`packages <arc6_packages>` and :ref:`services <arc6_services>` names.
#. Get familiar with :ref:`arcctl` that will simplify your life as an ARC6 administrator. #. Get familiar with :ref:`arcctl` that will simplify your life as an ARC6 administrator.
#. Don't forget to enable :ref:`RunTime Environments (RTE) <rtes>` with ``arcctl rte enable``. #. Don't forget to enable :ref:`RunTime Environments (RTE) <rtes>` with ``arcctl rte enable``.
...@@ -29,47 +29,47 @@ The details: ...@@ -29,47 +29,47 @@ The details:
Configuration file Configuration file
------------------ ------------------
Because of the complete overhaul of server-side ARC CE configuration, an existing ARC5 configuration can not be used with an ARC6 installation, Because of the complete overhaul of the server-side ARC CE configuration, an existing ARC5 configuration can not be used with an ARC6 installation,
it will immediately fail during the configuration validation process of ARC service startup. it will immediately fail during the configuration validation process of the ARC service startup.
You have to create a new ARC6 configuration from scratch. Therefore you must create a new ARC6 configuration from scratch.
.. _nordugrid-discuss: mailto:nordugrid-discuss@nordugrid.org .. _nordugrid-discuss: mailto:nordugrid-discuss@nordugrid.org
.. note:: .. note::
There is no automatic converter from old ARC5 config to the new ARC6 syntax. Mainly because in many places it requires more conceptual changes than simple option and block renaming. There is no automatic converter from an old ARC5 configuration file to the new ARC6 syntax. The main reason for this is that there are many conceptual changes rather than simple option and block renaming changes.
We offer support in configuration rework via nordugrid-discuss_ mailing list or `ARC6 Support Skype Channel <https://join.skype.com/dyf3A6Uutjy2>`_. We offer support in configuration rework via nordugrid-discuss_ mailing list or `ARC6 Support Skype Channel <https://join.skype.com/dyf3A6Uutjy2>`_.
Just send your configuration to us! Just send your configuration to us!
When reworking the configuration take attention to this **syntax changes**: When reworking the configuration take notice of these **syntax changes**:
* no more quotes in option values * no more quotes in option values
* blocks are now not only grouping options, but enable/disable functionality * blocks are now not only grouping options, but have a enable/disable functionality
* in block names keywords may be separated by ``/`` to represent subblocks, while block identifiers are separated by ``:`` from keywords * in block names keywords are separated by ``/`` to represent subblocks (if such exist), while block identifiers are separated by ``:`` from keywords
.. note:: .. note::
It is advised to read the :doc:`General configuration structure </admins/reference>` section of ARC configuration reference document before starting any rewrite. It is advised to read the :doc:`General configuration structure </admins/reference>` section of ARC configuration reference document before starting any rewrite.
There are also **changes in configuration approach** in the several areas. The major highlights are: There are also **changes in the configuration approach** in several areas. The major highlights are:
* The way :ref:`authorization and user mapping <auth_and_mapping>` is handled has been greatly reworked and improved. * The way :ref:`authorization and user mapping <auth_and_mapping>` is handled has been greatly reworked and improved.
In particular mapping via *gridmap files* is NO longer required nor recommended. If you still have *gridmap files* in your configuration consider whether you really want to keep this approach in ARC6. In particular mapping via *gridmap files* is NO longer required nor recommended. If you still have *gridmap files* in your configuration consider whether you really want to keep this approach in ARC6.
* Jura :ref:`accounting configuration <accounting>` is now configured within dedicated blocks. * Jura :ref:`accounting configuration <accounting>` is now configured within dedicated blocks.
* Infosys schemas are now also enabled/disabled with blocks. In particular the default ARC5 NorduGrid LDAP schema should be explicitly enabled with :ref:`reference_infosys_nordugrid`. * Infosys schemas are now also enabled/disabled with blocks. In particular the default ARC5 NorduGrid LDAP schema should be explicitly enabled with :ref:`reference_infosys_nordugrid`.
.. TODO: add a note that arc6 config comes with consistent defaults for everything and if a block is enabled all config vsriable gets its def valua.. arcctl to print .. TODO: add a note that arc6 config comes with consistent defaults for everything and if a block is enabled all config variables get its def valua.. arcctl to print
.. note:: .. note::
Config validation is enforced during A-REX start or can be run manually with ``arcctl config validate``. So don't worry you had misspelled something, validator will catch it! Config validation is enforced during A-REX start or can be run manually with ``arcctl config validate``. So don't worry if you had misspelled something, the validator will catch it!
Operating ARC services Operating ARC services
---------------------- ----------------------
ARC6 also comes with the rewised consistent :ref:`packages <arc6_packages>` and :ref:`services <arc6_services>` naming scheme. ARC6 also comes with the a rewised consistent :ref:`packages <arc6_packages>` and :ref:`services <arc6_services>` naming scheme.
We made the service and package names more clear and consistent with configuration block names in ``arc.conf``. We made the service and package names more clear and consistent with configuration block names in ``arc.conf``.
Log files location and internal format had been reviewed to provide consistency across ARC subsystems. Log files locations can be printed with ``arcctl config brief``. Log file locations and internal format have been reviewed to provide consistency across the ARC subsystems. Log file locations can be printed with ``arcctl config brief``.
ARC Control Tool ARC Control Tool
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
...@@ -85,13 +85,13 @@ The ``arcctl`` tool was designed with BASH-completion in mind. It completes subs ...@@ -85,13 +85,13 @@ The ``arcctl`` tool was designed with BASH-completion in mind. It completes subs
RunTime Environments RunTime Environments
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
A new framework for :ref:`RunTime Environments (RTE) <rtes>` has gotten a redesigned architecture and largely extended functionality (default, installed, enabled RTEs, introduction of RTE parameters). The new framework for :ref:`RunTime Environments (RTE) <rtes>` has gotten a redesigned architecture and a largely extended functionality (default, installed, enabled RTEs, introduction of RTE parameters).
The major conceptual and behaviour differences are: The major conceptual and behaviour differences are:
* in ARC6 RTE directories are local to the ARC CE head node and *SHOULD NOT* be shared to worker nodes * in ARC6 RTE directories are local to the ARC CE head node and *SHOULD NOT* be shared to worker nodes
* in ARC6 the RTE concept got extended by the introduction of RTE types such as default, installed, enabled, dummy, etc.. * in ARC6 the RTE concept got extended by the introduction of RTE types such as default, installed, enabled, dummy, etc..
An ordinary ARC5 RTE would correspond to a installed user-defined ARC6 RTE. Please read the documentation. An ordinary ARC5 RTE would correspond to an installed user-defined ARC6 RTE. Please read the documentation.
* All installed ARC5 RTEs (available in a directory) should be enabled explicitly (e.g. ``arcctl rte enable ENV/PROXY``) to be used on an ARC6 CE. * All installed ARC5 RTEs (available in a directory) should be enabled explicitly (e.g. ``arcctl rte enable ENV/PROXY``) to be used on an ARC6 CE.
.. note:: .. note::
...@@ -100,14 +100,13 @@ The major conceptual and behaviour differences are: ...@@ -100,14 +100,13 @@ The major conceptual and behaviour differences are:
Accounting Accounting
~~~~~~~~~~ ~~~~~~~~~~
The ARC6 :ref:`Jura accounting <accounting>` has a redesigned archive structure that introduces a database for local stats and comes with a redesigned record republishing to accounting services, The ARC6 :ref:`Jura accounting <accounting>` has a redesigned archive structure that introduces a database for local stats and comes with a redesigned record republishing to accounting services, in addition to the already mentioned configuration changes.
in addition to the already mentioned configuration changes.
To make ARC6 accounting compatible with ARC5 ``jura`` and archive structure an automatic conversion is done by an additional ``jura-archive-manager`` process run by AREX. To make ARC6 accounting compatible with ARC5 ``jura`` and archive structure, an automatic conversion is done by an additional ``jura-archive-manager`` process run by AREX.
.. warning:: .. warning::
The JURA archive conversion consumes CPU and I/O resources of your ARC CE. If you are upgrading and have a lot of records in archive already expect the additional load until conversion will be finished. The JURA archive conversion consumes CPU and I/O resources of your ARC CE. If you are upgrading and have a lot of records in archive already expect an additional load during conversion.
Retiring the EGIIS Retiring the EGIIS
------------------ ------------------
......
...@@ -25,6 +25,7 @@ ARC is available for variety of GNU/Linux flavors via stable :doc:`Repositores < ...@@ -25,6 +25,7 @@ ARC is available for variety of GNU/Linux flavors via stable :doc:`Repositores <
The source code is hosted in `NeIC's Coderefinery GitLab repository <https://source.coderefinery.org/nordugrid/arc>`_. The source code is hosted in `NeIC's Coderefinery GitLab repository <https://source.coderefinery.org/nordugrid/arc>`_.
.. _contact_us:
Support and Community Support and Community
********************* *********************
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment