Skip to content

Commit 71a9342

Browse files
committed
Follow-up for PR openshift#2122
- Use table for post-reboot "next step". - Simplify "Upgrading Cluster Metrics" (automatic). - Simplify "Upgrading Cluster Metrics" (manual).
1 parent 4364b8b commit 71a9342

File tree

2 files changed

+45
-45
lines changed

2 files changed

+45
-45
lines changed

install_config/upgrading/automated_upgrades.adoc

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -211,12 +211,20 @@ used, if needed.
211211
----
212212

213213
When the upgrade finishes, a recommendation will be printed to reboot all hosts.
214-
After rebooting, if you have aggregated logging enable you will need to follow steps outlined in the
215-
link:#automated-upgrading-efk-logging-stack[Upgrading the EFK Logging Stack] section,
216-
if you have cluster metrics enabled you will need to follow the setps outlined in the
217-
link:#automated-upgrading-cluster-metrics[Upgrading Cluster Metrics] section,
218-
otherwise proceed to
219-
link:#verifying-the-upgrade[Verifying the Upgrade].
214+
After rebooting, if there are no features enabled, you can
215+
link:#verifying-the-upgrade[verify the upgrade].
216+
Otherwise, the next step depends on what features are enabled.
217+
218+
[cols="1,4"]
219+
|===
220+
| Feature | Next Step
221+
222+
| Aggregated Logging
223+
| link:#automated-upgrading-efk-logging-stack[Upgrade the EFK logging stack.]
224+
225+
| Cluster Metrics
226+
| link:#automated-upgrading-cluster-metrics[Upgrade cluster metrics.]
227+
|===
220228

221229
[[upgrading-to-openshift-enterprise-3-2-asynchronous-releases]]
222230
=== Upgrading to OpenShift Enterprise 3.2 Asynchronous Releases
@@ -244,12 +252,11 @@ Upgrades].
244252
[[automated-upgrading-cluster-metrics]]
245253
== Upgrading Cluster Metrics
246254

247-
If you have previously link:../../install_config/cluster_metrics.html[deployed
248-
cluster metrics] you will need to update to the latest metric components, the steps must
249-
be performed manually as shown in
250-
link:../../install_config/upgrading/manual_upgrades.html#manual-upgrading-cluster-metrics[Manual
251-
Upgrades].
252-
255+
If you have previously
256+
link:../../install_config/cluster_metrics.html[deployed cluster metrics],
257+
you must manually
258+
link:../../install_config/upgrading/manual_upgrades.html#manual-upgrading-cluster-metrics[update]
259+
to the latest metric components.
253260

254261
[[verifying-the-upgrade]]
255262
== Verifying the Upgrade

install_config/upgrading/manual_upgrades.adoc

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -920,53 +920,46 @@ Elasticsearch while running this and it will not perform an install.
920920
[[manual-upgrading-cluster-metrics]]
921921
== Upgrading Cluster Metrics
922922

923-
Use the following to upgrade an
924-
link:../../install_config/cluster_metrics.html[already-deployed Cluster Metrics install].
923+
After upgrading an
924+
link:../../install_config/cluster_metrics.html[already-deployed Cluster Metrics install],
925+
you must update to a newer version of the metrics components.
926+
927+
- The update process stops all the metrics containers,
928+
updates the metrics configuration files,
929+
and redeploys the newer components.
925930

926-
To update to a newer version of the metrics components you will need to use the `refresh`
927-
mode of the deployer. This will stop all the metrics containers, update the metrics configuration
928-
files and redeploy the newer components. The `refresh` option will not change the metrics route or
929-
delete the metrics persistent volume claim.
931+
- It does not change the metrics route.
930932

931-
Metrics stored to persistent volumes will still contain the persisted data when the updated
932-
metrics are brought back online.
933+
- It does not delete the metrics persistent volume claim.
934+
Metrics stored to persistent volumes before the update
935+
are available after the update completes.
933936

934937
[IMPORTANT]
935938
====
936-
All non-persisted metric values will be lost during the metric `refresh`.
937-
938-
All local changes to the metrics configurations will be overwritten with new configurations meant for the latest install.
939-
This includes things like number of instances in a replica set.
939+
The update deletes all non-persisted metric values
940+
and overwrites local changes to the metrics configurations.
941+
For example, the number of instances in a replica set is not saved.
940942
====
941943

942-
To perform the update you will need to follow the
943-
link:../../install_config/cluster_metrics.html#deploying-the-metrics-components[same steps]
944-
as when the metrics components were first deployed except this time you will need to specify the
945-
`MODE=refresh` option.
946-
947-
You will also need to make sure you are using the correct template for your installation. Please see the following
948-
link:../../install_config/cluster_metrics.html#modifying-the-deployer-template[section] for the location of this template.
944+
To update, follow the same steps as when the metrics components were
945+
link:../../install_config/cluster_metrics.html#deploying-the-metrics-components[first deployed],
946+
using the
947+
link:../../install_config/cluster_metrics.html#modifying-the-deployer-template[correct template],
948+
except this time, specify the `MODE=refresh` option:
949949

950-
For instance, if before you deployed metrics using:
951-
952-
----
953-
$ oc new-app -f metrics-deployer.yaml \
954-
-p HAWKULAR_METRICS_HOSTNAME=hawkular-metrics.example.com
955-
----
956-
957-
You will now need to run:
950+
====
958951
----
959952
$ oc new-app -f metrics-deployer.yaml \
960-
-p HAWKULAR_METRICS_HOSTNAME=hawkular-metrics.example.com,MODE=redeploy
953+
-p HAWKULAR_METRICS_HOSTNAME=hm.example.com,MODE=refresh <1>
961954
----
962-
963-
After this the metrics components should have been restarted and are now using the most recent versions.
964-
955+
<1> In the original deployment command, there was no `MODE=refresh`.
956+
====
965957

966958
[NOTE]
967959
====
968-
It is normal to see a gap in the graphs during the time when the `refresh` is occuring. This is due to the
969-
metrics components not running and being available to gather metrics during this time.
960+
During the update, the metrics components do not run.
961+
Because of this, they cannot collect data
962+
and a gap normally appears in the graphs.
970963
====
971964

972965
[[additional-instructions-per-release]]

0 commit comments

Comments
 (0)