Parameterize reindex job in GitLab with catalog to reindex (#5336)

OPERATOR.rst

@@ -248,6 +248,22 @@ For an example of how to document failures within a PR `click here`_.
 
 .. _click here: https://github.com/DataBiosphere/azul/pull/3050#issuecomment-840033931
 
+Reindexing a specific catalog in GitLab
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+From the GitLab web app, select the ``reindex`` or ``reindex_early`` job for
+the pipeline that needs reindexing of a specific catalog. From there, you
+should see an option for defining the key and value of additional variables to
+parameterize the job with.
+
+Set ``Key`` to ``azul_current_catalog``, and ``Value`` to the name of the
+catalog to be reindexed, for example, ``dcp3``. Check the inputs you just made.
+Start the ``reindex`` job by clicking on ``Run job``. Wait until the job has
+completed.
+
+Repeat these steps to reindex any additional catalogs.
+
+
 Updating the AMI for GitLab instances
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

environment.py

@@ -138,6 +138,10 @@ def env() -> Mapping[str, Optional[str]]:
         #
         'AZUL_CATALOGS': None,
 
+        # The name of a catalog to perform reindex or other operational tasks on.
+        #
+        'azul_current_catalog': None,
+
         # The Account ID number for AWS
         #
         'AZUL_AWS_ACCOUNT_ID': None,

scripts/reindex.py

@@ -63,8 +63,13 @@
                     nargs='+',
                     metavar='NAME',
                     default=[
-                        c for c in config.catalogs
-                        if c not in config.integration_test_catalogs
+                        catalog.name
+                        for catalog in config.catalogs.values()
+                        if not catalog.is_integration_test_catalog
+                    ]
+                    if config.current_catalog is None else
+                    [
+                        config.catalogs[config.current_catalog].name
                     ],
                     choices=config.catalogs,
                     help='The names of the catalogs to reindex.')

src/azul/__init__.py

@@ -910,6 +910,10 @@ def catalogs(self) -> Mapping[CatalogName, Catalog]:
     def default_catalog(self) -> CatalogName:
         return first(self.catalogs)
 
+    @property
+    def current_catalog(self) -> Optional[str]:
+        return self.environ.get('azul_current_catalog')
+
     def it_catalog_for(self, catalog: CatalogName) -> Optional[CatalogName]:
         it_catalog = self.catalogs[catalog].it_catalog
         assert it_catalog in self.integration_test_catalogs, it_catalog