Add migration-wait-timeout to the helm chart (#20069)

The `airflow db check-migrations` command is missing a migration wait timeout value in the helm chart resulting in unexpected failures at times. This PR adds a default timeout to the command Co-authored-by: Kaxil Naik <[email protected]>
apache · Dec 6, 2021 · 12c916c · 12c916c
1 parent f9eab1c
commit 12c916c
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 4 deletions.
diff --git a/airflow/cli/cli_parser.py b/airflow/cli/cli_parser.py
@@ -448,7 +448,7 @@ def _check(value):
     ("-t", "--migration-wait-timeout"),
     help="timeout to wait for db to migrate ",
     type=int,
-    default=0,
+    default=60,
 )
 
 # webserver

diff --git a/chart/templates/_helpers.yaml b/chart/templates/_helpers.yaml
@@ -546,6 +546,7 @@ Create the name of the cleanup service account to use
   - airflow
   - db
   - check-migrations
+  - --migration-wait-timeout={{ .Values.images.migrationsWaitTimeout }}
   {{- else }}
   - python
   - -c

diff --git a/chart/tests/test_webserver.py b/chart/tests/test_webserver.py
@@ -139,8 +139,8 @@ def test_should_add_extra_containers(self):
 
     @parameterized.expand(
         [
-            ("2.0.0", ["airflow", "db", "check-migrations"]),
-            ("2.1.0", ["airflow", "db", "check-migrations"]),
+            ("2.0.0", ["airflow", "db", "check-migrations", "--migration-wait-timeout=60"]),
+            ("2.1.0", ["airflow", "db", "check-migrations", "--migration-wait-timeout=60"]),
             ("1.10.2", ["python", "-c"]),
         ],
     )

diff --git a/chart/values.schema.json b/chart/values.schema.json
@@ -372,6 +372,12 @@
                     "x-docsSection": "Images",
                     "default": false
                 },
+                "migrationsWaitTimeout": {
+                    "description": "The time (in seconds) to wait for the DB migrations to complete.",
+                    "type": "number",
+                    "x-docsSection": "Images",
+                    "default": 60
+                },
                 "pod_template": {
                     "description": "Configuration of the pod_template image.",
                     "type": "object",

diff --git a/chart/values.yaml b/chart/values.yaml
@@ -56,6 +56,8 @@ images:
   # will use the images from 'defaultAirflowRepository:defaultAirflowTag' values
   # to run and wait for DB migrations .
   useDefaultImageForMigration: false
+  # timeout (in seconds) for airflow-migrations to complete
+  migrationsWaitTimeout: 60
   pod_template:
     repository: ~
     tag: ~

diff --git a/tests/cli/commands/test_db_command.py b/tests/cli/commands/test_db_command.py
@@ -47,7 +47,7 @@ def test_cli_resetdb(self, mock_resetdb):
     def test_cli_check_migrations(self, mock_wait_for_migrations):
         db_command.check_migrations(self.parser.parse_args(['db', 'check-migrations']))
 
-        mock_wait_for_migrations.assert_called_once_with(timeout=0)
+        mock_wait_for_migrations.assert_called_once_with(timeout=60)
 
     @mock.patch("airflow.cli.commands.db_command.db.upgradedb")
     def test_cli_upgradedb(self, mock_upgradedb):
-Original file line number
+Diff line change
@@ Expand Up / @@ -546,6 +546,7 @@ Create the name of the cleanup service account to use @@
       - airflow
       - db
       - check-migrations
+      - --migration-wait-timeout={{ .Values.images.migrationsWaitTimeout }}
       {{- else }}
       - python
       - -c
@@ Expand Down @@