dlabrecq / insights-chrome

Chroming for Insights apps

Insights Chrome

The "wrapper" around your application!

Insights Chrome provides:

• Standard header and navigation
• Base CSS/style
• A Javascript library for interacting with Insights Chrome

For more detailed information about chrome and what it provides, look through the detailed documentation.

JavaScript API

Insights Chrome comes with a Javacript API that allows applications to control navigation, global filters, etc.

Check out the useChrome hook docs

Running the build

There are a few scripts for building this application.

To run a script you have to install dependencies npm install. Then you are free to use any task you want.

1. Building assets

   > npm run build

2. Building assets and watching files when they change

   > npm run build --watch

3. Running tests

   > npm run test

Running chrome locally

1. Install all dependencies

   > npm install

2. Run dev command in watch mode

   > npm run dev

3. Open browser at https://stage.foo.redhat.com:1337/ or Open browser at https://stage.foo.redhat.com:1337/preview.

Running chrome with other applications locally

You can spin chrome locally together with other applications. Use LOCAL_APPS to list the locally deployed applications.

Example 1 (using LOCAL_APPS)

For illustration, to deploy Advisor together with Insights Chrome, you would require to

1. Run Advisor on any available port with npm run start -- --port=8004 or npm run start:beta -- --port=8004,
2. Run Chrome and list the Advisor's port: LOCAL_APPS=advisor:8004:http npm run dev or LOCAL_APPS=advisor:8004:http npm run dev:beta.

Example 2 (using devServer route)

You can also specify deployed applications through devServer.routes field:

1. Run Advisor with --port=8004 (or any other available port number),
2. Update the webpack config in the following way:

...
devServer: {
    ...
    routes: {
        '/apps/ocp-advisor': {
            host: 'https://localhost:8004',
        },
    },
}
...

3. Run insights-chrome with npm run dev or npm run dev:beta.

LocalStorage Debugging

There are some localStorage values for you to enable debuging information or enable some values that are in experimental state. If you want to enable them call const iqe = insights.chrome.enable.iqe() for instance to enable such service. This function will return callback to disable such feature so calling iqe() will remove such item from localStorage.

Available function:

• iqe - to enable some iqe functions for QE purposes
• invTags - to enable experimental tags in inventory
• jwtDebug - to enable debugging of JWT
• remediationsDebug - to enable debug buttons in remediations app
• shortSession - to enable short session in order to test automatic logouts
• forcePendo - to force Pendo initializtion
• appFilter - to enable new application filter in any environment

Futher reading

More detailed documentation can be found in the docs section