ansys-saf-cli 4.1.dev0__py3-none-any.whl

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/README.md

@@ -0,0 +1,69 @@
+{{cookiecutter.__solution_name}}
+====================================
+|python|
+
+.. note::
+  This content needs to be configured according to the project specifics.
+
+# Team & Roles
+
+| Role                     |  Owner  |
+| ------------------------ | ------- |
+| Solution Owner           | XXXXXXX |
+| Solution Product Manager | XXXXXXX |
+| Domain ``SME``           | XXXXXXX |
+| Development Manager      | XXXXXXX |
+| Solution developer       | XXXXXXX |
+| UI/UX                    | XXXXXXX |
+| DevOps                   | XXXXXXX |
+| Documentation            | XXXXXXX |
+
+# Prerequisites
+
+| Prerequisite | Description |
+|--------------|-------------|
+| Operating system | Windows 10 or Ubuntu |
+| Python distribution | Python {{ cookiecutter.__python_version }} |
+| Supported Python distributions | Python 3.10, 3.11, 3.12, 3.13 and 3.14 |
+| IDE | [Visual Studio Code](https://code.visualstudio.com/download#) |
+| SAF CLI | Install [latest SAF CLI](https://dev-docs.external.solutions.ansys.com/version/stable/getting_started/prerequisites/saf_cli.html) |
+
+# Install the solution
+
+This assumes that SAF CLI is installed and the ``saf`` command is available in the terminal. Therefore, it is not strictly required to run the following commands from any directory in particular.
+
+1. Run the ``saf install`` command with the ``<solution_name>`` argument. By default, it will install ``desktop`` and ``ui`` dependency groups.
+
+```bash
+saf install {{ cookiecutter.__solution_name }}
+```
+
+Check the [Install solution’s development environment](https://saf-cli.external.solutions.ansys.com/version/stable/user_guide/install_solution_environment.html) section of the SAF CLI documentation for more options.
+
+# Start the solution
+
+To start the solution run the following command anywhere in the system:
+
+```bash
+saf run {{ cookiecutter.__solution_name }}
+```
+
+Check the [Run a solution](https://saf-cli.external.solutions.ansys.com/version/stable/user_guide/run.html) section of the SAF CLI documentation for more options.
+
+# Generate a distributable desktop installer
+
+To generate an executable installer from the solution application:
+
+1. Install the build dependencies:
+
+```bash
+saf install {{ cookiecutter.__solution_name }} -d build
+```
+
+2. Run the ``saf build`` command:
+
+```bash
+saf build {{ cookiecutter.__solution_name }}
+```
+
+Check the [Build a distributable installer](https://saf-cli.external.solutions.ansys.com/version/stable/user_guide/installer.html) section of the SAF CLI documentation for more options.

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/Dockerfile

@@ -0,0 +1,43 @@
+# === Base Stage ==================================================================================
+
+FROM python:3.12-slim AS base
+
+RUN apt update && apt install curl libx11-6 libglu1-mesa-dev libxrender1 libgl1 libglx-mesa0 xvfb iputils-ping tk libicu-dev -y
+RUN pip install --upgrade pip && pip install poetry==2.3.2
+
+WORKDIR /app
+
+COPY ../../pyproject.toml ../../poetry.lock /app/
+COPY README.md /app/
+
+RUN mkdir -p /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}
+RUN touch /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/__init__.py
+
+RUN poetry install
+
+COPY ../../minerva /usr/local/share/minerva
+
+RUN rm -rf /root/.cache/pip/* /dist /var/lib/apt/lists/*
+
+# === API Stage ===================================================================================
+
+FROM base AS solution_api
+
+COPY ../../src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/
+
+# Directory required by pyHPS
+RUN mkdir -p /.ansys/hps
+RUN chmod -R 777 /.ansys/hps
+
+ENTRYPOINT poetry run python -m uvicorn ansys.saf.glow.api:app --host $GLOW_API_HOST --port $GLOW_API_PORT --root-path $GLOW_API_PATH_PREFIX --workers ${GLOW_API_NUMBER_OF_WORKERS:-8}
+
+# === UI Stage ====================================================================================
+
+FROM base AS solution_ui
+
+RUN poetry install --only ui
+RUN poetry run pip install waitress
+
+COPY ../../src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/
+
+ENTRYPOINT poetry run python -m waitress --host $GLOW_UI_HOST --port $GLOW_UI_PORT --url-prefix $GLOW_UI_PATH_PREFIX ansys.saf.glow.ui:app

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/README.md

@@ -0,0 +1,13 @@
+# Deployment Options
+
+The solution template provides four different deployment options, each designed for specific use cases and environments. All deployments use Docker Compose for containerization.
+
+## Prerequisites for Container Deployments
+
+| Prerequisite | Description |
+|--------------|-------------|
+| WSL (Windows only) | [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) |
+| Virtualization | [Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/) (requires a license) or [Docker Engine](https://docs.docker.com/engine/install/) (open-source) |
+| Environment variables | Set `MACHINE_IP` with the IP address of your machine if you use Docker Desktop or the IP address of your WSL if you use WSL |
+
+Find more information about each deployment in the [Server-to-server deployments section](https://saf-cli.docs.solutions.ansys.com/version/stable/user_guide/solution_s2s_deployment.html) of the saf-cli documentation.

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/distributed-deployment-template/.env

@@ -0,0 +1,27 @@
+ACCESS_URL=solutions.${DOMAIN_NAME}
+APP_IMAGE_VERSION=main
+DATABASE_LOCATION={{ cookiecutter.__appdata_directory }}/Ansys/portal/{{ cookiecutter.__solution_name }}
+DOMAIN_NAME=
+EXT_NETWORK_NAME=platform_default
+GLOW_API_CONTAINER_PORT=8000
+GLOW_API_PATH_PREFIX=/
+# dotenv-linter:off QuoteCharacter
+GLOW_CORS_ORIGINS=["*"]
+# dotenv-linter:on QuoteCharacter
+GLOW_API_NUMBER_OF_WORKERS=8
+GLOW_DEPLOYMENT=DockerCompose
+GLOW_HPS_HOST=hps.${DOMAIN_NAME}
+GLOW_HPS_PASSWORD=repadmin
+GLOW_HPS_PORT=${TRAEFIK_PORT}
+GLOW_HPS_USERNAME=repadmin
+GLOW_PRODUCT_INSTANCE_SYSTEM=HPS
+GLOW_PROJECTS_DIR_SOLUTION=./data/projects
+GLOW_SOLUTION_DEFINITION={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.solution.definition
+GLOW_TRANSACTIONS_DIR_SOLUTION=./data/transactions
+GLOW_UI_CONTAINER_PORT=8001
+GLOW_UI_MODULE={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.ui.app
+GLOW_UI_PATH_PREFIX=/
+OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
+PORTAL_DATABASE_TYPE=postgres
+PORTAL_PROJECT_DATABASE_LOCATION=${DATABASE_LOCATION}/projects.db
+TRAEFIK_PORT=8443

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/distributed-deployment-template/compose.yaml

@@ -0,0 +1,132 @@
+name: {{ cookiecutter.__docker_name }}
+
+networks:
+  {{ cookiecutter.__docker_name }}-internal:
+    internal: true
+  {{ cookiecutter.__docker_name }}-external:
+    driver: bridge
+  external-network:
+    external: true
+    name: ${EXT_NETWORK_NAME}
+
+services:
+  {{ cookiecutter.__docker_name }}-postgresql:
+    image: postgres:16.0
+    networks:
+      - {{ cookiecutter.__docker_name }}-internal
+    environment:
+      - POSTGRES_USER=glow
+      - POSTGRES_PASSWORD=glow
+    healthcheck:
+      test: [ "CMD", "pg_isready", "-U", "glow" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - {{ cookiecutter.__docker_name }}-database:/var/lib/postgresql/data
+
+  {{ cookiecutter.__docker_name }}-api:
+    image: {{ cookiecutter.__docker_name }}-api
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_api
+      args:
+        EXTRAS: "hps"
+    depends_on:
+      {{ cookiecutter.__docker_name }}-postgresql:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+      - {{ cookiecutter.__docker_name }}-internal
+      - external-network
+    env_file:
+      - .env
+    init: true # to ensure reaping of killed child processes left by long-running transactions
+    environment:
+      - GLOW_DEPLOYMENT=DockerCompose
+      - GLOW_API_HOST=0.0.0.0
+      - GLOW_API_PORT=50000
+      - GLOW_DATABASE_TYPE=postgresql
+      - GLOW_DATABASE_LOCATION=postgresql://glow:glow@{{ cookiecutter.__docker_name }}-postgresql:5432
+      - GLOW_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_METHOD_EXECUTION_DIRECTORY=/transactions
+      - GLOW_EXTERNAL_API_URL=https://${ACCESS_URL}:${TRAEFIK_PORT}/{{ cookiecutter.__docker_name }}/api
+      - OTEL_EXPORTER_OTLP_ENDPOINT=${OTEL_EXPORTER_OTLP_ENDPOINT}
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50000/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+      - ${GLOW_TRANSACTIONS_DIR_SOLUTION}:/transactions
+      - /etc/hosts:/etc/hosts:ro
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.rule=Host(`${ACCESS_URL}`) && PathPrefix(`/{{ cookiecutter.__docker_name }}/api`)"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.entrypoints=web,external"
+      - "traefik.http.middlewares.{{ cookiecutter.__docker_name }}-api-stripprefix.stripprefix.prefixes=/{{ cookiecutter.__docker_name }}/api"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.middlewares={{ cookiecutter.__docker_name }}-api-stripprefix"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.service={{ cookiecutter.__docker_name }}-api"
+      - "traefik.http.services.{{ cookiecutter.__docker_name }}-api.loadbalancer.server.port=50000"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.tls=true"
+      - "traefik.docker.network=${EXT_NETWORK_NAME}"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.middlewares={{ cookiecutter.__docker_name }}-api-stripprefix,oauth-signin,oauth-verify,secure-and-gzip@file"
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+
+{% if cookiecutter.__ui_framework != "none" %}
+
+  {{ cookiecutter.__docker_name }}-ui:
+    image: {{ cookiecutter.__docker_name }}-ui
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_ui
+      args:
+        EXTRAS: "hps"
+    depends_on:
+      {{ cookiecutter.__docker_name }}-api:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+      - external-network
+    env_file:
+      - .env
+    environment:
+      - GLOW_DEPLOYMENT=DockerCompose
+      - GLOW_UI_HOST=0.0.0.0
+      - GLOW_UI_PORT=50001
+      - GLOW_API_URL=http://{{ cookiecutter.__docker_name }}-api:50000
+      - GLOW_UI_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_WS_EVENTS_ADDR=wss://${ACCESS_URL}:${TRAEFIK_PORT}/{{ cookiecutter.__docker_name }}/api
+      - GLOW_EXTERNAL_API_URL=https://${ACCESS_URL}:${TRAEFIK_PORT}/{{ cookiecutter.__docker_name }}/api
+      - GLOW_PORTAL_URL=https://portal.${DOMAIN_NAME}:${TRAEFIK_PORT}
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50001/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+      - /etc/hosts:/etc/hosts:ro
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.rule=Host(`${ACCESS_URL}`) && PathPrefix(`/{{ cookiecutter.__docker_name }}`)"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.entrypoints=external"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.service={{ cookiecutter.__docker_name }}-ui"
+      - "traefik.http.services.{{ cookiecutter.__docker_name }}-ui.loadbalancer.server.port=50001"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.tls=true"
+      - "traefik.docker.network=${EXT_NETWORK_NAME}"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.middlewares=oauth-signin,oauth-verify,secure-and-gzip@file"
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+
+{% endif %}
+
+volumes:
+  {{ cookiecutter.__docker_name }}-database:

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/standalone/.env

@@ -0,0 +1,20 @@
+APP_IMAGE_VERSION=main
+DATABASE_LOCATION={{ cookiecutter.__appdata_directory }}/Ansys/portal/{{ cookiecutter.__solution_name }}
+GLOW_API_CONTAINER_PORT=8000
+GLOW_API_PATH_PREFIX=/
+# dotenv-linter:off QuoteCharacter
+GLOW_CORS_ORIGINS=["*"]
+# dotenv-linter:on QuoteCharacter
+GLOW_API_NUMBER_OF_WORKERS=8
+GLOW_DEPLOYMENT=DockerCompose
+GLOW_PROJECTS_DIR_SOLUTION=./data/projects
+GLOW_SOLUTION_DEFINITION={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.solution.definition
+GLOW_TRANSACTIONS_DIR_SOLUTION=./data/transactions
+GLOW_UI_CONTAINER_PORT=8001
+GLOW_UI_MODULE={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.ui.app
+GLOW_UI_PATH_PREFIX=/
+OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-dashboard:18890
+# !!! Important !!! Change the following value and its reference in the compose.yaml to ensure secure connection with Aspire
+OTEL_EXPORTER_OTLP_HEADERS="x-otlp-api-key=YOU_MUST_GENERATE_A_RANDOM_STRING_AND_REPLACE_THIS"
+PORTAL_DATABASE_TYPE=sqlite
+PORTAL_PROJECT_DATABASE_LOCATION=${DATABASE_LOCATION}/projects.db

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/standalone/compose.yaml

@@ -0,0 +1,118 @@
+name: {{ cookiecutter.__docker_name }}
+
+networks:
+  {{ cookiecutter.__docker_name }}-internal:
+    internal: true
+  {{ cookiecutter.__docker_name }}-external:
+    driver: bridge
+
+services:
+  {{ cookiecutter.__docker_name }}-postgresql:
+    image: postgres:16.0
+    networks:
+      - {{ cookiecutter.__docker_name }}-internal
+    environment:
+      - POSTGRES_USER=glow
+      - POSTGRES_PASSWORD=glow
+    healthcheck:
+      test: [ "CMD", "pg_isready", "-U", "glow" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - {{ cookiecutter.__docker_name }}-database:/var/lib/postgresql/data
+
+  {{ cookiecutter.__docker_name }}-api:
+    image: {{ cookiecutter.__docker_name }}-api
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_api
+    depends_on:
+      {{ cookiecutter.__docker_name }}-postgresql:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+      - {{ cookiecutter.__docker_name }}-internal
+    env_file:
+      - .env
+    init: true # to ensure reaping of killed child processes left by long-running transactions
+    environment:
+      - GLOW_API_HOST=0.0.0.0
+      - GLOW_API_PORT=50000
+      - GLOW_DATABASE_TYPE=postgresql
+      - GLOW_DATABASE_LOCATION=postgresql://glow:glow@{{ cookiecutter.__docker_name }}-postgresql:5432
+      - GLOW_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_METHOD_EXECUTION_DIRECTORY=/transactions
+      - GLOW_EXTERNAL_API_URL=http://127.0.0.1:${GLOW_API_CONTAINER_PORT}
+      - OTEL_EXPORTER_OTLP_ENDPOINT=${OTEL_EXPORTER_OTLP_ENDPOINT}
+    ports:
+      - ${GLOW_API_CONTAINER_PORT}:50000
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50000/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+      - ${GLOW_TRANSACTIONS_DIR_SOLUTION}:/transactions
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+
+{% if cookiecutter.__ui_framework != "none" %}
+
+  {{ cookiecutter.__docker_name }}-ui:
+    image: {{ cookiecutter.__docker_name }}-ui
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_ui
+    depends_on:
+      {{ cookiecutter.__docker_name }}-api:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+    env_file:
+      - .env
+    environment:
+      - GLOW_DEPLOYMENT=DockerCompose
+      - GLOW_UI_HOST=0.0.0.0
+      - GLOW_UI_PORT=50001
+      - GLOW_API_URL=http://{{ cookiecutter.__docker_name }}-api:50000
+      - GLOW_UI_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_WS_EVENTS_ADDR=127.0.0.1:${GLOW_API_CONTAINER_PORT}
+      - GLOW_EXTERNAL_API_URL=http://127.0.0.1:${GLOW_API_CONTAINER_PORT}
+    ports:
+      - ${GLOW_UI_CONTAINER_PORT}:50001
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50001/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+
+{% endif %}
+
+  otel-dashboard:
+    image: mcr.microsoft.com/dotnet/aspire-dashboard:9.1.0
+    ports:
+      - 18888:18888 # UI
+      - 18889:18889 # OTLP gRPC
+      - 18890:18890 # OTLP HTTP
+    environment:
+      - DASHBOARD__OTLP__AUTHMODE=ApiKey
+      # !!! Important !!! For production, replace the following env var with secure values
+      # as described here: https://aspire.dev/dashboard/security-considerations/
+      - DASHBOARD__FRONTEND__AUTHMODE=Unsecured
+      - DASHBOARD__OTLP__PRIMARYAPIKEY=YOU_MUST_GENERATE_A_RANDOM_STRING_AND_REPLACE_THIS
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+
+volumes:
+  {{ cookiecutter.__docker_name }}-database:

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/standalone-with-hps/.env

@@ -0,0 +1,28 @@
+ACCESS_URL=${MACHINE_IP}
+APP_IMAGE_VERSION=main
+ASSETS_MOUNT=src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_name }}/solution/method_assets/Optimization
+DATABASE_LOCATION={{ cookiecutter.__appdata_directory }}/Ansys/portal/{{ cookiecutter.__solution_name }}
+EXT_NETWORK_NAME=ansys-hps_default
+GLOW_API_CONTAINER_PORT=8000
+GLOW_API_PATH_PREFIX=/
+# dotenv-linter:off QuoteCharacter
+GLOW_CORS_ORIGINS=["*"]
+# dotenv-linter:off QuoteCharacter
+GLOW_API_NUMBER_OF_WORKERS=8
+GLOW_DEPLOYMENT=DockerCompose
+GLOW_HPS_HOST=${MACHINE_IP}
+GLOW_HPS_PASSWORD=repadmin
+GLOW_HPS_PORT=8443
+GLOW_HPS_USERNAME=repadmin
+GLOW_PRODUCT_INSTANCE_SYSTEM=HPS
+GLOW_PROJECTS_DIR_SOLUTION=./data/projects
+GLOW_SOLUTION_DEFINITION={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.solution.definition
+GLOW_TRANSACTIONS_DIR_SOLUTION=./data/transactions
+GLOW_UI_CONTAINER_PORT=8001
+GLOW_UI_MODULE={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.ui.app
+GLOW_UI_PATH_PREFIX=/
+OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-dashboard:18890
+# !!! Important !!! Change the following value and its reference in the compose.yaml to ensure secure connection with Aspire
+OTEL_EXPORTER_OTLP_HEADERS="x-otlp-api-key=YOU_MUST_GENERATE_A_RANDOM_STRING_AND_REPLACE_THIS"
+PORTAL_DATABASE_TYPE=sqlite
+PORTAL_PROJECT_DATABASE_LOCATION=${DATABASE_LOCATION}/projects.db

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/standalone-with-hps/compose.yaml

@@ -0,0 +1,146 @@
+name: {{ cookiecutter.__docker_name }}
+
+networks:
+  {{ cookiecutter.__docker_name }}-internal:
+    internal: true
+  {{ cookiecutter.__docker_name }}-external:
+    driver: bridge
+  external-network:
+    external: true
+    name: ${EXT_NETWORK_NAME}
+
+services:
+  {{ cookiecutter.__docker_name }}-postgresql:
+    image: postgres:16.0
+    networks:
+      - {{ cookiecutter.__docker_name }}-internal
+    environment:
+      - POSTGRES_USER=glow
+      - POSTGRES_PASSWORD=glow
+    healthcheck:
+      test: [ "CMD", "pg_isready", "-U", "glow" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - {{ cookiecutter.__docker_name }}-database:/var/lib/postgresql/data
+
+  {{ cookiecutter.__docker_name }}-api:
+    image: {{ cookiecutter.__docker_name }}-api
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_api
+    depends_on:
+      {{ cookiecutter.__docker_name }}-postgresql:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+      - {{ cookiecutter.__docker_name }}-internal
+      - external-network
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    env_file:
+      - .env
+    init: true # to ensure reaping of killed child processes left by long-running transactions
+    environment:
+      - GLOW_DEPLOYMENT=DockerCompose
+      - GLOW_API_HOST=0.0.0.0
+      - GLOW_API_PORT=50000
+      - GLOW_DATABASE_TYPE=postgresql
+      - GLOW_DATABASE_LOCATION=postgresql://glow:glow@{{ cookiecutter.__docker_name }}-postgresql:5432
+      - GLOW_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_METHOD_EXECUTION_DIRECTORY=/transactions
+      - GLOW_EXTERNAL_API_URL=http://127.0.0.1:${GLOW_API_CONTAINER_PORT}
+      - OTEL_EXPORTER_OTLP_ENDPOINT=${OTEL_EXPORTER_OTLP_ENDPOINT}
+    ports:
+      - ${GLOW_API_CONTAINER_PORT}:50000
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50000/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+      - ${GLOW_TRANSACTIONS_DIR_SOLUTION}:/transactions
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.rule=Host(`${ACCESS_URL}`) && PathPrefix(`/api`)"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.entrypoints=web,external"
+      - "traefik.http.middlewares.{{ cookiecutter.__docker_name }}-api-stripprefix.stripprefix.prefixes=/api"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.middlewares={{ cookiecutter.__docker_name }}-api-stripprefix"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.service={{ cookiecutter.__docker_name }}-api"
+      - "traefik.http.services.{{ cookiecutter.__docker_name }}-api.loadbalancer.server.port=50000"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-api.tls=true"
+      - "traefik.docker.network=${EXT_NETWORK_NAME}"
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+
+{% if cookiecutter.__ui_framework != "none" %}
+
+  {{ cookiecutter.__docker_name }}-ui:
+    image: {{ cookiecutter.__docker_name }}-ui
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_ui
+    depends_on:
+      {{ cookiecutter.__docker_name }}-api:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+      - external-network
+    env_file:
+      - .env
+    environment:
+      - GLOW_DEPLOYMENT=DockerCompose
+      - GLOW_UI_HOST=0.0.0.0
+      - GLOW_UI_PORT=50001
+      - GLOW_API_URL=http://{{ cookiecutter.__docker_name }}-api:50000
+      - GLOW_UI_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_WS_EVENTS_ADDR=127.0.0.1:${GLOW_API_CONTAINER_PORT}
+      - GLOW_EXTERNAL_API_URL=http://127.0.0.1:${GLOW_API_CONTAINER_PORT}
+    ports:
+      - ${GLOW_UI_CONTAINER_PORT}:50001
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50001/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.rule=Host(`${ACCESS_URL}`) && PathPrefix(`/`)"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.entrypoints=web,external"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.service={{ cookiecutter.__docker_name }}-ui"
+      - "traefik.http.services.{{ cookiecutter.__docker_name }}-ui.loadbalancer.server.port=50001"
+      - "traefik.http.routers.{{ cookiecutter.__docker_name }}-ui.tls=true"
+      - "traefik.docker.network=${EXT_NETWORK_NAME}"
+
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+
+{% endif %}
+
+  otel-dashboard:
+    image: mcr.microsoft.com/dotnet/aspire-dashboard:9.1.0
+    ports:
+      - 18888:18888 # UI
+      - 18889:18889 # OTLP gRPC
+      - 18890:18890 # OTLP HTTP
+    environment:
+      - DASHBOARD__OTLP__AUTHMODE=ApiKey
+      # !!! Important !!! For production, replace the following env var with secure values
+      # as described here: https://aspire.dev/dashboard/security-considerations/
+      - DASHBOARD__FRONTEND__AUTHMODE=Unsecured
+      - DASHBOARD__OTLP__PRIMARYAPIKEY=YOU_MUST_GENERATE_A_RANDOM_STRING_AND_REPLACE_THIS
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+      - external-network
+
+volumes:
+  {{ cookiecutter.__docker_name }}-database:

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/standalone-with-minerva/.env

@@ -0,0 +1,25 @@
+ANS_MINERVA_AUTH__DATABASE=
+ANS_MINERVA_AUTH__PASSWORD=
+ANS_MINERVA_AUTH__USER=
+ANS_MINERVA_URL=
+APP_IMAGE_VERSION=main
+DATABASE_LOCATION={{ cookiecutter.__appdata_directory }}/Ansys/portal/{{ cookiecutter.__solution_name }}
+GLOW_API_CONTAINER_PORT=8000
+GLOW_API_PATH_PREFIX=/
+# dotenv-linter:off QuoteCharacter
+GLOW_CORS_ORIGINS=["*"]
+# dotenv-linter:on QuoteCharacter
+GLOW_API_NUMBER_OF_WORKERS=8
+GLOW_DATA_REPOSITORY_UPLOAD_ROOT=/Data/SAF/
+GLOW_DEPLOYMENT=DockerCompose
+GLOW_PROJECTS_DIR_SOLUTION=./data/projects
+GLOW_SOLUTION_DEFINITION={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.solution.definition
+GLOW_TRANSACTIONS_DIR_SOLUTION=./data/transactions
+GLOW_UI_CONTAINER_PORT=8001
+GLOW_UI_MODULE={{ cookiecutter.__solution_namespace }}.{{ cookiecutter.__solution_module_name }}.ui.app
+GLOW_UI_PATH_PREFIX=/
+OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-dashboard:18890
+# !!! Important !!! Change the following value and its reference in the compose.yaml to ensure secure connection with Aspire
+OTEL_EXPORTER_OTLP_HEADERS="x-otlp-api-key=YOU_MUST_GENERATE_A_RANDOM_STRING_AND_REPLACE_THIS"
+PORTAL_DATABASE_TYPE=sqlite
+PORTAL_PROJECT_DATABASE_LOCATION=${DATABASE_LOCATION}/projects.db