[v6r21][WIP]Add some tutorials #4026

chaen · 2019-04-11T15:24:49Z

This PR will contain the necessary things for the DMS + TS tutorial.
@andresailer @fstagni @atsareg please take a peek

The first tutorial is the setup of an installation for basic server + client, with WebApp and local CA. It is very largely inspired by the existing guides, except that no choice is given to the user (as a tutorial should be).
You can see it here: https://chaen-dirac.readthedocs.io/en/rel-v6r21_tuto_tsdms/AdministratorGuide/Tutorials/basicTutoSetup.html

This installation should be the base for all future tutorials

More will come, do not merge yet please

BEGINRELEASENOTES

*Core
NEW: install_site supports DIRACOS

*Docs
NEW: basic server and client tutorial
NEW: DIRAC SE tutorial
NEW: DFC tutorial

ENDRELEASENOTES

coveralls · 2019-04-11T15:39:07Z

Coverage increased (+0.008%) to 22.17% when pulling dd80252 on chaen:rel-v6r21_TUTO_TSDMS into a72e013 on DIRACGrid:rel-v6r21.

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

fstagni · 2019-04-11T16:49:39Z

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

+Client installation
+===================
+
+Now we will create another linux account `diracuser` and another installation to be used as client


Maybe you mention that for simplicity this can be done on the same machine, but can also be done on a different one. It's pretty obvious, of course, but shows that this installation is fully capable.

Since it is a tutorial, I'd rather be in favour of NOT giving any choice nor option. Otherwise you risk having people diverging. I can mention it, but I am not sure that it brings anything

We need to decide if what you are writing here is either:

"the tutorial for the workshop", or

"a general tutorial", that will also be used in the workshop to demonstrate something.

Of course you started with option 1, as this is the use case. My question is "can we make it a general one, so option 2"?

There are in the wiki some links to past tutorials/hands-on: https://github.com/DIRACGrid/DIRAC/wiki/DIRAC-Tutorials. There is also the one of last year's workshop. What we should aim to, in this "official documentation" is for general tutorials that readers can do alone. What you will do in the workshop can follow the lines outlined here, with maybe some deviations for convenience.

What I am aiming at is option 2. And Tutorial at the DUW should just follow that. But to save time, this part would already be done for them

I just went through the wiki.
We duplicate so much the source of information :-)
How about just linkinf readthedocs from the wiki ?

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

atsareg · 2019-04-15T09:18:47Z

I agree in general. We can keep some specific tutotials in the WiKi though, like a Quick one

chaen · 2019-04-15T09:22:36Z

Why ? This will for sure diverge :-( Oh btw, I did not know about this -V option of DIRAC install ! That's clever :-)

fstagni · 2019-04-15T10:15:00Z

Wiki are for "unmonitored", often "temporary" and sometimes "unofficial" docs. I would say that, as a general rule, we should promote the readthedocs tutorial as the "always updated" ones. What's in wiki should refer to it.

chaen · 2019-04-16T09:26:19Z

I've added a tuto for installing a DIRAC SE and one for the DFC.

codecov-io · 2019-04-16T09:36:21Z

Codecov Report

Merging #4026 into rel-v6r21 will decrease coverage by <.01%.
The diff coverage is n/a.

@@              Coverage Diff              @@
##           rel-v6r21    #4026      +/-   ##
=============================================
- Coverage      22.05%   22.05%   -0.01%     
=============================================
  Files            906      906              
  Lines         128904   128904              
=============================================
- Hits           28435    28427       -8     
- Misses        100469   100477       +8

Impacted Files	Coverage Δ
Core/Utilities/LockRing.py	`62.02% <0%> (-2.54%)`	⬇️
Core/Utilities/ProcessPool.py	`81.94% <0%> (-1.08%)`	⬇️
Core/Utilities/test/Test_ProcessPool.py	`85.78% <0%> (-0.99%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8727f53...2b8df33. Read the comment docs.

docs/source/AdministratorGuide/Resources/Catalog/index.rst

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

docs/source/AdministratorGuide/Tutorials/index.rst

fstagni · 2019-04-16T14:25:27Z

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

+
+This section has to be ran as `diracuser`
+
+We will do the installation in the `~/DIRAC` directory. For a client, the configuration is really minimal, so we will just install the code and its dependencies.


the ~/DIRAC directory is IMHO a bad name. It will then have another DIRAC directory inside it. Call it differently.

What do you propose ? DiracInstallation ?

It's possible.

OK I'll change to that

andresailer

Just very picky comments: use double ticks instead of single ticks for emphasis, single ticks will be interpreted by sphinx as links to something else (it tries at least), and if one enables picky mode there would be a lot of warnings.
Bullet lists do not need to be indented
Some typos, proposals to change words

andresailer · 2019-04-11T15:42:36Z

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

+The aim of the tutorial is to have a self contained DIRAC setup. You will be guided through the whole installation process both of the server part and the client part.
+By the end of the tutorial, you will have:
+
+  * a Configuration service, to server other servers and clients


Suggested change

* a Configuration service, to server other servers and clients

* a Configuration service, to serve other servers and clients

andresailer · 2019-04-11T15:42:50Z

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

+By the end of the tutorial, you will have:
+
+  * a Configuration service, to server other servers and clients
+  * a ComponentMonitoring service to keep track of other services and agents installed


Suggested change

* a ComponentMonitoring service to keep track of other services and agents installed

* a ComponentMonitoring service to keep track of other services and agents installed

andresailer · 2019-04-11T15:43:02Z

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

+
+  * a Configuration service, to server other servers and clients
+  * a ComponentMonitoring service to keep track of other services and agents installed
+  * a SystemAdministrator service to manage the DIRAC installation in the future


Suggested change

* a SystemAdministrator service to manage the DIRAC installation in the future

* a SystemAdministrator service to manage the DIRAC installation in the future

andresailer · 2019-04-11T15:43:13Z

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

+  * a Configuration service, to server other servers and clients
+  * a ComponentMonitoring service to keep track of other services and agents installed
+  * a SystemAdministrator service to manage the DIRAC installation in the future
+  * the WebApp, to allow for web interface access


Suggested change

* the WebApp, to allow for web interface access

* the WebApp, to allow for web interface access

docs/source/AdministratorGuide/Tutorials/basicTutoSetup.rst

andresailer · 2019-04-16T15:33:49Z

docs/source/AdministratorGuide/Tutorials/installDFC.rst

+
+You should:
+
+ * have a machine setup as described in :ref:`tuto_basic_setup`


Suggested change

* have a machine setup as described in :ref:`tuto_basic_setup`

* have a machine setup as described in :ref:`tuto_basic_setup`

andresailer · 2019-04-16T15:33:57Z

docs/source/AdministratorGuide/Tutorials/installDFC.rst

+You should:
+
+ * have a machine setup as described in :ref:`tuto_basic_setup`
+ * be able to install dirac components


Suggested change

* be able to install dirac components

* be able to install dirac components

andresailer · 2019-04-16T15:34:06Z

docs/source/AdministratorGuide/Tutorials/installDFC.rst

+
+ * have a machine setup as described in :ref:`tuto_basic_setup`
+ * be able to install dirac components
+ * have installed a DIRAC SE using the tutorial (:ref:`tuto_install_dirac_se`).


Suggested change

* have installed a DIRAC SE using the tutorial (:ref:`tuto_install_dirac_se`).

* have installed a DIRAC SE using the tutorial (:ref:`tuto_install_dirac_se`).

andresailer · 2019-04-16T15:34:38Z

docs/source/AdministratorGuide/Tutorials/diracSE.rst

+
+  echo "dummyFile" > /tmp/dummy.txt
+
+Now create a file called `/tmp/testSE.py`, with the following content::


Suggested change

Now create a file called `/tmp/testSE.py`, with the following content::

Now create a file called ``/tmp/testSE.py``, with the following content::

andresailer · 2019-04-16T15:34:53Z

docs/source/AdministratorGuide/Tutorials/diracSE.rst

+
+
+
+This file uploads `/tmp/dummy.txt` on the StorageElement, list the directory and removes it. The output should be something like that::


Suggested change

This file uploads `/tmp/dummy.txt` on the StorageElement, list the directory and removes it. The output should be something like that::

This file uploads ``/tmp/dummy.txt`` on the StorageElement, list the directory and removes it. The output should be something like that::

chaen · 2019-04-23T10:10:37Z

Thanks a lot.
Regarding the lists, is it a problem to keep them indented ? I find it much nicer when writing the doc. If it creates a warning, then no problem, I will remove the indentation

andresailer · 2019-04-23T10:32:31Z

It doesn't create a warning, but it affects the way the result is rendered, the more indentation in the rst the more indentation in the html, so things are not looking consistent

chaen · 2019-04-23T12:34:31Z

Fine, then I'll remove the indenation

chaen · 2019-04-24T08:04:21Z

I'll close that one and re-open one cleaner

install_site: allow to install with DIRACOS

091917e

chaen requested review from atsareg and fstagni as code owners April 11, 2019 15:24

Docs: add tutorial for basic server and client installation

1598c23

chaen force-pushed the rel-v6r21_TUTO_TSDMS branch from 8833581 to 1598c23 Compare April 11, 2019 15:32

fstagni reviewed Apr 11, 2019

View reviewed changes

Take review into account

dd80252

chaen added 4 commits April 16, 2019 11:23

Docs: add anchor and update Catalog documentation

079b193

Docs: use MySQL 5.7 in DIRAC tuto

f26bddd

Docs: add tutorial for DIRAC SE

8a17b33

Docs: add tutorial for DFC

8138616

fstagni reviewed Apr 16, 2019

View reviewed changes

andresailer reviewed Apr 16, 2019

View reviewed changes

TMP DFC

83ad39b

chaen force-pushed the rel-v6r21_TUTO_TSDMS branch from d63f4e5 to 828f6a8 Compare April 23, 2019 10:11

chaen added 3 commits April 23, 2019 14:41

Take review into account

6206764

use DiracInstallation instead of DIRAC

d505c01

Add TSDMS tuto

2b8df33

chaen force-pushed the rel-v6r21_TUTO_TSDMS branch from 828f6a8 to 2b8df33 Compare April 24, 2019 07:42

chaen closed this Apr 24, 2019

chaen mentioned this pull request Apr 24, 2019

[v6r21] Add some administrator tutorials #4046

Merged

chaen deleted the rel-v6r21_TUTO_TSDMS branch August 11, 2022 12:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[v6r21][WIP]Add some tutorials #4026

[v6r21][WIP]Add some tutorials #4026

chaen commented Apr 11, 2019 •

edited

coveralls commented Apr 11, 2019 •

edited

fstagni Apr 11, 2019

chaen Apr 12, 2019

fstagni Apr 12, 2019

chaen Apr 12, 2019

chaen Apr 15, 2019

atsareg commented Apr 15, 2019

chaen commented Apr 15, 2019

fstagni commented Apr 15, 2019

chaen commented Apr 16, 2019

codecov-io commented Apr 16, 2019 •

edited

fstagni Apr 16, 2019

chaen Apr 23, 2019

fstagni Apr 23, 2019

chaen Apr 23, 2019

andresailer left a comment

andresailer Apr 11, 2019

andresailer Apr 11, 2019

andresailer Apr 11, 2019

andresailer Apr 11, 2019

andresailer Apr 16, 2019

andresailer Apr 16, 2019

andresailer Apr 16, 2019

andresailer Apr 16, 2019

andresailer Apr 16, 2019

chaen commented Apr 23, 2019

andresailer commented Apr 23, 2019

chaen commented Apr 23, 2019

chaen commented Apr 24, 2019


		This section has to be ran as `diracuser`

		We will do the installation in the `~/DIRAC` directory. For a client, the configuration is really minimal, so we will just install the code and its dependencies.

	* a Configuration service, to server other servers and clients
	* a Configuration service, to serve other servers and clients

	* a ComponentMonitoring service to keep track of other services and agents installed
	* a ComponentMonitoring service to keep track of other services and agents installed

	* a SystemAdministrator service to manage the DIRAC installation in the future
	* a SystemAdministrator service to manage the DIRAC installation in the future

	* the WebApp, to allow for web interface access
	* the WebApp, to allow for web interface access


		You should:

		* have a machine setup as described in :ref:`tuto_basic_setup`

	* be able to install dirac components
	* be able to install dirac components

	* have installed a DIRAC SE using the tutorial (:ref:`tuto_install_dirac_se`).
	* have installed a DIRAC SE using the tutorial (:ref:`tuto_install_dirac_se`).


		echo "dummyFile" > /tmp/dummy.txt

		Now create a file called `/tmp/testSE.py`, with the following content::

	Now create a file called `/tmp/testSE.py`, with the following content::
	Now create a file called ``/tmp/testSE.py``, with the following content::




		This file uploads `/tmp/dummy.txt` on the StorageElement, list the directory and removes it. The output should be something like that::

	This file uploads `/tmp/dummy.txt` on the StorageElement, list the directory and removes it. The output should be something like that::
	This file uploads ``/tmp/dummy.txt`` on the StorageElement, list the directory and removes it. The output should be something like that::

[v6r21][WIP]Add some tutorials #4026

[v6r21][WIP]Add some tutorials #4026

Conversation

chaen commented Apr 11, 2019 • edited

coveralls commented Apr 11, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atsareg commented Apr 15, 2019

chaen commented Apr 15, 2019

fstagni commented Apr 15, 2019

chaen commented Apr 16, 2019

codecov-io commented Apr 16, 2019 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andresailer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chaen commented Apr 23, 2019

andresailer commented Apr 23, 2019

chaen commented Apr 23, 2019

chaen commented Apr 24, 2019

chaen commented Apr 11, 2019 •

edited

coveralls commented Apr 11, 2019 •

edited

codecov-io commented Apr 16, 2019 •

edited