Doc prod deployment #126

chaen · 2024-12-13T14:58:33Z

No description provided.

aldbr · 2025-01-30T16:55:01Z

docs/RUN_PROD.md

@@ -0,0 +1,261 @@
+# Details of deploying `diracx` in production
+
+The aim of this documentation is to give pointers on how to install the `diracx-charts` longside an existing `DIRAC` installation.


Suggested change

The aim of this documentation is to give pointers on how to install the `diracx-charts` longside an existing `DIRAC` installation.

The aim of this documentation is to give pointers on how to install the `diracx-charts` alongside an existing `DIRAC` installation.

aldbr · 2025-01-30T16:55:33Z

docs/RUN_PROD.md

+
+Effectively, this means that you will be using your existing databases (`MySQL`, `OpenSearch`), and just install the new dependencies of `diracx`.
+
+We go here with the assumption that you have a `kubernetes` cluster at hand. If you do no have one, see the [k3s example](../k3s/README.md).


Suggested change

We go here with the assumption that you have a `kubernetes` cluster at hand. If you do no have one, see the [k3s example](../k3s/README.md).

We go here with the assumption that you have a `kubernetes` cluster at hand. If you do not have one, see the [k3s example](../k3s/README.md).

aldbr · 2025-01-30T17:00:55Z

docs/RUN_PROD.md

+
+You can for example use [CERN SSO](SSO.md) as an IdP.
+
+Note that you still need to have the users registered in `diracx` by filling the `CsSync` section in the CS.


Do we actually explain that in details anywhere? If yes, may be we should add a link pointing to the CsSync section in the CS.

aldbr · 2025-01-30T17:01:53Z

docs/RUN_PROD.md

+## Admin VO
+
+
+A new concept in `diracx` is the `AdminVO`, which has super karma on `diracx` itself but not on the resources the VO use.


Suggested change

A new concept in `diracx` is the `AdminVO`, which has super karma on `diracx` itself but not on the resources the VO use.

A new concept in `diracx` is the `AdminVO`, which has super karma on `diracx` itself but not on the resources the VOs use.

aldbr · 2025-01-30T17:02:11Z

docs/RUN_PROD.md

+
+A new concept in `diracx` is the `AdminVO`, which has super karma on `diracx` itself but not on the resources the VO use.
+
+We recommand using the SSO of your institute of it supports it (see [IdP](#idp)).


Suggested change

We recommand using the SSO of your institute of it supports it (see [IdP](#idp)).

We recommand using the SSO of your institute if it supports it (see [IdP](#idp)).

aldbr · 2025-01-30T17:05:37Z

docs/RUN_PROD.md

+
+We recommend taking the configuration from a git repository (gitlab, github, ...).
+
+This is controled with the `DIRACX_CONFIG_BACKEND_URL` setting.


Suggested change

This is controled with the `DIRACX_CONFIG_BACKEND_URL` setting.

This is controlled with the `DIRACX_CONFIG_BACKEND_URL` setting.

aldbr · 2025-01-30T17:07:13Z

docs/RUN_PROD.md

+
+The Sandbox needs to be an object store. We highly recommend that you use one provided by your institute.
+
+The connections parameters are controlled with


Suggested change

The connections parameters are controlled with

The connections parameters are controlled with:

aldbr · 2025-01-30T17:10:27Z

docs/RUN_PROD.md

+      JobDB:
+```
+
+You can chose whether you prefer to create the DB yourself or let `diracx` do it.


Suggested change

You can chose whether you prefer to create the DB yourself or let `diracx` do it.

You can choose whether you prefer to create the DB yourself or let `diracx` do it.

aldbr · 2025-01-30T17:30:55Z

docs/RUN_PROD.md

+  enabled: fase
+```
+
+The command being executed is


Suggested change

The command being executed is

The command being executed is:

aldbr · 2025-01-30T17:31:06Z

docs/RUN_PROD.md

+
+
+Note that these options will generate mysql urls only. Should you need another DB,
+you should write the URL yourself in the settings, for example


Suggested change

you should write the URL yourself in the settings, for example

you should write the URL yourself in the settings, for example:

aldbr · 2025-01-30T17:31:41Z

docs/RUN_PROD.md

+```
+
+
+You can chose to initialize the DBs yourself or let `diracx` do it.


Suggested change

You can chose to initialize the DBs yourself or let `diracx` do it.

You can choose to initialize the DBs yourself or let `diracx` do it.

aldbr · 2025-01-30T17:31:59Z

docs/RUN_PROD.md

+  enabled: true
+```
+
+The command executed is


Suggested change

The command executed is

The command executed is:

aldbr · 2025-01-30T17:33:55Z

docs/RUN_PROD.md

+
+It will make sure to generate the appropriate settings from the db configurations, generate token signing keys if not present, etc
+
+We recommend you leave it to `true`.


Suggested change

We recommend you leave it to `true`.

We recommend you to leave it to `true`.

chaen force-pushed the doc_prod_deployment branch from 003c879 to 560db1f Compare January 30, 2025 10:07

chaen added 9 commits January 30, 2025 12:46

Make dex configuration more dynamic

ee1463f

Make developper option false by default

4c2799c

Up dex version to 2.41.1

d2d989c

document proper prod install

0a4345f

doc cont

a522c5d

upgrade helm-docs pre-commit

eaa902d

upgrade helm-lint to 3.17.0

c9d9d6e

doc cont

12b5ece

upgrade shellcheck to 0.10.0

ae5b5b0

chaen force-pushed the doc_prod_deployment branch from 560db1f to ae5b5b0 Compare January 30, 2025 11:47

chaen added 3 commits January 30, 2025 13:04

doc cont

4ec9fe0

remove useless

b483c30

production docs

f6aa7e0

aldbr reviewed Jan 30, 2025

View reviewed changes

docs/RUN_PROD.md

enabled: true

```

The command executed is

Copy link

Contributor

aldbr Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

The command executed is

The command executed is:

aldbr reviewed Jan 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc prod deployment #126

Doc prod deployment #126

chaen commented Dec 13, 2024

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

aldbr Jan 30, 2025

		@@ -0,0 +1,261 @@
		# Details of deploying `diracx` in production

		The aim of this documentation is to give pointers on how to install the `diracx-charts` longside an existing `DIRAC` installation.


		Effectively, this means that you will be using your existing databases (`MySQL`, `OpenSearch`), and just install the new dependencies of `diracx`.

		We go here with the assumption that you have a `kubernetes` cluster at hand. If you do no have one, see the [k3s example](../k3s/README.md).


		You can for example use [CERN SSO](SSO.md) as an IdP.

		Note that you still need to have the users registered in `diracx` by filling the `CsSync` section in the CS.

		## Admin VO


		A new concept in `diracx` is the `AdminVO`, which has super karma on `diracx` itself but not on the resources the VO use.


		A new concept in `diracx` is the `AdminVO`, which has super karma on `diracx` itself but not on the resources the VO use.

		We recommand using the SSO of your institute of it supports it (see [IdP](#idp)).


		We recommend taking the configuration from a git repository (gitlab, github, ...).

		This is controled with the `DIRACX_CONFIG_BACKEND_URL` setting.

	This is controled with the `DIRACX_CONFIG_BACKEND_URL` setting.
	This is controlled with the `DIRACX_CONFIG_BACKEND_URL` setting.


		The Sandbox needs to be an object store. We highly recommend that you use one provided by your institute.

		The connections parameters are controlled with

	You can chose whether you prefer to create the DB yourself or let `diracx` do it.
	You can choose whether you prefer to create the DB yourself or let `diracx` do it.



		Note that these options will generate mysql urls only. Should you need another DB,
		you should write the URL yourself in the settings, for example

		```


		You can chose to initialize the DBs yourself or let `diracx` do it.

	You can chose to initialize the DBs yourself or let `diracx` do it.
	You can choose to initialize the DBs yourself or let `diracx` do it.


		It will make sure to generate the appropriate settings from the db configurations, generate token signing keys if not present, etc

		We recommend you leave it to `true`.

	We recommend you leave it to `true`.
	We recommend you to leave it to `true`.

Doc prod deployment #126

Are you sure you want to change the base?

Doc prod deployment #126

Conversation

chaen commented Dec 13, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment