Skip to content

Commit 84c48eb

Browse files
JoanneOFlynn2018JoanneOFlynn2018
committed
SAF files and common folder containing attributes
1 parent b93900f commit 84c48eb

File tree

467 files changed

+52193
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

467 files changed

+52193
-0
lines changed

‎LICENSE

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Copyright © 2019 Red Hat, Inc.
2+
3+
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
4+
5+
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
6+
7+
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
8+
9+
All other trademarks are the property of their respective owners.

‎Makefile

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
all: html
2+
3+
html: all-html
4+
5+
pdf: all-pdf
6+
7+
clean: all-clean
8+
9+
all-html:
10+
cd doc-Provisioning_Guide && $(MAKE) html
11+
12+
all-pdf:
13+
cd doc-Provisioning_Guide && $(MAKE) pdf
14+
15+
all-clean:
16+
cd doc-Provisioning_Guide && $(MAKE) clean

‎common/Makefile

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
BUILD = foreman
2+
BUILD_DIR = ../build
3+
ROOTDIR = $(realpath .)
4+
NAME = $(notdir $(ROOTDIR))
5+
DEST_DIR = $(BUILD_DIR)/$(NAME)
6+
DEST_HTML = $(DEST_DIR)/index-$(BUILD).html
7+
DEST_PDF = $(BUILD_DIR)/$(NAME)-$(BUILD).pdf
8+
IMAGES_DIR = $(DEST_DIR)/images
9+
IMAGES_TS = $(DEST_DIR)/.timestamp-images
10+
SOURCES = master.adoc $(shell ls topics/*.adoc)
11+
IMAGES = $(shell find ./images -type f)
12+
UNAME = $(shell uname)
13+
14+
ifeq ($(UNAME), Linux)
15+
BROWSER_OPEN = xdg-open
16+
endif
17+
ifeq ($(UNAME), Darwin)
18+
BROWSER_OPEN = open
19+
endif
20+
21+
all: html
22+
23+
html: prepare $(IMAGES_TS) $(DEST_HTML)
24+
25+
pdf: prepare $(DEST_PDF)
26+
27+
prepare:
28+
@mkdir -p $(BUILD_DIR)
29+
@mkdir -p $(DEST_DIR) $(IMAGES_DIR)
30+
31+
clean:
32+
@rm -rf "$(DEST_DIR)" "$(DEST_PDF)"
33+
34+
browser: html
35+
${BROWSER_OPEN} "file://$(realpath $(ROOTDIR)/$(DEST_HTML))"
36+
37+
open-pdf: pdf
38+
${BROWSER_OPEN} "$(realpath $(ROOTDIR)/$(DEST_PDF))"
39+
40+
$(IMAGES_TS): $(IMAGES)
41+
cp $? $(IMAGES_DIR)
42+
touch $(IMAGES_TS)
43+
44+
$(DEST_HTML): $(SOURCES)
45+
asciidoctor -a build=$(BUILD) -b xhtml5 -d book -o $@ $<
46+
47+
$(DEST_PDF): $(SOURCES) $(IMAGES)
48+
asciidoctor-pdf -a build=$(BUILD) -d book -o $@ $<

‎common/attributes.adoc

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
:TargetVersion: 6.4
2+
:ProductVersion: 6.4
3+
:ProductVersionPrevious: 6.3
4+
:RepoRHEL7ServerSatelliteServerProductVersion: rhel-7-server-satellite-6.4-rpms
5+
:RepoRHEL7ServerSatelliteServerProductVersionPrevious: rhel-7-server-satellite-6.3-rpms
6+
:RepoRHEL7ServerSatelliteServerPuppetVersion: rhel-7-server-satellite-6.3-puppet4-rpms
7+
:RepoRHEL7ServerSatelliteCapsuleProductVersion: rhel-7-server-satellite-capsule-6.4-rpms
8+
:RepoRHEL7ServerSatelliteCapsulePuppetVersion: rhel-7-server-satellite-capsule-6.3-puppet4-rpms
9+
:RepoRHEL7ServerSatelliteToolsProductVersion: rhel-7-server-satellite-tools-6.4-rpms
10+
:RepoRHEL7Server: rhel-7-server-rpms
11+
:RepoRHEL7ServerSoftwareCollections: rhel-server-rhscl-7-rpms
12+
:RepoRHEL7ServerOptional: rhel-7-server-optional-rpms
13+
:RepoRHEL7ServerSatelliteMaintenanceProductVersion: rhel-7-server-satellite-maintenance-6-rpms
14+
:RepoRHEL7ServerAnsible: rhel-7-server-ansible-2.6-rpms
15+
:context: assembly
16+
17+
ifeval::["{build}" == "upstream"]
18+
:OpenShift: OpenShift
19+
:OpenShiftShort: OpenShift
20+
:OVirt: oVirt
21+
:OVirtShort: oVirt
22+
:OVirtLegacy: oVirt
23+
:OVirtLegacyShort: oVirt
24+
:ovirt-example-com: ovirt.example.com
25+
:OpenStack: OpenStack
26+
:Project: Service Assurance Framework
27+
:ProjectShort: SAF
28+
:MessageBus: QDR
29+
endif::[]
30+
31+
ifeval::["{build}" == "downstream"]
32+
:OpenShift: Red Hat OpenShift Container Platform
33+
:OpenShiftShort: OCP
34+
:OVirt: Red{nbsp}Hat{nbsp}Virtualization
35+
:OVirtShort: RHV
36+
:OVirtLegacy: Red{nbsp}Hat{nbsp}Enterprise{nbsp}Virtualization
37+
:OVirtLegacyShort: RHEV
38+
:ovirt-example-com: rhv.example.com
39+
:OpenStack: Red{nbsp}Hat OpenStack Platform
40+
:Project: Service Assurance Framework
41+
:ProjectShort: SAF
42+
:MessageBus: AMQP 1.0
43+
44+
endif::[]

‎common/collectd/con_data-collecting-agent.adoc

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// <List assemblies here, each on a new line>
4+
5+
// This module can be included from assemblies using the following include statement:
6+
// include::<path>/con_data-collecting-agent.adoc[leveloffset=+1]
7+
8+
// The file name and the ID are based on the module title. For example:
9+
// * file name: con_my-concept-module-a.adoc
10+
// * ID: [id='con_my-concept-module-a_{context}']
11+
// * Title: = My concept module A
12+
//
13+
// The ID is used as an anchor for linking to the module. Avoid changing
14+
// it after the module has been published to ensure existing links are not
15+
// broken.
16+
//
17+
// The `context` attribute enables module reuse. Every module's ID includes
18+
// {context}, which ensures that the module has a unique ID even if it is
19+
// reused multiple times in a guide.
20+
//
21+
// In the title, include nouns that are used in the body text. This helps
22+
// readers and search engines find information quickly.
23+
// Do not start the title with a verb. See also _Wording of headings_
24+
// in _The IBM Style Guide_.
25+
[id="data-collecting-agent_{context}"]
26+
= Data collecting agent
27+
28+
Performance monitoring collects system information periodically and provides a mechanism to store and monitor the values in a variety of ways using a data collecting agent. Red Hat supports the collectd daemon as a collection agent. This daemon stores the data in a time-series database. One of the Red Hat supported databases is called Prometheus. You can use this stored data to monitor systems, find performance bottlenecks, and predict future system load.
29+
30+
[NOTE]
31+
Red Hat OpenStack Platform supports performance monitoring only on the client side.

‎common/collectd/proc_installing-collectd.adoc

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// Module included in the following assemblies:
2+
//
3+
// doc-Service-Assurance-Framework/assemblies/assembly_configuring-saf-components.adoc
4+
5+
// This module can be included from assemblies using the following include statement:
6+
// include::<path>/proc_installing-collectd.adoc[leveloffset=+1]
7+
8+
// The file name and the ID are based on the module title. For example:
9+
// * file name: proc_doing-procedure-a.adoc
10+
// * ID: [id='proc_doing-procedure-a_{context}']
11+
// * Title: = Doing procedure A
12+
//
13+
// The ID is used as an anchor for linking to the module. Avoid changing
14+
// it after the module has been published to ensure existing links are not
15+
// broken.
16+
//
17+
// The `context` attribute enables module reuse. Every module's ID includes
18+
// {context}, which ensures that the module has a unique ID even if it is
19+
// reused multiple times in a guide.
20+
//
21+
// Start the title with a verb, such as Creating or Create. See also
22+
// _Wording of headings_ in _The IBM Style Guide_.
23+
24+
[id="installing-collectd"]
25+
= Installing collectd
26+
27+
To install collectd on the overcloud, complete the following steps:
28+
29+
. Copy the file ``/usr/share/openstack-tripleo-heat-templates/environments/collectd-environment.yaml` to your local directory. Open the file, set the following parameters, and list the plugins you want under `CollectdExtraPlugins`. You can also provide parameters in the `ExtraConfig` section:
30+
+
31+
----
32+
parameter_defaults:
33+
CollectdExtraPlugins:
34+
- disk
35+
- df
36+
- virt
37+
38+
ExtraConfig:
39+
collectd::plugin::virt::connection: "qemu:///system"
40+
collectd::plugin::virt::hostname_format: "hostname uuid"
41+
----
42+
+
43+
By default, collectd comes with the disk, interface, load, memory, processes, and tcpconns plugins. You can add additional plugins using the `CollectdExtraPlugins` parameter. You can also provide additional configuration information for the `CollectdExtraPlugins` using the `ExtraConfig` option as shown. The example above adds the virt plugin and configures the connection string and the hostname format.
44+
45+
. Include the modified YAML files in the `openstack overcloud deploy` command to install the collectd daemon on all overcloud nodes. For example:
46+
+
47+
----
48+
$ openstack overcloud deploy
49+
--templates /home/templates/environments/collectd.yaml \
50+
-e /path-to-copied/collectd-environment.yaml
51+
----
52+
+
53+
To view the collectd plugins and configurations, see
54+
<<appe-saf-collectd-plugins>>.

0 commit comments

Comments
 (0)