Skip to content

Commit a3ab580

Browse files
lmadsen/stf 1093 (#397)
* Update Makefile to build multiple version builds * Fix up CRC deployment instructions Clean up the CRC development environment deployment instructions. Enabling the cluster monitoring within the environment is required due to use of oauth-proxy, which is provided as part of the built in cluster monitoring. I also cleaned up the procedure a bit to not duplicate information and remove procedure steps from the concept portion of the documentation. This only affects the upstream documentation as this section is not rendered downstream. * Update doc-Service-Telemetry-Framework/modules/con_development-environment-resource-requirements.adoc Co-authored-by: JoanneOFlynn2018 <[email protected]> Co-authored-by: JoanneOFlynn2018 <[email protected]>
1 parent 83c17fc commit a3ab580

File tree

4 files changed

+27
-15
lines changed

4 files changed

+27
-15
lines changed

Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ clean: all-clean
1111
browser: all-browser
1212

1313
all-html:
14-
cd doc-Service-Telemetry-Framework && $(MAKE) html && $(MAKE) html13
14+
cd doc-Service-Telemetry-Framework && $(MAKE) html
1515

1616
all-html-downstream:
17-
cd doc-Service-Telemetry-Framework && $(MAKE) html BUILD=downstream && $(MAKE) html13 BUILD=downstream
17+
cd doc-Service-Telemetry-Framework && $(MAKE) html BUILD=downstream
1818

1919
all-pdf:
2020
cd doc-Service-Telemetry-Framework && $(MAKE) pdf

doc-Service-Telemetry-Framework/Makefile

+16-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ ROOTDIR = $(realpath .)
44
NAME = $(notdir $(ROOTDIR))
55
DEST_DIR = $(BUILD_DIR)/$(NAME)
66
DEST_HTML = $(DEST_DIR)/index-$(BUILD).html
7+
DEST_HTML_170 = $(DEST_DIR)/index-$(BUILD)-170.html
8+
DEST_HTML_162 = $(DEST_DIR)/index-$(BUILD)-162.html
79
DEST_HTML_13 = $(DEST_DIR)/index-$(BUILD)-13.html
810
DEST_PDF = $(BUILD_DIR)/$(NAME)-$(BUILD).pdf
911
IMAGES_DIR = $(DEST_DIR)/images
@@ -21,7 +23,13 @@ endif
2123

2224
all: html
2325

24-
html: prepare $(IMAGES_TS) $(DEST_HTML)
26+
html: html-latest html170 html162 html13
27+
28+
html-latest: prepare $(IMAGES_TS) $(DEST_HTML)
29+
30+
html170: prepare $(IMAGES_TS) $(DEST_HTML_170)
31+
32+
html162: prepare $(IMAGES_TS) $(DEST_HTML_162)
2533

2634
html13: prepare $(IMAGES_TS) $(DEST_HTML_13)
2735

@@ -45,7 +53,13 @@ $(IMAGES_TS): $(IMAGES)
4553
touch $(IMAGES_TS)
4654

4755
$(DEST_HTML): $(SOURCES)
48-
asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -b xhtml5 -d book -o $@ $<
56+
asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=17.0 -b xhtml5 -d book -o $@ $<
57+
58+
$(DEST_HTML_170): $(SOURCES)
59+
asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=17.0 -b xhtml5 -d book -o $@ $<
60+
61+
$(DEST_HTML_162): $(SOURCES)
62+
asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=16.2 -b xhtml5 -d book -o $@ $<
4963

5064
$(DEST_HTML_13): $(SOURCES)
5165
asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=13 -b xhtml5 -d book -o $@ $<

doc-Service-Telemetry-Framework/modules/con_development-environment-resource-requirements.adoc

+8-10
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ ifeval::["{build}" == "upstream"]
2727
[id="development-environment-resource-requirements_{context}"]
2828
= Development environment resource requirements
2929

30-
3130
[role="_abstract"]
3231
You can create an all-in-one development environment for {ProjectShort} locally by using https://code-ready.github.io/crc/[CodeReady Containers]. The installation process of CodeReady Containers (CRC) is available at https://code-ready.github.io/crc/#installation_gsg.
3332

@@ -37,25 +36,24 @@ The https://code-ready.github.io/crc/#minimum-system-requirements-hardware_gsg[m
3736
* 64 GB of memory
3837
* 80 GB of storage space
3938
40-
After you complete the installation of CRC, use the `crc start` command to start your environment. The recommended minimum system resources for running {ProjectShort} in CodeReady Containers is 48 GB of memory and 8 virtual CPU cores:
39+
.Procedure
4140

42-
[source,bash]
41+
. After you complete the installation of CRC, you must enable cluster monitoring in the CRC environment:
42+
+
43+
[source,bash,options="nowrap"]
4344
----
44-
crc start --memory=49152 --cpus=8
45+
$ crc config set enable-cluster-monitoring true
46+
Successfully configured enable-cluster-monitoring to true
4547
----
4648

47-
If you have an existing environment, delete it, and recreate it to ensure that the resource requests have an effect.
48-
49-
.Procedure
50-
51-
. Enter the `crc delete` command.
49+
. If you have an existing environment, delete it, and recreate it to ensure that the resource requests have an effect. Enter the `crc delete` command:
5250
+
5351
[source,bash]
5452
----
5553
crc delete
5654
----
5755

58-
. Run the `crc start` command to create your environment:
56+
. Use the `crc start` command to start your environment. The recommended minimum system resources for running {ProjectShort} in CRC is 48 GB of memory and 8 virtual CPU cores:
5957
+
6058
[source,bash]
6159
----

doc-Service-Telemetry-Framework/modules/proc_deploying-to-non-standard-network-topologies.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ If your nodes are on a separate network from the default `InternalApi` network,
66

77

88
// TODO: remove this after OSP13 z13 since it will no longer be necessary.
9-
If you use {ProjectShort} with {OpenStack} ({OpenStackShort}) {OpenStackVersion} and plan to monitor your Ceph, Block, or Object Storage nodes, you must make configuration changes that are similar to the configuration changes that you make to the spine-leaf and DCN network configuration. To monitor Ceph nodes, use the `CephStorageExtraConfig` parameter to define which network interface to load into the {MessageBus} and collectd configuration files.
9+
If you use {ProjectShort} with {OpenStack} ({OpenStackShort}) {OpenStackVersion} and plan to monitor your Ceph, Block, or Object Storage nodes, you must make configuration changes that are similar to the configuration changes that you make to the spine-leaf and DCN network configuration. To monitor Ceph nodes, use the `CephStorageExtraConfig` parameter to define which network interface to load into the {MessageBus} and collectd configuration files.
1010

1111
[source,yaml,options="nowrap",role="white-space-pre"]
1212
----

0 commit comments

Comments
 (0)