Skip to content

Commit 1b4abbf

Browse files
csibbittcsibbitt
authored
Merge pull request #140 from infrawatch/csibbitt-walkthrough-patch-1
Touchups from a top-to-bottom walkthrough and live test
2 parents d3d7f94 + 5774f8d commit 1b4abbf

5 files changed

Lines changed: 21 additions & 21 deletions

‎doc-Service-Telemetry-Framework/assemblies/assembly_introduction-to-stf.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
// The following block is rendered only if the `internal` variable is set.
3737
// The table shows various metadata useful when editing this file.
3838

39-
{Project} ({ProjectShort}) provides automated collection of measurements and data from remote clients - Red Hat OpenStack Platform or third-party nodes - and transmission of that information to a centralized, receiving {OpenShift} ({OpenShiftShort}) deployment for storage, retrieval, and monitoring. The data can be either of two types:
39+
{Project} ({ProjectShort}) receives monitoring data from {OpenStack} or third-party nodes for storage, dashboarding, and alerting. The monitoring data can be either of two types:
4040

4141
Metric:: a numeric measurement of an application or system
4242
Event:: irregular and discrete occurrences that happen in a system

‎doc-Service-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Each of these top-level configuration parameters provides various controls for a
4343

4444
Use the `backends` parameter to control which storage backends are available for storage of metrics and events, and to control the enablement of Smart Gateways, as defined by the `clouds` parameter. For more information, see xref:clouds_installing-the-core-components-of-stf[].
4545

46-
The available storage backends include `metrics` and `events`. The metrics backends include Prometheus and the events backends include ElasticSearch.
46+
Currently, you can use Prometheus as the metrics backend, and ElasticSearch as the events backend.
4747

4848

4949
==== Enabling Prometheus as a storage backend for metrics
@@ -74,7 +74,7 @@ To enable events support in {ProjectShort}, you must enable the Elastic Cloud fo
7474
[id="clouds_{context}"]
7575
=== clouds
7676

77-
Use the `clouds` parameter to control which Smart Gateway objects are deployed, thereby providing the interface for multiple monitoring cloud environments to connect to an instance of {ProjectShort}. If a supporting backend is available, then metrics and events Smart Gateways for the default cloud configuration are created. By default, the Service Telemetry Operator creates Smart Gateways for `cloud1`.
77+
Use the `clouds` parameter to control which Smart Gateway objects are deployed, thereby providing the interface for multiple monitored cloud environments to connect to an instance of {ProjectShort}. If a supporting backend is available, then metrics and events Smart Gateways for the default cloud configuration are created. By default, the Service Telemetry Operator creates Smart Gateways for `cloud1`.
7878

7979
You can create a list of cloud objects to control which Smart Gateways are created for each cloud defined. Each cloud is made up of data types and collectors. Data types are `metrics` or `events`. Each data type is made up of a list of collectors and the message bus subscription address. Available collectors are `collectd` and `ceilometer`. Ensure that the subscription address for each of these collectors is unique for every cloud, data type, and collector combination.
8080

@@ -120,4 +120,4 @@ Use The `highAvailability` parameter to control the instantiation of multiple co
120120

121121
=== transports
122122

123-
Use the `transports` parameter to control the enablement of the message bus for a {ProjectShort} deployment. The only transport currently supported is {MessageBus}. Ensure that it is enabled for proper operation of {ProjectShort}. By default, transports is enabled.
123+
Use the `transports` parameter to control the enablement of the message bus for a {ProjectShort} deployment. The only transport currently supported is {MessageBus}. Ensure that it is enabled for proper operation of {ProjectShort}. By default, the qdr transport is enabled.

‎doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To configure the {OpenStack} overcloud, complete the following tasks:
3434
ifdef::include_when_16_1[]
3535
.Additional resources
3636

37-
* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.1/html-single/monitoring_tools_configuration_guide/index#collecting-data-through-amq-interconnect[Collecting data through AMQ Interconnect] in the _Monitoring Tools Configuration_ guide.
37+
* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.1/html-single/monitoring_tools_configuration_guide/index#amqp1[The amqp1 plug-in] in the _Monitoring Tools Configuration_ guide.
3838

3939
endif::include_when_16_1[]
4040

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ elastic-cloud-eck.v1.2.1 Elastic Cloud on Kubernetes 1.2.1
307307
[id="subscribing-to-the-service-telemetry-operator"]
308308
== Subscribing to the Service Telemetry Operator
309309

310-
To instantiate an {ProjectShort} instance, create the `ServiceTelemetry` object to allow the Service Telemetry Operator to create the environment.
310+
You must subscribe to the Service Telemetry Operator which will manage the {ProjectShort} instances.
311311

312312
.Procedure
313313

‎doc-Service-Telemetry-Framework/modules/proc_validating-clientside-installation.adoc‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ Connections
7171
There are four connections:
7272
+
7373
* Outbound connection to {ProjectShort}
74-
* Inbound connection from collectd
7574
* Inbound connection from ceilometer
75+
* Inbound connection from collectd
7676
* Inbound connection from our `qdstat` client
7777
+
7878
The outbound {ProjectShort} connection is provided to the `MetricsQdrConnectors` host parameter and is the route for the {ProjectShort} storage domain. The other hosts are internal network addresses of the client connections to this {MessageBus}.
@@ -83,19 +83,19 @@ The outbound {ProjectShort} connection is provided to the `MetricsQdrConnectors`
8383
----
8484
$ sudo {containerbin} exec -it metrics_qdr qdstat --bus=172.17.1.44:5666 --links
8585
Router Links
86-
type dir conn id id peer class addr phs cap pri undel unsett deliv presett psdrop acc rej rel mod delay rate
86+
type dir conn id id peer class addr phs cap pri undel unsett deliv presett psdrop acc rej rel mod delay rate
8787
===========================================================================================================================================================
88-
endpoint out 1 5 local _edge 250 0 0 0 2979926 2979924 0 0 0 2 0 0 0
89-
endpoint in 1 6 250 0 0 0 0 0 0 0 0 0 0 0 0
90-
endpoint in 1 7 250 0 0 0 0 0 0 0 0 0 0 0 0
91-
endpoint out 1 8 250 0 0 0 0 0 0 0 0 0 0 0 0
92-
endpoint in 1 9 250 0 0 0 0 0 0 0 0 0 0 0 0
93-
endpoint out 1 10 250 0 0 0 911 911 0 0 0 0 0 911 0
94-
endpoint in 1 11 250 0 0 0 0 911 0 0 0 0 0 0 0
95-
endpoint out 12 32 local temp.lSY6Mcicol4J2Kp 250 0 0 0 0 0 0 0 0 0 0 0 0
96-
endpoint in 16 41 250 0 0 0 2979924 2979924 0 0 0 0 0 0 0
97-
endpoint in 912 1834 mobile $management 0 250 0 0 0 1 0 0 1 0 0 0 0 0
98-
endpoint out 912 1835 local temp.9Ok2resI9tmt+CT 250 0 0 0 0 0 0 0 0 0 0 0 0
88+
endpoint out 1 5 local _edge 250 0 0 0 2979926 0 0 0 0 2979926 0 0 0
89+
endpoint in 1 6 250 0 0 0 0 0 0 0 0 0 0 0 0
90+
endpoint in 1 7 250 0 0 0 0 0 0 0 0 0 0 0 0
91+
endpoint out 1 8 250 0 0 0 0 0 0 0 0 0 0 0 0
92+
endpoint in 1 9 250 0 0 0 0 0 0 0 0 0 0 0 0
93+
endpoint out 1 10 250 0 0 0 911 911 0 0 0 0 0 911 0
94+
endpoint in 1 11 250 0 0 0 0 911 0 0 0 0 0 0 0
95+
endpoint out 12 32 local temp.lSY6Mcicol4J2Kp 250 0 0 0 0 0 0 0 0 0 0 0 0
96+
endpoint in 16 41 250 0 0 0 2979924 0 0 0 0 2979924 0 0 0
97+
endpoint in 912 1834 mobile $management 0 250 0 0 0 1 0 0 1 0 0 0 0 0
98+
endpoint out 912 1835 local temp.9Ok2resI9tmt+CT 250 0 0 0 0 0 0 0 0 0 0 0 0
9999
----
100100

101101
. To list the addresses from {OpenStack} nodes to {ProjectShort}, connect to {OpenShiftShort} to get the {MessageBus} pod name and list the connections. List the available {MessageBus} pods:
@@ -112,7 +112,7 @@ default-interconnect-7458fd4d69-bgzfb 1/1 Running 0 6d21h
112112
+
113113
[source,bash,options="nowrap"]
114114
----
115-
$ oc exec -it deploy/default-interconnect -- qdstat --connections
115+
$ oc exec -it default-interconnect-7458fd4d69-bgzfb -- qdstat --connections
116116
117117
2020-04-21 18:25:47.243852 UTC
118118
default-interconnect-7458fd4d69-bgzfb
@@ -136,7 +136,7 @@ In this example, there are three `edge` connections from the {OpenStack} nodes w
136136
+
137137
[source,bash,options="nowrap"]
138138
----
139-
$ oc exec -it deploy/default-interconnect -- qdstat --address
139+
$ oc exec -it default-interconnect-7458fd4d69-bgzfb -- qdstat --address
140140
141141
2020-04-21 18:20:10.293258 UTC
142142
default-interconnect-7458fd4d69-bgzfb

0 commit comments

Comments
 (0)