Merge pull request #1116 from argonne-lcf/cerebras_grafana

Add page describing how to access Cerebras's Grafana dashboards

Author: felker

docs/ai-testbed/cerebras/accessing_cerebras_grafana_dashboard.md

@@ -0,0 +1,52 @@
+# Accessing Cerebras's Internal Grafana Dashboard
+
+The Cerebras Grafana dashboard is only accessible from systems within ALCF's internal networks.  To access it you will need to open a SOCKS proxy to `cerebras.alcf.anl.gov` and then route your connection via the SOCKS proxy.  Instructions on how to configure SOCKS proxies for your browser are at the end of the page.
+
+## Using Grafana Dashboard
+* Log in by going to [https://grafana.anl0.cerebras.internal](https://grafana.anl0.cerebras.internal/login){width=75%}
+    * If you get an `Hmm. We’re having trouble finding that site.` or `We can’t connect to the server at grafana.anl0.cerebras.internal.` then likely your browser and proxy settings are not working.
+    * ![Firefox Page Not Found](files/grafanaproxy_05_firefox_page_not_found.png){width=50%}
+    * You will likely get a `Warning: Potential Security Risk Ahead` notification the first time you visit the site.  This is due to the internal Grafana instance using a self-signed cert.  Click `advanced` and then click `Accept the Risk and Continue`.
+    * ![Firefox Warning](files/grafanaproxy_08_self_signed_cert.png){width=50%}
+* Enter your ALCF username and MobilePass+ token.  
+  * It can take up to 10 seconds before you are let in.
+    * ![Grafana Login Page](files/grafanaproxy_06_loginpage.png){width=50%}
+* We make several read only dashboards available under the Dashboard folder [UserDashboards](https://grafana.anl0.cerebras.internal/dashboards/f/bfdit1mx49ypsc/?orgId=1) 
+    * ![Grafana User Dashboards](files/grafanaproxy_07_UserDashBoard.png)
+* If you wish to create your own dashboards, please email [support](mailto:support@alcf.anl.gov) and request write access for a Cerebras Grafana dashboard.
+
+## SOCKS proxies
+### Setup the socks proxy via SSH
+* SSH's `-D` option will open a local socks proxy at the specified port.  In this example, we use port 5555
+    * `ssh -D5555 ${yourUsername}@cerebras.alcf.anl.gov`
+
+### Instuctions for setting up via Firefox GUI
+* Open Firefox's Application menu and click settings
+    * ![Firefox Application Menu](files/grafanaproxy_01_firefox_settings.png){width=25%}
+* In search box, type `proxy`. Under `Network Settings` click `settings`.
+    * ![Firefox Settings Proxy](files/grafanaproxy_02_firefox_settings_proxy.png){width=60%}
+* Under `Connection Settings` :
+    * select `Manual proxy configuration` and `Proxy DNS when using SOCKS v5`
+    * ![Firefox Connection Settings](files/grafanaproxy_03_firefox_conn_settings.png){width=60%}
+    * For `SOCKS Host` put in `127.0.0.1` and for the `Port` put 5555 (Or whatever port you used for ssh's -D option
+    * ![Firefox Connection SOCKS Settings](files/grafanaproxy_04_firefox_con_settings_socks.png){width=75%}
+    * Click "OK" to save"
+* Exit out of Firefox settings/preferences tab
+
+### Instuctions for setting up Chromium-based browsers (Chrome, Brave, Vivaldi) via the CLI on Linux or MacOS
+* Chromium-based browsers have a `--proxy` flag that lets you set a proxy for the new instance of that browser.  However they do not have a flag in all version that lets you proxy your DNS queries through the proxy.  Requiring you to update your hosts file.  The paths to your browser's binary files will be different depending on distribution and browsers.
+* Update `/etc/hosts` with a text editor. You will need to be root or sudo.
+    * Example: `sudo vim /etc/hosts` 
+    * Add the following as a new line : `10.125.8.2 grafana.anl0.cerebrassc.local grafana.anl0.cerebras.internal`
+    * save with `:wq`
+* Open your browser from the cli and the flags `--no-first-run --user-data-dir=$(mktemp -d) --proxy-server="socks5://127.0.0.1:5555"` and url `https://grafana.anl0.cerebras.internal/login`
+    * `--no-first-run`: Prevents browser from asking you to do a new setup of your profile.
+    * `--user-data-dir=$(mktemp -d)`: sets a new profile so as to not interfere with an already opened browser.
+    * `--proxy-server="socks5://127.0.0.1:5555"`: Tells the browser to use our SOCKS proxy from above.
+    * Example paths to the browsers with flags:
+```bash linenums="1"
+      /usr/bin/vivaldi-stable --no-first-run --user-data-dir=$(mktemp -d) --proxy-server="socks5://127.0.0.1:5555" https://grafana.anl0.cerebras.internal/login
+      /usr/bin/google-chrome-stable --no-first-run --user-data-dir=$(mktemp -d) --proxy-server="socks5://127.0.0.1:5555" https://grafana.anl0.cerebras.internal/login
+      /usr/bin/brave-browser-stable --no-first-run --user-data-dir=$(mktemp -d) --proxy-server="socks5://127.0.0.1:5555" https://grafana.anl0.cerebras.internal/login
+      /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --no-first-run --user-data-dir=$(mktemp -d) --proxy-server="socks5://127.0.0.1:5555" https://grafana.anl0.cerebras.internal/login
+```

docs/ai-testbed/cerebras/files/grafanaproxy_01_firefox_settings.png

@@ -274,6 +274,7 @@ nav:
         - Tunneling and Forwarding Ports: ai-testbed/cerebras/tunneling-and-forwarding-ports.md
         - Miscellaneous: ai-testbed/cerebras/miscellaneous.md
         - CSL: ai-testbed/cerebras/csl.md
+        - Grafana: ai-testbed/cerebras/accessing_cerebras_grafana_dashboard.md
       - Graphcore:
         - ai-testbed/graphcore/index.md
         - Getting Started: ai-testbed/graphcore/getting-started.md