You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* xref:../../updating/updating_a_cluster/updating-cluster-cli.adoc#update-upgrading-oc-adm-upgrade-status_updating-cluster-cli[Gathering cluster update status using oc adm upgrade status (Technology Preview)]
You can see available updates in the`HostedCluster.Status` field of the `HostedCluster`custom resource (CR).
9
+
You can set channel in your`HostedCluster` custom resource (CR) by directly modifying the `HostedCluster`CR or using the `oc patch` command to update the `spec.channel` field.
10
10
11
-
The available updates are not fetched from the Cluster Version Operator (CVO) of a hosted cluster. The list of the available updates can be different from the available updates from the following fields of the `HostedCluster`custom resource (CR):
11
+
The available updates are not fetched from the Cluster Version Operator (CVO) of a hosted cluster. The initial `HostedCluster` CR does not have any information in the `status.version.availableUpdates` and `status.version.conditionalUpdates` fields. After you set the `spec.channel` field to the stable {product-title} release version, the HyperShift Operator reconciles the `HostedCluster`CR and updates the `status.version` field with the available and conditional updates.
12
12
13
-
* `status.version.availableUpdates`
14
-
* `status.version.conditionalUpdates`
15
-
16
-
The initial `HostedCluster` CR does not have any information in the `status.version.availableUpdates` and `status.version.conditionalUpdates` fields. After you set the `spec.channel` field to the stable {product-title} release version, the HyperShift Operator reconciles the `HostedCluster` CR and updates the `status.version` field with the available and conditional updates.
17
-
18
-
See the following example of the `HostedCluster` CR that contains the channel configuration:
19
-
20
-
[source,yaml]
21
-
----
22
-
spec:
23
-
autoscaling: {}
24
-
channel: stable-4.y <1>
25
-
clusterID: d6d42268-7dff-4d37-92cf-691bd2d42f41
26
-
configuration: {}
27
-
controllerAvailabilityPolicy: SingleReplica
28
-
dns:
29
-
baseDomain: dev11.red-chesterfield.com
30
-
privateZoneID: Z0180092I0DQRKL55LN0
31
-
publicZoneID: Z00206462VG6ZP0H2QLWK
32
-
----
33
-
<1> Replace `<4.y>` with the {product-title} release version you specified in `spec.release`. For example, if you set the `spec.release` to `ocp-release:4.16.4-multi`, you must set `spec.channel` to `stable-4.16`.
34
-
35
-
After you configure the channel in the `HostedCluster` CR, to view the output of the `status.version.availableUpdates` and `status.version.conditionalUpdates` fields, run the following command:
13
+
.Procedure
36
14
15
+
. Check recommended updates and provided details on each version to choose a version from recommendations based on your requirements. Run the following command:
16
+
+
37
17
[source,terminal]
38
18
----
39
-
$ oc get -n <hosted_cluster_namespace> hostedcluster <hosted_cluster_name> -o yaml
19
+
$ oc get -n <hosted_cluster_namespace> hostedcluster <hosted_cluster_name> -o jsonpath='{.status.version.availableUpdates}'
<1> Replace `<4.y>` with the {product-title} release version you specified in `spec.release`. For example, if you set the `spec.release` to `ocp-release:4.18.4-multi`, you must set `spec.channel` to `stable-4.18`.
153
+
154
+
.. Update the `HostedCluster` CR by running the following `oc patch` command:
<1> Replace `<4.y>` with the {product-title} release version you specified in `spec.release`. For example, if you set the `spec.release` to `ocp-release:4.18.4-multi`, you must set `spec.channel` to `stable-4.18`.
161
+
162
+
. Monitor the progress of your ongoing update:
163
+
164
+
.. Monitor the status of the update rollout in the `HostedCluster` resource. You can check the progression of the update, timestamps and issues by running the following command:
165
+
+
166
+
[source,terminal]
167
+
----
168
+
$ oc get hostedcluster <hosted_cluster_name> -o jsonpath='{.status.version.history}'
169
+
----
170
+
171
+
.. Optional: To retrieve more detailed information about the status of your update, run the following command:
172
+
+
173
+
[source,terminal]
174
+
----
175
+
$ oc adm upgrade status
176
+
----
177
+
+
178
+
For more information about how to use the `oc adm upgrade status` command, see "Gathering cluster update status using oc adm upgrade status (Technology Preview)".
179
+
180
+
.. If the rollout encounters problems, review the following conditions:
181
+
182
+
* `ClusterVersionSucceeding`: Indicates if the cluster is successfully updating.
183
+
* `ClusterVersionProgressing`: Indicates if the update is actively progressing.
184
+
* `ClusterVersionAvailable`: Confirms the availability of the updated version.
185
+
+
186
+
Run the following command to check the status of conditions:
187
+
+
188
+
[source,terminal]
189
+
----
190
+
$ oc get hostedcluster <hosted_cluster_name> -o jsonpath='{.status.conditions}'
191
+
----
192
+
193
+
194
+
.Verification
195
+
196
+
* Verify that the` history` field in the `HostedCluster` resource indicates a status as `Completed`. Run the following command:
197
+
+
198
+
[source,terminal]
199
+
----
200
+
$ oc get hostedcluster <hosted_cluster_name> -o jsonpath='{.status.version.history}'
= Setting the updateService field in HostedCluster
8
+
9
+
You can configure the update service by using a specific update service URL in the `updateService` field of the `HostedCluster` custom resource (CR). By default, the hosted cluster uses the OpenShift Update Service (OSUS) based on its region and configuration.
10
+
11
+
Consider the following environments where you can use the update service:
12
+
13
+
* Private or disconnected: To update your cluster in an environment without access to the public OSUS.
14
+
* Regional: To direct the update service to a specific regional server for compliance or performance optimization.
15
+
* Custom: For environments that host their own OSUS and need updates to be sourced internally rather than from the default Red{nbsp}Hat services.
16
+
17
+
.Procedure
18
+
19
+
* To set a custom update service, add the update service URL to the `updateService` field in the `HostedCluster` CR. Run the following command:
<1> Replace `<update_service_url>` with the URL of the of the desired update service, for example, `https://custom-update-service.example.com/api/upgrades_info/v1/graph`.
26
+
27
+
28
+
[TIP]
29
+
====
30
+
If you face issues, consider the following troubleshooting factors:
31
+
32
+
* Connection issues: If the cluster is unable to reach the specified update service, confirm that the service URL is accessible from the cluster network.
33
+
* Update service compatibility: Ensure that an update information provided by the specified update service is compatible with the {product-title} versions used by the hosted cluster.
34
+
* Fallback behaviour: If the update service is incorrectly configured or unreachable, update recommendations might not be available. Verify the configuration and network connectivity as necessary.
35
+
====
36
+
37
+
38
+
.Verification
39
+
40
+
* Verify that the update service URL is successfully set in the `updateService` field by running the following command:
41
+
+
42
+
[source,terminal]
43
+
----
44
+
$ oc get hostedcluster <hosted_cluster_name> -o jsonpath='{.spec.updateService}'
0 commit comments