vantage6 5.0.0a33__py3-none-any.whl → 5.0.0a35__py3-none-any.whl

vantage6/cli/template/node_config.j2

@@ -1,33 +1,336 @@
-api_path: {{ api_path }}
-encryption:
-  enabled: false
-  private_key: null
-logging:
-  backup_count: 5
-  datefmt: '%Y-%m-%d %H:%M:%S'
-  file: {{ logging["file"] }}
-  format: '%(asctime)s - %(name)-14s - %(levelname)-8s - %(message)s'
-  level: DEBUG
-  max_size: 1024
-  use_console: true
-  loggers:
-  - level: warning
-    name: urllib3
-  - level: warning
-    name: requests
-  - level: warning
-    name: engineio.client
-  - level: warning
-    name: docker.utils.config
-  - level: warning
-    name: docker.auth
-  - level: warning
-    name: kubernetes.client.rest
-node_proxy_port: {{ node_proxy_port }}
-port: {{ port }}
-server_url: {{ server_url }}
-task_dir: {{ task_dir}}
-dev:
-  task_dir_extension: {{ task_dir_extension }}
-task_namespace: {{ task_namespace }}
-{{- user_provided_config -}}
+# override the chart name
+nameOverride: {{ nameOverride | default('vantage6-node') }}
+# Optional, by default the Release.Namespace is used
+# namespace: vantage6-node
+node:
+
+  # Set to false to prevent creation of node secrets (useful when secrets are managed
+  # externally)
+  createSecrets: {{ node.createSecrets | default(true) }}
+
+  name: {{ node.name | default('put-your-node-name-here') }}
+  apiKey: {{ node.apiKey | default('put-your-api-key-here') }}
+
+  # Keycloak configuration
+  keycloakUrl: {{ node.keycloakUrl | default('http://vantage6-auth-keycloak.vantage6.svc.cluster.local') }}
+  keycloakRealm: {{ node.keycloakRealm | default('vantage6') }}
+
+  # TODO v5+ set the url/port directly on node-configmap.yaml using \{\{ .Release.Name \}\}-vantage6-server-service
+  {% if node.server is defined %}
+  server:
+    url: {{ node.server.url | default('http://vantage6-server-vantage6-server-service') }}
+    port: {{ node.server.port | default(7601) }}
+    path: {{ node.server.path | default('/server') }}
+  {% else %}
+  server:
+    url: http://vantage6-server-vantage6-server-service
+    port: 7601
+    path: /server
+  {% endif %}
+
+
+  image: {{ node.image | default('harbor2.vantage6.ai/infrastructure/node:latest') }}
+
+  # Namespace in which the task kubernetes resources are created. This must be a
+  # namespace where the node has access to create pods.
+  taskNamespace: {{ node.taskNamespace | default('vantage6-tasks') }}
+
+  # Kubernetes node name, used for local persistent volumes
+  k8sNodeName: {{ node.k8sNodeName | default('docker-desktop') }}
+
+  logging:
+    # Controls the logging output level. Could be one of the following
+    # levels: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET
+    level: {{ node.logging.level | default('INFO') }}
+
+    # Location to the log file
+    file: {{ node.logging.file | default('node.log') }}
+
+    # Size in kb of a single log file
+    max_size: {{ node.logging.max_size | default(1024) }}
+    use_console: {{ node.logging.use_console | default(true) }}
+
+    # Date format for the log file
+    datefmt: "{{ node.logging.datefmt | default('%Y-%m-%d %H:%M:%S') }}"
+
+    # Format for the log file
+    format: "{{ node.logging.format | default('%(asctime)s - %(name)-14s - %(levelname)-8s - %(message)s') }}"
+
+    # Maximum number of log files to keep. Log files are rotated when the size of the
+    # current log file exceeds `max_size`.
+    backup_count: {{ node.logging.backup_count | default(5) }}
+
+    # Loggers to include in the log file
+    loggers:
+    {% if node.logging.loggers is defined %}
+    {% for logger in node.logging.loggers %}
+    - level: {{ logger.level }}
+      name: {{ logger.name }}
+    {% endfor %}
+    {% endif %}
+    {% if node.logging.loggers is not defined %}
+    - level: warning
+      name: urllib3
+    - level: warning
+      name: socketIO-client
+    - level: warning
+      name: socketio.server
+    - level: warning
+      name: engineio.server
+    - level: warning
+      name: sqlalchemy.engine
+    {% endif %}
+
+  {% if node.encryption is defined %}
+  encryption:
+    # Whether encryption is enabled or not. This should be the same as the `encrypted`
+    # setting of the collaboration to which this node belongs.
+    enabled: {{ node.encryption.enabled | default(false) }}
+
+    # Location to the private key file. Required if encryption is enabled.
+    {% if node.encryption.enabled | default(false) %}
+    private_key: {{ node.encryption.private_key | default('/path/to/private_key.pem') }}
+    {% else %}
+    # private_key: /path/to/private_key.pem
+    {% endif %}
+  {% else %}
+  encryption:
+    # Whether encryption is enabled or not. This should be the same as the `encrypted`
+    # setting of the collaboration to which this node belongs.
+    enabled: false
+
+    # Location to the private key file. Required if encryption is enabled.
+    # private_key: /path/to/private_key.pem
+  {% endif %}
+
+  # Port for the node proxy to run on
+  proxyPort: {{ node.proxyPort | default(7654) }}
+
+  # Storage settings on host of the node machine. This defines where the database is
+  # stored as well as the task directory (which will contain the input/output of the
+  # tasks).
+  {% if node.persistence is defined %}
+  persistence:
+    tasks:
+      storageClass: {{ node.persistence.tasks.storageClass | default('local-storage') }}
+      size: {{ node.persistence.tasks.size | default('10Gi') }}
+      hostPath: {{ node.persistence.tasks.hostPath | default('/path/to/where/task/files/are/stored') }}
+    database:
+      storageClass: {{ node.persistence.database.storageClass | default('local-storage') }}
+      size: {{ node.persistence.database.size | default('5Gi') }}
+  {% else %}
+  persistence:
+    tasks:
+      storageClass: local-storage
+      size: 10Gi
+      hostPath: /path/to/where/task/files/are/stored
+    database:
+      storageClass: local-storage
+      size: 5Gi
+  {% endif %}
+
+
+  # It is also possible not to specify the details of the service-based databases
+  # here. The node will then automatically detect the databases in the environment
+  # variables. This allows parent charts to specify the databases in their own
+  # values.yaml file or define them runtime using the CLI.
+  #
+  # In this case, the node expects the following environment variables to be set:
+  #
+  # DATABASE_LABELS: comma-separated list of database labels
+  # DATABASE_[LABEL]_URI: URI of the database
+  # DATABASE_[LABEL]_TYPE: type of the database
+  #
+  # Optionally, you can also specify additional environment variables for each
+  # database by setting the DATABASE_[LABEL]_SOME_OTHER_KEY variable.
+  #
+  # DATABASE_[LABEL]_SOME_OTHER_KEY: some_other_value
+  #
+  # It is recommended to do this through Kubernetes secrets. If you specify the
+  # details here, secrets will be used. File-based databases are automatically made
+  # available to your node.
+  {% if node.databases is defined %}
+  databases:
+    {% if node.databases.fileBased is defined %}
+    fileBased:
+    {% for db in node.databases.fileBased %}
+    - name: {{ db.name }}
+      uri: {{ db.uri }}
+      type: {{ db.type }}
+      volumePath: {{ db.volumePath }}
+      originalName: {{ db.originalName }}
+    {% endfor %}
+    {% endif %}
+    {% if node.databases.serviceBased is defined %}
+    serviceBased:
+    {% for db in node.databases.serviceBased %}
+    - name: {{ db.name }}
+      uri: {{ db.uri }}
+      type: {{ db.type }}
+      env:
+        {% for key, value in db.env.items() %}
+        {{ key }}: {{ value }}
+        {% endfor %}
+    {% endfor %}
+    {% endif %}
+  {% else %}
+  databases: []
+  {% endif %}
+
+  # Whether or not your node shares some configuration (e.g. which images are
+  # allowed to run on your node) with the central server. This can be useful
+  # for other organizations in your collaboration to understand why a task
+  # is not completed. Obviously, no sensitive data is shared. Default true
+  share_config: {{ node.share_config | default(true) }}
+
+  # Whether or not to share algorithm logs with the server. Otherwise they will
+  # only be displayed as part of the node logs. Default is true.
+  # NOTE: It's recommented to set this to false when using sensitive data
+  share_algorithm_logs: {{ node.share_algorithm_logs | default(true) }}
+
+  # Define who is allowed to run which algorithms on this node.
+  {% if node.policies is defined %}
+  policies:
+    # Control which algorithm images are allowed to run on this node. This is
+    # expected to be a valid regular expression. If you don't specify this, all algorithm
+    # images are allowed to run on this node (unless other policies restrict this).
+    {% if node.policies.allowed_algorithms is defined %}
+    allowed_algorithms:
+      {% for algo in node.policies.allowed_algorithms %}
+      - {{ algo }}
+      {% endfor %}
+    {% else %}
+    # allowed_algorithms:
+    #   - ^harbor2\.vantage6\.ai/[a-zA-Z]+/[a-zA-Z]+
+    #   - ^myalgorithm\.ai/some-algorithm
+    {% endif %}
+
+    # It is also possible to allow all algorithms from particular algorithm stores. Set
+    # these stores here. They may be strings or regular expressions. If you don't specify
+    # this, algorithms from any store are allowed (unless other policies prevent this).
+    {% if node.policies.allowed_algorithm_stores is defined %}
+    allowed_algorithm_stores:
+      {% for store in node.policies.allowed_algorithm_stores %}
+      - {{ store }}
+      {% endfor %}
+    {% else %}
+    # allowed_algorithm_stores:
+    #   # allow all algorithms from the vantage6 community store
+    #   - https://store.cotopaxi.vantage6.ai
+    #   # allow any store that is a subdomain of vantage6.ai
+    #   - ^https://[a-z]+\.vantage6\.ai$
+    {% endif %}
+
+    # If you define both `allowed_algorithm_stores` and `allowed_algorithms`, you can
+    # choose to only allow algorithms that both policies allow, or you can allow
+    # algorithms that either of them allows. By default, only algorithms that are given
+    # in *both* the `allowed_algorithms` and `allowed_algorithm_stores` are allowed by
+    # setting this to the default value `false`.
+    allow_either_whitelist_or_store: {{ node.policies.allow_either_whitelist_or_store | default(false) }}
+
+    # Define which users are allowed to run algorithms on your node by their ID
+    {% if node.policies.allowed_users is defined %}
+    allowed_users:
+      {% for user in node.policies.allowed_users %}
+      - {{ user }}
+      {% endfor %}
+    {% else %}
+    # allowed_users:
+    #   - 2
+    {% endif %}
+
+    # Define which organizations are allowed to run images on your node by
+    # their ID or name
+    {% if node.policies.allowed_organizations is defined %}
+    allowed_organizations:
+      {% for org in node.policies.allowed_organizations %}
+      - {{ org }}
+      {% endfor %}
+    {% else %}
+    # allowed_organizations:
+    #   - 6
+    #   - root
+    {% endif %}
+
+    # Set to true to always require that the algorithm image is successfully pulled. This
+    # ensures that no potentially outdated local images are used if internet connection
+    # is not available. This option should be set to false if you are testing with local
+    # algorithm images. Default value is true.
+    require_algorithm_pull: {{ node.policies.require_algorithm_pull | default(true) }}
+  {% else %}
+  policies:
+    # Control which algorithm images are allowed to run on this node. This is
+    # expected to be a valid regular expression. If you don't specify this, all algorithm
+    # images are allowed to run on this node (unless other policies restrict this).
+    # allowed_algorithms:
+    #   - ^harbor2\.vantage6\.ai/[a-zA-Z]+/[a-zA-Z]+
+    #   - ^myalgorithm\.ai/some-algorithm
+
+    # It is also possible to allow all algorithms from particular algorithm stores. Set
+    # these stores here. They may be strings or regular expressions. If you don't specify
+    # this, algorithms from any store are allowed (unless other policies prevent this).
+    # allowed_algorithm_stores:
+    #   # allow all algorithms from the vantage6 community store
+    #   - https://store.cotopaxi.vantage6.ai
+    #   # allow any store that is a subdomain of vantage6.ai
+    #   - ^https://[a-z]+\.vantage6\.ai$
+
+    # If you define both `allowed_algorithm_stores` and `allowed_algorithms`, you can
+    # choose to only allow algorithms that both policies allow, or you can allow
+    # algorithms that either of them allows. By default, only algorithms that are given
+    # in *both* the `allowed_algorithms` and `allowed_algorithm_stores` are allowed by
+    # setting this to the default value `false`.
+    # allow_either_whitelist_or_store: false
+
+    # Define which users are allowed to run algorithms on your node by their ID
+    # allowed_users:
+    #   - 2
+    # Define which organizations are allowed to run images on your node by
+    # their ID or name
+    # allowed_organizations:
+    #   - 6
+    #   - root
+
+    # Set to true to always require that the algorithm image is successfully pulled. This
+    # ensures that no potentially outdated local images are used if internet connection
+    # is not available. This option should be set to false if you are testing with local
+    # algorithm images. Default value is true.
+    require_algorithm_pull: true
+  {% endif %}
+
+  # Prometheus settings, for sending system metadata to the server.
+  {% if node.prometheus is defined %}
+  prometheus:
+    # Whether or not to enable Prometheus reporting. Default is false.
+    enabled: {{ node.prometheus.enabled | default(false) }}
+
+    # Interval (in seconds) at which the node sends system metadata to the server.
+    # This should align with the Prometheus scrape_interval to avoid stale data.
+    report_interval_seconds: {{ node.prometheus.report_interval_seconds | default(45) }}
+  {% else %}
+  prometheus:
+    # Whether or not to enable Prometheus reporting. Default is false.
+    enabled: false
+
+    # Interval (in seconds) at which the node sends system metadata to the server.
+    # This should align with the Prometheus scrape_interval to avoid stale data.
+    # report_interval_seconds: 45
+  {% endif %}
+
+  {% if node.debug is defined %}
+  # Debug settings
+  debug:
+    # Set to `true` to enable print debug messages from Flask/socketio.
+    socketio: {{ node.debug.socketio | default(false) }}
+
+    # Set to `true` to set the Flask app used for proxy service into debug mode.
+    proxy_server: {{ node.debug.proxy_server | default(false) }}
+  {% endif %}
+
+  {% if node.dev is defined %}
+  dev:
+    # Set extension for the task directory. In the development environment, the task
+    # directory is mounted as a volume. If multiple nodes are then running on the same
+    # machine, this extension is added to the task directory to avoid conflicts.
+    task_dir_extension: {{ node.dev.task_dir_extension }}
+  {% endif %}

vantage6/cli/template/server_config.j2

@@ -1,34 +1,256 @@
-allow_drop_all: false
-api_path: /api
-description: 'defaultserver'
-ip: 0.0.0.0
-logging:
-  backup_count: 5
-  datefmt: '%Y-%m-%d %H:%M:%S'
-  file: test-server.log
-  format: '%(asctime)s - %(name)-14s - %(levelname)-8s - %(message)s'
-  level: DEBUG
-  max_size: 1024
-  use_console: true
-  loggers:
-  - level: warning
-    name: urllib3
-  - level: warning
-    name: socketIO-client
-  - level: warning
-    name: socketio.server
-  - level: warning
-    name: engineio.server
-  - level: warning
-    name: sqlalchemy.engine
-  - level: warning
-    name: requests_oauthlib.oauth2_session
-port: {{ port }}
-uri: sqlite:///default.sqlite
-dev:
-  host_uri: {{ host_uri }}
-server_url: http://localhost:{{ port }}/api
+# Override the chart name
+nameOverride: {{ nameOverride | default('vantage6-server') }}
+# Optional, by default the Release.Namespace is used
+# namespace: vantage6-server
+server:
+  # The description of the server
+  description: {{ server.description | default('Vantage6 server version 5') }}
+
+  # The external URL of the server
+  baseUrl: {{ server.baseUrl | default('http://localhost:7601') }}
+  apiPath: {{ server.apiPath | default('/server') }}
+
+  # Keycloak configuration
+  keycloakUrl: {{ server.keycloakUrl }}
+  keycloakRealm: {{ server.keycloakRealm | default('vantage6') }}
+  keycloakAdminUsername: {{ server.keycloakAdminUsername | default('admin') }}
+  keycloakAdminPassword: {{ server.keycloakAdminPassword | default('admin') }}
+  keycloakAdminClient: {{ server.keycloakAdminClient | default('backend-admin-client') }}
+  keycloakAdminClientSecret: {{ server.keycloakAdminClientSecret | default('myadminclientsecret') }}
+  {% if server.keycloak is defined %}
+  keycloak:
+    manage_users_and_nodes: {{ server.keycloak.manage_users_and_nodes | default(true) }}
+  {% endif %}
+  {% if server.keycloak is not defined %}
+  keycloak:
+    manage_users_and_nodes: true
+  {% endif %}
+
+  {% if server.internal is defined %}
+  internal:
+    port: {{ server.internal.port | default(7601) }}
+  {% endif %}
+  {% if server.internal is not defined %}
+  internal:
+    port: 7601
+  {% endif %}
+
+  port: {{ server.port | default(7601) }}
+
+  # The number of replicas of the server
+  replications: {{ server.replications | default(1) }}
+
+  # The image used to start the server
+  image: {{ server.image | default('harbor2.vantage6.ai/infrastructure/server:latest') }}
+
+  logging:
+    # Controls the logging output level. Could be one of the following
+    # levels: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET
+    level: {{ server.logging.level | default('INFO') }}
+
+    # Location to the log file
+    file: {{ server.logging.file | default('server.log') }}
+
+    # Size in kb of a single log file
+    max_size: {{ server.logging.max_size | default(1024) }}
+    use_console: {{ server.logging.use_console | default(true) }}
+
+    # Date format for the log file
+    datefmt: "{{ server.logging.datefmt | default('%Y-%m-%d %H:%M:%S') }}"
+
+    # Format for the log file
+    format: "{{ server.logging.format | default('%(asctime)s - %(name)-14s - %(levelname)-8s - %(message)s') }}"
+
+    # Maximum number of log files to keep. Log files are rotated when the size of the
+    # current log file exceeds `max_size`.
+    backup_count: {{ server.logging.backup_count | default(5) }}
+
+    # Loggers to include in the log file
+    loggers:
+    {% if server.logging.loggers is defined %}
+    {% for logger in server.logging.loggers %}
+    - level: {{ logger.level }}
+      name: {{ logger.name }}
+    {% endfor %}
+    {% endif %}
+    {% if server.logging.loggers is not defined %}
+    - level: warning
+      name: urllib3
+    - level: warning
+      name: socketIO-client
+    - level: warning
+      name: socketio.server
+    - level: warning
+      name: engineio.server
+    - level: warning
+      name: sqlalchemy.engine
+    {% endif %}
+
+  {% if server.jwt is defined and server.jwt.secret is defined %}
+  # Setting constant secret for the JWT token. This is not recommended for production
+  # environments.
+  jwt:
+    secret: {{ server.jwt.secret }}
+  {% endif %}
+
+  {% if server.dev is defined %}
+  dev:
+    host_uri: {{ server.dev.host_uri | default('host.docker.internal') }}
+    # This should be set to true if you are running the algorithm store in the same
+    # cluster and namespace as the server
+    store_in_local_cluster: {{ server.dev.store_in_local_cluster | default(false) }}
+  {% endif %}
+
+  # If you want to couple algorithm stores to the server on startup, you can add them here.
+  # The name is used to identify the algorithm store in the server's database.
+  # The url is the URL of the algorithm store's API.
+  {% if server.algorithm_stores is defined %}
+  algorithm_stores:
+    {% for store in server.algorithm_stores %}
+    - name: {{ store.name }}
+      url: {{ store.url }}
+    {% endfor %}
+  {% else %}
+  # algorithm_stores:
+  # - name: local store
+  #   url: http://localhost:7602/api
+  {% endif %}
+
+  # Cleanup settings: This is used to cleanup the database from old results.
+  # Every hour, results older than the threshold for completed runs are deleted.
+  # Disabled unless you specify this option. Careful! Make sure you have regular
+  # backups of your database before enabling this feature, as a wrong configuration
+  # could lead to data loss.
+  {% if server.runs_data_cleanup_days is defined %}
+  runs_data_cleanup_days: {{ server.runs_data_cleanup_days }}
+  {% endif %}
+  {% if server.runs_data_cleanup_days is not defined %}
+  # runs_data_cleanup_days: 30
+  {% endif %}
+  # Whether to also delete the algorithm arguments of the runs. False by default.
+  {% if server.runs_data_cleanup_include_args is defined %}
+  runs_data_cleanup_include_args: {{ server.runs_data_cleanup_include_args }}
+  {% endif %}
+  {% if server.runs_data_cleanup_include_args is not defined %}
+  # runs_data_cleanup_include_args: false
+  {% endif %}
+
+  # Settings for enabling monitoring of vantage6 nodes resource usage (e.g. CPU, memory).
+  # This is done using Prometheus. There are two components to this:
+  # 1. The Prometheus exporter (running as part of the vantage6 server), which collects
+  #    the metrics from the nodes.
+  # 2. The Prometheus server (running as a separate Docker container), which scrapes the
+  #     metrics exposed by the Prometheus exporter and stores them.
+  # The exporter is started by default when the server starts (if prometheus is enabled).
+  # The Prometheus server can be started separately.
+  prometheus:
+    # Set to true to enable Prometheus reporting. Default is false.
+    {% if server.prometheus is defined %}
+    enabled: {{ server.prometheus.enabled | default(false) }}
+    {% else %}
+    enabled: false
+    {% endif %}
+    # Set to true to start the Prometheus server when starting the server
+    {% if server.prometheus is defined and server.prometheus.start_with_server is defined %}
+    start_with_server: {{ server.prometheus.start_with_server }}
+    {% else %}
+    # start_with_server: false
+    {% endif %}
+    # The port on which the Prometheus exporter will be available. This is the port that the Prometheus server will scrape.
+    # Note: The Prometheus server assumes the exporter is accessible via the Docker container's hostname.
+    # Ensure that Prometheus is in the same Docker network as the vantage6 server to resolve the hostname.
+    {% if server.prometheus is defined and server.prometheus.exporter_port is defined %}
+    exporter_port: {{ server.prometheus.exporter_port }}
+    {% else %}
+    # exporter_port: 7603
+    {% endif %}
+
+  # set up with which origins the server should allow CORS requests. The default
+  # is to allow all origins. If you want to restrict this, you can specify a list
+  # of origins here. Below are examples to allow requests from the Cotopaxi UI, and
+  # port 7600 on localhost. Usually, only the UI needs to access the server.
+  {% if server.cors_allowed_origins is defined %}
+  cors_allowed_origins:
+    {% for origin in server.cors_allowed_origins %}
+    - {{ origin }}
+    {% endfor %}
+  {% else %}
+  # cors_allowed_origins:
+  #   - https://portal.cotopaxi.vantage6.ai
+  #   - http://localhost:7600
+  {% endif %}
+
+rabbitmq:
+  # The image of the RabbitMQ server
+  image:
+    {% if rabbitmq.image is defined %}
+    repository: {{ rabbitmq.image.repository | default('rabbitmq') }}
+    tag: {{ rabbitmq.image.tag | default('3-management') }}
+    {% else %}
+    repository: rabbitmq
+    tag: 3-management
+    {% endif %}
+
+  # The username of the RabbitMQ server
+  username: {{ rabbitmq.username | default('rabbitmquser') }}
+
+  # The password of the RabbitMQ server
+  password: {{ rabbitmq.password | default('rabbitmquserpassword') }}
+
+  # The vhost of the RabbitMQ server
+  vhost: {{ rabbitmq.vhost | default('/vantage6') }}
+
+database:
+  # whether or not to use an external database
+  external: {{ database.external | default(false) }}
+  {% if database.external is defined and database.external %}
+  # the URI of the external database
+  uri: {{ database.uri | default('postgresql://vantage6:vantage6@localhost:5432/vantage6') }}
+  {% else %}
+  # The image of the database
+  image:
+    {% if database.image is defined %}
+    repository: {{ database.image.repository | default('postgres') }}
+    tag: {{ database.image.tag | default('13') }}
+    {% else %}
+    repository: postgres
+    tag: 13
+    {% endif %}
+
+  # The username of the database
+  username: {{ database.username | default('vantage6') }}
+
+  # The password of the database
+  password: {{ database.password | default('vantage6') }}
+
+  # The name of the database
+  name: {{ database.name | default('vantage6') }}
+
+  #hostpath of the database mount
+  volumePath: {{ database.volumePath }}
+
+  # The name of the k8s node where the database is running
+  k8sNodeName: {{ database.k8sNodeName }}
+  {% endif %}
+
 ui:
-  enabled: true
-  port: {{ ui_port }}
-{{ user_provided_config }}
+
+  # The image of the UI
+  image: {{ ui.image | default('harbor2.vantage6.ai/infrastructure/ui:latest') }}
+  # Service port for the UI
+  port: 7600
+  # keycloak realm
+  keycloakRealm: {{ ui.keycloakRealm | default('vantage6') }}
+  # keycloak client
+  keycloakClient: {{ ui.keycloakClient | default('public_client') }}
+  # keycloak public URL
+  keycloakPublicUrl: {{ ui.keycloakPublicUrl | default('http://localhost:8080') }}
+
+  # Allowed algorithm stores for Bearer token inclusion (comma-separated URLs)
+  # Use "*" to allow all stores (less secure) or specify specific URLs
+  # allowedAlgorithmStores: "http://localhost:7602 https://store.cotopaxi.vantage6.ai"
+  allowedAlgorithmStores: "{{ ui.allowedAlgorithmStores | default('*') }}"
+  # Community algorithm store URL.
+  communityStoreUrl: {{ ui.communityStoreUrl | default('https://store.cotopaxi.vantage6.ai') }}
+  # Community algorithm store API path
+  communityStoreApiPath: {{ ui.communityStoreApiPath | default('/api') }}

vantage6/cli/utils.py

@@ -32,8 +32,6 @@ def check_config_name_allowed(name: str) -> None:
             f"Name '{name}' is not allowed. Please use only the following "
             "characters: a-zA-Z0-9_.-"
         )
-        # FIXME: FM, 2023-01-03: I dont think this is a good side effect. This
-        # should be handled by the caller.
         exit(1)