Skip to content

Latest commit

 

History

History
141 lines (137 loc) · 28.7 KB

File metadata and controls

141 lines (137 loc) · 28.7 KB

REANA: reproducible research data analysis platform.

Chart Prefix

This Helm automatically prefixes all names using the release name to avoid collisions.

Configuration

Parameter Description Default value
components.reana_db.enabled Instantiate a PostgreSQL database inside the cluster true
components.reana_db.image PostgreSQL image to use docker.io/library/postgres:12.13
components.reana_job_controller.environment REANA-Job-Controller environment variables {}
components.reana_job_controller.image REANA-Job-Controller image to use docker.io/reanahub/reana-job-controller:<chart-release-version>
components.reana_message_broker.image REANA-Message-Broker image to use docker.io/reanahub/reana-message-broker:<chart-release-version>
components.reana_message_broker.imagePullPolicy REANA-Message-Broker image pull policy IfNotPresent
components.reana_server.environment REANA-Server environment variables
components.reana_server.environment.REANA_MAX_CONCURRENT_BATCH_WORKFLOWS Upper limit on concurrent REANA batch workflows running in the cluster. 30
components.reana_server.environment.REANA_USER_EMAIL_CONFIRMATION Enable user to confirm their email address. true
components.reana_server.environment.REANA_SCHEDULER_REQUEUE_SLEEP Seconds to wait between consuming workflows. 15
components.reana_server.environment.REANA_SCHEDULER_REQUEUE_COUNT The number of times to requeue workflow before failing it. "infinity" value could be used to deactivate workflow failing. 200
components.reana_server.environment.REANA_WORKFLOW_SCHEDULING_POLICY Define workflow scheduling strategy. Options are "fifo" for first-in-first-out strategy regardless of users and "balanced" for multi-user-aware scheduling strategy. "fifo"
components.reana_server.environment.REANA_WORKFLOW_SCHEDULING_READINESS_CHECK_LEVEL Define checks that are performed to assess whether the cluster is ready to start new workflows. Values are: 0 = no readiness check; schedule new workflow as soon as they arrive; 1 = check for maximum number of concurrently running workflows; schedule new workflows if not exceeded; 2 = check for available cluster memory size; schedule new workflow only if it fits; 9 = perform all checks; satisfy all previous criteria. 9
components.reana_server.environment.REANA_RATELIMIT_GUEST_USER Set API limiter config for guest users. Users using reana-client will be treated as guests. "20 per second"
components.reana_server.environment.REANA_RATELIMIT_AUTHENTICATED_USER Set API limiter config for authenticated web UI users. "20 per second"
components.reana_server.environment.REANA_RATELIMIT_SLOW Set API limiter config for slow endpoints that need to be protected e.g. launch endpoint. "1/5 second"
components.reana_server.image REANA-Server image to use docker.io/reanahub/reana-server:<chart-release-version>
components.reana_server.imagePullPolicy REANA-Server image pull policy IfNotPresent
components.reana_server.uwsgi.processes Number of uWSGI processes 6
components.reana_server.uwsgi.threads Number of uWSGI threads 4
components.reana_server.uwsgi.log_all Log all HTTP requests true
components.reana_server.uwsgi.log_4xx Log only error HTTP requests with status code 4xx. To make this configuration effective components.reana_server.uwsgi.log_all must be false. true
components.reana_server.uwsgi.log_5xx Log only error HTTP requests with status code 5xx. To make this configuration effective components.reana_server.uwsgi.log_all must be false. true
components.reana_ui.announcement Announcement message displayed in site top banner None
components.reana_ui.enabled Instantiate the REANA-UI true
components.reana_ui.file_preview_size_limit Maximum file size (in bytes) that can be previewed in the web interface. Default value: 5242880 bytes = 5 MiB 5242880
components.reana_ui.image REANA-UI image to use docker.io/reanahub/reana-ui:<chart-release-version>
components.reana_ui.imagePullPolicy REANA-UI image pull policy IfNotPresent
components.reana_ui.polling_secs Frequency of workflow list page reload in seconds 15
components.reana_ui.client_pyvenv REANA-Client python environment to source in the welcome example. None
components.reana_ui.docs_url URL of documentation site (footer icon) https://docs.reana.io
components.reana_ui.forum_url URL of forum site (footer icon) https://forum.reana.io
components.reana_ui.chat_url URL of chat channel (footer icon) None
components.reana_ui.privacy_notice_url URL of the privacy notice (footer icon) None
components.reana_ui.cern_sso Enable CERN SSO sign in false
components.reana_ui.local_users Enable local users sign in/up true
components.reana_ui.hide_signup Hide users sign up form false
components.reana_workflow_controller.environment REANA-Workflow-Controller environment variables {SHARED_VOLUME_PATH: /var/reana}
components.reana_workflow_controller.image REANA-Workflow-Controller image to use docker.io/reanahub/reana-workflow-controller:<chart-release-version>
components.reana_workflow_controller.imagePullPolicy REANA-Workflow-Controller image pull policy IfNotPresent
components.reana_workflow_controller.environment.REANA_JOB_HOSTPATH_MOUNTS JSON list of optional hostPath mounts, for all user jobs. Each mount object has a key name (name of the mount), hostPath (path to the directory to be mounted from the Kubernetes nodes) and mountPath (path inside the job containers where the hostPath will be mounted) None
components.reana_workflow_controller.environment.REANA_RUNTIME_KUBERNETES_KEEP_ALIVE_JOBS_WITH_STATUSES Keep alive Kubernetes user runtime jobs depending on status (finished and/or failed). None
components.reana_workflow_controller.environment.REANA_JOB_STATUS_CONSUMER_PREFETCH_COUNT Define max number of unacknowledged deliveries that are permitted on jobs-status queue consumer. 10
components.reana_workflow_engine_cwl.environment REANA-Workflow-Engine-CWL environment variables {}
components.reana_workflow_engine_cwl.image REANA-Workflow-Engine-CWL image to use docker.io/reanahub/reana-workflow-engine-cwl:<chart-release-version>
components.reana_workflow_engine_serial.environment REANA-Workflow-Engine-Serial environment variables {}
components.reana_workflow_engine_serial.image REANA-Workflow-Engine-Serial image to use docker.io/reanahub/reana-workflow-engine-serial:<chart-release-version>
components.reana_workflow_engine_yadage.environment REANA-Workflow-Engine-yadage environment variables {}
components.reana_workflow_engine_yadage.image REANA-Workflow-Engine-Yadage image to use docker.io/reanahub/reana-workflow-engine-yadage:<chart-release-version>
components.reana_workflow_engine_snakemake.environment REANA-Workflow-Engine-Snakemake environment variables {}
components.reana_workflow_engine_snakemake.image REANA-Workflow-Engine-Snakemake image to use docker.io/reanahub/reana-workflow-engine-snakemake:<chart-release-version>
compute_backends List of supported compute backends (kubernetes, htcondorcern, slurmcern) "kubernetes"
db_env_config.REANA_DB_HOST Environment variable to connect to external databases <chart-release-name>-db
db_env_config.REANA_DB_NAME Environment variable to connect to external databases reana
db_env_config.REANA_DB_PORT Environment variable to connect to external databases "5432"
debug.enabled Instantiate a wdb remote debugger inside the cluster, accessible in port 31984 false
eos.enabled [CERN only] Enable EOS support inside the cluster false
fullnameOverride Name to override the reana.prefix None
infrastructure_storage Optional volume used by REANA's infrastructure (i.e. database and message broker). It has the same settings as shared_storage {}
ingress.annotations.kubernetes.io/ingress.class Type of ingress controller traefik
ingress.annotations.traefik.ingress.kubernetes.io/router.entrypoints Entrypoints allowed by the ingress controller "web,websecure"
ingress.enabled Create an ingress resource to access the REANA instance from outside the cluster true
ingress.extra An array of extra ingress resources. They can be configured in the same way as the default ingress, with the addition of ingress.extra[].name. []
ingress.tls.hosts List of hosts included in the TLS certificate, needed by cert-manager []
ingress.tls.secret_name Name of the Kubernetes secret containing the TLS certificate to be used None
ingress.tls.self_signed_cert Enable the generation of a self-signed TLS certificate true
kubernetes_jobs_memory_limit Maximum default memory limit for user job containers. Exceeding this limit will terminate the container. Please see the following URL for possible values https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory. 4Gi
kubernetes_jobs_max_user_memory_limit Maximum custom memory limit that users can assign to their job containers via kubernetes_memory_limit hint in reana.yaml. Exceeding this limit will terminate the container. Please see the following URL for possible values https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory. None
kubernetes_jobs_timeout_limit Default timeout for user's jobs in seconds. Exceeding this time will terminate the job. Please see the following URL for more details https://kubernetes.io/docs/concepts/workloads/controllers/job/#job-termination-and-cleanup. Default value: 604800 seconds = 7 days. 604800
kubernetes_jobs_max_user_timeout_limit Maximum custom timeout in seconds that users can assign to their jobs. Please see the following URL for more details https://kubernetes.io/docs/concepts/workloads/controllers/job/#job-termination-and-cleanup. Default value: 1209600 seconds = 14 days. 1209600
login Enable and configure SSO authentication via a third-party Keycloak identity provider (configuration details) []
node_label_infrastructure Define the label which identifies the nodes where the infrastructure pods should run, e.g. reana.io/system=infrastructure. If you are setting this configuration variable, please also set .traefik.nodeSelector.reana.io/system=infrastructure so the ingress controller is also deployed on the infrastructure node. By default infrastructure pods can be scheduled to any available node in the cluster. None
node_label_infrastructuremq Define the label which identifies the node where message broker pod should run, e.g. reana.io/system=infrastructuremq. By default message broker pod can be scheduled to any available node in the cluster. None
node_label_infrastructuredb Define the label which identifies the node where database pod should run, e.g. reana.io/system=infrastructuredb. By default the database pod can be scheduled to any available node in the cluster. None
node_label_runtimebatch Define the label which identifies the nodes where the runtime workflow pods should run, e.g. reana.io/system=runtimebatch. By default runtime workflow pods can be scheduled to any available node in the cluster. None
node_label_runtimejobs Define the label which identifies the nodes where the runtime job pods should run, e.g. reana.io/system=runtimejobs. By default runtime job pods can be scheduled to any available node in the cluster. None
node_label_runtimesessions Define the label which identifies the nodes where the runtime session pods should run, e.g. reana.io/system=runtimesessions. By default runtime session pods can be scheduled to any available node in the cluster. None
notifications.email_config.login Login for the sender email address None
notifications.email_config.password Password for the sender email address None
notifications.email_config.receiver Email address which will be receiving the notifications None
notifications.email_config.sender Email address which will be sending the notifications None
notifications.email_config.smtp_server SMTP email server host None
notifications.email_config.smtp_ssl Use SSL to connect to SMTP server false
notifications.email_config.smtp_starttls Use STARTTLS command of SMTP to upgrade to an encrypted connection true
notifications.email_config.smtp_port SMTP email server port None
notifications.enabled Enable REANA system events notifications. For more information, visit the documentation page on user sign up. false
notifications.system_status Cronjob pattern representing how often the system status notification should be sent. Leave it empty to deactivate it "0 0 * * *"
reana_hostname REANA hostname (e.g. reana.example.org) None
namespace_runtime Namespace in which the REANA runtime pods (workflow engines, jobs etc...) will run .Release.Namespace
naming_scheme REANA component naming scheme None
secrets.cache.password [Do not save it in values.yaml, pass it to Helm with --set] Cache (Redis) password None
secrets.cern.sso.CERN_CONSUMER_KEY CERN SSO consumer key None
secrets.cern.sso.CERN_CONSUMER_SECRET [Do not save it in values.yaml, pass it to Helm with --set] CERN SSO consumer secret None
secrets.database.password [Do not save it in values.yaml, pass it to Helm with --set] PostgreSQL database password None
secrets.database.user PostgreSQL database username None
secrets.gitlab.REANA_GITLAB_HOST Hostname of the GitLab instance None
secrets.gitlab.REANA_GITLAB_OAUTH_APP_ID GitLab OAuth application id None
secrets.gitlab.REANA_GITLAB_OAUTH_APP_SECRET [Do not save it in values.yaml, pass it to Helm with --set] GitLab OAuth application secret None
secrets.login [Do not save it in values.yaml, pass it to Helm with --set] Third-party Keycloak identity provider consumer key and secret (configuration details) {}
secrets.message_broker.user Message broker (RabbitMQ) username. test
secrets.message_broker.password [Do not save it in values.yaml, pass it to Helm with --set] Message broker (RabbitMQ) password 1234
secrets.reana.REANA_SECRET_KEY [Do not save it in values.yaml, pass it to Helm with --set] REANA encryption secret key None
serviceAccount.create Create a service account for the REANA system user true
serviceAccount.name Service account name reana
shared_storage.access_modes Shared volume access mode ReadWriteMany
shared_storage.backend Shared volume storage backend hostpath
shared_storage.cephfs.availability_zone [CERN only] OpenStack Availability zone nova
shared_storage.cephfs.cephfs_os_share_access_id [CERN only] CephFS share access ID None
shared_storage.cephfs.cephfs_os_share_id [CERN only] CephFS share id None
shared_storage.cephfs.os_secret_name [CERN only] Name of the Secret object containing OpenStack credentials os-trustee
shared_storage.cephfs.os_secret_namespace [CERN only] Namespace of the OpenStack credentials Secret object kube-system
shared_storage.cephfs.provisioner [CERN only] CephFS provisioner manila-provisioner
shared_storage.cephfs.type [CERN only] CephFS availability zone "Geneva CephFS Testing"
shared_storage.volume_size Shared volume size 200
shared_storage.shared_volume_mount_path Path inside the REANA components where the shared volume will be mounted /var/reana
shared_storage.hostpath.root_path Path to the REANA directory inside the underlying storage volume /var/reana
traefik.* Pass any value from Traefik Helm chart values here, e.g. traefik.rbac.enabled=true -
traefik.enabled Install Traefik in the cluster when installing REANA true
volume_paths.root_path Path to the REANA directory inside the underlying storage volume /var/reana
volume_paths.shared_volume_path Path inside the REANA components where the shared volume will be mounted /var/reana
quota.enabled Enable user workflow accounting capabilities. true
quota.periodic_update_policy Cronjob pattern representing how often the users Disk and CPU quota usage should be updated. Leave it empty to deactivate it "0 3 * * *"
quota.workflow_termination_update_policy Resources to calculate quotas on worflow termination. Possible values: "cpu" and "disk". Leave it empty to deactivate workflow termination accounting. ""
quota.default_disk_limit Default users disk quota limit in bytes. (0=unlimited) 0
quota.default_cpu_limit Default users CPU quota limit in milliseconds. (0=unlimited) 0
workspaces.retention_rules.maximum_period Set a default period in days for workspace retention rules. Users will not be able to specify a longer period to retain the workspace files. After this period the workspace will be cleared. To disable the period and allow files to be kept forever, use value "forever". forever
workspaces.retention_rules.cronjob_schedule Cron format string describing how often pending retention rules should be applied. "0 2 * * *"
workspaces.paths List of additional workspace paths as strings. Each mount string is composed by a key hostPath(path to the directory to be mounted from the Kubernetes nodes) and a cluster_pod_mountpath (path inside the cluster containers where the mountPath will be mounted) e.g. hostPath:mountPath. The first value listed will be the default workspace root path. Any POSIX filesystem mounted on cluster nodes is supported None
interactive_sessions.cronjob_schedule Cron format string describing how often interactive session cleanup should be performed. "0 3 * * *"
interactive_sessions.maximum_inactivity_period Set a limit in days for the maximum inactivity period of interactive sessions. After this period interactive sessions will be automatically closed. To disable autoclosure and allow interactive sessions to run forever, use value "forever". forever
components.reana_ui.launcher_examples Array of demo examples to show in the launch page in the UI. Each demo repository is composed of name, url, image_url; you can also optionally specify a description and the specification filename. []