feat: Allow disable IAM registration

changelog.d/20240518_015519_jackylamhk_allow_disable_registration.md

@@ -0,0 +1,4 @@
+### Added
+
+- Allow disabling user registration via Django settings from an environment variable.
+  (<https://github.com/cvat-ai/cvat/pull/7910>)

cvat/apps/iam/urls.py

@@ -28,7 +28,6 @@
 
 if settings.IAM_TYPE == 'BASIC':
     urlpatterns += [
-        path('register', RegisterViewEx.as_view(), name=BASIC_REGISTER_PATH_NAME),
         # password
         path('password/reset', PasswordResetView.as_view(),
             name='rest_password_reset'),
@@ -37,6 +36,10 @@
         path('password/change', PasswordChangeView.as_view(),
             name='rest_password_change'),
     ]
+    if settings.IAM_REGISTRATION_ENABLED:
+        urlpatterns.append(
+            path('register', RegisterViewEx.as_view(), name=BASIC_REGISTER_PATH_NAME)
+        )
     if allauth_settings.EMAIL_VERIFICATION != \
        allauth_settings.EmailVerificationMethod.NONE:
         # emails

cvat/settings/base.py

@@ -234,6 +234,11 @@ def generate_secret_key():
 IAM_ADMIN_ROLE = 'admin'
 # Index in the list below corresponds to the priority (0 has highest priority)
 IAM_ROLES = [IAM_ADMIN_ROLE, 'business', 'user', 'worker']
+
+IAM_REGISTRATION_ENABLED = to_bool(os.getenv('IAM_REGISTRATION_ENABLED', 'true'))
+if IAM_REGISTRATION_ENABLED:
+    INSTALLED_APPS.append('dj_rest_auth.registration')
+
 IAM_OPA_HOST = 'http://opa:8181'
 IAM_OPA_DATA_URL = f'{IAM_OPA_HOST}/v1/data'
 LOGIN_URL = 'rest_login'

docker-compose.yml

@@ -88,6 +88,7 @@ services:
       CVAT_ANALYTICS: 1
       CVAT_BASE_URL:
       ONE_RUNNING_JOB_IN_QUEUE_PER_USER:
+      IAM_REGISTRATION_ENABLED: 'true'
     command: init run server
     labels:
       - traefik.enable=true

helm-chart/templates/cvat_backend/server/deployment.yml

@@ -58,6 +58,8 @@ spec:
           env:
           - name: ALLOWED_HOSTS
             value: {{ $localValues.envs.ALLOWED_HOSTS | squote}}
+          - name: IAM_REGISTRATION_ENABLED
+            value: {{ $localValues.envs.IAM_REGISTRATION_ENABLED | squote}}
           {{ include "cvat.sharedBackendEnv" . | indent 10 }}
           {{- with concat .Values.cvat.backend.additionalEnv $localValues.additionalEnv }}
           {{- toYaml . | nindent 10 }}

helm-chart/values.yaml

@@ -39,6 +39,9 @@ cvat:
       tolerations: []
       envs:
         ALLOWED_HOSTS: "*"
+        # Disable the frontend elements by disabling the following key and rebuilding
+        # ui/reducers/server-api-reducer/defaultState.configuration.isRegistrationEnabled
+        IAM_REGISTRATION_ENABLED: "true"
       additionalEnv: []
       additionalVolumes: []
       additionalVolumeMounts: []