|
| 1 | +# Instructions |
| 2 | + |
| 3 | +## Versions |
| 4 | + |
| 5 | +1. Helm chart versions: |
| 6 | + - dial: `5.20.0` |
| 7 | + - dial-core: `4.3.1` |
| 8 | + - dial-extension: `1.3.3` |
| 9 | + - dial-admin: `0.8.0` |
| 10 | +2. Main components versions: |
| 11 | + - ai-dial-adapter-bedrock: `0.36.3` |
| 12 | + - ai-dial-adapter-openai: `0.36.1` |
| 13 | + - ai-dial-adapter-vertexai: `0.32.0` |
| 14 | + - ai-dial-adapter-dial: `0.11.0` |
| 15 | + - ai-dial-auth-helper: `0.4.0` |
| 16 | + - ai-dial-chat-themes: `0.13.0` |
| 17 | + - ai-dial-chat: `0.42.2` |
| 18 | + - ai-dial-core: `0.40.0` |
| 19 | + - ai-dial-analytics-realtime: `0.20.2` |
| 20 | + - ai-dial-rag: `0.39.0` |
| 21 | + - ai-dial-log-parser: `0.3.0` |
| 22 | + - ai-dial-code-interpreter: `0.2.0` |
| 23 | + - ai-dial-app-controller: `0.3.0` |
| 24 | + - ai-dial-app-builder-python: `0.1.0` |
| 25 | + - quick-apps: `0.8.2` (deprecated, use ai-dial-quickapps-backend for new installations) |
| 26 | + - ai-dial-quickapps-backend: `0.4.0` (earlier known as quick-apps-2.0) |
| 27 | + - mindmap-backend: `0.13.0` |
| 28 | + - mindmap-frontend: `0.9.13` |
| 29 | + - admin-backend: `0.13.0` |
| 30 | + - admin-frontend: `0.13.4` |
| 31 | + - ai-dial-admin-deployment-manager-backend: `0.13.1` |
| 32 | + |
| 33 | +## Before upgrade |
| 34 | + |
| 35 | +### General notes |
| 36 | + |
| 37 | +- Please review the [Config changes](#config-changes) chapter carefully for each component that is used in your DIAL installation. Changes in components' configuration may be required. |
| 38 | +- Please check if any image tag overrides (`image.tag`) are present and remove them if they are not required anymore. |
| 39 | +- Please check and add `image.repository` to change the image location for `redis`, `postgresql`, `keycloak` and `keycloakConfigCli` components to start using alternative Docker registries (e.g. Amazon ECR Public Gallery) if required. |
| 40 | + |
| 41 | +### Release-specific notes |
| 42 | + |
| 43 | +## Config changes |
| 44 | + |
| 45 | +### ai-dial-core |
| 46 | + |
| 47 | + |
| 48 | +### ai-dial-chat |
| 49 | + |
| 50 | +### ai-dial-chat-themes |
| 51 | + |
| 52 | +### ai-dial-adapter-openai |
| 53 | + |
| 54 | +### ai-dial-adapter-bedrock |
| 55 | + |
| 56 | + |
| 57 | +### ai-dial-adapter-vertexai |
| 58 | + |
| 59 | +- Deprecation of COMPATIBILITY_MAPPING env var in favour of per-upstream configuration (https://github.com/epam/ai-dial-adapter-vertexai?tab=readme-ov-file#compatibility-configuration-in-dial-core-config) |
| 60 | + |
| 61 | +### admin-frontend |
| 62 | + |
| 63 | +#### Deployment manager FE configuration changes |
| 64 | + |
| 65 | +- Set `DEPLOYMENTS_ENABLED` to `true` to see the Deployment Manager. |
| 66 | +- `DISABLE_MENU_ITEMS`: add ModelDeployments to hide the Model Deployments UI when model serving infrastructure is not ready. |
| 67 | +- `EMBEDDED_APPS` — removed, no longer used. |
| 68 | +- `DEPLOYMENTS_PLUGIN_ENABLED` — removed, no longer used. |
| 69 | + |
| 70 | + |
| 71 | +### admin-backend |
| 72 | +#### S2S Admin Backend and core configuration |
| 73 | + Here is the full instraction for dial admin s2s configuration : |
| 74 | + - keycloack provider - https://github.com/epam/ai-dial-admin-backend/blob/development/docs/keycloack-s2s.md |
| 75 | + - azure provider - https://github.com/epam/ai-dial-admin-backend/blob/development/docs/azure-s2s-config.md |
| 76 | + |
| 77 | +### ai-dial-admin-deployment-manager-backend |
| 78 | + |
| 79 | +- Deployment manager: migrate to open source epam/ai-dial-admin-deployment-manager-backend:0.13.1 |
| 80 | +- Proxy images for deployment manager migrate to opensource: https://github.com/epam/ai-dial-deployment-manager-mcp-proxy. Replace `MCP_PROXY_EXECUTABLE_IMAGE_ALPINE` with `ghcr.io/epam/ai-dial-deployment-manager-mcp-proxy:0.1.0-alpine` and `MCP_PROXY_EXECUTABLE_IMAGE_DEBIAN` with `ghcr.io/epam/ai-dial-deployment-manager-mcp-proxy:0.1.0-debian` |
| 81 | + |
| 82 | +#### Changes made to environment variables |
| 83 | + |
| 84 | +|Previous Variable Name|New Variable Name|Description| |
| 85 | +|-|-|-| |
| 86 | +|`SECURITY_ALLOWED_ROLES`|`providers.<your_provider_name>.allowed-roles`|Comma-separated list of roles with access permissions defined for the specific identity provider.| |
| 87 | +|`SECURITY_JWT_JWKS_URI`|`providers.<your_provider_name>.jwk-set-uri`|URI for JSON Web Key Set defined for the specific identity provider.| |
| 88 | +|`SECURITY_JWT_ACCEPTED_ISSUERS`|`providers.<your_provider_name>.issuer`|List of accepted JWT token issuers defined for the specific identity provider.| |
| 89 | +|`SECURITY_JWT_ACCEPTED_ISSUERS_ALIAS`|`providers.azure.aliases`|Aliases for accepted JWT token issuers (applicable only for Azure provider).| |
| 90 | +|`DIAL_ADMIN_CLIENT_ID`|`providers.<your_provider_name>.audiences`|Previously used as a unique identifier of the DIAL Admin Deployment Manager application. This environment variable was removed bacause it defined the same property as `SECURITY_JWT_ACCEPTED_AUDIENCES`.| |
| 91 | +|`SECURITY_JWT_ACCEPTED_AUDIENCES`|`providers.<your_provider_name>.audiences`|List of accepted JWT token audiences. Defines the intended recipients of the claim `aud` in JWT.| |
| 92 | +|`SECURITY_ROLES_CLAIM`|`providers.<your_provider_name>.role-claims`|JWT claim name for user roles defined for the specific identity provider.| |
| 93 | +|`SECURITY_USER_CLAIM`|`providers.<your_provider_name>.principal-claim`|Specific claim that uniquely identifies the user or service (the "principal") for whom the token was issued.| |
| 94 | + |
| 95 | +**Note**: In this release, the following provider configuration properties have changed from optional to mandatory: |
| 96 | +* providers.<your_provider_name>.role-claims |
| 97 | +* providers.<your_provider_name>.principal-claim |
| 98 | + |
| 99 | + |
| 100 | +#### Added support for multiple identity providers |
| 101 | + |
| 102 | +The DIAL Admin Deployment Manager application now supports the use of multiple identity providers, which offers greater flexibility and integration with various identity services. Below is an example of configuration demonstrating how to set up multiple providers: |
| 103 | + |
| 104 | +```properties |
| 105 | +providers.auth0.jwk-set-uri: "https://example-auth0.com/.well-known/jwks.json" |
| 106 | +providers.auth0.issuer: "https://example-auth0.com" |
| 107 | +providers.auth0.role-claims: "example_roles" |
| 108 | +providers.auth0.principal-claim: "example_roles" |
| 109 | +providers.auth0.audiences: "example-audience-id" |
| 110 | +providers.keycloak.jwk-set-uri: "https://example-keycloak.com/realms/Example/protocol/openid-connect/certs" |
| 111 | +providers.keycloak.issuer: "https://example-keycloak.com/realms/Example" |
| 112 | +providers.keycloak.role-claims: "example_roles" |
| 113 | +providers.keycloak.principal-claim: "example_roles" |
| 114 | +providers.keycloak.audiences: "example-ui, example-admin" |
| 115 | +providers.azure.jwk-set-uri: "https://example.microsoft.com/common/discovery/v2.0/keys" |
| 116 | +providers.azure.issuer: "example-issuer-id" |
| 117 | +providers.azure.role-claims: "example_groups" |
| 118 | +providers.azure.principal-claim: "example_groups" |
| 119 | +providers.azure.audiences: "example-audience-id" |
| 120 | +providers.azure.aliases: "login.microsoftonline.com, login.windows.net, login.microsoft.com, sts.windows.net, login.partner.microsoftonline.cn, login.chinacloudapi.cn, login.microsoftonline.de, login.microsoftonline.us, login.usgovcloudapi.net, login-us.microsoftonline.com" |
| 121 | +providers.azure.allowed-roles: "example-role-id" |
| 122 | +``` |
| 123 | + |
| 124 | +#### Model Serving (Preview) |
| 125 | + |
| 126 | +A new **Model Serving (Preview)** feature has been introduced. When the underlying model serving infrastructure (KServe/NIM) are not yet available, configure the service with: |
| 127 | + |
| 128 | +- `K8S_NIM_ENABLED: "false"` |
| 129 | +- `K8S_KSERVE_ENABLED: "false"` |
| 130 | + |
| 131 | +These settings ensure the service operates correctly in environments where model serving components are not yet ready or deployed. |
| 132 | + |
| 133 | +### ai-dial-rag |
| 134 | + |
| 135 | +### Mind Map |
| 136 | + |
| 137 | +### ai-dial-quickapps-backend |
| 138 | + |
| 139 | +- Now docker image for `ai-dial-quickapps-backend` is published to [Docker Hub](https://hub.docker.com/r/epam/ai-dial-quickapps-backend). Update your Helm chart values to use the new image location if you were using a custom image registry before. |
| 140 | + |
0 commit comments