Skip to content

Commit 40d4eb8

Browse files
author
Russell Zaleski
authored
Merge pull request #24 from morenod/rename_project
Update all references from rosa-burner to hcp-burner
2 parents 1813adb + 84427aa commit 40d4eb8

File tree

17 files changed

+103
-103
lines changed

17 files changed

+103
-103
lines changed

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ jobs:
5252
HCP_BURNER_AWS_ACCOUNT_FILE: "/tmp/aws_config.ini"
5353
HCP_BURNER_HYPERSHIFT_SERVICE_CLUSTER: ${{ secrets.HCP_BURNER_HYPERSHIFT_SERVICE_CLUSTER}}
5454
HCP_BURNER_ES_URL: ${{ secrets.HCP_BURNER_ES_URL}}
55-
HCP_BURNER_ES_INDEX: "rosa-burner"
55+
HCP_BURNER_ES_INDEX: "hcp-burner"
5656

5757
# - name: Install bats
5858
# uses: mig4/setup-bats@v1

docs/index.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Rosa Burner Docs
2+
title: HCP Burner Docs
33
---
44

5-
## What is rosa-burner
5+
## What is HCP-Burner
66

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.
88

9-
## How rosa-burner works
9+
## How HCP-Burner works
1010

1111
Following helpers are available for every platform:
1212

@@ -41,11 +41,11 @@ Following platforms are available at this moment:
4141

4242
Almost all the parameters can be defined in three ways:
4343
- Wrapper parameters:
44-
`rosa-burner.py --cluster-count 100`
44+
`hcp-burner.py --cluster-count 100`
4545
- Environment Variable:
46-
`ROSA_BURNER_CLUSTER_COUNT=100 rosa-burner.py`
46+
`HCP_BURNER_CLUSTER_COUNT=100 hcp-burner.py`
4747
- Configuration File:
48-
`rosa-burner.py --config-file ./rosa-burner.conf`
48+
`hcp-burner.py --config-file ./hcp-burner.ini`
4949

5050
**Only parameters --platform and --subplatform must be defined as wrapper arguments, platform is always required but subplatform is optional**
5151

@@ -57,7 +57,7 @@ To add any other parameter to the config file, remove `--` from the argument and
5757
cluster_name_seed = test
5858
```
5959

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
6161

6262
## Preference
6363

@@ -71,42 +71,42 @@ To use the config file, define common parameters under the `[Defaults]` section
7171

7272
| Argument | Default Value | Config file variable | Environment Variable |
7373
|--------------------------|-------------------|----------------------|--------------------------------|
74-
| --config-file | | | ROSA_BURNER_CONFIG_FILE |
74+
| --config-file | | | HCP_BURNER_CONFIG_FILE |
7575
| --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 |
8484
| --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 |
9090
| --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 |
9797
| --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 |
100100

101101
## ElasticSearch arguments
102102

103103
To use the config file, define common parameters under the `[Elasticsearch]` section
104104

105105
| Argument | Default Value | Config file variable | Environment Variable |
106106
|--------------------------|-------------------|----------------------|--------------------------------|
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 |
110110
| --es-insecure | | | |
111111

112112
## Logging arguments
@@ -115,5 +115,5 @@ To use the config file, define common parameters under the `[Logging]` section
115115

116116
| Argument | Default Value | Config file variable | Environment Variable |
117117
|--------------------------|-------------------|----------------------|--------------------------------|
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 |

docs/platforms/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ To use the config file, define parameters related to platform under the `[Platfo
1111

1212
| Argument | Default Value | Config file variable | Environment Variable |
1313
|--------------------------|-------------------|----------------------|--------------------------------|
14-
| --ocm-token | | ocm_token | ROSA_BURNER_OCM_TOKEN |
15-
| --ocm-url | https://api.stage.openshift.com | ocm_url | ROSA_BURNER_OCM_URL |
14+
| --ocm-token | | ocm_token | HCP_BURNER_OCM_TOKEN |
15+
| --ocm-url | https://api.stage.openshift.com | ocm_url | HCP_BURNER_OCM_URL |

docs/platforms/rosa/hypershift.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Classes related to Hypershift subplatform
22

33
As hypershift is a subplatform or ROSA, select rosa as platform parameter and hypershift as subplatform:
4-
`rosa-burner --platform rosa --subplatform hypershift`
4+
`hcp-burner --platform rosa --subplatform hypershift`
55

66
### Arguments
77

@@ -10,7 +10,7 @@ To use the config file, define parameters related to platform under the `[Platfo
1010
| Argument | Default Value | Config file variable | Environment Variable |
1111
|--------------------------|-------------------|----------------------|--------------------------------|
1212
| --create-vpcs | | | |
13-
| --clusters-per-vpc | 1 | | ROSA_BURNER_CLUSTERS_PER_VPC |
13+
| --clusters-per-vpc | 1 | | HCP_BURNER_CLUSTERS_PER_VPC |
1414
| --terraform-retry | 5 | | |
15-
| --service-cluster | | hypershift_service_cluster | ROSA_BURNER_HYPERSHIFT_SERVICE_CLUSTER |
15+
| --service-cluster | | hypershift_service_cluster | HCP_BURNER_HYPERSHIFT_SERVICE_CLUSTER |
1616
| --delete-vpcs | | | |

docs/platforms/rosa/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33
Classes related to ROSA platform
44

55
To use this platform, select rosa as platform parameter:
6-
`rosa-burner --platform rosa`
6+
`hcp-burner --platform rosa`
77

88
## Platforms Arguments
99

1010
To use the config file, define parameters related to platform under the `[Platform:Rosa]` section
1111

1212
| Argument | Default Value | Config file variable | Environment Variable |
1313
|--------------------------|-------------------|----------------------|--------------------------------|
14-
| --rosa-env | staging | | ROSA_BURNER_ROSA_ENV |
15-
| --aws-account-file | | | ROSA_BURNER_AWS_ACCOUNT_FILE |
16-
| --aws-profile | | | ROSA_BURNER_AWS_PROFILE |
17-
| --aws-region | us-east-2 | | ROSA_BURNER_AWS_REGION |
18-
| --oidc-config-id | | | ROSA_BURNER_OIDC_CONFIG_ID |
14+
| --rosa-env | staging | | HCP_BURNER_ROSA_ENV |
15+
| --aws-account-file | | | HCP_BURNER_AWS_ACCOUNT_FILE |
16+
| --aws-profile | | | HCP_BURNER_AWS_PROFILE |
17+
| --aws-region | us-east-2 | | HCP_BURNER_AWS_REGION |
18+
| --oidc-config-id | | | HCP_BURNER_OIDC_CONFIG_ID |
1919
| --common-operator-roles | | | |
20-
| --extra-machinepool-name | | | ROSA_BURNER_MACHINE_POOL_NAME |
21-
| --extra-machinepool-machine-type| m5.xlarge | | ROSA_BURNER_MACHINE_POOL_MACHINE_TYPE |
22-
| --extra-machinepool-replicas | 3 | | ROSA_BURNER_MACHINE_POOL_REPLICAS |
23-
| --extra-machinepool-labels | | | ROSA_BURNER_MACHINEPOOL_LABELS |
24-
| --extra-machinepool-taints | | | ROSA_BURNER_MACHINEPOOL_TAINTS |
20+
| --extra-machinepool-name | | | HCP_BURNER_MACHINE_POOL_NAME |
21+
| --extra-machinepool-machine-type| m5.xlarge | | HCP_BURNER_MACHINE_POOL_MACHINE_TYPE |
22+
| --extra-machinepool-replicas | 3 | | HCP_BURNER_MACHINE_POOL_REPLICAS |
23+
| --extra-machinepool-labels | | | HCP_BURNER_MACHINEPOOL_LABELS |
24+
| --extra-machinepool-taints | | | HCP_BURNER_MACHINEPOOL_TAINTS |

docs/platforms/rosa/terraform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Classes related to Terraform subplatform
55

66
As terraform is a subplatform or ROSA, select rosa as platform parameter and terraform as subplatform:
7-
`rosa-burner --platform rosa --subplatform terraform`
7+
`hcp-burner --platform rosa --subplatform terraform`
88

99
## Platforms Arguments
1010

rosa-burner.ini renamed to hcp-burner.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ delay_between_cleanup = 1
2222

2323
[Logging]
2424
log_level = DEBUG
25-
log_file = /tmp/rosa-burner.log
25+
log_file = /tmp/hcp-burner.log
2626

2727
[Elasticsearch]
2828
#es_url = https://elasticsearch.foo.bar
29-
#es_index = rosa-burner
29+
#es_index = hcp-burner
3030
#es_index_retry = 5
3131
#es_insecure = True
3232

File renamed without changes.

0 commit comments

Comments
 (0)