insights-standalone

A minimal standalone backend for cloud.redhat.com useful for frontend developers working offline. Includes a script for starting keycloak with a user user / user, a mocked RBAC/entitlements insights API that includes required static assets, and a helper to create Webpack proxy config for webpack-dev-server.

Usage

This package is intended to be installed as an NPM dependency:

npm install --save-dev @redhat-cloud-services/insights-standalone

package.json

"scripts": {
  "start:backend": "insights-standalone",
  "start:standalone": "npm-run-all --parallel start:backend start"
}

You'll need to modify your webpack config 2 places as well:

webpack.config.js

const { getProxyPaths, getHtmlReplacements } = require('@redhat-cloud-services/insights-standalone');

// If using ESI tags
plugins: [
  new HtmlReplaceWebpackPlugin([
    {
      pattern: '@@env',
      replacement: appDeployment,
    },
    ...(!isProduction ? getHtmlReplacements() : [])
  ]),
]

// To proxy requests to backend
devServer: {
  proxy: getProxyPaths({ webpackPort })
}

Note: The insights-standalone command will clone ci-beta branches of Git repos under your node_modules folder. You can control this behavior:

Usage: insights-standalone [options]

download required static files and serve alongside mock API

Options:
  -V, --version                 output the version number
  -d, --dir <env>               Directory to look for (or clone) repos into (default:
                                "/home/thesm/src/crc/insights-standalone/repos")
  -e, --env <env>               Files to use from cloned repos:
                                ci-beta|ci-stable|qa-beta|qa-stable|prod-beta|prod-stable|nightly-stable
                                (default: "ci-beta")
  -p, --port <port>             Port to run static asset server + mock entitlements on (default: 4000)
  --chrome <path>               Path to serve insights-chrome dist from (default: "insights-chrome-build")
  --landing <path>              Path to serve landing-page-frontend dist from (default:
                                "landing-page-frontend-build")
  --service-config <path>       Path to serve cloud-services-config dist from (default: "cloud-services-config")
  --keycloak-uri <uri>          Uri to inject in insights-chrome (default: "http://localhost:4001")
  --entitlements-config <path>  Path to get entitlements config from for mock entitlements service (default:
                                "entitlements-config")
  --rbac-config <path>          Path to get entitlements config from for mock entitlements service (default:
                                "rbac-config")
  -h, --help                    display help for commandUsage: insights-standalone [options]

Development / Local usage

This package can also be cloned locally and then run. Commands of interest are npm start:api and npm start:keycloak.

Dependencies

This project clones the following repos that contain static assets required for cloud.redhat.com SPAs into the repos folder:

• insights-chrome-build
  • Contains top/side nav and app loading
• landing-page-frontend-build
  • Contains silent-check-sso.html needed for user auth
• cloud-services-config
  • Contains main.yml needed by chrome for enumerating paths and apps