Skip to content
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.

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

Override qdr::router_id defaults in stf-connectors #487

Merged
merged 2 commits into from
Sep 11, 2023

Conversation

leifmadsen
Copy link
Member

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

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
@leifmadsen
Copy link
Member Author

oc exec -it default-interconnect-7cc45b86c5-nxd98 -- qdstat --all-routers -c
2023-09-08 15:06:44.956170 UTC
default-interconnect-7cc45b86c5-nxd98

Connections
  id     host                container                             role    dir  security                                authentication  tenant  last dlv      uptime
  ==========================================================================================================================================================================
  1      10.129.1.184:55334  bridge-96                             edge    in   no-security                             anonymous-user          -             001:02:24:47
  2      10.129.1.183:59278  bridge-96                             edge    in   no-security                             anonymous-user          000:00:00:02  001:02:24:47
  13     10.130.1.192:60290  bridge-19f                            edge    in   no-security                             anonymous-user          000:00:00:23  001:02:24:39
  19     10.130.1.194:56016  bridge-36e                            edge    in   no-security                             anonymous-user          000:12:58:42  001:02:24:35
  23     10.128.0.105:37418  bridge-7c                             edge    in   no-security                             anonymous-user          000:00:00:01  001:02:24:31
  22853  10.129.0.1:54334    controller-0.cloud1                   edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:03  000:07:05:09
  22854  10.129.0.1:54348    compute-0.cloud1                      edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:02  000:07:05:08
  22855  10.129.0.1:54362    compute-1.cloud1                      edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:02  000:07:05:08
  22856  10.129.0.1:54376    controller-2.cloud1                   edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:01  000:07:05:08
  22857  10.129.0.1:54388    controller-1.cloud1                   edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:03  000:07:05:02
  22858  127.0.0.1:33026     3a68cfc2-1cff-46bb-b80d-cf67632581ed  normal  in   no-security                             no-auth                 000:00:00:00  000:00:00:00

@leifmadsen
Copy link
Member Author

I also verified everything is still working etc. This only changes how the router IDs show up in QDR, and doesn't have any effect on the node names in the metrics themselves.

@leifmadsen leifmadsen merged commit b248a57 into master Sep 11, 2023
1 check passed
@leifmadsen leifmadsen deleted the rhbz2208020/qdr-hostname-config branch September 11, 2023 18:35
@leifmadsen leifmadsen mentioned this pull request Dec 6, 2023
leifmadsen added a commit that referenced this pull request Dec 7, 2023
* Fix xrefs for director Operator (#481)

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 (#483)

* 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 <lmadsen@redhat.com>

* Minor adjustments from review

---------

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

* Trivial leftover suggestions (#485)

* Trivial leftover suggestions

* Link ES section to KB article (#486)

* 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 <lmadsen@redhat.com>

* Initial changes to installation for STF 1.5.3 (#484)

* 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 <lmadsen@redhat.com>

* 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 <lmadsen@redhat.com>

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* 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 <mickogeary@gmail.com>

* Reword section that repeats itself

---------

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

* use_redhat and migration link (#462)

* use_redhat and migration link

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Apply suggestions from code review

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

* Minor typo fix

* Visual tweak

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

---------

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

* Override qdr::router_id defaults in stf-connectors (#487)

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 (#488)

* 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.

* No longer import the events dashboard (#490)

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 is no longer necessary (#491)

Installation of cluster monitoring in CRC (and elsewhere) is no longer necessary for installation of STF.

Resolved by #465

* Adjust the default polling interval for collectd (#489)

Adjust the collectd polling interval to be 30 seconds instead of 5
seconds.

Related STF-1512

Co-authored-by: Victoria Martinez de la Cruz <victoria@redhat.com>

* Remove logs configuration from sample CR (#493)

Related STF-1504

* mg_master_RHOSPDOC-1380_chunk-installation-procedure (#492)

* 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 (#497)

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 (#494)

* 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 <mickogeary@gmail.com>

---------

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

* Fix up the table syntax in Observability Strategy (#495)

The existing table was in markdown format which isn't compatible with asciidoc syntax.

* Do not manage the event pipeline by default (#498)

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

* Minor clean up and user experience updates (#496)

Some minor clean up items and convert some commands to be a bit more
user friendly and generic

Resolves STF-1533

* Creating an alert does not use curl (#500)

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.

* Eliminate duplicate line (#501)

* Adding details for QDR password auth (#502)

* 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 <lmadsen@redhat.com>

* Update doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc

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

---------

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

* Support OCP versions 4.12 through 4.14 (#503)

* 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

* Summary: Replace incorrect stf-connectors.yaml filename with enable-stf.yaml (#504)

Tracker: https://bugzilla.redhat.com/show_bug.cgi?id=2239871

Branch: master-BZ-2239871

* Clean up the STF install (#505)

* 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 STF object for deployment (#507)

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 RHOSP links and versions (#508)

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 dashboard procedures (#509)

Update and adjust the dashboard installation procedures based on
testing.

* Add deprecation note for Grafana authentication (#510)

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 deprecated Grafana login warning (#511)

Update the Grafana login deprecation warning with wording from the
documentation team.

* Add updated architecture diagrams (#499)

* 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 <mickogeary@gmail.com>

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

---------

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

* Update install guide for dependent operators (#513)

* 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 <csibbitt@redhat.com>

* Add prerequisites to STF deployment

* Adjust wording based on editorial feedback

---------

Co-authored-by: Chris Sibbitt <csibbitt@redhat.com>

* Clean up the prerequisites lists (#514)

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 (#516)

* 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 (#515)

* 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

* Pre-STF 1.5.3 Documentation Walkthrough and Cleanup (#517)

* 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.

* Modularize STF architecture changes (#518)

* Update diagrams for Cluster Observability Operator (#519)

* mg_master_517_minor-style-edits (#521)

* 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 <lmadsen@redhat.com>

* Reference 17.1 in docinfo.xml (#522)

* PrometheusRules must reference monitoring.rhobs (#523)

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.

---------

Signed-off-by: Leif Madsen <lmadsen@redhat.com>
Co-authored-by: Chris Sibbitt <csibbitt@redhat.com>
Co-authored-by: mickogeary <mickogeary@gmail.com>
Co-authored-by: Victoria Martinez de la Cruz <victoria@redhat.com>
Co-authored-by: Roger Heslop <rheslop@redhat.com>
leifmadsen added a commit that referenced this pull request Mar 5, 2024
* Fix xrefs for director Operator (#481)

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 (#483)

* 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 <lmadsen@redhat.com>

* Minor adjustments from review

---------

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

* Trivial leftover suggestions (#485)

* Trivial leftover suggestions

* Link ES section to KB article (#486)

* 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 <lmadsen@redhat.com>

* Initial changes to installation for STF 1.5.3 (#484)

* 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 <lmadsen@redhat.com>

* 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 <lmadsen@redhat.com>

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

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

* 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 <mickogeary@gmail.com>

* Reword section that repeats itself

---------

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

* use_redhat and migration link (#462)

* use_redhat and migration link

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Apply suggestions from code review

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

* Minor typo fix

* Visual tweak

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

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

---------

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

* Override qdr::router_id defaults in stf-connectors (#487)

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 (#488)

* 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.

* No longer import the events dashboard (#490)

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 is no longer necessary (#491)

Installation of cluster monitoring in CRC (and elsewhere) is no longer necessary for installation of STF.

Resolved by #465

* Adjust the default polling interval for collectd (#489)

Adjust the collectd polling interval to be 30 seconds instead of 5
seconds.

Related STF-1512

Co-authored-by: Victoria Martinez de la Cruz <victoria@redhat.com>

* Remove logs configuration from sample CR (#493)

Related STF-1504

* mg_master_RHOSPDOC-1380_chunk-installation-procedure (#492)

* 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 (#497)

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 (#494)

* 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 <mickogeary@gmail.com>

---------

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

* Fix up the table syntax in Observability Strategy (#495)

The existing table was in markdown format which isn't compatible with asciidoc syntax.

* Do not manage the event pipeline by default (#498)

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

* Minor clean up and user experience updates (#496)

Some minor clean up items and convert some commands to be a bit more
user friendly and generic

Resolves STF-1533

* Creating an alert does not use curl (#500)

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.

* Eliminate duplicate line (#501)

* Adding details for QDR password auth (#502)

* 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 <lmadsen@redhat.com>

* Update doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc

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

---------

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

* Support OCP versions 4.12 through 4.14 (#503)

* 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

* Summary: Replace incorrect stf-connectors.yaml filename with enable-stf.yaml (#504)

Tracker: https://bugzilla.redhat.com/show_bug.cgi?id=2239871

Branch: master-BZ-2239871

* Clean up the STF install (#505)

* 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 STF object for deployment (#507)

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 RHOSP links and versions (#508)

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 dashboard procedures (#509)

Update and adjust the dashboard installation procedures based on
testing.

* Add deprecation note for Grafana authentication (#510)

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 deprecated Grafana login warning (#511)

Update the Grafana login deprecation warning with wording from the
documentation team.

* Add updated architecture diagrams (#499)

* 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 <mickogeary@gmail.com>

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

* Update doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

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

---------

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

* Update install guide for dependent operators (#513)

* 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 <csibbitt@redhat.com>

* Add prerequisites to STF deployment

* Adjust wording based on editorial feedback

---------

Co-authored-by: Chris Sibbitt <csibbitt@redhat.com>

* Clean up the prerequisites lists (#514)

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 (#516)

* 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 (#515)

* 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

* Pre-STF 1.5.3 Documentation Walkthrough and Cleanup (#517)

* 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.

* Modularize STF architecture changes (#518)

* Update diagrams for Cluster Observability Operator (#519)

* mg_master_517_minor-style-edits (#521)

* 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 <lmadsen@redhat.com>

* Reference 17.1 in docinfo.xml (#522)

* PrometheusRules must reference monitoring.rhobs (#523)

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.

* Basic Auth in Grafana no longer supported (#525)

* Adjust prometheus query to use token (#520)

* 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 <lmadsen@redhat.com>

* Update doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc

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

---------

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

* Update installation to target Grafana Operator v5 (#526)

Update the dashboarding installation procedures to target Grafana
Operator v5 by default.

Resolves: JIRA#STF-1680

* Add enable dashboard procedure (#527)

* 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 <mickogeary@gmail.com>

* Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc

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

* Update doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc

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

---------

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

* Update OCP version support status (#529)

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 required resource permission reference (#528)

Update the required resource permission reference to use the Grafana
Operator v5 group.

* Drop unused module found in other issue (#533)

* mg-master_RHOSPDOC-1200_STF-disconnected (#531)

* 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 <lmadsen@redhat.com>

---------

Signed-off-by: Leif Madsen <lmadsen@redhat.com>
Co-authored-by: Leif Madsen <lmadsen@redhat.com>
Co-authored-by: Chris Sibbitt <csibbitt@redhat.com>
Co-authored-by: mickogeary <mickogeary@gmail.com>
Co-authored-by: Victoria Martinez de la Cruz <victoria@redhat.com>
Co-authored-by: Roger Heslop <rheslop@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants