Skip to content
Snippets Groups Projects
Commit 72207ecf authored by Arie Peterson's avatar Arie Peterson
Browse files

Update README and CHANGELOG

parent 62e63cc5
No related branches found
No related tags found
No related merge requests found
# Changelog
## [0.6.0]
- Add TOTP as second factor authentication. Please note that you'll need to set
a `backend.dashboardUrl` value instead of the old `backend.loginPanelUrl` one
-- typically dropping the `/web` suffix to get the new value.
## [0.5.2]
- Fix login welcome message
......
......@@ -104,7 +104,8 @@ The application will run on `http://stackspin_proxy`. Add the following line to
#### 4. Kubernetes access
The script needs you to have access to the Kubernetes cluster that runs
Stackspin. Point the `KUBECONFIG` environment variable to a kubectl config. Attention points:
Stackspin. Point the `KUBECONFIG` environment variable to a kubectl config.
Attention points:
* The kubeconfig will be mounted inside docker containers, so also make sure
your Docker user can read it.
......@@ -121,3 +122,23 @@ After you've finished all setup steps, you can run everything using
This sets a few environment variables based on what is in your cluster
secrets, and run `docker compose up` to build and run all necessary components,
including a reverse proxy and the backend flask application.
## Testing as a part of Stackspin
Sometimes you may want to make more fundamental changes to the dashboard that
might behave differently in the local development environment compared to a
regular Stackspin instance, i.e., one that's not a local/cluster hybrid. In
this case, you'll want to run your new version in a regular Stackspin cluster.
To do that, make sure to increase the chart version number in `Chart.yaml`, and
push your work to a MR. The CI pipeline should then publish your new chart
version in the Gitlab helm chart repo for the dashboard project, but in the
`unstable` channel -- the `stable` channel is reserved for chart versions that
have been merged to the `main` branch.
Once your package is published, use it by
1. changing the `spec.url` field of the `flux-system/dashboard`
`HelmRepository` object in the cluster where you want to run this, replacing
`stable` by `unstable`; and
2. changing the `spec.chart.spec.version` field of the `stackspin/dashboard`
`HelmRelease` to your chart version (the one from this chart's `Chart.yaml`).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment