feat: add documentation for diracx container deploment#851
feat: add documentation for diracx container deploment#851marianne013 wants to merge 2 commits intoDIRACGrid:mainfrom
Conversation
Documentation build overview
150 files changed ·
|
| At the time of writing, the only supported way of running DiracX is through **[Kubernetes](https://kubernetes.io/docs/tutorials/kubernetes-basics/)**. | ||
| At the time of writing, the only fully supported way of running DiracX is through **[Kubernetes](https://kubernetes.io/docs/tutorials/kubernetes-basics/)**. | ||
|
|
||
| If you need to decouple your DIRAC v9 upgrade from a kubernetes deployment, you can deploy DiracX in a container. This has only been tested in conjunction with a DIRAC v9.0 deployment. In this case, your starting point is: [Prepare a node for container deployment](prepare-container-node.md). |
There was a problem hiding this comment.
I think this sentence is overly conservative. We know the changes in v9.1 are unrelated it's more likely to be affected by diracx updates (e.g. #842) though even then it shouldn't be too bad.
| If you need to decouple your DIRAC v9 upgrade from a kubernetes deployment, you can deploy DiracX in a container. This has only been tested in conjunction with a DIRAC v9.0 deployment. In this case, your starting point is: [Prepare a node for container deployment](prepare-container-node.md). | |
| If you need to decouple your DIRAC v9 upgrade from a kubernetes deployment, you can deploy DiracX in a container. In this case, your starting point is: [Prepare a node for container deployment](prepare-container-node.md). |
| - admin/how-to/install/index.md | ||
| - Minimal requirements: admin/how-to/install/minimal-requirements.md | ||
| - Installing kubernetes: admin/how-to/install/install-kubernetes.md | ||
| - Preparing a container node: admin/how-to/install/prepare-container-node.md |
There was a problem hiding this comment.
I think we need a way of making the table of contents clearer, maybe Alt: or something as a prefix to make clear it's an alternative to the previous? Or maybe just having a single page after Minimal requirements named Installing without kubernetes or something?
|
Hi @fstagni , @chrisburr This has now a lot of comments, and I am not sure we can re-organize the whole documentation on top of that. Can I suggest that I address all immediate issues (text, links etc) and we publish it in the location it's currently at, and make the re-organisation a separate issue ("2 points") ? |
marianne013
force-pushed
the
containerdoc
branch
2 times, most recently
from
2693e7c to
733cbe9
Compare
|
|
I've pushed a suggestion for the layout change, what do you think? |
It does not solve, IMHO. Also some links are broken now. I will push myself. |
|
|
||
| Note: The username and password will then re-appear in the `diracx.env` connection strings for the databases. | ||
|
|
||
| You can now continue to [Convert CS](../convert-cs.md). After this please read [Installing DiracX](../installing.md) for some background information before proceeding to [Installing DiracX in a container](installing-in-a-container.md). |
There was a problem hiding this comment.
After this please read Installing DiracX for some background information before proceeding to
This is rather confusing. Which info should be gathered from that document, which contains (also) kubernetes specific info?
There was a problem hiding this comment.
At the moment the table of contents in the sidebar is unreadable with this:
The other issue with this is that you need to convert the CS before installing.
There was a problem hiding this comment.
I can address "After this please read Installing DiracX for some background information before proceeding to", but I am staying off the layout.
I pushed a new schema. Have a look. |
|
@fstagni any update on this? |
I am done with this. The ball is again on @marianne013 |
|
Ha, just as I am about to go on holiday. |
Co-authored-by: Federico Stagni <federico.stagni@cern.ch> Co-authored-by: Chris Burr <chrisburr@users.noreply.github.com>
Co-authored-by: Chris Burr <chrisburr@users.noreply.github.com>
5 participants
This attempts to address #798.