1
1
---
2
- title : Rosa Burner Docs
2
+ title : HCP Burner Docs
3
3
---
4
4
5
- ## What is rosa-burner
5
+ ## What is HCP-Burner
6
6
7
- Rosa -burner is a wrapper to automate create-use-destroy of OCP clusters in the different managed platforms.
7
+ hcp -burner is a wrapper to automate create-use-destroy of OCP clusters in the different managed platforms.
8
8
9
- ## How rosa-burner works
9
+ ## How HCP-Burner works
10
10
11
11
Following helpers are available for every platform:
12
12
@@ -41,11 +41,11 @@ Following platforms are available at this moment:
41
41
42
42
Almost all the parameters can be defined in three ways:
43
43
- Wrapper parameters:
44
- ` rosa -burner.py --cluster-count 100`
44
+ ` hcp -burner.py --cluster-count 100`
45
45
- Environment Variable:
46
- ` ROSA_BURNER_CLUSTER_COUNT =100 rosa -burner.py`
46
+ ` HCP_BURNER_CLUSTER_COUNT =100 hcp -burner.py`
47
47
- Configuration File:
48
- ` rosa -burner.py --config-file ./rosa -burner.conf `
48
+ ` hcp -burner.py --config-file ./hcp -burner.ini `
49
49
50
50
** Only parameters --platform and --subplatform must be defined as wrapper arguments, platform is always required but subplatform is optional**
51
51
@@ -57,7 +57,7 @@ To add any other parameter to the config file, remove `--` from the argument and
57
57
cluster_name_seed = test
58
58
```
59
59
60
- Full version of a config file can be found on ** rosa -burner.conf ** file
60
+ Full version of a config file can be found on ** hcp -burner.ini ** file
61
61
62
62
## Preference
63
63
@@ -71,42 +71,42 @@ To use the config file, define common parameters under the `[Defaults]` section
71
71
72
72
| Argument | Default Value | Config file variable | Environment Variable |
73
73
| --------------------------| -------------------| ----------------------| --------------------------------|
74
- | --config-file | | | ROSA_BURNER_CONFIG_FILE |
74
+ | --config-file | | | HCP_BURNER_CONFIG_FILE |
75
75
| --install-clusters | | | |
76
- | --platform | | platform | ROSA_BURNER_PLATFORM |
77
- | --subplatform | | subplatform | ROSA_BURNER_SUBPLATFORM |
78
- | --uuid | | | ROSA_BURNER_UUID |
79
- | --path | | | ROSA_BURNER_PATH |
80
- | --cluster-name-seed | | | ROSA_BURNER_CLUSTER_NAME_SEED |
81
- | --static-cluster-name | | | ROSA_BURNER_STATIC_CLUSTER_NAME |
82
- | --workers | 3 | | ROSA_BURNER_WORKERS |
83
- | --workers-wait-time | 60 | | ROSA_BURNER_WORKERS_WAIT_TIME |
76
+ | --platform | | platform | HCP_BURNER_PLATFORM |
77
+ | --subplatform | | subplatform | HCP_BURNER_SUBPLATFORM |
78
+ | --uuid | | | HCP_BURNER_UUID |
79
+ | --path | | | HCP_BURNER_PATH |
80
+ | --cluster-name-seed | | | HCP_BURNER_CLUSTER_NAME_SEED |
81
+ | --static-cluster-name | | | HCP_BURNER_STATIC_CLUSTER_NAME |
82
+ | --workers | 3 | | HCP_BURNER_WORKERS |
83
+ | --workers-wait-time | 60 | | HCP_BURNER_WORKERS_WAIT_TIME |
84
84
| --wait-for-workers | | | |
85
- | --cluster-count | 1 | | ROSA_BURNER_CLUSTER_COUNT |
86
- | --delay-between-batch | 60 | | ROSA_BURNER_DELAY_BETWEEN_BATCH |
87
- | --batch-size | 0 | | ROSA_BURNER_BATCH_SIZE |
88
- | --watcher-delay | 60 | | ROSA_BURNER_WATCHER_DELAY |
89
- | --wildcard-options | | | ROSA_BURNER_WILDCARD_OPTIONS |
85
+ | --cluster-count | 1 | | HCP_BURNER_CLUSTER_COUNT |
86
+ | --delay-between-batch | 60 | | HCP_BURNER_DELAY_BETWEEN_BATCH |
87
+ | --batch-size | 0 | | HCP_BURNER_BATCH_SIZE |
88
+ | --watcher-delay | 60 | | HCP_BURNER_WATCHER_DELAY |
89
+ | --wildcard-options | | | HCP_BURNER_WILDCARD_OPTIONS |
90
90
| --enable-workload | | | |
91
- | --workload-repo | https://github.com/cloud-bulldozer/e2e-benchmarking.git | workload_repo | ROSA_BURNER_WORKLOAD_REPO |
92
- | --workload | cluster-density-ms | workload | ROSA_BURNER_WORKLOAD |
93
- | --workload-script-path | workloads/kube-burner-ocp-wrapper | workload_script_path | ROSA_BURNER_WORKLOAD_SCRIPT_PATH |
94
- | --workload-executor | /usr/bin/kube-burner | workload_executor | ROSA_BURNER_WORKLOAD_EXECUTOR |
95
- | --workload-duration | 1h | | ROSA_BURNER_WORKLOAD_DURATION |
96
- | --workload-jobs | 10 | | ROSA_BURNER_WORKLOAD_JOBS |
91
+ | --workload-repo | https://github.com/cloud-bulldozer/e2e-benchmarking.git | workload_repo | HCP_BURNER_WORKLOAD_REPO |
92
+ | --workload | cluster-density-ms | workload | HCP_BURNER_WORKLOAD |
93
+ | --workload-script-path | workloads/kube-burner-ocp-wrapper | workload_script_path | HCP_BURNER_WORKLOAD_SCRIPT_PATH |
94
+ | --workload-executor | /usr/bin/kube-burner | workload_executor | HCP_BURNER_WORKLOAD_EXECUTOR |
95
+ | --workload-duration | 1h | | HCP_BURNER_WORKLOAD_DURATION |
96
+ | --workload-jobs | 10 | | HCP_BURNER_WORKLOAD_JOBS |
97
97
| --cleanup-clusters | | | |
98
- | --wait-before-cleanup | 0 | | ROSA_BURNER_WAIT_BEFORE_CLEANUP |
99
- | --delay-between-cleanup | 0 | | ROSA_BURNER_DELAY_BETWEEN_CLEANUP |
98
+ | --wait-before-cleanup | 0 | | HCP_BURNER_WAIT_BEFORE_CLEANUP |
99
+ | --delay-between-cleanup | 0 | | HCP_BURNER_DELAY_BETWEEN_CLEANUP |
100
100
101
101
## ElasticSearch arguments
102
102
103
103
To use the config file, define common parameters under the ` [Elasticsearch] ` section
104
104
105
105
| Argument | Default Value | Config file variable | Environment Variable |
106
106
| --------------------------| -------------------| ----------------------| --------------------------------|
107
- | --es-url | | | ROSA_BURNER_ES_URL |
108
- | --es-index | rosa -burner | | ROSA_BURNER_ES_INDEX |
109
- | --es-index-retry | 5 | | ROSA_BURNER_ES_INDEX_RETRY |
107
+ | --es-url | | | HCP_BURNER_ES_URL |
108
+ | --es-index | hcp -burner | | HCP_BURNER_ES_INDEX |
109
+ | --es-index-retry | 5 | | HCP_BURNER_ES_INDEX_RETRY |
110
110
| --es-insecure | | | |
111
111
112
112
## Logging arguments
@@ -115,5 +115,5 @@ To use the config file, define common parameters under the `[Logging]` section
115
115
116
116
| Argument | Default Value | Config file variable | Environment Variable |
117
117
| --------------------------| -------------------| ----------------------| --------------------------------|
118
- | --log-level | INFO | | ROSA_BURNER_LOG_LEVEL |
119
- | --log-file | | | ROSA_BURNER_LOG_FILE |
118
+ | --log-level | INFO | | HCP_BURNER_LOG_LEVEL |
119
+ | --log-file | | | HCP_BURNER_LOG_FILE |
0 commit comments