You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: fix description of the PERFORMANCE_PROFILE_INPUT_FILES env var (openshift#399)
* Minor correction in Performance Addon doc
Environment variable PERFORMANCE_PROFILE_INPUT_FILES used in render mode
should be a comma separated list of PerformanceProfile manifests not a
folder.
* Solve minor layout issues in Markdown file
Copy file name to clipboardExpand all lines: docs/performanceprofile/performance_controller.md
+22-21
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The `Performance Profile Controller` optimizes OpenShift clusters for applications sensitive to cpu and network latency.
4
4
5
-

5
+

6
6
7
7
## PerformanceProfile
8
8
@@ -12,17 +12,17 @@ for applying various performance tunings to cluster nodes.
12
12
The performance profile API is documented in detail in the [Performance Profile](performance_profile.md) doc.
13
13
Follow the [API versions](api-versions.md) doc to check the supported API versions.
14
14
15
-
# Building and pushing the operator images
15
+
##Building and pushing the operator images
16
16
17
17
TBD
18
18
19
-
# Deploying
19
+
##Deploying
20
20
21
21
If you use your own images, make sure they are made public in your quay.io account!
22
22
23
23
Deploy a perfomance profile configuration by running:
24
24
25
-
```
25
+
```shell
26
26
CLUSTER=manual make cluster-deploy-pao
27
27
```
28
28
@@ -37,72 +37,74 @@ The deployment will be retried in a loop until everything is deployed successful
37
37
In CI the `test/e2e/performanceprofile/cluster-setup/ci-cluster/performance/` dir will be used. The difference is that the CI cluster will deploy
38
38
the PerformanceProfile in the test code, while the `manual` cluster includes it in the kustomize based deployment.
39
39
40
-
41
40
Now you need to label the nodes which should be tuned. This can be done with
42
41
43
-
```
42
+
```shell
44
43
make cluster-label-worker-cnf
45
44
```
46
45
47
46
This will label 1 worker node with the `worker-cnf` role, and OCP's `Machine Config Operator` will start tuning this node.
48
47
49
-
In order to wait until MCO is ready, you can watch the `MachineConfigPool` until it is marked as updated with
48
+
In order to wait until MCO is ready, you can watch the `MachineConfigPool` until it is marked as updated with
50
49
51
-
```
50
+
```shell
52
51
CLUSTER=manual make cluster-wait-for-pao-mcp
53
52
```
54
53
55
54
> Note: Be aware this can take quite a while (many minutes)
56
55
57
56
> Note: in CI this step is skipped, because the test code will wait for the MCP being up to date.
58
57
59
-
# Render mode
58
+
##Render mode
60
59
61
60
The operator can render manifests for all the components it supposes to create, based on Given a `PerformanceProfile`
62
61
63
62
You need to provide the following environment variables
When the deployment fails, or the performance tuning does not work as expected, follow the [Troubleshooting Guide](troubleshooting.md)
82
84
for debugging the cluster. Please provide as much info from troubleshooting as possible when reporting issues. Thanks!
83
85
84
-
# Testing
86
+
##Testing
85
87
86
-
## Unit tests
88
+
###Unit tests
87
89
88
90
Unit tests can be executed with `make test-unit`.
89
91
90
-
## Func tests
92
+
###Func tests
91
93
92
94
The functional tests are located in `/functests`. They can be executed with `make pao-functests-only` on a cluster with a
93
95
deployed Performance Profile Controller and configured MCP and nodes. It will create its own Performance profile!
94
96
95
-
### Latency test
97
+
####Latency test
96
98
97
-
The latency-test container image gives the possibility to run the latency
99
+
The latency-test container image gives the possibility to run the latency
98
100
test without need to install go, ginkgo or other go related modules.
99
101
100
102
The test itself is running the `oslat``cyclictest` and `hwlatdetect` binaries and verifies if the maximal latency returned by each one of the tools is
101
103
less than specified value under the `MAXIMUM_LATENCY`.
102
104
103
105
To run the latency test inside the container:
104
106
105
-
```
107
+
```shell
106
108
docker run --rm -v /kubeconfig:/kubeconfig \
107
109
-e KUBECONFIG=/kubeconfig \
108
110
-e LATENCY_TEST_RUN=true \
@@ -124,4 +126,3 @@ You can run the container with different ENV variables, but the bare minimum is
124
126
-`CYCLICTEST_MAXIMUM_LATENCY` the expected maximum latency for the cyclictest test.
125
127
-`HWLATDETECT_MAXIMUM_LATENCY` the expected maximum latency for the hwlatdetect test.
126
128
-`MAXIMUM_LATENCY` a unified value for the expected maximum latency for all tests (In case both provided, the specific variables will have precedence over the unified one).
0 commit comments