This repo holds all charts for the sciebo rds microservices.
You can either check out this git repository and then use the charts directly
or use the oci chart repository oci://harbor.uni-muenster.de/rds/, e.g. via:
helm install <release name> oci://harbor.uni-muenster.de/rds/allCaveat: These values may be a little bit outdated, when in doubt you should look at the corresponding values.yaml in the subdirectory.
If you want to install the whole system, you can use the all chart, which depends on all services for sciebo RDS. You have to specify a values.yaml file to set all required parameters. The values.yaml should be taken from the getting-started folder here: https://github.com/Sciebo-RDS/getting-started/blob/master/deploy/values.yaml.example . Save this file as values.yaml in a directory of your choice. This file is your main configuration endpoint for sciebo RDS. So please change the content to your needs.
The following commands will add the needed repository, opens the values.yaml with vi and after you enter your credentials, it will try to install the chart with all services under the name "sciebo-rds" in your configured cluster with your values.yaml. If you changed something in the values.yaml, you only need to run the last command again.
vi values.yaml
helm upgrade rds oci://harbor.uni-muenster.de/rds/all --install --values values.yamlThe following table lists the most used configurable parameters of the Sciebo RDS chart and their default values.
| Parameter | Description | Default / Example |
|---|---|---|
global.REDIS_HOST |
This redis host will be used to store values. Redis-Cluster instance | redis |
global.REDIS_PORT |
This redis port will be used to store values. Redis-Cluster instance | 6379 |
global.REDIS_HELPER_HOST |
This redis host will be used to store values. Standalone redis (Purpose: Pubsub) | redis |
global.REDIS_HELPER_HOST |
This redis port will be used to store values. Standalone redis (Purpose: Pubsub) | 6379 |
global.describo.api_secret |
This secret needs to be sent everytime you want to communicate with describo. | XXX |
global.describo.domain |
The domain where describo is located at. | https://describo.localhost.org |
global.rds.domain |
Tehe omain where RDS Web is located at. | https://app.localhost.org |
global.ingress.tls.secretName |
The name of the tls secret within k8s. | "sciebords-tls-public" |
global.ingress.annotations |
Annotations for ingress. Will be merged with local annotations. | {} |
global.storageClass |
Can be used to set a global storageClass. Local values will not be overwrite. | "" |
layer1-port-zenodo.environment.ADDRESS |
https://sandbox.zenodo.org | |
layer1-port-zenodo.environment.ZENODO_OAUTH_CLIENT_ID |
Required | |
layer1-port-zenodo.environment.ZENODO_OAUTH_CLIENT_SECRET |
Required | |
layer1-port-openscienceframework.ADDRESS |
https://accounts.test.osf.io | |
layer1-port-openscienceframework.API_ADDRESS |
https://api.test.osf.io/v2 | |
layer1-port-openscienceframework.OPENSCIENCEFRAMEWORK_OAUTH_CLIENT_ID |
Required | |
layer1-port-openscienceframework.OPENSCIENCEFRAMEWORK_OAUTH_CLIENT_SECRET |
Required | |
layer1-port-owncloud.environment.ADDRESS |
https://localhost/owncloud | |
layer1-port-owncloud.environment.OAUTH_CLIENT_ID |
Required | |
layer1-port-owncloud.environment.OAUTH_CLIENT_SECRET |
Required | |
<layer3-COMPONENT>.environment.IN_MEMORY_AS_FAILOVER |
If no redis was found, service crashes. With "True" it uses inmemory. | "False" |
redis |
See Dependencies | |
jaeger |
See Dependencies | |
<component>.replicaCount |
1 | |
<component>.image.repository |
zivgitlab.wwu.io/sciebo-rds/sciebo-rds/<component> |
|
<component>.image.tag |
master | |
<component>.image.pullPolicy |
Always | |
<component>.service.type |
ClusterIP | |
<component>.service.port |
80 | |
<component>.service.targetPort |
8080 | |
<component>.service.annotations |
prometheus.io/scrape: "true" | |
<component>.resources.* |
Set Limits and request resources | {} |
<component>.nodeSelector.* |
{} | |
<component>.tolerations.* |
[] | |
<component>.affinity.* |
{} |
Additionally, there a few parameters that can be used to "brand" a connector, e.g. show the logo of your branded owncloud instance, instead of the owncloud logo. None of these are required, as all connectors come with a default Displayname, Info- and HelpURL, Icon (Logo), Describo Profile. A "Go to project" button for published projects will only be available if PROJECT_LINK_TEMPLATE is set.
| Parameter | Description | Default / Example |
|---|---|---|
layer1-port-zenodo.environment.DISPLAYNAME |
||
layer1-port-zenodo.environment.INFO_URL |
||
layer1-port-zenodo.environment.HELP_URL |
||
layer1-port-zenodo.environment.ICON |
Path to Image File | |
layer1-port-zenodo.environment.METADATA_Profile |
Path to Describo Profile | |
layer1-port-zenodo.environment.PROJECT_LINK_TEMPLATE |
A template string for URLs to published projects | "https://zenodo.org/record/${projectID}", ${projectID} will be replaced by the ID provided by the repository |
layer1-port-openscienceframework.environment.DISPLAYNAME |
||
layer1-port-openscienceframework.environment.INFO_URL |
||
layer1-port-openscienceframework.environment.HELP_URL |
||
layer1-port-openscienceframework.environment.ICON |
Path to Image File | |
layer1-port-openscienceframework.environment.METADATA_Profile |
Path to Describo Profile | |
layer1-port-openscienceframework.environment.PROJECT_LINK_TEMPLATE |
A template string for URLs to published projects | "https://osf.io/${projectID}", ${projectID} will be replaced by the ID provided by the repository |
layer1-port-owncloud.environment.DISPLAYNAME |
||
layer1-port-owncloud.environment.INFO_URL |
||
layer1-port-owncloud.environment.HELP_URL |
||
layer1-port-owncloud.environment.ICON |
Path to Image File |
If you need more parameters, please take a look into the values.yaml of the corresponding service.
This chart also use jaeger and redis-cluster. Take a look to the corresponding repositories to find all options.
With the following command, you can remove the sciebo-rds system from your cluster.
helm uninstall rds