OCM UI

This repository contains the UI components for the OpenShift Cluster Manager site.

The UI is a JavaScript/TypeScript application written in React and Redux.

Slack channels: #forum-cluster-management for OCM in general, #ocm-osd-ui for UI.

Table of contents

• Requirements
• Setup
• Building
• Running locally
• Environments and Deployments
• Contributing

Requirements

• NodeJS >= 18.12.0
• Yarn 1.22.19 - (higher versions are not supported)
• Podman >= v5.5.2

Setup

For a first time setup, it's required to run yarn fec patch-etc-hosts.

This may ask for your sudo password to add some entries to /etc/hosts.

If you're on macOS, then you will need to initialize a new podman virtual machine with podman machine init.

If your macOS is running on an M (ARM) processor, then it's recommended to initialize with this image --image docker://quay.io/podman/machine-os:5.5. Higher image versions may not be supported.

If you intend to contribute code, also refer to the Setup section of the Contributing guide.

Building

To build the application run these commands:

yarn install
yarn build

Running locally

If you're on macOS and have Podman fully set up, then verify that the initialized virtual machine is currently running. If it's not, then start the machine with podman machine start.

Run yarn install && yarn start.

By default, the Chrome server (Red Hat Console shell) runs on port :9990. To use a different port, run FEC_CHROME_PORT=<PORT> yarn start.

The UI will be available at https://prod.foo.redhat.com:1337/openshift/

By default, UI will use a real staging backend. You can switch between real backends and mockserver (see below) at any time by appending ?env=staging / ?env=production / ?env=mockdata URL param. (src/config/ directory contains some more options, but they might not work.)

You can find more information about mocked data in the mocked APIs guide.

In development mode, analytics events are configured to be routed to the OCM Web Portal development source on Segment. If you see them in the production source instead, reload the page once (this will stick until local storage is cleared).

By default, UI run Assisted Installer without standalone mode. To run with Assisted Installer in standalone mode you need to follow these steps:

• Download https://github.com/openshift-assisted/assisted-installer-app project
• Inside assisted-installer-app run npm install && npm run start:federated
• In uhc-portal run LOCAL_APPS=assisted-installer-app:8003 yarn start

Continuous integration

See Continuous integration doc.

Environments and Deployments

uhc-portal branch	deployed env	insights-chrome	default backend
main	https://console.dev.redhat.com/openshift	stable version	staging
main (specific revision)	https://console.redhat.com/openshift	stable version	production

Issues/Troubleshooting

If you get a timeout/network connection issue when running yarn install, try increasing the timeout e.g. yarn install --network-timeout 600000.

Contributing

See Contributing guide.

Release

A detailed explanation of how to make a release can be found on the Release to Production page