yeekangc/developer-dashboard

Dashboard for enable you fast access to your development tools that have been installed into your development cluster

IBM Garage Cloud Native Toolkit

Developer Dashboard

A simple dashboard that enables navigation to the tools that have been installed using the iteration-zero Terraform asset or configured with igc tool -config command line.

Customizing Cards

To add, change or delete cards on the developer dashboard edit the /public/data/links.json file and update the information in the appropriate section.

Build

To build the project use the following commands.

Build and develop with the server code it will open on port 3000

npm install
npm run build
npm run start

Build and develop with the client code it will open on port 3001

cd client
npm run dev

When running locally you can override default settings by putting environment variables in .env.local and /client/.env.local files.

Testing API

Use PostMan newman CLI

brew install newman
npm run api:test

Release steps

Creating a release

This repository uses GitHub actions to automatically create a release whenever a change is pushed to main. The workflow for changes should follow a typical process:

1. Create a branch (ideally in a fork of the repository)

2. Create a pull-request to merge the changes from the branch into main. Add a release label (major, minor, patch) and a change type label (feature, bug, chore) to the pull request to effect the new release tag that is generated and how the change log is generated for the release.

3. Merge the pull-request into main. This will trigger the workflow to create the release.

Building the container image

This repository is also connected to the Docker Hub build image. The build process has been configured with two rules:

1. Any time a change is pushed to main, a new image is built with the latest tag
2. Any time a new release is created for the repository, a new image is built with a tag that matches the repository tag (e.g. git tag v1.1.1 -> docker tag 1.1.1)

Updating the Dashboard terraform module

The terraform-tools-dashboard module deploys the built image to the cluster. The terraform module uses the developer-dashboard chart in the Toolkit charts repository to deploy the image.

Each version of the module refers to a particular version of the image. As part of the release process, a GitHub Action will trigger a notification to the terraform module that a new version is available. This will trigger a process in the terraform module to get the latest version number and create a PR containing the change.