]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephadm: don't hardcode default oauth2-proxy image into docs 59843/head
authorAdam King <adking@redhat.com>
Wed, 18 Sep 2024 15:54:48 +0000 (11:54 -0400)
committerAdam King <adking@redhat.com>
Wed, 18 Sep 2024 15:56:29 +0000 (11:56 -0400)
This makes it another place we need to update when changing
the default image which is easy to forget. Instead, we can
document how users can find the the image which will still
hold even if we change what the default image is.

Signed-off-by: Adam King <adking@redhat.com>
doc/cephadm/services/oauth2-proxy.rst

index d8e644a7fe717e3de217d4f6c86de975572789df..d1afb515ca21efdcb1d4c49e206840754752fcd3 100644 (file)
@@ -119,17 +119,17 @@ A non-exhaustive list of important limitations for the `oauth2-proxy` service fo
 * Proper configuration of the IDP and OAuth2 parameters is crucial to avoid authentication failures. Misconfigurations can lead to access issues.
 
 
-Default images
-~~~~~~~~~~~~~~
+Container images
+~~~~~~~~~~~~~~~~
 
-The `oauth2-proxy` service typically uses the default container image:
+The container image the `oauth2-proxy` service will use can be found by running:
 
 ::
 
-    DEFAULT_OAUTH2_PROXY = 'quay.io/oauth2-proxy/oauth2-proxy:v7.2.0'
+    ceph config get mgr mgr/cephadm/container_image_oauth2_proxy
 
-Admins can specify the image to be used by changing the `container_image_oauth2_proxy` cephadm module option. If there were already running daemon(s),
-you must redeploy the daemon(s) to apply the new image.
+Admins can specify a custom image to be used by changing the `container_image_oauth2_proxy` cephadm module option.
+If there were already running daemon(s), you must also redeploy the daemon(s) for them to use the new image.
 
 For example: