Science Portal Helm Chart¶
Dependencies¶
- An existing Kubernetes cluster (1.29+).
- An IVOA Registry (See the Current SKAO Registry)
- A working
skahaweb service deployed and registered in the IVOA Registry.
Install¶
The Science Portal is a Single Page Application (SPA) with a rich Javascript client and DOM manager. It uses React to power the various Dashboard elements, and is configurable for different OpenID Providers (OIdP).
Minimum Helm configuration¶
See the full set of options in the values.yaml. The deployed Redirect URI (redirect_uri) is /science-portal/oidc-callback, which handles
receiving the code as part of the authorization code flow, and obtaining a token to put into a cookie.
Run with configured values¶
helm repo add science-platform https://images.opencadc.org/chartrepo/science-platform
helm repo update
helm --namespace skaha-system upgrade --install --values my-science-portal-local-values-file.yaml science-portal science-platform/scienceportal
Release "science-portal" has been installed. Happy Helming!
NAME: science-portal
LAST DEPLOYED: Thu Oct 19 11:59:15 2024
NAMESPACE: skaha-system
STATUS: deployed
REVISION: 7
TEST SUITE: None
Configuration¶
Theme¶
The Science Portal supports minimal theming via configuration options. The following options are available under the deployment.sciencePortal.theme object:
- name: The name of the theme to use. Options are canfar and src. These simply modify the header menu options.
- logoURL: A URL to a logo image to use in the header (far left). This overrides the default logo for the selected theme.
The previous deployment.sciencePortal.themeName is deprecated in favour of the new theme object.
Authentication & Authorization¶
A&A is handle by caching the Token Set server side and issuing a cookie to the browser to enable secure retrieval. See the Application Authentication Documentation.
Endpoints¶
The system will be available at the /science-portal endpoint, (i.e. https://example.com/science-portal). Authenticating to the system is mandatory.
Values Reference¶
scienceportal¶
A Helm chart to install the Science Portal UI
| Chart | AppVersion | Type |
|---|---|---|
| 1.2.0 | 1.2.6 | application |
Requirements¶
| Repository | Name | Version |
|---|---|---|
| file://../utils | utils | ^0.1.0 |
| oci://registry-1.docker.io/bitnamicharts | redis | ^18.19.0 |
Values¶
| Key | Type | Default | Description |
|---|---|---|---|
| deployment.hostname | string | "example.host.com" |
|
| deployment.sciencePortal.defaultProjectName | string | "skaha" |
|
| deployment.sciencePortal.gmsID | string | nil |
|
| deployment.sciencePortal.identityManagerClass | string | "org.opencadc.auth.StandardIdentityManager" |
|
| deployment.sciencePortal.image | string | "images.opencadc.org/platform/science-portal:1.2.6" |
|
| deployment.sciencePortal.imagePullPolicy | string | "Always" |
|
| deployment.sciencePortal.resources.limits.cpu | string | "1" |
|
| deployment.sciencePortal.resources.limits.memory | string | "1000Mi" |
|
| deployment.sciencePortal.resources.requests.cpu | string | "500m" |
|
| deployment.sciencePortal.resources.requests.memory | string | "750Mi" |
|
| deployment.sciencePortal.skahaResourceID | string | nil |
|
| deployment.sciencePortal.tabLabels[0] | string | "Standard" |
|
| deployment.sciencePortal.tabLabels[1] | string | "Advanced" |
|
| deployment.sciencePortal.theme | object | {} |
|
| experimentalFeatures.enabled | bool | false |
|
| kubernetesClusterDomain | string | "cluster.local" |
|
| podSecurityContext | object | {} |
|
| redis.architecture | string | "standalone" |
|
| redis.auth.enabled | bool | false |
|
| redis.image.repository | string | "redis" |
|
| redis.image.tag | string | "8.2.2-bookworm" |
|
| redis.master.persistence.enabled | bool | false |
|
| replicaCount | int | 1 |
|
| securityContext | object | {} |
|
| tolerations | list | [] |