Create consoleLinkDomain ENV Var (opendatahub-io#3456)

Author: dpanshug

Diff for: backend/src/utils/prometheusUtils.ts

@@ -77,7 +77,8 @@ const generatePrometheusHostURL = (
 ): string => {
   if (DEV_MODE) {
     const apiPath = fastify.kube.config.getCurrentCluster().server;
-    const namedHost = apiPath.slice('https://api.'.length).split(':')[0];
+    const namedHost =
+      process.env.CONSOLE_LINK_DOMAIN || apiPath.slice('https://api.'.length).split(':')[0];
     return `https://${instanceName}-${namespace}.apps.${namedHost}`;
   }
   return `https://${instanceName}.${namespace}.svc.cluster.local:${port}`;

Diff for: docs/dev-setup.md

@@ -18,13 +18,13 @@ ODH requires the following to run:
 ## Development
 
 1. Clone the repository
-      ``` bash
-      git clone https://github.com/opendatahub-io/odh-dashboard
-      ```
+   ```bash
+   git clone https://github.com/opendatahub-io/odh-dashboard
+   ```
 2. Within the repo context, install project dependencies
-     ```bash
-     cd odh-dashboard && npm install
-     ```
+   ```bash
+   cd odh-dashboard && npm install
+   ```
 
 ### Build project
 
@@ -34,7 +34,7 @@ npm run build
 
 ### Serve development content
 
-This is the default context for running a local UI.  Make sure you build the project using the instructions above prior to running the command below.
+This is the default context for running a local UI. Make sure you build the project using the instructions above prior to running the command below.
 
 > Note: You must be logged-in with `oc` before you can start the backend. Details for that are in the the [contribution guidelines](../CONTRIBUTING.md#give-your-dev-env-access).
 
@@ -52,9 +52,9 @@ For in-depth local run guidance review the [contribution guidelines](../CONTRIBU
 
 Run the tests.
 
-  ```bash
-  npm run test
-  ```
+```bash
+npm run test
+```
 
 For in-depth testing guidance review the [testing guidelines](./testing.md)
 
@@ -64,13 +64,26 @@ Feature flags are defined in the [dashboard config](./dashboard-config.md#featur
 
 With the dev feature flags modal opened, the browser URL will update to include the current feature flag enablement settings. The URL can then be bookmarked or shared.
 
+### Configuring Custom Console Link Domain (CONSOLE_LINK_DOMAIN)
+
+Certain environments require custom access configurations for the OpenShift console and Prometheus endpoints because they may not have access to internal services. To support these configurations, the CONSOLE_LINK_DOMAIN environment variable allows developers to specify a custom domain to override default calculations.
+
+Steps to Configure:
+
+1.  Open the root `.env.local` file (or create it if it doesn't exist).
+2.  Add the following line to define the custom console domain:
+
+    <code>CONSOLE_LINK_DOMAIN=your-custom-domain.com</code>
+
+Replace your-custom-domain.com with the specific domain for your OpenShift console
+
 ## Deploying the ODH Dashbard
 
 ### Official Image Builds
 
 odh-dashboard images are automatically built and pushed to [quay.io](https://quay.io/repository/opendatahub/odh-dashboard) after every commit to the `main` branch. The image tag name format for each image is `main-<COMMIT SHORT HASH>`.
 
-Example: The `main` branch is updated with commit `f76e3952834f453b1d085e8627f9c17297c2f64c`.  The CI system will automatically build an odh-dashboard image based on that code and push the new image to `odh-dashboard:main-f76e395` and updated `odh-dashboard:main` to point to the same image hash.
+Example: The `main` branch is updated with commit `f76e3952834f453b1d085e8627f9c17297c2f64c`. The CI system will automatically build an odh-dashboard image based on that code and push the new image to `odh-dashboard:main-f76e395` and updated `odh-dashboard:main` to point to the same image hash.
 
 The [nightly](https://quay.io/opendatahub/odh-dashboard:nightly) tag is a floating tag that is updated nightly and points to the most recent `main-<HASH>` commit from the previous day.
 

Diff for: frontend/src/utilities/clusterUtils.ts

@@ -1,13 +1,13 @@
 import { useClusterInfo } from '~/redux/selectors/clusterInfo';
-import { DEV_MODE } from '~/utilities/const';
+import { CONSOLE_LINK_DOMAIN, DEV_MODE } from '~/utilities/const';
 
 const consolePrefix = 'console-openshift-console';
 
 export const getOpenShiftConsoleServerURL = (apiURL?: string): string | null => {
   const { hostname, protocol, port } = window.location;
 
   if (DEV_MODE && apiURL) {
-    let apiURLWithoutPrefix = apiURL.slice('https://api.'.length);
+    let apiURLWithoutPrefix = CONSOLE_LINK_DOMAIN || apiURL.slice('https://api.'.length);
     if (apiURLWithoutPrefix.includes(':')) {
       const [withoutPort] = apiURLWithoutPrefix.split(':');
       apiURLWithoutPrefix = withoutPort;

Diff for: frontend/src/utilities/const.ts

@@ -22,6 +22,7 @@ const { ODH_NOTEBOOK_REPO } = process.env;
 const DASHBOARD_CONFIG = process.env.DASHBOARD_CONFIG || 'odh-dashboard-config';
 const { EXT_CLUSTER } = process.env;
 const { INTERNAL_DASHBOARD_VERSION } = process.env;
+const { CONSOLE_LINK_DOMAIN } = process.env;
 
 export {
   DEV_MODE,
@@ -39,6 +40,7 @@ export {
   WS_HOSTNAME,
   EXT_CLUSTER,
   INTERNAL_DASHBOARD_VERSION,
+  CONSOLE_LINK_DOMAIN,
 };
 
 export const DOC_TYPE_TOOLTIPS = {