Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion common/stf-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ ifeval::["{build}" == "upstream"]
:OpenShift: OpenShift
:OpenShiftShort: OKD
:OpenStack: OpenStack
:OpenStackShort: OSP
:OpenStackVersion: Train
:OpenStackLong: {OpenStack}{nbsp}{OpenStackVersion}
:OpenStackInstaller: TripleO
Expand All @@ -40,7 +41,8 @@ ifeval::["{build}" == "downstream"]
:OpenShift: Red{nbsp}Hat{nbsp}OpenShift{nbsp}Container{nbsp}Platform
:OpenShiftShort: OCP
:OpenStack: Red{nbsp}Hat{nbsp}OpenStack{nbsp}Platform
:OpenStackVersion: 16.1
:OpenStackShort: RHOSP
:OpenStackVersion: 16.2
:OpenStackLong: {OpenStack}{nbsp}{OpenStackVersion}
:OpenStackInstaller: director
:OVirt: Red{nbsp}Hat{nbsp}Virtualization
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
// This assembly is included in the following assemblies:
//
// <List assemblies here, each on a new line>

////
Retains the context of the parent assembly if this assembly is nested within another assembly.
For more information about nesting assemblies, see: https://redhat-documentation.github.io/modular-docs/#nesting-assemblies
See also the complementary step on the last line of this file.
////

ifdef::context[:parent-context: {context}]

[id="assembly-introduction-to-stf_{context}"]
Expand All @@ -21,15 +11,8 @@ ifdef::context[:parent-context: {context}]
// The following block is rendered only if the `internal` variable is set.
// The table shows various metadata useful when editing this file.

ifeval::["{build}" == "downstream"]
[IMPORTANT]
{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion} and {NextSupportedOpenShiftVersion}.

//For more information about migrating, see https://access.redhat.com/articles/5477371[Migrating Service Telemetry Framework v1.0 from OperatorSource to CatalogSource].
endif::[]

[role="_abstract"]
{Project} ({ProjectShort}) collects monitoring data from {OpenStack} or third party nodes. With {ProjectShort}, you can perform the following tasks:
{Project} ({ProjectShort}) collects monitoring data from {OpenStack} ({OpenStackShort}) or third-party nodes. With {ProjectShort}, you can perform the following tasks:

* Store or archive the monitoring data for historical information
* View the monitoring data graphically on the dashboard
Expand All @@ -42,6 +25,11 @@ Event:: irregular and discrete occurrences that happen in a system

The multicast message bus provides fast, reliable data transport and is shared by all the clients in the deployment. Other modular components that receive and store data are deployed in containers on {OpenShift}.

ifeval::["{build}" == "downstream"]
[IMPORTANT]
{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion}.
endif::[]

ifeval::["{build}" == "downstream"]
include::../modules/con_support-for-stf.adoc[leveloffset=+1]
endif::[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,38 +1,15 @@
// Module included in the following assemblies:
//
// <List assemblies here, each on a new line>

// This module can be included from assemblies using the following include statement:
// include::<path>/con_sizing-your-installation.adoc[leveloffset=+1]

// The file name and the ID are based on the module title. For example:
// * file name: con_my-concept-module-a.adoc
// * ID: [id='con_my-concept-module-a_{context}']
// * Title: = My concept module A
//
// The ID is used as an anchor for linking to the module. Avoid changing
// it after the module has been published to ensure existing links are not
// broken.
//
// The `context` attribute enables module reuse. Every module's ID includes
// {context}, which ensures that the module has a unique ID even if it is
// reused multiple times in a guide.
//
// In the title, include nouns that are used in the body text. This helps
// readers and search engines find information quickly.
// Do not start the title with a verb. See also _Wording of headings_
// in _The IBM Style Guide_.
[id="installation-size-of-ocp_{context}"]
= Installation size of {OpenShift}

[role="_abstract"]
The size of your {OpenShift} installation depends on the following factors:

* The infrastructure you select.
* The number of nodes you want to monitor.
* The number of metrics you want to collect.
* The resolution of metrics.
* The length of time that you want to store the data.

Installation of {Project} ({ProjectShort}) depends on the existing {OpenShift} environment. Ensure that you install monitoring for {OpenStack} on a platform separate from your {OpenStack} environment. You can install {OpenShift} on baremetal or other supported cloud platforms. For more information about installing {OpenShift}, see https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/welcome/index.html#cluster-installer-activities[OpenShift Container Platform {SupportedOpenShiftVersion} Documentation].
Installation of {Project} ({ProjectShort}) depends on the existing {OpenShift} environment. Ensure that you install monitoring for {OpenStack} ({OpenStackShort}) on a platform separate from your {OpenStackShort} environment. You can install {OpenShift} on baremetal or other supported cloud platforms. For more information about installing {OpenShift}, see https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/welcome/index.html#cluster-installer-activities[OpenShift Container Platform {SupportedOpenShiftVersion} Documentation].
Copy link
Contributor

Choose a reason for hiding this comment

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

Haha, it looks like someone was writing too much jinja for ansible :)


The size of your {OpenShift} environment depends on the infrastructure you select. For more information about minimum resources requirements when installing {OpenShift} on baremetal, see https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/installing/installing_bare_metal/installing-bare-metal.html#minimum-resource-requirements_installing-bare-metal[Minimum resource requirements] in the _Installing a cluster on bare metal_ guide. For installation requirements of the various public and private cloud platforms which you can install, see the corresponding installation documentation for your cloud platform of choice.
For more information about minimum resources requirements when you install {OpenShift} on baremetal, see https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/installing/installing_bare_metal/installing-bare-metal.html#minimum-resource-requirements_installing-bare-metal[Minimum resource requirements] in the _Installing a cluster on bare metal_ guide. For installation requirements of the various public and private cloud platforms that you can install, see the corresponding installation documentation for your cloud platform of choice.
15 changes: 4 additions & 11 deletions doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
= {Project} architecture

[role="_abstract"]
{Project} ({ProjectShort}) uses the components described in the following table:
{Project} ({ProjectShort}) uses the client and server components described in the following table:

[[table-stf-components]]
.{ProjectShort} components
.Client and server components of {ProjectShort}
[cols="65,15,20"]
|===
|Component |Client ({OpenStack}) |Server ({OpenShift})
Expand Down Expand Up @@ -50,20 +50,13 @@ To ensure that the monitoring platform can report operational problems with your
.Service Telemetry Framework architecture overview
image::OpenStack_STF_Overview_37_1019_arch.png[Service Telemetry Framework architecture overview]

ifeval::["{build}" == "downstream"]

[NOTE]
The {ProjectShort} data collection components, collectd and Ceilometer, and the transport components, {MessageBus} and Smart Gateway, are fully supported. The data storage components, Prometheus and ElasticSearch, including the Operator artifacts, and visualization component Grafana are community-supported, and are not officially supported.

endif::[]

For metrics, on the client side, collectd provides infrastructure metrics without project data, and Ceilometer provides {OpenStack} platform data based on projects or user workload. Both Ceilometer and collectd deliver data to Prometheus by using the {MessageBus} transport, delivering the data through the message bus. On the server side, a Golang application called the Smart Gateway takes the data stream from the bus and exposes it as a local scrape endpoint for Prometheus.
On the client side, collectd provides infrastructure metrics without project data, and Ceilometer provides {OpenStack} ({OpenStackShort}) platform data based on projects or user workload. Both Ceilometer and collectd deliver data to Prometheus by using the {MessageBus} transport, delivering the data through the message bus. On the server side, a Golang application called the Smart Gateway takes the data stream from the bus and exposes it as a local scrape endpoint for Prometheus.

If you plan to collect and store events, collectd and Ceilometer delivers event data to the server side by using the {MessageBus} transport. Another Smart Gateway writes the data to the ElasticSearch datastore.

Server-side {ProjectShort} monitoring infrastructure consists of the following layers:

* {Project} {ProductVersion} ({ProjectShort})
* {Project} {ProductVersion}
* {OpenShift} {SupportedOpenShiftVersion} or {NextSupportedOpenShiftVersion}
* Infrastructure platform

Expand Down