Skip to content

Commit

Permalink
[ci skip] publishing updated documentation...
Browse files Browse the repository at this point in the history
  • Loading branch information
@infrawatch-bot
infrawatch-bot committed Jan 31, 2024
1 parent 7f3fd8b commit a72eac8
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 174 deletions.
112 changes: 54 additions & 58 deletions index-upstream-162.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ <h1>Service Telemetry Framework 1.5</h1>
<li><a href="#dashboards_assembly-advanced-features">Dashboards in Service&#160;Telemetry&#160;Framework</a>
<ul class="sectlevel3">
<li><a href="#setting-up-grafana-to-host-the-dashboard_assembly-advanced-features">Configuring Grafana to host the dashboard</a></li>
<li><a href="#importing-dashboards_assembly-advanced-features">Importing dashboards</a></li>
<li><a href="#importing-dashboards_assembly-advanced-features">Enabling dashboards</a></li>
<li><a href="#connecting-an-external-dashboard-system_assembly-advanced-features">Connecting an external dashboard system</a></li>
</ul>
</li>
Expand Down Expand Up @@ -1884,7 +1884,7 @@ <h3 id="configuring-observability-strategy_assembly-installing-the-core-componen
<p>Delete the remaining objects that are managed by community operators</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ for o in alertmanager/default prometheus/default elasticsearch/elasticsearch grafana/default; do oc delete $o; done</code></pre>
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ for o in alertmanagers.monitoring.rhobs/default prometheuses.monitoring.rhobs/default elasticsearch/elasticsearch grafana/default-grafana; do oc delete $o; done</code></pre>
</div>
</div>
</li>
Expand Down Expand Up @@ -2284,7 +2284,7 @@ <h4 id="deploying-the-overcloud_assembly-completing-the-stf-configuration">Deplo
<p>Add your data collection and Apache&#160;Qpid&#160;Dispatch&#160;Router environment files to the stack with your other environment files and deploy the overcloud:</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">(undercloud)$ openstack overcloud deploy --templates \
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">(undercloud)$ openstack overcloud deploy --templates \
-e [your environment files] \
-e /usr/share/openstack-tripleo-heat-templates/environments/metrics/ceilometer-write-qdr.yaml \
-e /usr/share/openstack-tripleo-heat-templates/environments/metrics/qdr-edge-only.yaml \
Expand Down Expand Up @@ -3304,87 +3304,83 @@ <h4 id="setting-up-grafana-to-host-the-dashboard_assembly-advanced-features">Con
</div>
</div>
<div class="sect3">
<h4 id="importing-dashboards_assembly-advanced-features">Importing dashboards</h4>
<h4 id="importing-dashboards_assembly-advanced-features">Enabling dashboards</h4>
<div class="paragraph _abstract">
<p>The Grafana Operator can import and manage dashboards by creating <code>GrafanaDashboard</code> objects. You can view example dashboards at <a href="https://github.com/infrawatch/dashboards" class="bare">https://github.com/infrawatch/dashboards</a>.</p>
</div>
<div class="olist arabic">
<div class="title">Procedure</div>
<ol class="arabic">
<li>
<p>Import the infrastructure dashboard:</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/rhos-dashboard.yaml

grafanadashboard.integreatly.org/rhos-dashboard-1 created</code></pre>
<p>The Grafana Operator can import and manage dashboards by creating <code>GrafanaDashboard</code> objects. Service Telemetry Operator can enable a set of default dashboards that create the <code>GrafanaDashboard</code> objects that load dashboards into the Grafana instance.</p>
</div>
<div class="paragraph">
<p>Set the value of <code>graphing.grafana.dashboards.enabled</code> to <code>true</code> to load the following dashboards into Grafana :</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Infrastructure dashboard</p>
</li>
<li>
<p>Import the cloud dashboard:</p>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
In the <code>enable-stf.yaml</code> file, ensure you set the value of the collectd <code>virt</code> plugin parameter <code>hostname_format</code> to <code>name uuid hostname</code>, otherwise some of the panels on the cloud dashboard display no information.
For more information about the <code>virt</code> plugin, see <a href="{defaultURL}/operational_measurements/collectd-plugins_assembly">collectd plugins</a>.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/rhos-cloud-dashboard.yaml

grafanadashboard.integreatly.org/rhos-cloud-dashboard-1 created</code></pre>
</div>
</div>
<p>Cloud view dashboard</p>
</li>
<li>
<p>Import the virtual machine dashboard:</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/virtual-machine-view.yaml

grafanadashboard.integreatly.org/virtual-machine-view-1 configured</code></pre>
<p>Virtual machine view dashboard</p>
</li>
<li>
<p>Memcached view dashboard</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>You can use the <code>GrafanaDashboard</code> object to create and load additional dashboards into Grafana. For more information about managing dashboards with Grafana Operator, see <a href="https://grafana.github.io/grafana-operator/docs/dashboards/">Dashboards</a> in the <em>Grafana Operator project documentation</em>.</p>
</div>
<div class="ulist">
<div class="title">Prerequisites</div>
<ul>
<li>
<p>You enabled graphing in the <code>ServiceTelemetry</code> object. For more information about graphing, see <a href="#setting-up-grafana-to-host-the-dashboard_assembly-advanced-features">Configuring Grafana to host the dashboard</a>.</p>
</li>
</ul>
</div>
<div class="olist arabic">
<div class="title">Procedure</div>
<ol class="arabic">
<li>
<p>Import the memcached dashboard:</p>
<p>To enable the managed dashboards, create or modify the <code>ServiceTelemetry</code> object. Set <code>graphing.grafana.dashboards.enabled</code> to <code>true</code>:</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/memcached-dashboard.yaml
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ oc edit stf default

grafanadashboard.integreatly.org/memcached-dashboard-1 created</code></pre>
apiVersion: infra.watch/v1beta1
kind: ServiceTelemetry
...
spec:
...
graphing:
enabled: true
grafana:
dashboards:
enabled: true</code></pre>
</div>
</div>
</li>
<li>
<p>Verify that the dashboards are available:</p>
<p>Verify that the Grafana dashboards are created. The process of Service Telemetry Operator creating the dashboards might take some time.</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ oc get grafanadashboards
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">$ oc get grafanadashboards.grafana.integreatly.org

NAME AGE
memcached-dashboard-1 7s
rhos-cloud-dashboard-1 23s
rhos-dashboard-1 29s
virtual-machine-view-1 13s</code></pre>
NAME NO MATCHING INSTANCES LAST RESYNC AGE
memcached-dashboard-1 38s 38s
rhos-cloud-dashboard-1 39s 39s
rhos-dashboard-1 39s 39s
virtual-machine-dashboard-1 37s 37s</code></pre>
</div>
</div>
</li>
<li>
<p>Retrieve the Grafana route address:</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">$ oc get route grafana-route -ojsonpath='{.spec.host}'
<pre class="highlightjs highlight nowrap"><code class="language-bash hljs" data-lang="bash">$ oc get route default-grafana-route -ojsonpath='{.spec.host}'

grafana-route-service-telemetry.apps.infra.watch</code></pre>
default-grafana-route-service-telemetry.apps.infra.watch</code></pre>
</div>
</div>
</li>
Expand All @@ -3395,7 +3391,7 @@ <h4 id="importing-dashboards_assembly-advanced-features">Importing dashboards</h
<p>Log in with OpenShift credentials. For more information about logging in, see <a href="#accessing-uis-for-stf-components_assembly-installing-the-core-components-of-stf">Accessing user interfaces for STF components</a>.</p>
</li>
<li>
<p>To view the dashboard, click <strong>Dashboards</strong> and <strong>Manage</strong>.</p>
<p>To view the dashboard, click <strong>Dashboards</strong> and <strong>Browse</strong>. The managed dashboards are available in the <em>service-telemetry</em> folder.</p>
</li>
</ol>
</div>
Expand Down Expand Up @@ -4516,7 +4512,7 @@ <h4 id="configuring-observability-strategy_assembly-advanced-features">Configuri
<p>Delete the remaining objects that are managed by community operators</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ for o in alertmanager/default prometheus/default elasticsearch/elasticsearch grafana/default; do oc delete $o; done</code></pre>
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ for o in alertmanagers.monitoring.rhobs/default prometheuses.monitoring.rhobs/default elasticsearch/elasticsearch grafana/default-grafana; do oc delete $o; done</code></pre>
</div>
</div>
</li>
Expand Down Expand Up @@ -4940,7 +4936,7 @@ <h3 id="removing-the-observability-operator_assembly-removing-stf-from-the-opens
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-30 18:34:11 UTC
Last updated 2024-01-31 17:43:04 UTC
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
Expand Down
Loading

0 comments on commit a72eac8

Please sign in to comment.