Merge pull request #624 from chaen/tmp_installation_docs

installation docs

Author: chrisburr

diracx-cli/src/diracx/cli/internal/legacy.py

@@ -211,7 +211,6 @@ def generate_helm_values(
         },
         "rabbitmq": {"enabled": False},
         "mysql": {"enabled": False},
-        "global": {"images": {"services": "FILL ME"}, "storageClassName": "FILL ME"},
     }
 
     cfg = diraccfg.CFG().loadFromBuffer(public_cfg.read_text())
@@ -265,7 +264,7 @@ def generate_helm_values(
 
     from diracx.core.extensions import select_from_extension
 
-    for entry_point in select_from_extension(group="diracx.db.sql"):
+    for entry_point in select_from_extension(group="diracx.dbs.sql"):
         db_name = entry_point.name
         db_config = all_db_configs.get(db_name, {})
 
@@ -311,7 +310,7 @@ def generate_helm_values(
         },
     }
 
-    for entry_point in select_from_extension(group="diracx.db.os"):
+    for entry_point in select_from_extension(group="diracx.dbs.os"):
         db_name = entry_point.name
         db_config = all_db_configs.get(db_name, {})
 

docs/admin/explanations/configuration.md

@@ -29,4 +29,4 @@ We foresee this will continue to be the case until the migration from DIRAC -> D
 During this time, the DiracX configuration is not intended to be edited directly.
 The DiracX `default.yml` file differs in structure and contents from the legacy DIRAC Configuration Service.
 
-See [how-to](../how-to/convert-cs.md) for how to convert.
+See [how-to](../how-to/install/convert-cs.md) for how to convert.

docs/admin/explanations/sandbox-store.md

@@ -0,0 +1,5 @@
+# SandboxStore
+
+TODO: https://github.com/DIRACGrid/diracx/issues/13
+
+sds

docs/admin/how-to/convert-cs.md docs/admin/how-to/install/convert-cs.mddocs/admin/how-to/convert-cs.md renamed to docs/admin/how-to/install/convert-cs.md

@@ -70,7 +70,11 @@
     User IDs are associated to the usernames that are defined in the `Registry > Users` section. This allows DiracX to retrieve the groups they belong to and their properties.
 
 After saving, you should sync the configuration with DiracX. Dirac Groups and properties should then be associated to users defined in the `DiracX` section.
-See [Convert CS](./convert-cs.md) for next steps.
+See the previous step [Convert CS](./convert-cs.md) for a refresher.
+
+### Automatic population of the UserSubjects
+
+The `DIRAC VOMS2CSAgent` can populate this list for you from an `IAM` server. For that you need to enable the `UseIAM` flag to True.
 
 ## Interact with Computing Elements
 

docs/admin/how-to/register-a-vo.md …cs/admin/how-to/install/register-a-vo.mddocs/admin/how-to/register-a-vo.md renamed to docs/admin/how-to/install/register-a-vo.md docs/admin/how-to/register-a-vo.md renamed to docs/admin/how-to/install/register-a-vo.md

@@ -1,6 +1,7 @@
 # Databases
 
 TODO: review
+TODO: add transactions info
 
 The primary store of operational data in DiracX is in SQL databases managed through SQLAlchemy.
 In addition, DiracX utilizes OpenSearch (or Elasticsearch) for storing pilot logs, medium-term metadata about jobs and pilots ("Job Parameters" and "Pilot Parameters"), and optionally, for OpenTelemetry data.

…cs/admin/how-to/register-the-admin-vo.md …/how-to/install/register-the-admin-vo.mddocs/admin/how-to/register-the-admin-vo.md renamed to docs/admin/how-to/install/register-the-admin-vo.md docs/admin/how-to/register-the-admin-vo.md renamed to docs/admin/how-to/install/register-the-admin-vo.md

@@ -70,19 +70,21 @@ nav:
     - Tutorials:
       - Run locally: admin/tutorials/run_locally.md
     - How-To:
-      - Install kubernetes: admin/how-to/install-kubernetes.md
-      - Installing: admin/how-to/installing.md
-      - Convert CS: admin/how-to/convert-cs.md
-      - Register a VO: admin/how-to/register-a-vo.md
-      - Register the admin VO: admin/how-to/register-the-admin-vo.md
+      - install:
+        - Install kubernetes: admin/how-to/install/install-kubernetes.md
+        - Installing DiracX: admin/how-to/install/installing.md
+        - Convert CS: admin/how-to/install/convert-cs.md
+        - Register a VO: admin/how-to/install/register-a-vo.md
+        - Register the admin VO: admin/how-to/install/register-the-admin-vo.md
       - Debugging: admin/how-to/debugging.md
       - Upgrading: admin/how-to/upgrading.md
       - Rotate a secret: admin/how-to/rotate-a-secret.md
     - Explanations:
       - Configuration: admin/explanations/configuration.md
       - OpenTelemetry: admin/explanations/opentelemetry.md
       - Chart structure: admin/explanations/chart-structure.md
-      - Databases: docs/admin/explanations/database-management.md
+      - Databases: admin/explanations/database-management.md
+      - Sandbox Store: admin/explanations/sandbox-store.md
     - Reference:
       - Security Model: admin/reference/security_model.md
       - Charts values: admin/reference/values.md