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

Update install guide for dependent operators #513

Merged
merged 4 commits into from
Nov 23, 2023
Merged

Conversation

leifmadsen
Copy link
Member

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

TODO: I need to add a .Prerequisites section to the "Creating a ServiceTelemetry object in Red Hat OpenShift Container Platform" section which references both the COO and cert-manager installation steps.

@leifmadsen leifmadsen added the do not merge Code is not ready to be merged label Nov 22, 2023
@leifmadsen leifmadsen added ready for tech writer Ready for review and editing by tech writer and removed do not merge Code is not ready to be merged labels Nov 23, 2023
@leifmadsen leifmadsen merged commit 9c79b75 into master Nov 23, 2023
1 check passed
@leifmadsen leifmadsen deleted the install-dependencies branch November 23, 2023 15:48
leifmadsen added a commit to infrawatch/service-telemetry-operator that referenced this pull request Nov 23, 2023
Update the stf-run-ci scripting to match the documented installation
procedures which landed in
infrawatch/documentation#513. These changes are
also reflected in #541.
leifmadsen added a commit to infrawatch/service-telemetry-operator that referenced this pull request Nov 24, 2023
* Perform CI update to match docs install changes

Update the stf-run-ci scripting to match the documented installation
procedures which landed in
infrawatch/documentation#513. These changes are
also reflected in #541.

* Update build/stf-run-ci/tasks/setup_base.yml

Co-authored-by: Emma Foley <[email protected]>

---------

Co-authored-by: Emma Foley <[email protected]>
leifmadsen added a commit to infrawatch/service-telemetry-operator that referenced this pull request Nov 24, 2023
* Only require Interconnect and Smart Gateway

Update the dependency management within Service Telemetry Operator to
only require AMQ Interconnect and Smart Gateway Operator, which is
enough to deploy STF with observabilityStrategy: none. Other Operators
can be installed in order to satisfy data storage of telemetry and
events.

Installation of cert-manager is also required, but needs to be
pre-installed similar to Cluster Observability Operator, either as a
cluster-scoped operator with the tech-preview channel, or a single time
on the cluster as a namespace scoped operator, which is how the
stable-v1 channel installs.

Documentation will be updated to adjust for this change.

Related: STF-1636

* Perform CI update to match docs install changes (#542)

* Perform CI update to match docs install changes

Update the stf-run-ci scripting to match the documented installation
procedures which landed in
infrawatch/documentation#513. These changes are
also reflected in #541.

* Update build/stf-run-ci/tasks/setup_base.yml

Co-authored-by: Emma Foley <[email protected]>

---------

Co-authored-by: Emma Foley <[email protected]>

* Also drop cert-manager project

The cert-manager project gets created with workload items when deploying
the cert-manager from the cert-manager-operator project. When removing
cert-manager this project is not cleaned up, so we need to delete it as
well.

---------

Co-authored-by: Emma Foley <[email protected]>
leifmadsen added a commit to infrawatch/service-telemetry-operator that referenced this pull request Nov 24, 2023
* Only require Interconnect and Smart Gateway

Update the dependency management within Service Telemetry Operator to
only require AMQ Interconnect and Smart Gateway Operator, which is
enough to deploy STF with observabilityStrategy: none. Other Operators
can be installed in order to satisfy data storage of telemetry and
events.

Installation of cert-manager is also required, but needs to be
pre-installed similar to Cluster Observability Operator, either as a
cluster-scoped operator with the tech-preview channel, or a single time
on the cluster as a namespace scoped operator, which is how the
stable-v1 channel installs.

Documentation will be updated to adjust for this change.

Related: STF-1636

* Perform CI update to match docs install changes (#542)

* Perform CI update to match docs install changes

Update the stf-run-ci scripting to match the documented installation
procedures which landed in
infrawatch/documentation#513. These changes are
also reflected in #541.

* Update build/stf-run-ci/tasks/setup_base.yml

Co-authored-by: Emma Foley <[email protected]>

---------

Co-authored-by: Emma Foley <[email protected]>

* Also drop cert-manager project

The cert-manager project gets created with workload items when deploying
the cert-manager from the cert-manager-operator project. When removing
cert-manager this project is not cleaned up, so we need to delete it as
well.

---------

Co-authored-by: Emma Foley <[email protected]>
(cherry picked from commit ba9c918)
leifmadsen added a commit to infrawatch/service-telemetry-operator that referenced this pull request Nov 27, 2023
* Adjust Operator dependency version requirements (#538)

Adjust the operator package dependency requirements to align to known
required versions. Primarily reduce the version of
openshift-cert-manager from 1.10 to 1.7 in order to support the
tech-preview channel which was previously used.

Lowering the version requirement allows for the
openshift-cert-manager-operator installed previously to be used during
the STF 1.5.2 to 1.5.3 update, removing the update from being blocked.

Related: STF-1636
(cherry picked from commit 77dea87)

* Only require Interconnect and Smart Gateway (#541)

* Only require Interconnect and Smart Gateway

Update the dependency management within Service Telemetry Operator to
only require AMQ Interconnect and Smart Gateway Operator, which is
enough to deploy STF with observabilityStrategy: none. Other Operators
can be installed in order to satisfy data storage of telemetry and
events.

Installation of cert-manager is also required, but needs to be
pre-installed similar to Cluster Observability Operator, either as a
cluster-scoped operator with the tech-preview channel, or a single time
on the cluster as a namespace scoped operator, which is how the
stable-v1 channel installs.

Documentation will be updated to adjust for this change.

Related: STF-1636

* Perform CI update to match docs install changes (#542)

* Perform CI update to match docs install changes

Update the stf-run-ci scripting to match the documented installation
procedures which landed in
infrawatch/documentation#513. These changes are
also reflected in #541.

* Update build/stf-run-ci/tasks/setup_base.yml

Co-authored-by: Emma Foley <[email protected]>

---------

Co-authored-by: Emma Foley <[email protected]>

* Also drop cert-manager project

The cert-manager project gets created with workload items when deploying
the cert-manager from the cert-manager-operator project. When removing
cert-manager this project is not cleaned up, so we need to delete it as
well.

---------

Co-authored-by: Emma Foley <[email protected]>
(cherry picked from commit ba9c918)
@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 <[email protected]>

* Minor adjustments from review

---------

Co-authored-by: Leif Madsen <[email protected]>

* 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 <[email protected]>

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

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

* 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 <[email protected]>

* 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 <[email protected]>

---------

Co-authored-by: mickogeary <[email protected]>

* 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 <[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 (#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 <[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 (#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 <[email protected]>

* Add prerequisites to STF deployment

* Adjust wording based on editorial feedback

---------

Co-authored-by: Chris Sibbitt <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>
Co-authored-by: Chris Sibbitt <[email protected]>
Co-authored-by: mickogeary <[email protected]>
Co-authored-by: Victoria Martinez de la Cruz <[email protected]>
Co-authored-by: Roger Heslop <[email protected]>
vkmc added a commit to infrawatch/service-telemetry-operator that referenced this pull request Feb 14, 2024
* Add gitleaks.toml for rh-gitleaks (#510)

Add a .gitleaks.toml file to avoid the false positive leak for the
example certificate when deploying for Elasticsearch.

* [stf-collect-logs] Move describe build|pod from ci/ to the role (#505)

* [stf-run-ci] Fix check to include bool filter (#511)

Update the check to use bool filter instead of a bar var.
By default, ansible parses vars as strings, and without the | bool
filter, this check is invalid, as it will always resolve to true, since
it is a non-empty string. Other instances of the same check did this,
but this one was missed.

* [allow_skip_clone] Allow skipping of the cloning stages (#512)

* [allow_skip_clone] Use <repo>_dir instead of hardcoding all directories relative to base_dir

This will allow configuration of the repo clone destination, so we can
use pre-cloned dirs instead of explicitly cloning the dirs each time.

This is essential for CI systems like zuul, that set-up the repos with
particular versions/branches prior to running the test scripts.

* [zuul] List the other infrawatch repos as required for the job

* [zuul] Set the {sgo,sg-bridge,sg-core,prometheus-webhook-snmp}_dir vars

Add in the repo dir locations where the repos should be pre-cloned by
zuul

* Replace base_dir with sto_dir

* set sto_dir relative to base_dir is it isn't already set

* [ci] use absolute dir for requirements.txt

* [ci] Update sto_dir using explicit reference

zuul.project.src_dir refers to the current project dir. When using the jobs
in another infrawatch project, this becomes invalid.
Instead, sto_dir is explicitly set using
zuul.projects[<project_name>].src_dir, the same way that the other repo dirs
are set in vars-zuul-common

---------

Co-authored-by: Chris Sibbitt <[email protected]>

* Fix qdr auth one_time_upgrade label check (#518)

* Fix qdr auth one_time_upgrade label check

* Fix incorrect variable naming on one_time_upgrade label check

* Adjust QDR authentication password generation (#520)

Adjust the passwords being generated for QDR authentication since
certain characters (such as colon) will cause a failure in the parsing
routine within qpid-dispatch. Updates the lookup function to only use
ascii_letters and digits and increases the length to 32 characters.

---------

Co-authored-by: Leif Madsen <[email protected]>

* Add docs for skip_clone (#515)

* [allow_skip_clone] Add docs for clone_repos and *_dir vars

* Align README table column spacing (#516)

* Align README table column spacing

* Update build/stf-run-ci/README.md

---------

Co-authored-by: Emma Foley <[email protected]>

---------

Co-authored-by: Leif Madsen <[email protected]>

* [zuul] Add STO to required repos (#524)

It appears that STO is not included explictly when running jobs from
SGO [1]. This will be the case in all the other repos.
This change explicitly add it, in case it's not already included by
zuul.

[1] https://review.rdoproject.org/zuul/build/edd8f17bfdac4360a94186b46c4cea3f

* QDR Auth in smoketest (#525)

* QDR Auth in smoketest

* Added qdr-test as a mock of the OSP-side QDR
* Connection from qdr-test -> default-interconnect is TLS+Auth
* Collectors point at qdr-test instead of default-interconnect directly
* Much more realistic than the existing setup
* Eliminated a substitution in sensubility config
* Used default QDR basic auth in Jenkinsfile

* QDR Auth for infrared 17.1 script (#517)

* QDR Auth for infrared 17.1 script

* Fix missing substitution for AMQP_PASS in infrared script

* [zuul] Define a project template for stf-crc-jobs (#514)

* [allow_skip_clone] Use <repo>_dir instead of hardcoding all directories relative to base_dir

This will allow configuration of the repo clone destination, so we can
use pre-cloned dirs instead of explicitly cloning the dirs each time.

This is essential for CI systems like zuul, that set-up the repos with
particular versions/branches prior to running the test scripts.

* [zuul] List the other infrawatch repos as required for the job

* [zuul] Set the {sgo,sg-bridge,sg-core,prometheus-webhook-snmp}_dir vars

Add in the repo dir locations where the repos should be pre-cloned by
zuul

* Replace base_dir with sto_dir

* set sto_dir relative to base_dir is it isn't already set

* [ci] use absolute dir for requirements.txt

* [ci] Update sto_dir using explicit reference

zuul.project.src_dir refers to the current project dir. When using the jobs
in another infrawatch project, this becomes invalid.
Instead, sto_dir is explicitly set using
zuul.projects[<project_name>].src_dir, the same way that the other repo dirs
are set in vars-zuul-common

* [zuul] Define a project template for stf-crc-jobs

Instead of listing all the jobs for each preoject in-repo, and needing to update the list every time
that a new job is added, the project template can be updated and the changes propogated to the
other infrawatch projects

* [zuul] don't enable using the template

* Revert "[zuul] don't enable using the template"

This reverts commit 56e2009.

---------

Co-authored-by: Chris Sibbitt <[email protected]>

* Restart QDR after changing the password (#530)

* Restart QDR after changing the password

* Fixes bug reported here: #517 (comment)
* Avoids an extra manual step when changing password
* Would affect users who upgrade from earlier STF and subsequently enable basic auth
* Also users who need to change their passwords

* Fixing ansible lint

* Update roles/servicetelemetry/tasks/component_qdr.yml

* Adjust QDR restarts to account for HA

* [smoketest] Wait for qdr-test to be Running

* [smoketest] Wait for QDR password upgrade

* Remove zuul QDR auth override

* [zuul] Add jobs to test with different versions of OCP (#432)


* Add crc_ocp_bundle value to select OCP version
* zuul: add log collection post-task to get crc logs
* Add ocp v13 and a timeout to the job

* Update README for 17.1 IR test (#533)

* Update README for 17.1 IR test

Update the 17.1 infrared test script README to show how to deploy a
virtualized workload on the deployed overcloud infrastructure. Helps
with testing by providing additional telemetry to STF required in
certain dashboards.

* Update tests/infrared/17.1/README.md

Co-authored-by: Chris Sibbitt <[email protected]>

* Update tests/infrared/17.1/README.md

---------

Co-authored-by: Chris Sibbitt <[email protected]>

* Support OCP v4.12 through v4.14 (#535)

Support STF 1.5.3 starting at OpenShift version 4.12 due to
incompatibility with 4.11 due to dependency requirements. Our primary
target is support of OCP EUS releases.

Closes: STF-1632

* [stf-collect-logs] Add ignore_errors to task (#529)

The "Question the deployment" task didn't have
ignore_errors: true set, so when the task fails, the play
is finished. This means that we don't get to the
"copy logs" task and can't see the job logs in zuul.

ignore_errors is set to true to be consistent with other tasks

* Mgirgisf/stf 1580/fix log commands (#526)

* update stf-collect-logs tasks
* Update log path
* solve log bugs in stf-run-ci tasks
* create log directory

* Adjust Operator dependency version requirements (#538)

Adjust the operator package dependency requirements to align to known
required versions. Primarily reduce the version of
openshift-cert-manager from 1.10 to 1.7 in order to support the
tech-preview channel which was previously used.

Lowering the version requirement allows for the
openshift-cert-manager-operator installed previously to be used during
the STF 1.5.2 to 1.5.3 update, removing the update from being blocked.

Related: STF-1636

* Clean up stf-run-ci for OCP 4.12 minimum version (#539)

Update the stf-run-ci base setup to no longer need testing against OCP
4.10 and earlier, meaning we can rely on a single workflow for
installation. Also update the deployment to use
cluster-observability-operator via the redhat-operators CatalogSource
for installation via use_redhat and use_hybrid strategies.

* [zuul] Add job to build locally and do an index-based deployment (#495)

* [zuul] Add job to build locally and do an index-based deployment

* Only require Interconnect and Smart Gateway (#541)

* Only require Interconnect and Smart Gateway

Update the dependency management within Service Telemetry Operator to
only require AMQ Interconnect and Smart Gateway Operator, which is
enough to deploy STF with observabilityStrategy: none. Other Operators
can be installed in order to satisfy data storage of telemetry and
events.

Installation of cert-manager is also required, but needs to be
pre-installed similar to Cluster Observability Operator, either as a
cluster-scoped operator with the tech-preview channel, or a single time
on the cluster as a namespace scoped operator, which is how the
stable-v1 channel installs.

Documentation will be updated to adjust for this change.

Related: STF-1636

* Perform CI update to match docs install changes (#542)

* Perform CI update to match docs install changes

Update the stf-run-ci scripting to match the documented installation
procedures which landed in
infrawatch/documentation#513. These changes are
also reflected in #541.

* Update build/stf-run-ci/tasks/setup_base.yml

Co-authored-by: Emma Foley <[email protected]>

---------

Co-authored-by: Emma Foley <[email protected]>

* Also drop cert-manager project

The cert-manager project gets created with workload items when deploying
the cert-manager from the cert-manager-operator project. When removing
cert-manager this project is not cleaned up, so we need to delete it as
well.

---------

Co-authored-by: Emma Foley <[email protected]>

* [stf-run-ci] Explicitly check the validate_daployment was successful (#545)

In [1], the validate_deployment step is successful, despite the
deployment not being successful.
This causes the job to timeout because the following steps continue to
run despite an invalid state.

To get the expected behaviour, the output should be checked for a string
indicating success.
i.e. * [info] CI Build complete. You can now run tests.
[2] shows the output for a successful run.

[1] https://review.rdoproject.org/zuul/build/245ae63e41884dc09353d938ec9058d7/console#5/0/144/controller
[2] https://review.rdoproject.org/zuul/build/802432b23da24649b818985b7b1633bb/console#5/0/82/controller

* Implement dashboard management (#548)

* Implement dashboard management

Implement a new configuration option graphing.grafana.dashboards.enabled
which results in dashboards objects being created for the Grafana
Operator. Previously loading dashboards would be done manually via 'oc
apply' using instructions from documentation.

The new CRD parameters to the ServiceTelemetry object allows the Service
Telemetry Operator to now make the GrafanaDashboard objects directly.

Related: OSPRH-825

* Drop unnecessary cluster roles

* Update CSV for owned parameter

* Remove basic-auth method from grafana (#550)

* Only openshift auth will be allowed

* Adjust Alertmanager SAR to be more specific

* This matches recent changes in prometheus[1] and grafana[2]

[1] https://github.com/infrawatch/service-telemetry-operator/pull/549/files#diff-2cf84bcf66f12393c86949ec0d3f16c473a650173d55549bb02556d23aa22bd2R46
[2] https://github.com/infrawatch/service-telemetry-operator/pull/550/files#diff-ae71801975adb4f8dd4aa5479a66ad46e46f17de40f9d147b2e09e13ce26633eR45

* Revert "Adjust Alertmanager SAR to be more specific"

This reverts commit 0f94fd5.

* Auth to prometheus using token instead of basicauth (#549)

* Auth to prometheus using token instead of basicauth

* Add present/absent logic to prometheus-reader resources

* s/password/token in smoketest output

* [zuul] Make nightly_bundles jobs non-voting (#551)

---------

Co-authored-by: Emma Foley <[email protected]>

* Fix branch co-ordination in stf-run-ci (#555)

I think it got broken by an oops recently[1].

Since that change, working_branch (`branch` at that point) is never used because version_branches.sgo has a default value.

This breaks the branch co-ordination in Jenkins[2] and in local testing[3].

[1] https://github.com/infrawatch/service-telemetry-operator/pull/512/files#diff-c073fe1e346d08112920aa0bbc8a7453bbd3032b7a9b09ae8cbc70df4db4ea2dR19
[2] https://github.com/infrawatch/service-telemetry-operator/blob/0f94fd577617aee6a85fc4141f98ebdfc49a9f92/Jenkinsfile#L157
[3] https://github.com/infrawatch/service-telemetry-operator/blob/0f94fd577617aee6a85fc4141f98ebdfc49a9f92/README.md?plain=1#L62

* Adjust Alertmanager SAR to be more specific (#553)

* This matches recent changes in prometheus[1] and grafana[2]

[1] https://github.com/infrawatch/service-telemetry-operator/pull/549/files#diff-2cf84bcf66f12393c86949ec0d3f16c473a650173d55549bb02556d23aa22bd2R46
[2] https://github.com/infrawatch/service-telemetry-operator/pull/550/files#diff-ae71801975adb4f8dd4aa5479a66ad46e46f17de40f9d147b2e09e13ce26633eR45

* Add optional spec.replaces field to CSV for update graph compliance

The way we generate our CSVs uses OLM's skipRange functionality. This is fine,
but using only this leads to older versions becoming unavailable after the
fact -- see the warning at [1].

By adding an optional spec.replaces to our CSV we allow update testing as
well as actual production updates for downstream builds that leverage it.

Populating the field requires knowledge of the latest-released bundle,
so we take it from an environment variable to be provided by the
builder. If this is unset we don't include the spec.replaces field at
all -- leaving previous behavior unchanged.

Resolves #559
Related: STF-1658

[1] https://olm.operatorframework.io/docs/concepts/olm-architecture/operator-catalog/creating-an-update-graph/#skiprange

* Stop using ephemeral storage for testing (#547)

Update the __service_telemetry_storage_persistent_storage_class to use CRC PVs
Use the default value (false) for __service_telemetry_storage_ephemeral_enabled

* [zuul] Use extracted CRC nodes in stf-base (#531)

* [zuul] Update base job for stf-base

* Add in required projects: dataplane-operator, infra-operator, openstack-operator

* Remove nodeset from stf-base
  it overrides the nodeset set in the base job.
  The nodeset is going to be used to select the OCP version

* [zuul] define nodesets for easy reuse

* Define the nodeset
* Rename the base
* Select OCP version with the nodeset

* [zuul] Add a login command to get initial kubeconfig file

* [stf-run-ci] Add retries to pre-clean

* Update galaxy requirements

* [ci] Add retry to login command

* [ci] Configure kubeconfig for rhol_crc role

* Apply suggestions from code review

* Zuul: Update how we get the initial kubeconfig (#558)

* use ci-framework infra playbook
* add make targets to do set-up
* link the kubeconfig files
* Remove pre-get_kubeconfig.yml; the script is no longer used

* [ci] Add common-tasks.yml to cover the tasks that setup every play (#556)

* [zuul] Update the labels used for extracted CRC

* Remove non-default cifmw_rhol_crc_kubeconfig value

* Implement support for Grafana Operator v5 (#561)

* Implement support for Grafana Operator v5

Implement changes to support Grafana Operator v5 when the new
grafana.integreatly.org CRD is available. Use the new CRDs as default
when they are available. Fallover to deploying with Grafana Operator v4
when the Grafana Operator v5 CRDs are not available, thereby providing
backwards compatibility to allow administrators time to migrate.

Additionally, the polystat plugin has been removed from the rhos-cloud
dashboard due to compatibility issues with grafana-cli usage when
dynamically loading plugins. Usage of Grafana Operator v5 is also a
target for disconnected support, and dynamically loading plugins in
these environments is expected to be a problem.

Related: OSPRH-2577
Closes: STF-1667

* Default Grafana role set to Admin

In order to match the previous (Grafana Operator v4) role, set
auto_assign_org_role to the Admin value. Default is Viewer.

* Remove old vendored operator_sdk/util collection (#563)

Remove the old 0.1.0 vendored collection operator_sdk/util from the
upstream Dockerfile and repository. Instead use the default
operator_sdk/util in the base image which is a newer version of 0.4.0.

We only use the util collection for one call to k8s_status when
ephemeral storage is enabled. The newer collection also provides a
k8s_event module which could be useful in the future.

Closes: STF-1683

* Add nightly_bundle jobs to periodic pipeline (#564)

The nightly_bundle jobs will run once a day

* Remove hard-coded Prometheus version in template (#565)

Remove the hard-coded Prometheus version in the Prometheus template when
using observabilityStrategy use_redhat, which uses Cluster Observability
Operator to manage the Prometheus instance requests.

Previously this value was hard-coded to prevent a potential rollback
when moving from Community Prometheus Operator to Cluster Observability
Operator.

Resolves: JIRA#OSPRH-2140

* Set features.operators.openshift.io/disconnected to True (#570)

STF can now be deployed in disconnected mode. This change updates
the features.operators.openshift.io/disconnected annotation to
reflect this.

* [stf-run-ci] Update validation check for bundle URLs (#571)

* [stf-run-ci] Update validation check for bundle URLs

An empty string passed as the bundle URL will pass the existing test
of "is defined" and "is not None" and still be invalid.

The validation for the bundle URL can be done in one check per var:

* If the var is undefined, it becomes "", and the check fails, because of length
* If the var is None, there's an error because None does not have a length
* If the var is an empty string, the check fails because of the length

This simplifies the check and improves readability

* Prefer Grafana 9 workload (#575)

Prefer usage of Grafana 9 container image from RHCC. Grafana 7 is EOL
upstream and receives no security support. Prefer use of Grafana 9 which
is still supported.

---------

Co-authored-by: Leif Madsen <[email protected]>
Co-authored-by: Emma Foley <[email protected]>
Co-authored-by: Chris Sibbitt <[email protected]>
Co-authored-by: Marihan Girgis <[email protected]>
Co-authored-by: Miguel Garcia <[email protected]>
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 <[email protected]>

* Minor adjustments from review

---------

Co-authored-by: Leif Madsen <[email protected]>

* 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 <[email protected]>

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

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

* 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 <[email protected]>

* 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 <[email protected]>

---------

Co-authored-by: mickogeary <[email protected]>

* 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 <[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 (#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 <[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 (#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 <[email protected]>

* Add prerequisites to STF deployment

* Adjust wording based on editorial feedback

---------

Co-authored-by: Chris Sibbitt <[email protected]>

* 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 <[email protected]>

* 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 <[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 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 <[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 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 <[email protected]>

---------

Signed-off-by: Leif Madsen <[email protected]>
Co-authored-by: Leif Madsen <[email protected]>
Co-authored-by: Chris Sibbitt <[email protected]>
Co-authored-by: mickogeary <[email protected]>
Co-authored-by: Victoria Martinez de la Cruz <[email protected]>
Co-authored-by: Roger Heslop <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for tech writer Ready for review and editing by tech writer
Development

Successfully merging this pull request may close these issues.

3 participants