Add instructions for getting secrets from NERC-OCP

FNNDSC · Feb 12, 2024 · bef7324 · bef7324
1 parent 1cd8538
commit bef7324
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 1 deletion.
diff --git a/docs/internal/deployments/data.tsx b/docs/internal/deployments/data.tsx
@@ -43,7 +43,7 @@ const deployments: DeploymentInfo[] = [
       <p>
         Login account credentials can be obtained from{' '}
         <a
-          href="https://console.apps.shift.nerc.mghpcc.org/k8s/ns/hosting-of-medical-image-analysis-platform-dcb83b/secrets/cube1-orthanc">
+          href="https://console.apps.shift.nerc.mghpcc.org/k8s/ns/hosting-of-medical-image-analysis-platform-dcb83b/secrets/orthanc-user">
           OpenShift Console
         </a>.
       </p>

diff --git a/docs/internal/deployments/index.mdx b/docs/internal/deployments/index.mdx
@@ -8,4 +8,12 @@ This page is a list of all our deployments.
 
 Status page: https://fnndsc.github.io/statuspage/
 
+:::tip
+
+If the details say that the account username and/or password can be obtained from a
+URL which looks like `https://console.apps.shift.nerc.mghpcc.org/k8s/ns/.../secrets/...`,
+follow the instructions here: [how to get secrets from OpenShift Console](./nerc/secrets).
+
+:::
+
 <DeploymentsTable data={deployments} />
diff --git a/docs/internal/nerc/secrets/cilogin.png b/docs/internal/nerc/secrets/cilogin.png
diff --git a/docs/internal/nerc/secrets/index.md b/docs/internal/nerc/secrets/index.md
@@ -0,0 +1,28 @@
+# Getting Secrets from OpenShift Console
+
+Username and password for admin accounts of our services deployed on the
+NERC OpenShift Platform (NERC-OCP) are stored as Kubernetes secrets, which
+are accessible from the OpenShift web console. The console's URL is
+
+https://console.apps.shift.nerc.mghpcc.org
+
+A direct link to a secret looks like
+
+https://console.apps.shift.nerc.mghpcc.org/k8s/ns/hosting-of-medical-image-analysis-platform-dcb83b/secrets/ackee-password
+
+## How to Get a Secret's Value from the OpenShift Console
+
+Click on the direct link to the secret, then log in.
+
+![Screenshot of OpenShift Console login page](./login.png)
+
+Most of us log in using the "mss-keycloak" option, which redirects us to
+university/academic institution login pages.
+
+![CILogoon institution selection](./cilogin.png)
+
+After logging in, you will see details about the secret.
+Scroll down to the bottom section titled "Data". On the bottom right side
+there are buttons to either reveal all values, or to copy-paste a specific value.
+
+![Screenshot of secret details in OpenShift Console](./secret.png)
diff --git a/docs/internal/nerc/secrets/login.png b/docs/internal/nerc/secrets/login.png
diff --git a/docs/internal/nerc/secrets/secret.png b/docs/internal/nerc/secrets/secret.png