Skip to content

mg_master_2168184_adding section with procedures for upgrade from 1.4… #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Feb 17, 2023
Merged

mg_master_2168184_adding section with procedures for upgrade from 1.4… #444

merged 9 commits into from
Feb 17, 2023

Conversation

mickogeary
Copy link
Collaborator

… to 1.5

@mickogeary mickogeary self-assigned this Feb 9, 2023
@JoanneOFlynn2018
Copy link
Collaborator

I'm not sure why the build fails, everything is fine when I build locally.

@leifmadsen
Copy link
Member

I'm not sure why the build fails, everything is fine when I build locally.

Huh builds for me as well locally. Let me look at the build system itself. I might have to try and reproduce it locally here, but we'll see.

@leifmadsen
Copy link
Member

I'm not sure why the build fails, everything is fine when I build locally.

Huh builds for me as well locally. Let me look at the build system itself. I might have to try and reproduce it locally here, but we'll see.

Ahhhh I see the problem. Looks like the Fedora 33 base image I was using for the build system is gone now (F33 no longer receiving updates and is EOL I suppose). I will need to update to a newer base image. Might take me a bit, but I'll get it figured out. Nothing appears to be wrong with the actual asciidoc here though.

docker: Error response from daemon: unknown: Tag 33-x86_64 was deleted or has expired. To pull, revive via time machine.

@leifmadsen
Copy link
Member

I fixed the build issue in #445 and will merge it into this PR once it has been approved and merged to master.

@JoanneOFlynn2018
Copy link
Collaborator

I fixed the build issue in #445 and will merge it into this PR once it has been approved and merged to master.

Nice one Leif!

@leifmadsen
Bump base image for building to Fedora 37 (#445)
d4c1368 
* Bump base image for building to Fedora 37

Bump the base image for building in CI to Fedora 37 because Fedora 33 is
now EOL and has been removed from the quay repository.

* Set /docs directory to being marked safe

* Bump actions/checkout v2 (deprecated) to v3
@leifmadsen
Merge branch 'master' into mg_master_2168184_procedures-to-upgrade-fr…
1dd53fa 
…om-1.4-to-1.5
rheslop
rheslop reviewed Feb 9, 2023
View reviewed changes
...etry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc Outdated
.Prerequisites

* Back up your data. There is an outage during the Red Hat OpenShift Container Platform upgrade. You cannot reconfigure the `ServiceTelemetry` and `SmartGateway` objects during the Operators replacement.
* Prepare your environment for upgrade from Red Hat OpenShift Container Platform v4.8 to v4.10. STF v1.5 only supports Red Hat OpenShift Container Platform v4.10.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Prepare your environment for upgrade from Red Hat OpenShift Container Platform v4.8 to v4.10. STF v1.5 only supports Red Hat OpenShift Container Platform v4.10.
* Prepare your environment for upgrade from Red Hat OpenShift Container Platform v4.8 to the supported version, v4.10.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{OpenShift}

@leifmadsen
Copy link
Member

I'm noting here that once the review is complete here, we'll need to do a round of variable replacement so that the values are dynamic. There are also a few sections that need to get wrapped in ifdef as well because some sections are not applicable for all versions of RHOSP.

leifmadsen
leifmadsen previously requested changes Feb 9, 2023
View reviewed changes
Copy link
Member

@leifmadsen leifmadsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just applying a review rejection for now so that we can come back and apply the variables after the content review is ready to go.

csibbitt
csibbitt requested changes Feb 9, 2023
View reviewed changes
Copy link
Contributor

@csibbitt csibbitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I got all the missing attributes; maybe a fresh copy with the existing ones fixed would help, then I could at least grep locally.

...emetry-Framework/modules/proc_installing-the-service-telemetry-framework-v1-5-operators.adoc
* Title: = Installing the Service Telemetry Framework v1.5 Operators
////

:_content-type: PROCEDURE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've not noticed this attribute before. I see it used only one other place in our docs before this PR, but you've used them consistently here. Are they necessary, and if so, should we add them to all the other files?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Chris, the newdoc script contains this attribute. The script generates a template of a procedure, reference or a concept module and follows our mod docs guidelines. According to the guidelines, if we didn't use our file naming convention proc_title-of-procedure.adoc then that attribute is important. It doesn't say why though!

https://redhat-documentation.github.io/modular-docs/#module_anchor-and-file-names-concept

newdoc script: https://github.com/redhat-documentation/newdoc

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading that, it seems like a fallback option. The content type will be identified by the filename prefix, but if the prefix is not present, the _content-type attribute is needed. Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you are correct! So going forward we should drop ":_content-type: PROCEDURE" from our docs, it's not a priority obviously but it might reduce future confusion.

@mickogeary

...modules/proc_updating-the-amq-interconnect-ca-certificate-on-red-hat-openstack-platform.adoc Outdated
[id="updating-the-amq-interconnect-ca-certificate-on-red-hat-openstack-platform_{context}"]
= Updating the AMQ Interconnect CA Certificate on Red Hat OpenStack Platform

After you upgrade to Service Telemetry Framework (STF) v1.5, the CA certificate for AMQ Interconnect regenerates. In STF v1.4 the CA certificate for AMQ Interconnect is valid for three months and must be updated periodically in Red Hat OpenStack Platform (RHOSP). In STF v1.5, the generated certificates are valid for the lifetime of the RHOSP lifecycle, 70080 hours by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After you upgrade to Service Telemetry Framework (STF) v1.5, the CA certificate for AMQ Interconnect regenerates. In STF v1.4 the CA certificate for AMQ Interconnect is valid for three months and must be updated periodically in Red Hat OpenStack Platform (RHOSP). In STF v1.5, the generated certificates are valid for the lifetime of the RHOSP lifecycle, 70080 hours by default.
After you upgrade to Service Telemetry Framework (STF) v1.5, the CA certificate for {MessageBus} regenerates. In STF v1.4 the CA certificate for {MessageBus} is valid for three months and must be updated periodically in {OpenStack} ({OpenStackShort}). In STF v1.5, the generated certificates are valid for 8 years by default.

...modules/proc_updating-the-amq-interconnect-ca-certificate-on-red-hat-openstack-platform.adoc Outdated

.Procedure

* For more information about how to update the CA certificate in your RHOSP environment, see: link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.0/html/service_telemetry_framework_1.5/assembly-renewing-the-amq-interconnect-certificate_assembly#proc-updating-the-amq-interconnect-ca-certificate_assembly-renewing-the-amq-interconnect-certificate[Updating the AMQ Interconnect CA certificate]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* For more information about how to update the CA certificate in your RHOSP environment, see: link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.0/html/service_telemetry_framework_1.5/assembly-renewing-the-amq-interconnect-certificate_assembly#proc-updating-the-amq-interconnect-ca-certificate_assembly-renewing-the-amq-interconnect-certificate[Updating the AMQ Interconnect CA certificate]
* For more information about how to update the CA certificate in your {OpenStackShort} environment, see: link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.0/html/service_telemetry_framework_1.5/assembly-renewing-the-amq-interconnect-certificate_assembly#proc-updating-the-amq-interconnect-ca-certificate_assembly-renewing-the-amq-interconnect-certificate[Updating the AMQ Interconnect CA certificate]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link also probably shouldn't be explicit like this, but be an internal reference, right?

...elemetry-Framework/modules/proc_upgrading-red-hat-openshift-container-platform-to-v4-10.adoc Outdated
[role="_additional-resources"]
.Additional resources

For more information about upgrading your Red Hat OpenShift Container Platform from v4.8 to v4.10, see link:https://docs.openshift.com/container-platform/4.8///updating/index.html[Updating clusters overview ].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more information about upgrading your Red Hat OpenShift Container Platform from v4.8 to v4.10, see link:https://docs.openshift.com/container-platform/4.8///updating/index.html[Updating clusters overview ].
For more information about upgrading your {OpenShift} from v4.8 to v4.10, see link:https://docs.openshift.com/container-platform/4.8///updating/index.html[Updating clusters overview ].

...etry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc Outdated
.Prerequisites

* Back up your data. There is an outage during the Red Hat OpenShift Container Platform upgrade. You cannot reconfigure the `ServiceTelemetry` and `SmartGateway` objects during the Operators replacement.
* Prepare your environment for upgrade from Red Hat OpenShift Container Platform v4.8 to v4.10. STF v1.5 only supports Red Hat OpenShift Container Platform v4.10.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{OpenShift}

@mickogeary mickogeary requested a review from vkmc February 10, 2023 14:15
@leifmadsen leifmadsen mentioned this pull request Feb 16, 2023
Merged
@leifmadsen
Copy link
Member

I'm noting here that once the review is complete here, we'll need to do a round of variable replacement so that the values are dynamic. There are also a few sections that need to get wrapped in ifdef as well because some sections are not applicable for all versions of RHOSP.

I have proposed these changes against this branch in #447

csibbitt
csibbitt approved these changes Feb 16, 2023
View reviewed changes
...emetry-Framework/modules/proc_installing-the-service-telemetry-framework-v1-5-operators.adoc
* Title: = Installing the Service Telemetry Framework v1.5 Operators
////

:_content-type: PROCEDURE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading that, it seems like a fallback option. The content type will be identified by the filename prefix, but if the prefix is not present, the _content-type attribute is needed. Thanks!

@leifmadsen
Add ifdef wrappers for certificate parts (#447)
becf47a 
* Add ifdef wrappers for certificate documentation parts which do not
  apply to OSP16 (only 13 and 17).
* Add a couple of clean up items for consistency and visual bits.
JoanneOFlynn2018
JoanneOFlynn2018 reviewed Feb 17, 2023
View reviewed changes
...etry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc Outdated
.Prerequisites

* You have backed up your data. There is an outage during the {OpenShift} upgrade. You cannot reconfigure the `ServiceTelemetry` and `SmartGateway` objects during the Operators replacement.
* Prepare your environment for upgrade from {OpenShift} v4.8 to the supported version, v4.10.
Copy link
Collaborator

@JoanneOFlynn2018 JoanneOFlynn2018 Feb 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Prepare your environment for upgrade from {OpenShift} v4.8 to the supported version, v4.10.
* You have prepared your environment for upgrade from {OpenShift} v4.8 to the supported version, v4.10.

Don't use present tense for prerequisites. Prereqs are tasks you should have already completed or software/hardware you should already have.

JoanneOFlynn2018
JoanneOFlynn2018 reviewed Feb 17, 2023
View reviewed changes
...etry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc Outdated
* You have backed up your data. There is an outage during the {OpenShift} upgrade. You cannot reconfigure the `ServiceTelemetry` and `SmartGateway` objects during the Operators replacement.
* Prepare your environment for upgrade from {OpenShift} v4.8 to the supported version, v4.10.
* The {OpenShift} cluster is fully connected. {ProjectShort} does not support disconnected or restricted-network clusters.
* Remove the AMQ Certificate Manager before you upgrade {OpenShift}. Verify that no other Operators or workloads require the AMQ Certificate Manager in your environment.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Remove the AMQ Certificate Manager before you upgrade {OpenShift}. Verify that no other Operators or workloads require the AMQ Certificate Manager in your environment.

This isn't a prereq to this user story, this is part of it.

JoanneOFlynn2018
JoanneOFlynn2018 reviewed Feb 17, 2023
View reviewed changes
...emetry-Framework/modules/proc_installing-the-service-telemetry-framework-v1-5-operators.adoc
.Prerequisites

* You have upgraded your {OpenShift} environment to v4.10. For more information about upgrading {OpenShift}, see xref:upgrading-red-hat-openshift-container-platform-to-v4-10_upgrading-service-telemetry-framework-to-version-1-5[].
* Your {OpenShift} environment network is fully-connected.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Your {OpenShift} environment network is fully-connected.
* Your {OpenShift} environment network is fully connected.

Global comment:
fully connected is definitely not hyphenated.

JoanneOFlynn2018
JoanneOFlynn2018 reviewed Feb 17, 2023
View reviewed changes
...emetry-Framework/modules/proc_installing-the-service-telemetry-framework-v1-5-operators.adoc Outdated
openshift-cert-manager.v1.7.1 cert-manager Operator for Red Hat OpenShift 1.7.1-1 Succeeded
----

. Optional: Re-subscribe to the Grafana Operator. For more information, see xref:setting-up-grafana-to-host-the-dashboard_assembly-advanced-features[].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Optional: Re-subscribe to the Grafana Operator. For more information, see xref:setting-up-grafana-to-host-the-dashboard_assembly-advanced-features[].
. Optional: Resubscribe to the Grafana Operator. For more information, see xref:setting-up-grafana-to-host-the-dashboard_assembly-advanced-features[].

JoanneOFlynn2018
JoanneOFlynn2018 reviewed Feb 17, 2023
View reviewed changes
...elemetry-Framework/modules/proc_removing-the-service-telemetry-framework-v1-4-operators.adoc Outdated
[role="_additional-resources"]
.Additional resources

* For more information about removing Operators from the {OpenShift}, see link:https://docs.openshift.com/container-platform/4.8/operators/admin/olm-deleting-operators-from-cluster.html[Deleting Operators from a cluster]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* For more information about removing Operators from the {OpenShift}, see link:https://docs.openshift.com/container-platform/4.8/operators/admin/olm-deleting-operators-from-cluster.html[Deleting Operators from a cluster]
* For more information about removing Operators from the {OpenShift}, see link:https://docs.openshift.com/container-platform/4.8/operators/admin/olm-deleting-operators-from-cluster.html[Deleting Operators from a cluster].

JoanneOFlynn2018
JoanneOFlynn2018 reviewed Feb 17, 2023
View reviewed changes
...elemetry-Framework/modules/proc_upgrading-red-hat-openshift-container-platform-to-v4-10.adoc Outdated
:_content-type: PROCEDURE

[id="upgrading-red-hat-openshift-container-platform-to-v4-10_{context}"]
= Upgrading {OpenShift} to v4.10
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
= Upgrading {OpenShift} to v4.10
= Upgrading {OpenShift} to 4.10

JoanneOFlynn2018
JoanneOFlynn2018 reviewed Feb 17, 2023
View reviewed changes
...elemetry-Framework/modules/proc_upgrading-red-hat-openshift-container-platform-to-v4-10.adoc Outdated

:_content-type: PROCEDURE

[id="upgrading-red-hat-openshift-container-platform-to-v4-10_{context}"]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[id="upgrading-red-hat-openshift-container-platform-to-v4-10_{context}"]
[id="upgrading-red-hat-openshift-container-platform-to-4-10_{context}"]

YOu'll need to update the actual file name also.

JoanneOFlynn2018
JoanneOFlynn2018 previously requested changes Feb 17, 2023
View reviewed changes
Copy link
Collaborator

@JoanneOFlynn2018 JoanneOFlynn2018 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Michael,
I finished my review and requested a few changes. Nothing major.

@mickogeary mickogeary dismissed stale reviews from JoanneOFlynn2018 and leifmadsen February 17, 2023 14:19

addressed comments

@mickogeary mickogeary merged commit 665e823 into master Feb 17, 2023
@mickogeary mickogeary deleted the mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5 branch February 17, 2023 14:20
mickogeary added a commit that referenced this pull request Feb 17, 2023
@mickogeary @leifmadsen
mg_master_2168184_adding section with procedures for upgrade from 1.4… (
2e8938a 
#444)

* mg_master_2168184_adding section with procedures for upgrade from 1.4 to 1.5

* Bump base image for building to Fedora 37 (#445)

* Bump base image for building to Fedora 37

Bump the base image for building in CI to Fedora 37 because Fedora 33 is
now EOL and has been removed from the quay repository.

* Set /docs directory to being marked safe

* Bump actions/checkout v2 (deprecated) to v3

* Update doc-Service-Telemetry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc

* commit 2, incorporating feedback mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5

* commit 3, fixed internal link to Grafana section mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5

* mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5 commit Feb 14th

* Add ifdef wrappers for certificate parts (#447)

* Add ifdef wrappers for certificate documentation parts which do not
  apply to OSP16 (only 13 and 17).
* Add a couple of clean up items for consistency and visual bits.

* mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5 commit Feb 17

Rebased

---------

Co-authored-by: Leif Madsen <lmadsen@redhat.com>
@mickogeary mickogeary mentioned this pull request Feb 17, 2023
Merged
JoanneOFlynn2018 pushed a commit that referenced this pull request Feb 17, 2023
@mickogeary @leifmadsen
mg_master_2168184_adding section with procedures for upgrade from 1.4… (
a70b357 
#444) (#448)

* mg_master_2168184_adding section with procedures for upgrade from 1.4 to 1.5

* Bump base image for building to Fedora 37 (#445)

* Bump base image for building to Fedora 37

Bump the base image for building in CI to Fedora 37 because Fedora 33 is
now EOL and has been removed from the quay repository.

* Set /docs directory to being marked safe

* Bump actions/checkout v2 (deprecated) to v3

* Update doc-Service-Telemetry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc

* commit 2, incorporating feedback mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5

* commit 3, fixed internal link to Grafana section mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5

* mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5 commit Feb 14th

* Add ifdef wrappers for certificate parts (#447)

* Add ifdef wrappers for certificate documentation parts which do not
  apply to OSP16 (only 13 and 17).
* Add a couple of clean up items for consistency and visual bits.

* mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5 commit Feb 17

Rebased

---------

Co-authored-by: Leif Madsen <lmadsen@redhat.com>
@leifmadsen leifmadsen mentioned this pull request Mar 27, 2023
Merged
leifmadsen added a commit that referenced this pull request Mar 29, 2023
@leifmadsen @JoanneOFlynn2018
@csibbitt @mickogeary @vkmc @lnatapov
Import changes for STF 1.5.1 (#459)
c63f9a3 
* Add procedure to disable services on OSP side (#407)

* Add procedure to disable services on OSP side

Add a procedure that disables the services provisioned when enabling STF.

Resolves: rhbz#2096853

* Add warning to not use procedure with gnocchi

Add a warning to not use the disable procedure when making use of the
Sending metrics to Gnocchi and Service Telemetry Framework procedure
since not all dependencies are provided as part of that instruction set,
since they are a super-set of the STF deployment instructions. In the
future we should probably just remove the Gnocchi deployment
instructions since we've re-written the autoscaling guide and that is
the one procedure that would provide Gnocchi deployments, and would
contain all the necessary dependencies in the provided THT environment
files.

* Apply suggestions from code review

Small changes from jof

* Update doc-Service-Telemetry-Framework/modules/proc_disabling-openstack-services-used-with-stf.adoc

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>

* Update doc-Service-Telemetry-Framework/modules/proc_disabling-openstack-services-used-with-stf.adoc

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>

* Update doc-Service-Telemetry-Framework/modules/proc_disabling-openstack-services-used-with-stf.adoc

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>

* Don't remove existing 'stable-1.5' generated files (#412)

* Minor updates to dashboarding guide (#413)

* Minor updates to dashboarding guide

Perform some minor updates to the dashboarding guide, referencing
existing dashboards we have for virtual machine and memcached views.

Update the ServiceTelemetry manifest to reference the rhel8/grafana:7
container image which should provide more consistency in how things are
deployed, helping avoid a situation where newer versions of Grafana out
of hub.docker.com no longer interface with the version of Elasticsearch
that would be used when enabling events support by default.

Update the path to the dashboards being created to reference the
'stf-1/' directory to reduce confusion by no longer referencing stf-1.3
in the links.

Depends-On: infrawatch/dashboards#50

* Update doc-Service-Telemetry-Framework/modules/con_dashboards.adoc

plural to single

* Update doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc

* Add note about STF 1.3 and revert path change

Revert path changes to the dashboards as use of symlinks as intended is
not possible. Instead, add a note stating that the reference to STF 1.3
is the earliest version compatible with the dashboards, and can be used
with STF versions 1.3 through 1.5.

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>

* Fix syntax error in certificate renewal module (#416)

* Fix syntax error in certificate renewal module

Fix a syntax error in the certificate renewal module. Fixing this
results in another issue that was hidden, whereby extra source lines are
shown when building for version 17.0 due to loose version ranges.
Unfortunately asciidoc doesn't provide an AND function in an ifeval or
ifdef so we need separate parameters defined and nested to perform what
is effectively a greater-than AND less-than evaluation.

This was caught by QE when identifying a link that didn't have a
corresponding section being built. The syntax error on the endif
resulted in everything after that not being built, but did not result in
a build error oddly enough. With this fix, everything is working as
intended and included assemblies after this one are now visible.

* Update ifdef to use AND syntax

Update ifdef to use AND syntax per https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/#checking-multiple-attributes

* Removed sending-metrics-to-gnocchi-and-to-stf m… (#414)

* Removed xrefs and include for sending-metrics-to-gnocchi-and-to-stf module

* New folder named departure to hold files before deletion, updated gitignore file

* I removed an assembly xref from additional resources section so that build is 100%

* Removed upgrade section

* Added link at assembly level re disabling services

Co-authored-by: Leif Madsen <lmadsen@redhat.com>

* Jof mas minor edits 1.5 (#421)

* changes to Primary parameters of the ServiceTelemetry object

* Minor edits mostly reducing future tense

* Apply suggestions from code review

Routers -> dispatch routers

* Update link to STF life cycle page (#423)

Update the link to the STF life cycle page and remove reference to
supporting the two most recent versions of STF. This has recently
changed. STF 1.4 will be supported until the EOL of OpenShift 4.8 at
which point STF 1.4 will also be EOL. In the meantime STF 1.4 is now in
maintenance mode (CVE fixes only, no backport of features). STF 1.5 is
supported as of 4.10 and will EOL with RHOSP 17.1.

* updated link (#428)

* Updated path to match PR#52 in dashboard repo (#427)

* Fixed alertmanager verification command (#430)

* Eliminate mentions of sensubility in OSP13 (#431)

* A list of low hanging docs changes from our feature testing (#426)

* A list of low hanging docs changes from our feature testing

Items below are from STF-1167

* OSP Connection 1a Docs: Check other containers, not just metrics_qdr
* Dashboards 1c: Docs: Rewording or change object we source creds from
* Dashboards 1d: Docs: Wait for grafana restart
* Metrics retention 1b:  Docs: Tell customers how to verify
* Alerts 2: Docs: More explicit example of how to construct this config
* HA 2 Docs: Improve alertmanager config docs and re-test
  * Continues to work for me
* Ephemeral Storage Docs: Document this only upstream and/or dev docs
* Observability Strategy Docs: Add a note of which objects to delete
* Docs: Double check that libpodstats and sensubility are not mentioned in OSP 13 (they shouldn't be)
  * I checked here: https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html-single/service_telemetry_framework_1.5/index
  * libpodstats is not mentioned, but sensubility is mentioned in several places
  * Is this a mistake? I don't have an OSP 13 handy and haven't dug through the artifacts to figure it out.
    * If changes are needed, there are several affected locations, so I'll use a dedicated PR
* Certificate Handling (Issue 15.1 or sooner): Set 7.5yr expiry on all certs
  * infrawatch/service-telemetry-operator#389

* Update doc-Service-Telemetry-Framework/modules/proc_creating-an-alert-route-with-templating-in-alertmanager.adoc

Co-authored-by: Leif Madsen <lmadsen@redhat.com>

* Apply suggestions from code review

Co-authored-by: Leif Madsen <lmadsen@redhat.com>

* Include more ceilometer agents in verification

* Source block for container verif

Co-authored-by: Leif Madsen <lmadsen@redhat.com>

* mg_master_2161659_minor-style-edit changed note text and position (#437)

Co-authored-by: Michael Geary <mgeary@redhat.com>

* Remove note from importing dashboards procedure (#439)

Remove the note from the importing dashboards procedure since the paths
no longer refer to STF 1.3.

* Adjust network polling meter for ceilometer (#440)

Adjust the broad ceilometer polling meter configuration to be a bit more
specific so that we aren't attempting to poll APIs that no longer exist.

Closes rhbz#2129729

* Eliminate vestiges of "stf-default" (#442)

* I think this used to be the default name long-long ago?
* I made a deployment by cut/pasting the manifest from the ephemeral storage
  * And then all the names mismatched the examples and documented commands

* Link to the amqp1 plugin header directly (#443)

* Bump base image for building to Fedora 37 (#445)

* Bump base image for building to Fedora 37

Bump the base image for building in CI to Fedora 37 because Fedora 33 is
now EOL and has been removed from the quay repository.

* Set /docs directory to being marked safe

* Bump actions/checkout v2 (deprecated) to v3

* mg_master_2168184_adding section with procedures for upgrade from 1.4… (#444)

* mg_master_2168184_adding section with procedures for upgrade from 1.4 to 1.5

* Bump base image for building to Fedora 37 (#445)

* Bump base image for building to Fedora 37

Bump the base image for building in CI to Fedora 37 because Fedora 33 is
now EOL and has been removed from the quay repository.

* Set /docs directory to being marked safe

* Bump actions/checkout v2 (deprecated) to v3

* Update doc-Service-Telemetry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc

* commit 2, incorporating feedback mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5

* commit 3, fixed internal link to Grafana section mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5

* mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5 commit Feb 14th

* Add ifdef wrappers for certificate parts (#447)

* Add ifdef wrappers for certificate documentation parts which do not
  apply to OSP16 (only 13 and 17).
* Add a couple of clean up items for consistency and visual bits.

* mg_master_2168184_procedures-to-upgrade-from-1.4-to-1.5 commit Feb 17

Rebased

---------

Co-authored-by: Leif Madsen <lmadsen@redhat.com>

* Fix alertmanager verification command

* See #430
* I missed this second instance

* Revert "Fix alertmanager verification command"

Accidental push to master. I will go protect the branch...

This reverts commit a9aa450.

* Fix alertmanager verification command (#450)

* See #430
* I missed this second instance

* Reference event enablement for virtual machine view (#451)

* Reference event enablement for virtual machine view

Reference the event enablement for the virtual machine dashboard which uses the es_ceilometer datasource.

Closes: rhbz#2173856

* Soften language to make event enablement optional

Soften language to make event enablement optional as suggested by Chris.

* Expand supported OCP range through to 4.12 (#452)

* Adjust path to triple-ansible-inventory file (#454)

Adjust the path to the Ansible inventory file across RHOSP versions during documentation generation. Also fix inclusion of AMQ certificate renewal procedures in RHOSP 16 where certificate distribution does not exist.

Closes: rhbz#2158178

* Remove DCN related configuration artifacts (#455)

Remove DCN related configuration artifacts because it's not clear that
this is helpful guidance, and there is information provided it may
actually be harmful to getting a working environment.

Closes: rhbz#2023902

* Add SNMP trap configuration parameters (#449)

* Add SNMP trap configuration parameters

Add SNMP trap configuration parameters that are being exposed via the
ServiceTelemetry object. Create a concept module that provides a better
overview of the OID configuration and link to location of the MIB
definition. Also provide an example prometheus rule that shows how to
override the OID value on a per-alert rule definition.

Closes: STF-1257

* Clean up some wording

* Add an example configuration manifest

* Update doc-Service-Telemetry-Framework/modules/con_snmp-traps.adoc

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>

* Update doc-Service-Telemetry-Framework/modules/con_snmp-traps.adoc

Changing a style comment to a suggestion which I can implement

* Update doc-Service-Telemetry-Framework/modules/con_snmp-traps.adoc

* Update doc-Service-Telemetry-Framework/modules/con_snmp-traps.adoc

* Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc

* Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc

* Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc

* Update doc-Service-Telemetry-Framework/modules/con_snmp-traps.adoc

* Update doc-Service-Telemetry-Framework/modules/con_snmp-traps.adoc

---------

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>
Co-authored-by: mickogeary <mickogeary@gmail.com>

* Expose ability to set certificate renewal target times (#453)

* Expose ability to set certificate renewal target times

Expose the duration value in STO to allow better control of the default certificate renewal times.

* Fix format errors and enhance redaction

* ElasticSearch to Elasticsearch
* Mispelling in  default values
* Inclusion of assembly for OSP 13 and OSP 16
* AQDR to {MessageBus}

* Minor typo fix

* Apply suggestions from code review

Co-authored-by: mickogeary <mickogeary@gmail.com>

---------

Co-authored-by: Leif Madsen <lmadsen@redhat.com>
Co-authored-by: mickogeary <mickogeary@gmail.com>

* [OSP13] Replacing "allovercloud" with "overcloud" in ansible command (#456)

Co-authored-by: root <root@seal31.lab.eng.tlv2.redhat.com>

* [OSP13] Replacing podman with docker in ansible command. (#457)

* [OSP13] Replacing podman with docker in ansible command.

* Apply suggestions from code review

Co-authored-by: Leif Madsen <lmadsen@redhat.com>

---------

Co-authored-by: root <root@seal31.lab.eng.tlv2.redhat.com>
Co-authored-by: Leif Madsen <lmadsen@redhat.com>

* Fix improper merge conflict for build_tools

---------

Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>
Co-authored-by: Chris Sibbitt <csibbitt@redhat.com>
Co-authored-by: mickogeary <mickogeary@gmail.com>
Co-authored-by: Michael Geary <mgeary@redhat.com>
Co-authored-by: Victoria Martinez de la Cruz <victoria@redhat.com>
Co-authored-by: Leonid Natapov <lnatapov@redhat.com>
Co-authored-by: root <root@seal31.lab.eng.tlv2.redhat.com>
@leifmadsen leifmadsen mentioned this pull request Jun 19, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@csibbitt csibbitt csibbitt approved these changes

@JoanneOFlynn2018 JoanneOFlynn2018 JoanneOFlynn2018 left review comments

@vkmc vkmc Awaiting requested review from vkmc

@leifmadsen leifmadsen Awaiting requested review from leifmadsen

@rheslop rheslop Awaiting requested review from rheslop

Assignees

@mickogeary mickogeary

Labels

1.5 needs-backport Requires a cherry pick back to previous release(s)

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mickogeary @JoanneOFlynn2018 @leifmadsen @csibbitt @rheslop