Skip to content

Commit c454ea7

Browse files
tnguyen-rhadellape
authored andcommitted
Follow-up for PR #2122
- Use table for post-reboot "next step". - Simplify "Upgrading Cluster Metrics" (automatic). - Simplify "Upgrading Cluster Metrics" (manual).
1 parent dc05897 commit c454ea7

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
@@ -221,12 +221,20 @@ used, if needed.
221221
----
222222

223223
When the upgrade finishes, a recommendation will be printed to reboot all hosts.
224-
After rebooting, if you have aggregated logging enable you will need to follow steps outlined in the
225-
link:#automated-upgrading-efk-logging-stack[Upgrading the EFK Logging Stack] section,
226-
if you have cluster metrics enabled you will need to follow the setps outlined in the
227-
link:#automated-upgrading-cluster-metrics[Upgrading Cluster Metrics] section,
228-
otherwise proceed to
229-
link:#verifying-the-upgrade[Verifying the Upgrade].
224+
After rebooting, if there are no features enabled, you can
225+
link:#verifying-the-upgrade[verify the upgrade].
226+
Otherwise, the next step depends on what features are enabled.
227+
228+
[cols="1,4"]
229+
|===
230+
| Feature | Next Step
231+
232+
| Aggregated Logging
233+
| link:#automated-upgrading-efk-logging-stack[Upgrade the EFK logging stack.]
234+
235+
| Cluster Metrics
236+
| link:#automated-upgrading-cluster-metrics[Upgrade cluster metrics.]
237+
|===
230238

231239
[[upgrading-to-openshift-enterprise-3-2-asynchronous-releases]]
232240
=== Upgrading to OpenShift Enterprise 3.2 Asynchronous Releases
@@ -262,12 +270,11 @@ Upgrades].
262270
[[automated-upgrading-cluster-metrics]]
263271
== Upgrading Cluster Metrics
264272

265-
If you have previously link:../../install_config/cluster_metrics.html[deployed
266-
cluster metrics] you will need to update to the latest metric components, the steps must
267-
be performed manually as shown in
268-
link:../../install_config/upgrading/manual_upgrades.html#manual-upgrading-cluster-metrics[Manual
269-
Upgrades].
270-
273+
If you have previously
274+
link:../../install_config/cluster_metrics.html[deployed cluster metrics],
275+
you must manually
276+
link:../../install_config/upgrading/manual_upgrades.html#manual-upgrading-cluster-metrics[update]
277+
to the latest metric components.
271278

272279
[[verifying-the-upgrade]]
273280
== Verifying the Upgrade

install_config/upgrading/manual_upgrades.adoc

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

1200-
Use the following to upgrade an
1201-
link:../../install_config/cluster_metrics.html[already-deployed Cluster Metrics install].
1200+
After upgrading an
1201+
link:../../install_config/cluster_metrics.html[already-deployed Cluster Metrics install],
1202+
you must update to a newer version of the metrics components.
1203+
1204+
- The update process stops all the metrics containers,
1205+
updates the metrics configuration files,
1206+
and redeploys the newer components.
12021207

1203-
To update to a newer version of the metrics components you will need to use the `refresh`
1204-
mode of the deployer. This will stop all the metrics containers, update the metrics configuration
1205-
files and redeploy the newer components. The `refresh` option will not change the metrics route or
1206-
delete the metrics persistent volume claim.
1208+
- It does not change the metrics route.
12071209

1208-
Metrics stored to persistent volumes will still contain the persisted data when the updated
1209-
metrics are brought back online.
1210+
- It does not delete the metrics persistent volume claim.
1211+
Metrics stored to persistent volumes before the update
1212+
are available after the update completes.
12101213

12111214
[IMPORTANT]
12121215
====
1213-
All non-persisted metric values will be lost during the metric `refresh`.
1214-
1215-
All local changes to the metrics configurations will be overwritten with new configurations meant for the latest install.
1216-
This includes things like number of instances in a replica set.
1216+
The update deletes all non-persisted metric values
1217+
and overwrites local changes to the metrics configurations.
1218+
For example, the number of instances in a replica set is not saved.
12171219
====
12181220

1219-
To perform the update you will need to follow the
1220-
link:../../install_config/cluster_metrics.html#deploying-the-metrics-components[same steps]
1221-
as when the metrics components were first deployed except this time you will need to specify the
1222-
`MODE=refresh` option.
1223-
1224-
You will also need to make sure you are using the correct template for your installation. Please see the following
1225-
link:../../install_config/cluster_metrics.html#modifying-the-deployer-template[section] for the location of this template.
1221+
To update, follow the same steps as when the metrics components were
1222+
link:../../install_config/cluster_metrics.html#deploying-the-metrics-components[first deployed],
1223+
using the
1224+
link:../../install_config/cluster_metrics.html#modifying-the-deployer-template[correct template],
1225+
except this time, specify the `MODE=refresh` option:
12261226

1227-
For instance, if before you deployed metrics using:
1228-
1229-
----
1230-
$ oc new-app -f metrics-deployer.yaml \
1231-
-p HAWKULAR_METRICS_HOSTNAME=hawkular-metrics.example.com
1232-
----
1233-
1234-
You will now need to run:
1227+
====
12351228
----
12361229
$ oc new-app -f metrics-deployer.yaml \
1237-
-p HAWKULAR_METRICS_HOSTNAME=hawkular-metrics.example.com,MODE=redeploy
1230+
-p HAWKULAR_METRICS_HOSTNAME=hm.example.com,MODE=refresh <1>
12381231
----
1239-
1240-
After this the metrics components should have been restarted and are now using the most recent versions.
1241-
1232+
<1> In the original deployment command, there was no `MODE=refresh`.
1233+
====
12421234

12431235
[NOTE]
12441236
====
1245-
It is normal to see a gap in the graphs during the time when the `refresh` is occuring. This is due to the
1246-
metrics components not running and being available to gather metrics during this time.
1237+
During the update, the metrics components do not run.
1238+
Because of this, they cannot collect data
1239+
and a gap normally appears in the graphs.
12471240
====
12481241

12491242
[[additional-instructions-per-release]]

0 commit comments

Comments
 (0)