Skip to content

Commit

Permalink
Version v0.3.10 (#178)
Browse files Browse the repository at this point in the history
  • Loading branch information
spjmurray authored Feb 27, 2025
1 parent 9f25e5a commit 8e13c93
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 6 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ yarn.lock
/static
/.github
/my-custom-theme.ts
README.md
67 changes: 63 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,63 @@

## Overview

This is a user-friendly user interface built on top of [Unikorn](https://github.com/spjmurray/unikorn) server.
This is a user-friendly user interface built on top of [Unikorn](https://github.com/unikorn-cloud) server.

## Installing

### Prerequisites

First install the [Unikorn Identity Service](https://github.com/unikorn-cloud/identity) creating an OIDC client for your UI.

Your identity `values.yaml` for Helm should have something similar to this:

```yaml
clients:
unikorn-ui:
redirectURI: https://console.unikorn-cloud.org/oauth2/callback
loginURI: https://console.unikorn-cloud.org/login
errorURI: https://console.unikorn-cloud.org/error
```
The host names will be used/created later during deployment.
When that has finished deploying, you will need to retrieve your OIDC client ID and secret.
```shell
$ kubectl get oauth2clients.identity.unikorn-cloud.org -A
NAMESPACE NAME DISPLAY NAME REDIRECT URI SECRET AGE
unikorn-identity f9f78f4a-e715-4d5c-8f44-f6d0203a0a50 unikorn-ui https://console.unikorn-cloud.org/oauth2/callback/oauth2/callback taw7mc-ZTnpNXeSB4wVelpN7bDc9Gk-xPoygkZlkhNU 239d
```

### Deployment

Install using your method of choice:

<details>
<summary>Helm</summary>

Define your `values.yaml`:

```yaml
ui:
host: console.unikorn-cloud.org
identity:
host: identity.unikorn-cloud.org
region:
host: region.unikorn-cloud.org
kubernetes:
host: kubernetes.unikorn-cloud.org
compute:
host: compute.unikorn-cloud.org
oauth2:
clientID: f9f78f4a-e715-4d5c-8f44-f6d0203a0a50
clientSecret: taw7mc-ZTnpNXeSB4wVelpN7bDc9Gk-xPoygkZlkhNU
ingress:
externalDns: true
```
```shell
helm repo add unikorn-ui https::/unikorn-cloud.github.io/ui
helm install unikorn-ui unikorn-ui/ui --namespace unikorn --create-namespace
helm install unikorn-ui unikorn-ui/ui --namespace unikorn --create-namespace -f values.yaml
```

</details>
Expand All @@ -38,8 +83,22 @@ spec:
targetRevision: v0.1.0
helm:
parameters:
- name: dockerConfig
value: # output of "base64 -w0 ~/.docker/config.json"
- name: ui.host
value: console.unikorn-cloud.org
- name: identity.host
value: identity.unikorn-cloud.org
- name: region.host
value: region.unikorn-cloud.org
- name: kubernetes.host
value: kubernetes.unikorn-cloud.org
- name: compute.host
value: compute.unikorn-cloud.org
- name: oauth2.clientID
value: f9f78f4a-e715-4d5c-8f44-f6d0203a0a50
- name: oauth2.clientSecret
value: taw7mc-ZTnpNXeSB4wVelpN7bDc9Gk-xPoygkZlkhNU
- name: ingress.externalDns
value: 'true'
destination:
namespace: unikorn
server: https://kubernetes.default.svc
Expand Down
4 changes: 2 additions & 2 deletions charts/ui/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ description: A Helm chart for deploying Unikorn UI

type: application

version: v0.3.10-rc1
appVersion: v0.3.10-rc1
version: v0.3.10
appVersion: v0.3.10

icon: https://assets.unikorn-cloud.org/assets/images/logos/dark-on-light/icon.png

Expand Down

0 comments on commit 8e13c93

Please sign in to comment.