Skip to content

Latest commit

 

History

History
241 lines (174 loc) · 7.52 KB

RELEASING.md

File metadata and controls

241 lines (174 loc) · 7.52 KB
Raw

Releasing Juju Dashboard

To release the dashboard, first follow the QA steps, then you will need to do a dashboard GitHub release then release both charms.

QA

Deployments

Juju dashboard can be deployed in a number of different scenarios. Each one needs to be QAed to ensure a successful release.

Local machine controller

If you don't already have a local controller you will need to set one up.

As we're testing an unreleased version of the dashboard we'll need build the dashboard and manually update the charm.

git clone [email protected]:canonical/juju-dashboard.git
cd juju-dashboard
yarn install
yarn build

Next clone the juju-dashboard-charm repo.

cd ..
git clone [email protected]:canonical/juju-dashboard-charm.git
cd juju-dashboard-charm/machine-charm

Remove the built dashboard files and replace them with the dashboard files that were built above.

rm -rf src/dist/*
cp -r ../../juju-dashboard/build/* src/dist

Then follow the instructions to build and deploy the machine charm and finally, follow the QA steps.

Local k8s controller

To QA the dashboard in Kubernetes you will need a local k8s environment. This can be quite tricky, but is possible even inside a Multipass container. We have a separate guide for how you can set this up.

Once you have K8s running then shell or ssh into the Multipass container that is running K8s and continue with these instructions.

Clone the juju-dashboard-charm repo.

git clone [email protected]:canonical/juju-dashboard-charm.git
cd juju-dashboard-charm

Then follow the instructions to build and deploy the Kubernetes charm and finally, follow the QA steps.

QA steps

The following QA steps should be preformed in each of the deployments before doing a dashboard release.

  • Check that you can log in and out both using a username/password as well as through an external provider.
  • Check that the controllers list displays the available controller(s).
  • Check that your models appear in the model list.
  • Check that you can search and filter models.
  • Check that you can modify model access.
  • Check that you can only see the models you have access to.
  • Check that you can view a model details page.
  • Check that you can search applications and perform multiple actions on multiple apps.
  • Check that you can configure an application.
  • Check that you can perform actions on units.
  • Check that you can view the action logs for a model.
  • Check that the dashboard works at various screen sizes, including mobile.
  • Check that the dashboard works across browsers.
  • (JAAS only) check that you can perform cross-model searches.
  • (JAAS only) check that you can view audit logs for a model.
  • (JAAS only) check that you can view audit logs for a controller.

Release the dashboard

The first step before releasing the dashboard is to follow the QA instructions. This is a good time to do a really thorough QA and pause and fix any issues you find so that you don't have to restart the release process.

Next, update the dashboard with the next version, following the SemVer rules.

yarn version [major|minor|patch]

Create a PR and land the version update.

Now get a fresh copy of the dashboard:

git clone [email protected]:canonical/juju-dashboard.git
cd juju-dashboard

Install the dependencies and build the dashboard package:

yarn install
yarn generate-release-tarball

Now create a new release on GitHub with the following details:

You should create a new tag for the release using the same version that was set in your package.json.

Set the title to the same version number.

Attach the release tarball that you created earlier.

Get the changes since the last release. You can get the changes using GitHub at https://github.com/canonical/juju-dashboard/compare/<last-version-number>...main or run the following command inside the repo:

git log $(git describe --tags --abbrev=0)..HEAD  --oneline

Create the release notes using the following template:

## New features:

-

## Improvements:

-

## Bug fixes:

-

Finally, publish the release.

Release charms

Juju Dashboard can be deployed using a machine charm or a Kubernetes charm which both need updating and releasing.

Machine charm

Fork and clone the juju-dashboard-charm repo.

git clone [email protected]:<your-username>/juju-dashboard-charm.git
cd juju-dashboard-charm

Update the dashboard to the latest release:

./scripts/update-machine-charm-dashboard.sh

Build and deploy the machine charm and follow the QA steps to confirm it is working.

Now create a PR to land the update dashboard package.

Next follow the release steps to publish the charm to the edge channel.

Deploy the edge machine charm in a controller and check that the dashboard works.

Finally, follow the release steps again to publish the charm to either the beta or stable channel depending on whether this release is ready for general use.

https://github.com/canonical/juju-dashboard-charm#building-and-testing-the-k8s-charm

Kubernetes charm

Fork and clone the juju-dashboard-charm repo.

git clone [email protected]:<your-username>/juju-dashboard-charm.git
cd juju-dashboard-charm

Build and deploy the Kubernetes charm and follow the QA steps to confirm it is working.

The K8s charm does not need to commit any changes to the repo as a Docker image is published to Charmhub instead.

Next follow the release steps to upload the docker resource and publish the charm to the edge channel (you can skip the checkout and docker build steps if you've just completed them in the previous step).

Deploy the edge K8s charm in a controller inside Kubernetes and check that the dashboard works.

Finally, follow the release steps again (skipping the image upload as you can use the previously uploaded resource) to publish the charm to either the beta or stable channel depending on whether this release is ready for general use.