[v7r1] docs: user manage, proxy manager (issue #4702) by TaykYoku · Pull Request #4853 · DIRACGrid/DIRAC

TaykYoku · 2020-11-28T18:33:44Z

BEGINRELEASENOTES
This PR provide documentation about user management, ProxyManager, etc. This PR is trying to solve #4702 .

*Framework
CHANGE: docs

*Resources
CHANGE: docs

*docs
NEW: user management, ProxyManager
CHANGE: move Registry from ConfReference to dirac.cfg
CHANGE: move CommandReference content to scripts docs

ENDRELEASENOTES

fstagni · 2020-12-02T15:11:57Z

That's a lot of docs, thanks! On my side, just fix

/Core/scripts/dirac-version.py:11:18: W291 trailing whitespace

and that's it.

andresailer

Thanks for all this work!

As this PR is still WIP so the developer part of the proxy manager docs are still coming, I guess?

fstagni · 2020-12-09T08:52:19Z

Thanks for all this work!

As this PR is still WIP so the developer part of the proxy manager docs are still coming, I guess?

Maybe it could be merged already, and that part come in a second PR?

fstagni · 2020-12-09T08:53:41Z

BTW @chaen should comment here as he opened originally the issue that is addressed here.

TaykYoku · 2020-12-09T11:17:53Z

Thanks for all this work!
As this PR is still WIP so the developer part of the proxy manager docs are still coming, I guess?

Maybe it could be merged already, and that part come in a second PR?

I'd better add this part later when OAuth 2 PR is adopted

chaen · 2020-12-09T15:45:50Z

BTW @chaen should comment here as he opened originally the issue that is addressed here.

I am in the process, but it takes time ! :D

chaen

Thanks for all this docs ! It already ticks quite a few boxes of #4702

Am I correct in understanding that all the IDProvider and ProxyProvider things will only be enabled in v7r2 ? If that is the case, then it is fine to leave them aside for the time being

chaen · 2020-12-11T10:43:34Z

@@ -0,0 +1,101 @@
+.. _admin_usermanagement:


Can you factorize this doc with https://dirac.readthedocs.io/en/rel-v7r1/AdministratorGuide/HowTo/authentication.html ? There are quite a lot of duplicates. Maybe all the command examples should go in the how-to

And maybe adding a few words and links to the ProxyProvider ?

andresailer · 2021-01-11T11:42:24Z

-SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
+CFGPATH				= ../dirac.cfg


Apologies, I proposed to put this in the Makefile, but I forgot that readthedocs doesn't use the makefile to build the documentation. It only uses the conf.py.

DIRAC/docs/source/conf.py

Line 49 in fc83573

if os.environ.get('READTHEDOCS') == 'True':

Could you instead do the copy here for example?

DIRAC/docs/diracdoctools/cmd/concatcfg.py

Line 40 in fc83573

This still needs to be moved from the makefile to the concatcfg command

Co-authored-by: fstagni <federico.stagni@cern.ch>

…index.rst Co-authored-by: fstagni <federico.stagni@cern.ch>

fstagni · 2021-01-22T10:26:10Z

      storeHostInfo = Operator
    }
  }
+  ## ProxyManager:


You can surround the doc with

##BEGIN ProxyManager ... ##END

And use it in the ProxyManagerHandler.py (see examples e.g. in TransformationSystem). What you did works the same, but it's not the "standard" way we have done it in other DIRAC systems.

I agree that we should follow the standard, but in my opinion this view is more readable. Given that the documentation uses not only "clippings" from the configuration but also the full text of the configuration, such a record makes it easier (many words BEGIN, END complicate reading).
So what do you think this makes sense?

In the ProxyManagerHandler.py is already used.

For ConfigTemplate.cfg files please stick to ##BEGIN xxxxxx and ##END

If my arguments are not convincing, then ok.. That is, to fix it in ConfigTemplate.cfg, or both in ConfigTemplate.cfg and in dirac.cfg? Because in the end everything is mixed into the overall configuration https://dirac.readthedocs.io/en/latest/AdministratorGuide/Configuration/ExampleConfig.html

fstagni · 2021-01-22T10:28:46Z

@@ -3,13 +3,23 @@
 # File :    dirac-admin-proxy-upload.py


Do we want to keep this script? It seems redundant to me.

IMHO this tool is sometimes useful.

andresailer · 2021-01-22T12:10:45Z

Why this move
docs/diracdoctools/cmd/→ docs/diracdoctools/diraccmd/
?

TaykYoku · 2021-01-22T12:15:07Z

an error occurs during assembly:
AttributeError: 'module' object has no attribute 'Cmd'

this cmd module conflicts with the standard library module. As a result, pdb actually imports a different cmd module than it is trying to, one that does not have a Cmd class.

andresailer · 2021-01-22T12:21:46Z

Under what circumstances does this error occur ? There is no Cmd (capital C) in docs

There are external users of this however, https://gitlab.cern.ch/lhcb-dirac/LHCbDIRAC/-/blob/master/docs/source/conf.py#L43

TaykYoku · 2021-01-22T12:34:31Z

Unfortunately, I did not keep the full log

  516  cd docs;
  517  export PYTHONPATH=$PWD:$PYTHONPATH
  518  make htmlall

as a result got something like this ParmEd/ParmEd#148

andresailer · 2021-01-22T12:46:31Z

Are you sure you didn't accidentally put diracdoctools in your PYTHONPATH? Which would trigger this problem, otherwise there is no need to rename this folder

cd docs
PYTHONPATH=$PWD/diracdoctools:$PWD:$PYTHONPATH make html
cp ../dirac.cfg source/ && sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.8.5
                  conf.py:     INFO: Current location '/home/sailer/work/software/DIRAC/DIRAC/docs/source'
                  conf.py:     INFO: DiracDocTools location '/home/sailer/work/software/DIRAC/DIRAC/docs/diracdoctools/__init__.pyo'
                  conf.py:     INFO: DiracDocTools location '/home/sailer/work/software/DIRAC/DIRAC/docs/diracdoctools/Utilities.pyo'
                  conf.py:     INFO: DiracDocTools location '/home/sailer/work/software/DIRAC/DIRAC/docs/diracdoctools/cmd/__init__.pyo'
                  conf.py:     INFO: Found dirac version 'v7r1p25'
                  conf.py:     INFO: DIRACVERSION is 'v7r1p25'

Exception occurred:
  File "/home/sailer/work/software/DIRAC/diracos/usr/lib64/python2.7/pdb.py", line 59, in <module>
    class Pdb(bdb.Bdb, cmd.Cmd):
AttributeError: 'module' object has no attribute 'Cmd'

TaykYoku · 2021-01-22T12:50:16Z

so it could happen .. i will check again and put everything back if the reason was.

[v7r2] fix ProxyManagerClient docs (from #4853)

* upstream/rel-v7r2: v7r2p19 fix highlight:: console fix (should be a list) update instructions for release if a user is in quarantinegroup, remove it from all others v7r2p18 Echo storage: throttle deletion GFAL2_StorageBase: make private methods protected CSA: use real setup to look in correct CS paths PR DIRACGrid#4853 DRA: fix divide by zero if we have just 1 job PY3: Fix call to JobMonitoringClient.getJobsStatus in WorkflowTasks

TaykYoku requested review from andresailer, atsareg and fstagni as code owners November 28, 2020 18:33

TaykYoku mentioned this pull request Nov 29, 2020

[v7r1-v7r3] documentation request for proxy management #4702

Closed

10 tasks

fstagni reviewed Nov 30, 2020

View reviewed changes

TaykYoku requested a review from chaen as a code owner December 1, 2020 19:20

andresailer reviewed Dec 7, 2020

View reviewed changes

chaen reviewed Dec 11, 2020

View reviewed changes

TaykYoku force-pushed the v7r1_user_manage_docs branch from e62a291 to 9ee37fc Compare January 5, 2021 20:16

andresailer reviewed Jan 7, 2021

View reviewed changes

Comment thread docs/diracdoctools/Utilities.py

TaykYoku changed the title ~~[v7r1][WIP] docs: user manage, proxy manager (issue #4702)~~ [v7r1] docs: user manage, proxy manager (issue #4702) Jan 9, 2021

andresailer reviewed Jan 11, 2021

View reviewed changes

fstagni requested a review from chaen January 14, 2021 09:33

andresailer mentioned this pull request Jan 19, 2021

[v7r2] Fully support setuptools #4865

Merged

TaykYoku and others added 11 commits January 19, 2021 16:10

add PM doc

c838873

move ProxyProviders&Registry from ConfReference to dirac.cfg

2028a19

add user manage

e6a419c

fix docs

69a5451

fix docs

87e0183

fix docs

32ee785

fix docs

54d658c

Update FrameworkSystem/Client/ProxyManagerClient.py

b5bec64

Co-authored-by: fstagni <federico.stagni@cern.ch>

Update FrameworkSystem/ConfigTemplate.cfg

04ef7b7

Co-authored-by: fstagni <federico.stagni@cern.ch>

Update FrameworkSystem/DB/ProxyDB.py

6d2e9c4

Co-authored-by: fstagni <federico.stagni@cern.ch>

Update docs/source/AdministratorGuide/Systems/Framework/ProxyManager/…

b26ab13

…index.rst Co-authored-by: fstagni <federico.stagni@cern.ch>

TaykYoku added 2 commits January 20, 2021 20:31

fix doc

4c15f3e

cmd module to diraccmd

c7ceff8

fstagni reviewed Jan 22, 2021

View reviewed changes

TaykYoku added 5 commits January 22, 2021 13:53

fix dirac-deploy-scripts

08d7224

diraccmd -> cmd

0592197

fix ref

06c9ed3

use BEGIN in ConfigTemplate

3985d06

fix ref

4d93c24

TaykYoku closed this Jan 23, 2021

TaykYoku reopened this Jan 23, 2021

TaykYoku added 2 commits January 29, 2021 19:47

fix docs

6a057c5

fix whitespace

7934bdc

fstagni approved these changes Feb 3, 2021

View reviewed changes

atsareg approved these changes Feb 3, 2021

View reviewed changes

atsareg merged commit 2a7dee9 into DIRACGrid:rel-v7r1 Feb 3, 2021

fstagni mentioned this pull request Feb 9, 2021

[v7r2] renames of column names to avoid reserved keywords #4956

Merged

TaykYoku mentioned this pull request Feb 9, 2021

[v7r2] scriptdocs #4958

Merged

TaykYoku mentioned this pull request Jul 30, 2021

Documentation: Document Service/Agent/Executor Options via literalinclude of ConfigTemplate #4087

Closed

64 tasks

TaykYoku added a commit to TaykYoku/DIRAC that referenced this pull request Jul 30, 2021

PR DIRACGrid#4853

f7cc035

TaykYoku mentioned this pull request Jul 30, 2021

[v7r2] fix ProxyManagerClient docs (from #4853) #5303

Merged

TaykYoku deleted the v7r1_user_manage_docs branch July 31, 2021 12:34

fstagni added a commit that referenced this pull request Aug 2, 2021

Merge pull request #5303 from TaykYoku/v7r2_pr4853

4f4e943

[v7r2] fix ProxyManagerClient docs (from #4853)

fstagni pushed a commit that referenced this pull request Aug 4, 2021

PR #4853

c19a6e6

Uh oh!

Conversation

TaykYoku commented Nov 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fstagni commented Dec 2, 2020

Uh oh!

andresailer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fstagni commented Dec 9, 2020

Uh oh!

fstagni commented Dec 9, 2020

Uh oh!

TaykYoku commented Dec 9, 2020

Uh oh!

chaen commented Dec 9, 2020

Uh oh!

chaen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

andresailer commented Jan 22, 2021

Uh oh!

TaykYoku commented Jan 22, 2021

Uh oh!

andresailer commented Jan 22, 2021

Uh oh!

TaykYoku commented Jan 22, 2021

Uh oh!

TaykYoku commented Nov 28, 2020 •

edited

Loading