add env FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS for teams-app

Author: imanjra

docker/README.md

@@ -825,6 +825,7 @@ If containers show unhealthy states (e.g., `Restarting`, `Exited`):
 | `FIFTYONE_APP_THEME`                         | The default theme configuration for your FiftyOne Enterprise application as described [in our documentation](https://docs.voxel51.com/user_guide/config.html#configuring-the-app)                                                                                              | No                        |
 | `FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE`     | Controls whether Query Performance mode is enabled by default for every dataset for the application. Set to false to set default mode to off.                                                                                                                                  | No                        |
 | `FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE`      | Controls whether Query Performance mode is enabled for the application. Set to false to disable Query Performance mode for entire application.                                                                                                                                 | No                        |
+| `FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS`    | Deployment characteristics for the `teams-app`                                                                                                                                                                                                                                 | No                        |
 | `FIFTYONE_API_URI`                           | The URI to be displayed in the `Install FiftyOne` Modal and `API Keys` configuration screens                                                                                                                                                                                   | No                        |
 | `FIFTYONE_AUTH_SECRET`                       | The secret used for services to authenticate with `teams-cas`; also used to login to the SuperAdmin UI                                                                                                                                                                         | Yes                       |
 | `FIFTYONE_DATABASE_NAME`                     | The MongoDB Database that `fiftyone-app`, `teams-api`, and `teams-app` use for FiftyOne Enterprise dataset metadata; the default is `fiftyone`                                                                                                                                 | Yes                       |

docker/common-services.yaml

@@ -75,6 +75,7 @@ services:
       NODE_ENV: production
       RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED: false
       FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED: ${FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED:-true}
+      FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS: docker
       # If you are routing through a proxy server you will want to set
       #  HTTP_PROXY_URL, HTTPS_PROXY_URL, and NO_PROXY_LIST in your .env
       #  then add the following environment variables to your

helm/fiftyone-teams-app/README.md

@@ -1038,6 +1038,7 @@ If pods show unhealthy states (e.g., `0/1`, `CrashLoopBackOff`, `Pending`):
 | teamsAppSettings.env.APP_USE_HTTPS | bool | `true` | Controls the protocol of the `teams-app`.  Configure your ingress to match. When `true`, uses the https protocol. When `false`, uses the http protocol. |
 | teamsAppSettings.env.FIFTYONE_APP_ALLOW_MEDIA_EXPORT | bool | `true` | When `false`, disables media export options |
 | teamsAppSettings.env.FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED | bool | `true` | Controls whether anonymous analytics are captured for the application. Set to false to opt-out of anonymous analytics. |
+| teamsAppSettings.env.FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS | string | `"kubernetes"` | Deployment characteristics for the `teams-app`. `kubernetes`: Indicates the app is running in a Kubernetes environment. `docker`: Indicates the app is running in a Docker environment. `kubernetes,managed`: Indicates the app is running in a managed Kubernetes environment |
 | teamsAppSettings.env.FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION | string | `"2.17.1"` | The recommended fiftyone SDK version that will be displayed in the install modal (i.e. `pip install ... fiftyone==0.11.0`). |
 | teamsAppSettings.env.FIFTYONE_APP_THEME | string | `"dark"` | The default theme configuration. `dark`: Theme will be dark when user visits for the first time. `light`: Theme will be light theme when user visits for the first time. `always-dark`: Sets dark theme on each refresh (overrides user theme changes in the app). `always-light`: Sets light theme on each refresh (overrides user theme changes in the app). |
 | teamsAppSettings.env.RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED | bool | `false` | Disable duplicate atom/selector key checking that generated false-positive errors. [Reference][recoil-env]. |

helm/fiftyone-teams-app/values.schema.json

@@ -3672,6 +3672,13 @@
                 "boolean"
               ]
             },
+            "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS": {
+              "default": "kubernetes",
+              "description": "Deployment characteristics for the `teams-app`.\n`kubernetes`: Indicates the app is running in a Kubernetes environment.\n`docker`: Indicates the app is running in a Docker environment.\n`kubernetes,managed`: Indicates the app is running in a managed Kubernetes environment",
+              "required": [],
+              "title": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+              "type": "string"
+            },
             "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION": {
               "default": "2.17.1",
               "description": "The recommended fiftyone SDK version that will be displayed in the\ninstall modal (i.e. `pip install ... fiftyone==0.11.0`).",

helm/fiftyone-teams-app/values.yaml

@@ -1419,6 +1419,11 @@ teamsAppSettings:
     # -- Controls whether anonymous analytics are captured for the
     # application. Set to false to opt-out of anonymous analytics.
     FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED: true
+    # -- Deployment characteristics for the `teams-app`.
+    # `kubernetes`: Indicates the app is running in a Kubernetes environment.
+    # `docker`: Indicates the app is running in a Docker environment.
+    # `kubernetes,managed`: Indicates the app is running in a managed Kubernetes environment
+    FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS: 'kubernetes'
 
   # -- Secret variables to be passed to the `teams-app` containers.
   secretEnv: {}

tests/unit/compose/docker-compose-internal-auth_test.go

@@ -290,6 +290,7 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
 				"NODE_ENV=production",
 				"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
 				"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
+				"FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS=docker",
 			},
 		},
 		{
@@ -374,6 +375,7 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
 				"NODE_ENV=production",
 				"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
 				"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
+				"FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS=docker",
 			},
 		},
 		{
@@ -458,6 +460,7 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
 				"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
 				"FIFTYONE_TEAMS_PLUGIN_URL=http://teams-plugins:5151",
 				"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
+				"FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS=docker",
 			},
 		},
 		{

tests/unit/compose/docker-compose-legacy-auth_test.go

@@ -290,6 +290,7 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
 				"NODE_ENV=production",
 				"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
 				"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
+				"FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS=docker",
 			},
 		},
 		{
@@ -371,6 +372,7 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
 				"NODE_ENV=production",
 				"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
 				"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
+				"FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS=docker",
 			},
 		},
 		{
@@ -454,6 +456,7 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
 				"NODE_ENV=production",
 				"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
 				"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
+				"FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS=docker",
 			},
 		},
 		{
@@ -537,6 +540,7 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
 				"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
 				"FIFTYONE_TEAMS_PLUGIN_URL=http://teams-plugins:5151",
 				"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
+				"FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS=docker",
 			},
 		},
 		{

tests/unit/helm/teams-app-deployment_test.go

@@ -492,6 +492,10 @@ func (s *deploymentTeamsAppTemplateTest) TestContainerEnv() {
             "name": "FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED",
             "value": "true"
           },
+          {
+            "name": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+            "value": "kubernetes"
+          },
           {
             "name": "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION",
             "value": "%s"
@@ -574,6 +578,10 @@ func (s *deploymentTeamsAppTemplateTest) TestContainerEnv() {
             "name": "FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED",
             "value": "true"
           },
+          {
+            "name": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+            "value": "kubernetes"
+          },
           {
             "name": "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION",
             "value": "%s"
@@ -669,6 +677,10 @@ func (s *deploymentTeamsAppTemplateTest) TestContainerEnv() {
             "name": "FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED",
             "value": "true"
           },
+          {
+            "name": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+            "value": "kubernetes"
+          },
           {
             "name": "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION",
             "value": "%s"
@@ -750,6 +762,10 @@ func (s *deploymentTeamsAppTemplateTest) TestContainerEnv() {
             "name": "FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED",
             "value": "true"
           },
+          {
+            "name": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+            "value": "kubernetes"
+          },
           {
             "name": "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION",
             "value": "%s"
@@ -830,6 +846,10 @@ func (s *deploymentTeamsAppTemplateTest) TestContainerEnv() {
             "name": "FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED",
             "value": "true"
           },
+          {
+            "name": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+            "value": "kubernetes"
+          },
           {
             "name": "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION",
             "value": "%s"
@@ -910,6 +930,10 @@ func (s *deploymentTeamsAppTemplateTest) TestContainerEnv() {
             "name": "FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED",
             "value": "true"
           },
+          {
+            "name": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+            "value": "kubernetes"
+          },
           {
             "name": "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION",
             "value": "%s"
@@ -990,6 +1014,10 @@ func (s *deploymentTeamsAppTemplateTest) TestContainerEnv() {
             "name": "FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED",
             "value": "true"
           },
+          {
+            "name": "FIFTYONE_APP_DEPLOYMENT_CHARACTERISTICS",
+            "value": "kubernetes"
+          },
           {
             "name": "FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION",
             "value": "%s"