Skip to content

Commit 953fae5

Browse files
authored
Update the installation doc (#171)
1 parent ea8652b commit 953fae5

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

docs/admin/how-to/install/installing.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,41 @@ The aim of this documentation is to give pointers on how to install the `diracx-
66

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

9-
!!! note "We assume you have a Kubernetes cluster available"
9+
## Prerequisites
10+
11+
12+
??? note "A Kubernetes cluster available"
1013
Which ever it is, at the stage we expect that you have a fully functional kubernetes cluster available. If it is not the case, check the [k3s how-to](./install-kubernetes.md)
1114

12-
!!! warning "You should have a running `DIRAC` installation. "
15+
??? note "A running `DIRAC` installation. "
1316
DiracX always has to run in parallel of a `DIRAC v9` installation.
1417
In particular, make sure that the `DiracX` section of the `DIRAC CS` has been filled properly following the Dirac V9 migration guide
1518

1619

17-
## Requirements
20+
??? note "Access to [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) and [helm](https://helm.sh/docs/intro/install/#from-script)"
1821

19-
You need a UI with [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) and [helm](https://helm.sh/docs/intro/install/#from-script) available. You also need to be able to access and interact with your `DIRAC` installation
22+
```bash
23+
# kubectl
24+
curl -LO https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl
2025

21-
```bash
22-
# kubectl
23-
curl -LO https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl
26+
# kubectl checksum file
27+
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl.sha256"
2428

25-
# kubectl checksum file
26-
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl.sha256"
29+
# validate binary
30+
echo "$(cat kubectl.sha256) kubectl" | sha256sum --check
2731

28-
# validate binary
29-
echo "$(cat kubectl.sha256) kubectl" | sha256sum --check
32+
# install
33+
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
3034

31-
# install
32-
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
3335

36+
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
37+
chmod 700 get_helm.sh
38+
./get_helm.sh
39+
```
3440

35-
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
36-
chmod 700 get_helm.sh
37-
./get_helm.sh
38-
```
41+
??? note "The `kubeconfig` file to connect to your cluster"
3942

40-
You should also have the `kubeconfig` file to connect to your cluster available.
43+
See the [k3s docs](https://docs.k3s.io/cluster-access) if you installed it.
4144

4245

4346
## Configure the DiracX URL in DIRAC
@@ -233,6 +236,12 @@ The [DiracX SandboxStore](../../explanations/sandbox-store.md) stores files on a
233236
"sdalkja34983204923kds"}'
234237
```
235238

239+
??? question "What if I don't have an object store at hand?"
240+
241+
* Investigate if there is a plugin for any storage system you already run (e.g. [CEPH](https://docs.ceph.com/en/latest/radosgw/s3/))
242+
* Consider investing in a public cloud storage
243+
* If you have to install it yourself, we recommand installing [Minio](https://www.min.io/).
244+
236245

237246
## Ingress configuration
238247

@@ -343,13 +352,4 @@ helm install --timeout 3600s <release-name> ./diracx-charts/diracx/ -f my_values
343352

344353
!!! success "Congrats, you have installed DiracX"
345354

346-
However, it does not do anything so far... Follow the post-installation steps
347-
348-
## After installation
349-
350-
### Enable the sandbox
351-
352-
353-
!!! warning Enable the DiracX SandboxStore in the DIRAC CS
354-
355-
The `DIRAC` clients still interact with the DIRAC services to proxy the sandbox files to S3. New writes only go to S3, and read can be done from both. Eventually, given the periodic cleanup of sandboxes, all the files will be on S3 only.
355+
However, it does not do anything so far... See the [following steps](register-the-admin-vo.md)

0 commit comments

Comments
 (0)