Skip to content

Latest commit

 

History

History
244 lines (157 loc) · 6.94 KB

CONTRIBUTING.md

File metadata and controls

244 lines (157 loc) · 6.94 KB
Raw

Contributing

Contributing encompasses repository specific requirements.

Requirements

You can check the requirements of ODH in the README section.

Writing code

Running locally

Development for both "frontend" and "backend" can be done while running:

npm run dev

But the recommended flow for development would be have two sessions, one for the frontend:

cd frontend
npm run start:dev

And one for the backend

cd backend
npm run start:dev

Once you have these running, you can open the dashboard locally at: http://localhost:4010. The dev server will reload automatically when you make changes.

Give your dev env access

To give your dev environment access to the ODH configuration, log in to the OpenShift cluster and set the project to the location of the ODH installation

oc login https://api.my-openshift-cluster.com:6443 -u <username> -p <password>

or log in using the makefile and .env.local settings

OC_URL=https://specify.in.env:6443
OC_PROJECT=my-project
OC_USER=kubeadmin
OC_PASSWORD=my-password

make login

or

npm run make:login

Debugging and Testing

Unit testing

Tests using Jest to test util functions (not components).

npm run test:unit

Accessibility testing

Storybook tests using axe a11y testing plugin. This command requires a already running storybook instance. Start storybook with:

cd ./frontend && npm run storybook

Then run the accessibility tests with:

npm run test:accessibility

Integration testing

Playwright tests using storybook stories to test components. This command will start a storybook instance and run the tests or it will run the tests against an already running storybook instance.

npm run test:integration

End to end testing

Playwright tests using a running instance of the dashboard to test the full application. This command uses the environment variable E2E_DASHBOARD_URL=http://localhost:4010 in /frontend/.env.test to determine the url to test against.

npm run test:e2e

Linter testing

cd ./frontend && npm run test:lint

You can apply lint auto-fixes with

npm run test:fix

CI tests

The CI will run the command npm run test which will run the following tests:

npm run test:lint
npm run test:type-check
npm run tests:unit
npm run test:accessibility
npm run test:integration

Environment variables

dotenv files

The current build leverages dotenv, or .env*, files to apply environment build configuration.

Applied dotenv files

dotenv files applied to the root of this project...

  • .env, basic settings, utilized by both "frontend" and "backend"
  • .env.local, gitignored settings, utilized by both "frontend" and "backend"
  • .env.development, utilized by both "frontend" and "backend". Its use can be seen with the NPM script $ npm run dev
  • .env.development.local, utilized by both "frontend" and "backend". Its use can be seen with the NPM script $ npm run dev
  • .env.production, is primarily used by the "frontend", minimally used by the "backend". Its use can be seen with the NPM script $ npm run start
  • .env.production.local, is primarily used by the "frontend", minimally used by the "backend". Its use can be seen with the NPM script $ npm run start
  • .env.test, is primarily used by the "frontend", minimally used by the "backend" during testing
  • .env.test.local, is primarily used by the "frontend", minimally used by the "backend" during testing

There are build processes in place that leverage the .env*.local files, these files are actively applied in our .gitignore in order to avoid build conflicts. They should continue to remain ignored, and not be added to the repository.

Available parameters

The dotenv files have access to default settings grouped by facet; frontend, backend, build

...

Deploy a new dashboard version in your cluster

For testing purposes, we recommend deploying a new version of the dashboard in your cluster following the steps below.

Prerequisites

  1. Make sure you have the oc command line tool installed and configured to access your cluster.
  2. Make sure you have the Open Data Hub Operator installed in your cluster.
  3. Remove the dashboard component from your KfDef CR if already deployed.
  4. You can remove previous dashboard deployments by running make undeploy or npm run make:undeploy in the root of this repository.

Customize your env

We use IMAGE_REPOSITORY as the environment variable to specify the image to use for the dashboard. You can set it in the .env.local file in the root of this repository. This environment variable is used in the Makefile to build and deploy the dashboard image, and can be set to a new image tag to build or to a pre-built image to deploy.

Building your image

To deploy a new image, you can either build it locally or use the one built by the CI.

Local Build

You can build your image by running

make build

or

npm run make:build

in the root of this repository. By default, we use podman as the default container tool, but you can change it by setting the CONTAINER_TOOL environment variable to docker.

After building the image, you need to push it to a container registry accessible by your cluster. You can do that by running

make push

or

npm run make:push

in the root of this repository.

Pull Request Images

All pull requests will have an associated pr-<PULL REQUEST NUMBER> image built and pushed to quay.io for use in testing and verifying code changes as part of the PR code review. Any updates to the PR code will automatically trigger a new PR image build, replacing the previous hash that was referenced by pr-<PULL REQUEST NUMBER>.

Deploying your image

To deploy your image, you just need to run the following command in the root of this repository

make deploy

or

npm run make:deploy

you will deploy all the resources located in the manifests folder alongside the image you selected in the previous step.

Working with the MCAD exporter

The architecture for the MCAD dashboard requires an MCAD exporter to enable the storage of time-series appwrapper information in a Prometheus server.

To run the exporter locally, you can run the following command:

npm run start:dev

To build an image that exposes exported metrics, run the following make target:

make build-exporter

To run this image locally, run the following command:

{CONTAINER_BUILDER} run -p 9101:9101 {CONTAINER_IMAGE}

where {CONTAINER_BUILDER} is the container tool you use, set in the Makefile. This should work with podman or docker. {EXPORTER_IMAGE_TAG} is the tag of the exporter image. This is set in the .env file in the home directory of the git repo.