Skip to content

Commit 94e3abb

Browse files
Merge pull request #818 from ozRunAI/v2.18
added preinstall script details
2 parents 9400457 + bbf8743 commit 94e3abb

File tree

1 file changed

+49
-4
lines changed

1 file changed

+49
-4
lines changed

docs/admin/runai-setup/cluster-setup/cluster-prerequisites.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -381,10 +381,55 @@ Once you believe that the Run:ai prerequisites are met, we highly recommend inst
381381

382382
To use the script [download](https://github.com/run-ai/preinstall-diagnostics/releases){target=_blank} the latest version of the script and run:
383383

384-
```
385-
chmod +x preinstall-diagnostics-<platform>
386-
./preinstall-diagnostics-<platform>
387-
```
384+
385+
386+
=== "SaaS"
387+
* On EKS deployments, run `aws configure` prior to execution
388+
389+
``` bash
390+
chmod +x ./preinstall-diagnostics-<platform> && \
391+
./preinstall-diagnostics-<platform> \
392+
--domain ${TENANT_NAME}.run.ai \
393+
--cluster-domain ${CLUSTER_FQDN}
394+
```
395+
396+
=== "Self-hosted"
397+
398+
``` bash
399+
chmod +x ./preinstall-diagnostics-<platform> && \
400+
./preinstall-diagnostics-<platform> \
401+
--domain ${CONTROL_PLANE_FQDN} \
402+
--cluster-domain ${CLUSTER_FQDN} \
403+
#if the diagnostics image is hosted in a private registry
404+
--image-pull-secret ${IMAGE_PULL_SECRET_NAME} \
405+
--image ${PRIVATE_REGISTRY_IMAGE_URL}
406+
```
407+
408+
=== "Airgap"
409+
410+
In an air-gapped deployment, the diagnostics image is saved, pushed, and pulled manually from the organization's registry.
411+
412+
413+
``` bash
414+
#Save the image locally
415+
docker save --output preinstall-diagnostics.tar gcr.io/run-ai-lab/preinstall-diagnostics:${VERSION}
416+
#Load the image to the organization's registry
417+
docker load --input preinstall-diagnostics.tar
418+
docker tag gcr.io/run-ai-lab/preinstall-diagnostics:${VERSION} ${CLIENT_IMAGE_AND_TAG}
419+
docker push ${CLIENT_IMAGE_AND_TAG}
420+
```
421+
422+
Run the binary with the `--image` parameter to modify the diagnostics image to be used:
423+
424+
``` bash
425+
chmod +x ./preinstall-diagnostics-darwin-arm64 && \
426+
./preinstall-diagnostics-darwin-arm64 \
427+
--domain ${CONTROL_PLANE_FQDN} \
428+
--cluster-domain ${CLUSTER_FQDN} \
429+
--image-pull-secret ${IMAGE_PULL_SECRET_NAME} \
430+
--image ${PRIVATE_REGISTRY_IMAGE_URL}
431+
```
432+
388433

389434
If the script shows warnings or errors, locate the file `runai-preinstall-diagnostics.txt` in the current directory and send it to Run:ai technical support.
390435

0 commit comments

Comments
 (0)