Projquay 9504 (quay#1456)

* Updates a link the deploy docs

* Fixes typo in Deploy guide

* Updates Troubleshooting Quay on OCP docs

---------

Co-authored-by: Steven Smith <[email protected]>

Author: stevsmit

deploy_red_hat_quay_operator/master.adoc

@@ -55,9 +55,16 @@ include::modules/creating-registry-infra-node.adoc[leveloffset=+2]
 //Advanced configuration
 
 
+//Troubleshooting
+include::modules/operator-quayregistry-troubleshooting.adoc[leveloffset=+1]
+include::modules/operator-quayregistry-status.adoc[leveloffset=+2]
+include::modules/operator-monitor-deploy-cli.adoc[leveloffset=+2]
+
+
+
+
 include::modules/operator-deploy-hpa.adoc[leveloffset=+1]
 
-//Advanced configuration options
 
 //traffic ingress
 [id="configuring-traffic-ingress"]
@@ -87,19 +94,6 @@ include::modules/operator-unmanaged-monitoring.adoc[leveloffset=+3]
 include::modules/operator-unmanaged-mirroring.adoc[leveloffset=+3]
 
 
-
-
-
-
-include::modules/operator-monitor-deploy-cli.adoc[leveloffset=+1]
-//ui
-include::modules/operator-deploy-ui.adoc[leveloffset=+2]
-
-//quayregistry status
-include::modules/operator-quayregistry-status.adoc[leveloffset=+1]
-
-
-
 //SSL/TLS
 include::modules/operator-custom-ssl-certs-config-bundle.adoc[leveloffset=+1]
 //include::modules/ssl-create-certs.adoc[leveloffset=+2]

modules/first-user-api.adoc

@@ -17,7 +17,7 @@ SUPER_USERS:
 # ..
 ----
 +
-If you did not configure these settings upon registry creation, and need to re-configure your registry to enable these settings, see. . .
+If you did not configure these settings upon registry creation, and need to re-configure your registry to enable these settings, see "Enabling features after deployment".
 
 * You have not created a user by using the {productname} UI.
 

modules/operator-config-cli-download.adoc

@@ -23,6 +23,8 @@ Modifying the `config.yaml` file that is stored by the `configBundleSecret` reso
 $ oc describe quayregistry -n <quay_namespace>
 ----
 +
+.Example output
++
 [source,terminal]
 ----
 # ...

modules/operator-config-cli.adoc

@@ -20,4 +20,4 @@ To enable features in the {ocp} web console, you can edit the `configBundleSecre
 
 . In the *Value* text box, add the new configuration fields for the features that you want to enable. For a list of all configuration fields, see link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html/configure_red_hat_quay/index[Configure {productname}].
 
-. Click *Save*. The {productname} Operator automatically reconciles the changes by restarting all Quay-related pods. After all pods are restart, the features are enabled.
+. Click *Save*. The {productname} Operator automatically reconciles the changes by restarting all Quay-related pods. After all pods are restarted, the features are enabled.

modules/operator-deploy-ui.adoc

@@ -1,66 +1,24 @@
 :_mod-docs-content-type: PROCEDURE
 [id="operator-monitor-deploy-cli"]
-= Monitoring and debugging the deployment process
+= Monitoring and debugging the QuayRegistry CR by using the CLI
 
-Users can now troubleshoot problems during the deployment phase. The status in the `QuayRegistry` object can help you monitor the health of the components during the deployment an help you debug any problems that may arise.
+The `oc` CLI tool can be used to troubleshoot problems related to registry deployment. With the `oc` CLI, you can obtain the following information about the `QuayRegistry` CR:
 
-.Procedure
+* The `conditions` field, which field shows the status of all `QuayRegistry` components.
 
-. Enter the following command to check the status of your deployment:
-+
-[source,terminal]
-----
-$ oc get quayregistry -n quay-enterprise -o yaml
-----
-+
-.Example output
-+
-Immediately after deployment, the `QuayRegistry` object will show the basic configuration:
-+
-[source,yaml]
-----
-apiVersion: v1
-items:
-- apiVersion: quay.redhat.com/v1
-  kind: QuayRegistry
-  metadata:
-    creationTimestamp: "2021-09-14T10:51:22Z"
-    generation: 3
-    name: example-registry
-    namespace: quay-enterprise
-    resourceVersion: "50147"
-    selfLink: /apis/quay.redhat.com/v1/namespaces/quay-enterprise/quayregistries/example-registry
-    uid: e3fc82ba-e716-4646-bb0f-63c26d05e00e
-  spec:
-    components:
-    - kind: postgres
-      managed: true
-    - kind: clair
-      managed: true
-    - kind: redis
-      managed: true
-    - kind: horizontalpodautoscaler
-      managed: true
-    - kind: objectstorage
-      managed: true
-    - kind: route
-      managed: true
-    - kind: mirror
-      managed: true
-    - kind: monitoring
-      managed: true
-    - kind: tls
-      managed: true
-    - kind: clairpostgres
-      managed: true
-    configBundleSecret: example-registry-config-bundle-kt55s
-kind: List
-metadata:
-  resourceVersion: ""
-  selfLink: ""
-----
+* The `currentVersion` field, which shows the version of {productname}.
+
+* The `registryEndpoint` field, which shows the publicly available hostname of the registry. 
+
+When troubleshooting deployment issues, you can check the `Status` field of the `QuayRegistry` custom resource (CR). This field reveals the health of the components during the deployment and can help you debug various problems with the deployment.
 
-. Use the `oc get pods` command to view the current state of the deployed components:
+.Prerequisites
+
+* You have deployed a {productname} registry by using the web console or the CLI.
+
+.Procedure
+
+. View the state of deployed components by entering the following command:
 +
 [source,terminal]
 ----
@@ -83,68 +41,44 @@ example-registry-quay-postgres-init-bktdt              0/1     Terminating
 example-registry-quay-redis-f9b9d44bf-4htpz            0/1     ContainerCreating   0          17s
 ----
 
-. While the deployment is in progress, the `QuayRegistry` object will show the current status. In this instance, database migrations are taking place, and other components are waiting until completion:
+. Return information about your deployment by entering the following command:
 +
 [source,terminal]
 ----
-  status:
-    conditions:
-    - lastTransitionTime: "2021-09-14T10:52:04Z"
-      lastUpdateTime: "2021-09-14T10:52:04Z"
-      message: all objects created/updated successfully
-      reason: ComponentsCreationSuccess
-      status: "False"
-      type: RolloutBlocked
-    - lastTransitionTime: "2021-09-14T10:52:05Z"
-      lastUpdateTime: "2021-09-14T10:52:05Z"
-      message: running database migrations
-      reason: MigrationsInProgress
-      status: "False"
-      type: Available
-    lastUpdated: 2021-09-14 10:52:05.371425635 +0000 UTC
-    unhealthyComponents:
-      clair:
-      - lastTransitionTime: "2021-09-14T10:51:32Z"
-        lastUpdateTime: "2021-09-14T10:51:32Z"
-        message: 'Deployment example-registry-clair-postgres: Deployment does not have minimum availability.'
-        reason: MinimumReplicasUnavailable
-        status: "False"
-        type: Available
-      - lastTransitionTime: "2021-09-14T10:51:32Z"
-        lastUpdateTime: "2021-09-14T10:51:32Z"
-        message: 'Deployment example-registry-clair-app: Deployment does not have minimum availability.'
-        reason: MinimumReplicasUnavailable
-        status: "False"
-        type: Available
-      mirror:
-      - lastTransitionTime: "2021-09-14T10:51:32Z"
-        lastUpdateTime: "2021-09-14T10:51:32Z"
-        message: 'Deployment example-registry-quay-mirror: Deployment does not have minimum availability.'
-        reason: MinimumReplicasUnavailable
-        status: "False"
-        type: Available
+$ oc get quayregistry -n <namespace> -o yaml
 ----
-
-. When the deployment process finishes successfully, the status in the `QuayRegistry` object shows no unhealthy components:
++
+.Example output
 +
 [source,terminal]
 ----
-  status:
-    conditions:
-    - lastTransitionTime: "2021-09-14T10:52:36Z"
-      lastUpdateTime: "2021-09-14T10:52:36Z"
-      message: all registry component healthchecks passing
-      reason: HealthChecksPassing
+apiVersion: v1
+items:
+- apiVersion: quay.redhat.com/v1
+  kind: QuayRegistry
+  metadata:
+    annotations:
+...
+  spec:
+    components:
+    - kind: clair
+      managed: true
+    - kind: objectstorage
+      managed: false
+...
+ status:
+    conditions: <1>
+    - lastTransitionTime: "2025-10-01T18:46:13Z"
+      lastUpdateTime: "2025-10-07T13:12:54Z"
+      message: Horizontal pod autoscaler found
+      reason: ComponentReady
       status: "True"
-      type: Available
-    - lastTransitionTime: "2021-09-14T10:52:46Z"
-      lastUpdateTime: "2021-09-14T10:52:46Z"
-      message: all objects created/updated successfully
-      reason: ComponentsCreationSuccess
-      status: "False"
-      type: RolloutBlocked
-    currentVersion: {producty}
-    lastUpdated: 2021-09-14 10:52:46.104181633 +0000 UTC
-    registryEndpoint: https://example-registry-quay-quay-enterprise.apps.docs.quayteam.org
-    unhealthyComponents: {}
-----
+      type: ComponentHPAReady
+...
+    currentVersion: v3.15.2 <2>
+    lastUpdated: 2025-10-07 13:12:54.48811705 +0000 UTC
+    registryEndpoint: https://example-registry-quay-cluster-new.gcp.quaydev.org <3>
+----
+<1> Shows information about the status of all `QuayRegistry` components.
+<2> Shows the current version that the registry is using.
+<3> Shows the publicly available hostname of the registry.

modules/operator-monitor-deploy-cli.adoc

@@ -1,20 +1,19 @@
 :_mod-docs-content-type: REFERENCE
 [id="operator-quayregistry-status"]
-= Viewing the status of the QuayRegistry object
+= Monitoring and debugging the QuayRegistry CR by using the {ocp} web console
 
-Lifecycle observability for a given {productname} deployment is reported in the `status` section of the corresponding `QuayRegistry` object. The {productname} Operator constantly updates this section, and this should be the first place to look for any problems or state changes in {productname} or its managed dependencies.
+Lifecycle observability for a {productname} registry is reported on the *Events* page of the registry. If leveraging the {ocp} web console, this is the first place to look for any problems related to registry deployment.
 
-[id="quayregistry-endpoint"]
-== Viewing the registry endpoint
+.Prerequisites
 
-Once {productname} is ready to be used, the `status.registryEndpoint` field will be populated with the publicly available hostname of the registry.
+* You have deployed a {productname} registry.
 
-[id="quayregistry-current-version"]
-== Viewing the version of {productname} in use
+.Procedure
 
-The current version of {productname} that is running will be reported in `status.currentVersion`.
+. On the {ocp} web console, click *Operators* -> *Installed Operators* -> *Red Hat Quay*.
 
-[id="quayregistry-conditions"]
-== Viewing the conditions of your {productname} deployment
+. On the *{productname} Operator* details page, click *Quay Registry*. 
 
-Certain conditions will be reported in `status.conditions`.
+. Click the name of the registry -> *Events*. On this page, events a streamed in real-time.
+
+. Optional: To reveal more information about deployment issues, you can click the name of the registry on the *Events* page to navigate to the *QuayRegistry details* page. On the *QuayRegistry details page*, you can view the condition of all `QuayRegistry` CR components.

modules/operator-quayregistry-status.adoc

@@ -0,0 +1,5 @@
+:_mod-docs-content-type: PROCEDURE
+[id="operator-quayregistry-troubleshooting"]
+= Troubleshooting the QuayRegistry CR
+
+You can troubleshoot the `QuayRegistry` CR to reveal issues during registry deployment by checking the *Events* page on the {ocp} web console, or by using the `oc` CLI.