Inmanta web console

Docs

This project is the current frontend for the Inmanta service orchestrator.
The eventual goal is to replace the current dashboard entirely.
The console is developed in TypeScript using React and React Query.
Testing is performed using Cypress and Vitest.

The frontend uses (Patternfly)[https://www.patternfly.org/] for its UI components. The choice of the framework is motived by:

• Use by many (mostly RedHat backed) infra products (Cockpit, OpenStack, OpenShift, Keycloak, etc.). The advantage of this is that the scope of the component is similar and the design will have some familiarity.
• There are extensive UX guidelines included with the project both in general and per component.

The repository holds two apps:

• apps/oss (@inmanta/web-console-oss): the open-source web console, with the OSS features only.
• apps/web-console (@inmanta/web-console-app): the ISO web console, with every feature. The composer needs JointJS+, which needs a licence token to install.

To install the OSS app only, which needs no token:

yarn workspaces focus @inmanta/web-console-oss

That installs what the OSS app and its packages use, so yarn build:oss, yarn start:oss, yarn tsc:oss and yarn test:oss work. The checks that cover every package (yarn lint, yarn tsc, yarn test) and the ISO app need the full install, with the JointJS token exported in your shell (see ENV Tokens and PAT):

yarn install

Every package declares whether it is OSS or ISO in its package.json ("inmanta": { "edition": "oss" }), and yarn constraints fails when an OSS package depends on an ISO one.

You will need to create a file env.sh in shell-scripts folder containing the variable GITLAB_TOKEN. It should look like so: export GITLAB_TOKEN=xxxxxxxxxxxxxxxxx (xxxx equals your PAT token, of course.)

If you want to install the ISO version of the application, you will need to add a npm access token to the JointJS Plus library in your env file, and export it in the shell you install from. The OSS app installs without it. JOINTJS_NPM_TOKEN=jjs-xxxxxxxxxxxxxx

To enable authentication with keycloak, you can use environment variables, e.g. add the following variable to a dotenv (.env in the root of the project) file (further information on https://github.com/motdotla/dotenv)

VITE_SHOULD_USE_AUTH=true

The keycloak parameters need to be specified in an external file in the production environment, called config.js, following the example apps/web-console/src/config.js file.

The base url of the backend services can also be specified here, e.g.:

VITE_API_BASEURL=http://localhost:8888

Cypress can be configured via cypress.json (or command line arguments). It is always best to run the install commands from the web-console repository.

To setup the containers for the latest version of ISO, you can run these steps:

yarn install:orchestrator:iso

If you need to run the test-suit headless you can chain it with:

cypress-test:iso

or run npx cypress open if you need to run the tests in the cypress UI.

(If you want to run the cypress UI) Adjust the cypress.json file to have

  env: {
    edition: "oss",
    project: "oss-frontend",
  },

Then :

yarn install:orchestrator:oss

If you need to run the test-suit headless you can chain it with:

cypress-test:oss

or run npx cypress open if you need to run the tests in the cypress UI.