Propose release 1.5.4 #534
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix the xrefs for the director Operator. The xrefs were referring to the filename instead of the id+assembly value.
* Initial pass for external ES * Updates for external ES * Notice about deprecated behaviour * Mention how the migration works (automatically) * Adjust comments about observabilityStrategy: none ** Events SGs will now deploy if events are enabled ** Adjusted relevant outputs * Apply suggestions from code review Co-authored-by: Leif Madsen <[email protected]> * Minor adjustments from review --------- Co-authored-by: Leif Madsen <[email protected]>
* Trivial leftover suggestions
* Link ES section to KB article * Update doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc --------- Co-authored-by: Leif Madsen <[email protected]>
* Initial changes to installation for STF 1.5.3 Make the initial changes to the installation documentation for STF 1.5.3, which uses observabilityStrategy: use_redhat by default along with preferring to install Observability Operator. Uses the community operators catalogsource for now until OBO is officially available from redhat-operators CatalogSource. Updates the Makefile as well to include Red Hat OpenStack Platform 17.1. Signed-off-by: Leif Madsen <[email protected]> * Update install guide for pre-installed Operators Update the installation guide layout for pre-installed Operators that cannot be managed with OLM (due to them being cluster-scoped Operators vs namespace-scoped Operators). Resolves: STF-1485 Signed-off-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc Co-authored-by: mickogeary <[email protected]> * Adjust wording for cert-manager installation module * Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc Co-authored-by: mickogeary <[email protected]> * Reword section that repeats itself --------- Signed-off-by: Leif Madsen <[email protected]> Co-authored-by: mickogeary <[email protected]>
* use_redhat and migration link * Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen <[email protected]> * Apply suggestions from code review Co-authored-by: Leif Madsen <[email protected]> * Minor typo fix * Visual tweak * Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen <[email protected]> --------- Co-authored-by: Leif Madsen <[email protected]>
Update the documentation to provide an override to the FQDN in the qdr::router_id configuration to avoid hostnames longer than 61 chars. Closes rhbz#2208020
* Don't enable event collection by default on OSP Closes STF-1498 * Remove events configurations and use defaults The defaults for events pipeline and Ceilometer QDR publish events is disabled and does not need to be called out specifically.
With a refocus on telemetry by default and without event usage, remove the event dashboards as an event data store is optional and no longer included by default. Related STF-1498
Installation of cluster monitoring in CRC (and elsewhere) is no longer necessary for installation of STF. Resolved by #465
Adjust the collectd polling interval to be 30 seconds instead of 5 seconds. Related STF-1512 Co-authored-by: Victoria Martinez de la Cruz <[email protected]>
Related STF-1504
* mg_master_RHOSPDOC-1380_chunk-installation-procedure * mg_master_RHOSPDOC-1380_chunk-installation-procedure 2nd commoit with further modularisation and chunkage * Commit 3: renaming proc_deploying-stf-to-the-openshift-environment.adoc to con_deploying-stf-to-the-openshift-environment.adoc
Reduce the number of Ceilometer pollsters to only those used by the sample STF dashboards. Closes: rhbz#2239390
* Deprecate the use of high availability mode in STF Resolves STF-1507 * Update doc-Service-Telemetry-Framework/modules/con_high-availability.adoc Co-authored-by: mickogeary <[email protected]> --------- Co-authored-by: mickogeary <[email protected]>
The existing table was in markdown format which isn't compatible with asciidoc syntax.
We do not want events to be sent to QDR by default, as the STF 1.5.3 default configuration will deploy telemetry only Related STF-1498
Some minor clean up items and convert some commands to be a bit more user friendly and generic Resolves STF-1533
The Creating a standard alert route in Alertmanager section no longer uses curl to verify the configuration was loaded, since it uses the prometheus pod and the wget command instance. Removes an extra procedure step that is no longer applicable.
* Adding details for QDR password auth * Move note about disabling auth to main section * Update doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc Co-authored-by: mickogeary <[email protected]> --------- Co-authored-by: Leif Madsen <[email protected]> Co-authored-by: mickogeary <[email protected]>
* Support OCP versions 4.12 through 4.14 Update the stf-attributes to cover OCP 4.12 through 4.14 as our default, as OCP 4.10 is EOL. Update the Makefile for building to only cover RHOSP 17.1 and 16.2. * Need html-latest for upstream publish script
…tf.yaml (#504) Tracker: https://bugzilla.redhat.com/show_bug.cgi?id=2239871 Branch: master-BZ-2239871
* Clean up the STF install for OCP 4.12 and later Clean up the STF installation documentation along with a command that will wait for the STO CSV to be ready and then automatically show the dependencies. Also hide contents that are no longer applicable when the supported base version of OCP is greater than 4.10, since OCP 4.10 is now EOL. * Adjust the ifeval to be < 4.12
Provide the preferred ServiceTelemetry object for deployments rather than asking the administrator to build a configuration. The provided object will result in a metrics-focused deployment without extra configuration options, which will be a foundation for disconnected installations in the future.
Fix various links to RHOSP documentation as the paths are different between RHOSP 16.2 and 17.1. Guides were updated but there is no auto-redirect, so we'll need to verify every link that uses defaultURL parameter. This covers the initial ones while working through documentation. Update some older version links and add a new parameter for 17.1 paths specifically.
Update and adjust the dashboard installation procedures based on testing.
Deprecate the basic auth login parameters for Grafana login. Preference is to use the Log in for OpenShift button going forward. Fix syntax issues in asciidoc.
Update the Grafana login deprecation warning with wording from the documentation team.
* Add updated architecture diagrams * Use updated architecture diagrams * Update architecture overview to focus on metrics Update the architecture overview to make it clear STF is focused on delivery of metrics from RHOSP. Provide information about use_redhat observability strategy, and note that prior versions of STF would manage Elasticsearch instances. Note that new installations use the observability strategy of use_redhat, and that the guide will focus on that deployment model. Provide a placeholder for a new xref that would guide the user towards the deprecated architecture using events, where our updated metrics-and-events architecture diagram would live. * Link to observability strategy * Remove community components from core overview * Use ObservabilityOperator parameter to refer to OBO/COO * Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc * Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc Co-authored-by: mickogeary <[email protected]> --------- Co-authored-by: mickogeary <[email protected]>
* Update install guide for dependent operators Update the installation guide for dependent operators. Adds installation instructions for Cluster Observability Operator and cert-manager for Red Hat OpenShift using the latest channels available for those Operators. The result is that deployment of observabilityStrategy: use_redhat is now possible as the default installation method. Related: STF-1636 * Update doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc Co-authored-by: Chris Sibbitt <[email protected]> * Add prerequisites to STF deployment * Adjust wording based on editorial feedback --------- Co-authored-by: Chris Sibbitt <[email protected]>
The prerequisite lists were slightly wrong and have been adjusted for correctness. Minor update of output in the same area to match latest version of STF.
* Add removal instructions for COO Add removal instructions for Cluster Observability Operator, pointing at the existing product documentation. Closes: STF-1643 * Update based on editor feedback
* Refer to cert-manager removal documentation Update the STF removal guide to refer to the cert-manager uninstallation procedure which is maintained by that team. Closes: STF-1642 * Adjust cert-manager removal after editor review
* Documentation walk-through and clean up * Update architecture documentation, creating a new section describing the architecture changes in STF 1.5.3 * Update style for knowledge base article references based on editorial feedback * Add links to COO and cert-manager * Update cert-manager install to use oc wait * Multi-Cloud: Add warning about unique domains * HA: Move warning to top * Params: Add warning about HA deprecation * Obs Strat: Add link to migration KBA * Multi-Cloud: Remove reference to Ansible-based deployments * Dashboard: Fix links to collectd plugins Add wrappers to the collectd plugins in the Dashboard guide because paths changed between 16.2 and 17.1. * Update wording for CloudDomain overview Update the wording in the CloudDomain overview since router connections are controlled with router_id parameters now.
* mg_master_517_minor-style-edits * Update doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc --------- Co-authored-by: Leif Madsen <[email protected]>
The PrometheusRules and editing must all reference the new monitoring.rhobs CRD vs the old monitoring.coreos.com CRD which was provided by the community Prometheus Operator (and potentially conflicted with user-workload monitoring, and openshift-monitoring). All references to PrometheusRules now refer to the monitoring.rhobs CRD and any CLI commands are expanded for the full CRD path.
* Adjust prometheus query to use token * Add section for prometheus token handling * Correction for RBAC changes * Add link to OCP token secret docs * Specifics about UI perms * Update doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc Co-authored-by: mickogeary <[email protected]> --------- Co-authored-by: Leif Madsen <[email protected]> Co-authored-by: mickogeary <[email protected]>
Update the dashboarding installation procedures to target Grafana Operator v5 by default. Resolves: JIRA#STF-1680
* Add enable dashboard procedure Update the import dashboards procedure to be enable dashboards procedure now that STF has the ability to manage the dashboards which were formerly imported via URL. Also includes some minor procedure updates in related areas that were referenced in dashboard documentation. Resolves: JIRA#STF-1624 * Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc Co-authored-by: mickogeary <[email protected]> --------- Co-authored-by: mickogeary <[email protected]>
Update the version support status to specifically say that STF is supported on OCP EUS releases. While the STF bundles are generated for a range of releases, this is to support the ability of customers to upgrade OCP clusters between EUS releases without needing to remove STF first. Only minor testing is done against standard lifecycle releases of OCP (odd-numbered minor releases).
Update the required resource permission reference to use the Grafana Operator v5 group.
* mg-master_RHOSPDOC-1200_STF-disconnected * added more info about mirror types and verificiation * 3rd commit * another commit from feedback. Added xref and removed openshiftshort as well as a few other changes * another push to fix broken xref * Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc * fix mentions of OCP * edits based on SME feedback * more edits based on SME feedback * Minor syntax clean up * Update doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc --------- Co-authored-by: Leif Madsen <[email protected]>
mickogeary
approved these changes
Mar 5, 2024
leifmadsen
reviewed
Mar 5, 2024
|
|
||
| .Prerequisites | ||
|
|
||
| * {OpenShift} Extended Update Support (EUS) version 4.12 or 4.14 deployed in a restricted network. |
There was a problem hiding this comment.
Heh this could have used variables :)
There was a problem hiding this comment.
Discussion in Slack states that changes will happen in master and then be merged into stable-1.5 at a future time.
leifmadsen
approved these changes
Mar 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.