Skip to content

Conversation

JoanneOFlynn2018
Copy link
Collaborator

…odule

@JoanneOFlynn2018
Copy link
Collaborator Author

@leifmadsen Didn't delete the module itself in case we need any of the contents for Op Measures guide... WDYT?

@JoanneOFlynn2018 JoanneOFlynn2018 added documentation Improvements or additions to documentation cherry-pick Needs cherry-pick to stable branches labels Dec 2, 2022
@JoanneOFlynn2018 JoanneOFlynn2018 changed the title Removed xrefs and include for sending-metrics-to-gnocchi-and-to-stf m… Removed sending-metrics-to-gnocchi-and-to-stf m… Dec 5, 2022
@leifmadsen
Copy link
Member

I have updated this branch from master to pull in the changes that fixes the syntax issue in the renewal procedure, and should allow the included STF removal procedure to be included again. Should also fix issues on downstream import.


// upgrading to 1.4
include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-4.adoc[leveloffset=+1]
//include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-4.adoc[leveloffset=+1]
Copy link
Member

Choose a reason for hiding this comment

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

👍🏻

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 built this locally and reviewed. Everything looks good. Thanks!

@JoanneOFlynn2018 JoanneOFlynn2018 merged commit 652b913 into master Dec 7, 2022
@JoanneOFlynn2018 JoanneOFlynn2018 deleted the jof-mas-2150029-remove-gnocchi-section branch December 7, 2022 19:31
JoanneOFlynn2018 added a commit that referenced this pull request Dec 7, 2022
* 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>
JoanneOFlynn2018 added a commit that referenced this pull request Dec 7, 2022
* 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>
leifmadsen pushed a commit that referenced this pull request Dec 7, 2022
* 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

(cherry picked from commit 652b913)
JoanneOFlynn2018 added a commit that referenced this pull request Dec 7, 2022
* 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>

Co-authored-by: Leif Madsen <lmadsen@redhat.com>
leifmadsen added a commit that referenced this pull request Mar 29, 2023
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-pick Needs cherry-pick to stable branches documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

2 participants