MM-68316: recommend builtin DB readiness check for K8s deployments

source/deployment-guide/reference-architecture/deployment-scenarios/air-gapped-deployment.rst

@@ -76,6 +76,28 @@ On an internet connected machine, you must gather all required packages, contain
     - Load balancer: If you already have a load balancer running in your air-gapped environment you can skip this resource, otherwise we recommend deploying :doc:`NGINX </deployment-guide/server/setup-nginx-proxy>`, using the `NGINX Ingress Controller operator <https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-operator/>`__.
     - Desktop app: Download the `required package <https://github.com/mattermost/desktop/releases>`_ based on your deployment method.
 
+    .. note::
+
+      **Database readiness check (air-gapped recommendation)**
+
+      If your installed Mattermost Operator supports ``spec.database.readinessCheck.mode``, it can run the database-readiness init container from the same Mattermost image as the main container by setting ``spec.database.readinessCheck.mode: builtin`` on the ``Mattermost`` custom resource. The init container then invokes the in-image ``mattermost db ping`` command instead of pulling ``postgres:13`` and running ``pg_isready``.
+
+      We recommend this mode for air-gapped clusters because it removes the requirement to mirror ``postgres:13`` into your private registry; the only image needed for the readiness check is the Mattermost image you're already mirroring. Before using ``builtin`` mode, confirm that your installed operator version includes the ``readinessCheck.mode`` field in the Mattermost CRD or in the operator release notes. ``builtin`` mode also requires a Mattermost release that ships the ``mattermost db ping`` command (see the `Mattermost server release notes <https://github.com/mattermost/mattermost/pull/36406>`__ for availability).
+
+      Example:
+
+      .. code-block:: yaml
+
+        spec:
+          database:
+            external:
+              secret: <my-db-secret>
+            readinessCheck:
+              mode: builtin
+              timeout: 5m   # optional; default is 5m
+
+      The legacy ``external`` mode (which uses ``postgres:13`` + ``pg_isready``) remains the default for backward compatibility and is still selectable for users on older Mattermost versions, but it is slated for deprecation in a future operator release. See the `Mattermost CRD reference <https://github.com/mattermost/mattermost-operator/blob/master/docs/mattermost_v1beta1_crd.md>`__ for the full ``readinessCheck`` field schema.
+
     **(Optional) Supporting Services**
     Consider downloading these additional resources if you plan to enable these optional components:
 

source/deployment-guide/server/kubernetes/deploy-k8s.rst

@@ -138,6 +138,10 @@ Step 3: Deploy Mattermost
       name: my-postgres-connection
     type: Opaque
 
+  .. note::
+
+    The ``DB_CONNECTION_CHECK_URL`` value is consumed by the operator's legacy ``postgres:13`` + ``pg_isready`` readiness init container (the default ``external`` mode of ``spec.database.readinessCheck``). New deployments are encouraged to set ``spec.database.readinessCheck.mode: builtin`` (see Step 5 below), in which case the readiness init container runs the in-image ``mattermost db ping`` command and the ``DB_CONNECTION_CHECK_URL`` field is no longer required. The legacy ``external`` mode remains the default for backward compatibility but is slated for deprecation in a future operator release.
+
 Step 4: Create the Filestore Secret
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -194,6 +198,22 @@ Step 5: Configure the Mattermost Installation Manifest
           external:
             secret: <database-secret-name>  # The name of the database secret (e.g., my-postgres-connection)
 
+  b. **(Recommended)** Configure the database-readiness init container to use the in-image ``mattermost db ping`` command instead of the legacy ``postgres:13`` + ``pg_isready`` flow. This avoids the need to pull a separate ``postgres:13`` image (the primary motivation for air-gapped clusters that can't mirror it) and keeps your readiness check in sync with the Mattermost release you're running.
+
+    .. code-block:: yaml
+
+      spec:
+        database:
+          external:
+            secret: <database-secret-name>
+          readinessCheck:
+            mode: builtin
+            timeout: 5m   # optional; default is 5m
+
+    Using ``builtin`` mode requires a Mattermost release that ships the ``mattermost db ping`` command (see the `Mattermost server pull request <https://github.com/mattermost/mattermost/pull/36406>`__ for availability).
+
+    Omitting ``readinessCheck`` (or setting ``mode: external``) preserves the legacy ``postgres:13`` + ``pg_isready`` behavior. The legacy mode is the current default for backward compatibility and will be deprecated in a future operator release. See the `Mattermost CRD reference <https://github.com/mattermost/mattermost-operator/blob/master/docs/mattermost_v1beta1_crd.md>`__ for the full ``readinessCheck`` field schema.
+
 3. Connect to Object Storage:
 
   a. Add the following to the ``spec`` section of your manifest: