Merge pull request #24 from morenod/rename_project

Update all references from rosa-burner to hcp-burner
cloud-bulldozer · Jan 11, 2024 · 40d4eb8 · 40d4eb8
2 parents 1813adb + 84427aa
commit 40d4eb8
Show file tree

Hide file tree

Showing 17 changed files with 103 additions and 103 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -52,7 +52,7 @@ jobs:
         HCP_BURNER_AWS_ACCOUNT_FILE: "/tmp/aws_config.ini"
         HCP_BURNER_HYPERSHIFT_SERVICE_CLUSTER: ${{ secrets.HCP_BURNER_HYPERSHIFT_SERVICE_CLUSTER}}
         HCP_BURNER_ES_URL: ${{ secrets.HCP_BURNER_ES_URL}}
-        HCP_BURNER_ES_INDEX: "rosa-burner"
+        HCP_BURNER_ES_INDEX: "hcp-burner"
 
     # - name: Install bats
     #   uses: mig4/setup-bats@v1

diff --git a/docs/index.md b/docs/index.md
@@ -1,12 +1,12 @@
 ---
-title: Rosa Burner Docs
+title: HCP Burner Docs
 ---
 
-## What is rosa-burner
+## What is HCP-Burner
 
-Rosa-burner is a wrapper to automate create-use-destroy of OCP clusters in the different managed platforms.
+hcp-burner is a wrapper to automate create-use-destroy of OCP clusters in the different managed platforms.
 
-## How rosa-burner works
+## How HCP-Burner works
 
 Following helpers are available for every platform:
 
@@ -41,11 +41,11 @@ Following platforms are available at this moment:
 
 Almost all the parameters can be defined in three ways:
 - Wrapper parameters:
-`rosa-burner.py --cluster-count 100`
+`hcp-burner.py --cluster-count 100`
 - Environment Variable:
-`ROSA_BURNER_CLUSTER_COUNT=100 rosa-burner.py`
+`HCP_BURNER_CLUSTER_COUNT=100 hcp-burner.py`
 - Configuration File:
-`rosa-burner.py --config-file ./rosa-burner.conf`
+`hcp-burner.py --config-file ./hcp-burner.ini`
 
 **Only parameters --platform and --subplatform must be defined as wrapper arguments, platform is always required but subplatform is optional**
 
@@ -57,7 +57,7 @@ To add any other parameter to the config file, remove `--` from the argument and
 cluster_name_seed = test
 ```
 
-Full version of a config file can be found on **rosa-burner.conf** file
+Full version of a config file can be found on **hcp-burner.ini** file
 
 ## Preference
 
@@ -71,42 +71,42 @@ To use the config file, define common parameters under the `[Defaults]` section
 
 | Argument                 | Default Value     | Config file variable | Environment Variable           |
 |--------------------------|-------------------|----------------------|--------------------------------|
-| --config-file            |                   |                      | ROSA_BURNER_CONFIG_FILE        |
+| --config-file            |                   |                      | HCP_BURNER_CONFIG_FILE        |
 | --install-clusters       |                   |                      |                                |
-| --platform               |                   | platform             | ROSA_BURNER_PLATFORM           |
-| --subplatform            |                   | subplatform          | ROSA_BURNER_SUBPLATFORM        |
-| --uuid                   |                   |                      | ROSA_BURNER_UUID               |
-| --path                   |                   |                      | ROSA_BURNER_PATH               |
-| --cluster-name-seed      |                   |                      | ROSA_BURNER_CLUSTER_NAME_SEED  |
-| --static-cluster-name    |                   |                      | ROSA_BURNER_STATIC_CLUSTER_NAME|
-| --workers                | 3                 |                      | ROSA_BURNER_WORKERS            |
-| --workers-wait-time      | 60                |                      | ROSA_BURNER_WORKERS_WAIT_TIME  |
+| --platform               |                   | platform             | HCP_BURNER_PLATFORM           |
+| --subplatform            |                   | subplatform          | HCP_BURNER_SUBPLATFORM        |
+| --uuid                   |                   |                      | HCP_BURNER_UUID               |
+| --path                   |                   |                      | HCP_BURNER_PATH               |
+| --cluster-name-seed      |                   |                      | HCP_BURNER_CLUSTER_NAME_SEED  |
+| --static-cluster-name    |                   |                      | HCP_BURNER_STATIC_CLUSTER_NAME|
+| --workers                | 3                 |                      | HCP_BURNER_WORKERS            |
+| --workers-wait-time      | 60                |                      | HCP_BURNER_WORKERS_WAIT_TIME  |
 | --wait-for-workers       |                   |                      |                                |
-| --cluster-count          | 1                 |                      | ROSA_BURNER_CLUSTER_COUNT      |
-| --delay-between-batch    | 60                |                      | ROSA_BURNER_DELAY_BETWEEN_BATCH|
-| --batch-size             | 0                 |                      | ROSA_BURNER_BATCH_SIZE         |
-| --watcher-delay          | 60                |                      | ROSA_BURNER_WATCHER_DELAY      |
-| --wildcard-options       |                   |                      | ROSA_BURNER_WILDCARD_OPTIONS   |
+| --cluster-count          | 1                 |                      | HCP_BURNER_CLUSTER_COUNT      |
+| --delay-between-batch    | 60                |                      | HCP_BURNER_DELAY_BETWEEN_BATCH|
+| --batch-size             | 0                 |                      | HCP_BURNER_BATCH_SIZE         |
+| --watcher-delay          | 60                |                      | HCP_BURNER_WATCHER_DELAY      |
+| --wildcard-options       |                   |                      | HCP_BURNER_WILDCARD_OPTIONS   |
 | --enable-workload        |                   |                      |                                |
-| --workload-repo          | https://github.com/cloud-bulldozer/e2e-benchmarking.git | workload_repo | ROSA_BURNER_WORKLOAD_REPO |
-| --workload               | cluster-density-ms | workload             | ROSA_BURNER_WORKLOAD           |
-| --workload-script-path        | workloads/kube-burner-ocp-wrapper | workload_script_path | ROSA_BURNER_WORKLOAD_SCRIPT_PATH |
-| --workload-executor      | /usr/bin/kube-burner | workload_executor | ROSA_BURNER_WORKLOAD_EXECUTOR |
-| --workload-duration      | 1h                |                      | ROSA_BURNER_WORKLOAD_DURATION  |
-| --workload-jobs          | 10                |                      | ROSA_BURNER_WORKLOAD_JOBS      |
+| --workload-repo          | https://github.com/cloud-bulldozer/e2e-benchmarking.git | workload_repo | HCP_BURNER_WORKLOAD_REPO |
+| --workload               | cluster-density-ms | workload             | HCP_BURNER_WORKLOAD           |
+| --workload-script-path        | workloads/kube-burner-ocp-wrapper | workload_script_path | HCP_BURNER_WORKLOAD_SCRIPT_PATH |
+| --workload-executor      | /usr/bin/kube-burner | workload_executor | HCP_BURNER_WORKLOAD_EXECUTOR |
+| --workload-duration      | 1h                |                      | HCP_BURNER_WORKLOAD_DURATION  |
+| --workload-jobs          | 10                |                      | HCP_BURNER_WORKLOAD_JOBS      |
 | --cleanup-clusters       |                   |                      |                                |
-| --wait-before-cleanup    | 0                 |                      | ROSA_BURNER_WAIT_BEFORE_CLEANUP|
-| --delay-between-cleanup  | 0                 |                      | ROSA_BURNER_DELAY_BETWEEN_CLEANUP |
+| --wait-before-cleanup    | 0                 |                      | HCP_BURNER_WAIT_BEFORE_CLEANUP|
+| --delay-between-cleanup  | 0                 |                      | HCP_BURNER_DELAY_BETWEEN_CLEANUP |
 
 ## ElasticSearch arguments
 
 To use the config file, define common parameters under the `[Elasticsearch]` section
 
 | Argument                 | Default Value     | Config file variable | Environment Variable           |
 |--------------------------|-------------------|----------------------|--------------------------------|
-| --es-url               |                   |                         | ROSA_BURNER_ES_URL              |
-| --es-index             | rosa-burner       |                         | ROSA_BURNER_ES_INDEX            |
-| --es-index-retry       | 5                 |                         | ROSA_BURNER_ES_INDEX_RETRY      |
+| --es-url               |                   |                         | HCP_BURNER_ES_URL              |
+| --es-index             | hcp-burner       |                         | HCP_BURNER_ES_INDEX            |
+| --es-index-retry       | 5                 |                         | HCP_BURNER_ES_INDEX_RETRY      |
 | --es-insecure          |                   |                         |                                 |
 
 ## Logging arguments
@@ -115,5 +115,5 @@ To use the config file, define common parameters under the `[Logging]` section
 
 | Argument                 | Default Value     | Config file variable | Environment Variable           |
 |--------------------------|-------------------|----------------------|--------------------------------|
-| --log-level              | INFO              |                      | ROSA_BURNER_LOG_LEVEL          |
-| --log-file               |                   |                      | ROSA_BURNER_LOG_FILE           |
+| --log-level              | INFO              |                      | HCP_BURNER_LOG_LEVEL          |
+| --log-file               |                   |                      | HCP_BURNER_LOG_FILE           |
diff --git a/docs/platforms/index.md b/docs/platforms/index.md
@@ -11,5 +11,5 @@ To use the config file, define parameters related to platform under the `[Platfo
 
 | Argument                 | Default Value     | Config file variable | Environment Variable           |
 |--------------------------|-------------------|----------------------|--------------------------------|
-| --ocm-token              |   | ocm_token                     | ROSA_BURNER_OCM_TOKEN          |
-| --ocm-url                | https://api.stage.openshift.com | ocm_url | ROSA_BURNER_OCM_URL                     |
+| --ocm-token              |   | ocm_token                     | HCP_BURNER_OCM_TOKEN          |
+| --ocm-url                | https://api.stage.openshift.com | ocm_url | HCP_BURNER_OCM_URL                     |
diff --git a/docs/platforms/rosa/hypershift.md b/docs/platforms/rosa/hypershift.md
@@ -1,7 +1,7 @@
 Classes related to Hypershift subplatform
 
 As hypershift is a subplatform or ROSA, select rosa as platform parameter and hypershift as subplatform:
-`rosa-burner --platform rosa --subplatform hypershift`
+`hcp-burner --platform rosa --subplatform hypershift`
 
 ### Arguments
 
@@ -10,7 +10,7 @@ To use the config file, define parameters related to platform under the `[Platfo
 | Argument                 | Default Value     | Config file variable | Environment Variable           |
 |--------------------------|-------------------|----------------------|--------------------------------|
 | --create-vpcs             |                   |                                |                                          |
-| --clusters-per-vpc        | 1                 |                                | ROSA_BURNER_CLUSTERS_PER_VPC              |
+| --clusters-per-vpc        | 1                 |                                | HCP_BURNER_CLUSTERS_PER_VPC              |
 | --terraform-retry         | 5                 |                                |                                          |
-| --service-cluster         |                   | hypershift_service_cluster     | ROSA_BURNER_HYPERSHIFT_SERVICE_CLUSTER    |
+| --service-cluster         |                   | hypershift_service_cluster     | HCP_BURNER_HYPERSHIFT_SERVICE_CLUSTER    |
 | --delete-vpcs             |                   |                                |                                          |
diff --git a/docs/platforms/rosa/index.md b/docs/platforms/rosa/index.md
@@ -3,22 +3,22 @@
 Classes related to ROSA platform
 
 To use this platform, select rosa as platform parameter:
-`rosa-burner --platform rosa`
+`hcp-burner --platform rosa`
 
 ## Platforms Arguments
 
 To use the config file, define parameters related to platform under the `[Platform:Rosa]` section
 
 | Argument                 | Default Value     | Config file variable | Environment Variable           |
 |--------------------------|-------------------|----------------------|--------------------------------|
-| --rosa-env                      | staging           |                              | ROSA_BURNER_ROSA_ENV             |
-| --aws-account-file              |                   |                              | ROSA_BURNER_AWS_ACCOUNT_FILE     |
-| --aws-profile                   |                   |                              | ROSA_BURNER_AWS_PROFILE          |
-| --aws-region                    | us-east-2         |                              | ROSA_BURNER_AWS_REGION           |
-| --oidc-config-id                |                   |                              | ROSA_BURNER_OIDC_CONFIG_ID       |
+| --rosa-env                      | staging           |                              | HCP_BURNER_ROSA_ENV             |
+| --aws-account-file              |                   |                              | HCP_BURNER_AWS_ACCOUNT_FILE     |
+| --aws-profile                   |                   |                              | HCP_BURNER_AWS_PROFILE          |
+| --aws-region                    | us-east-2         |                              | HCP_BURNER_AWS_REGION           |
+| --oidc-config-id                |                   |                              | HCP_BURNER_OIDC_CONFIG_ID       |
 | --common-operator-roles         |                   |                              |                                  |
-| --extra-machinepool-name        |                   |                              | ROSA_BURNER_MACHINE_POOL_NAME    |
-| --extra-machinepool-machine-type| m5.xlarge         |                              | ROSA_BURNER_MACHINE_POOL_MACHINE_TYPE |
-| --extra-machinepool-replicas    | 3                 |                              | ROSA_BURNER_MACHINE_POOL_REPLICAS |
-| --extra-machinepool-labels      |                   |                              | ROSA_BURNER_MACHINEPOOL_LABELS   |
-| --extra-machinepool-taints      |                   |                              | ROSA_BURNER_MACHINEPOOL_TAINTS   |
+| --extra-machinepool-name        |                   |                              | HCP_BURNER_MACHINE_POOL_NAME    |
+| --extra-machinepool-machine-type| m5.xlarge         |                              | HCP_BURNER_MACHINE_POOL_MACHINE_TYPE |
+| --extra-machinepool-replicas    | 3                 |                              | HCP_BURNER_MACHINE_POOL_REPLICAS |
+| --extra-machinepool-labels      |                   |                              | HCP_BURNER_MACHINEPOOL_LABELS   |
+| --extra-machinepool-taints      |                   |                              | HCP_BURNER_MACHINEPOOL_TAINTS   |
diff --git a/docs/platforms/rosa/terraform.md b/docs/platforms/rosa/terraform.md
@@ -4,7 +4,7 @@
 Classes related to Terraform subplatform
 
 As terraform is a subplatform or ROSA, select rosa as platform parameter and terraform as subplatform:
-`rosa-burner --platform rosa --subplatform terraform`
+`hcp-burner --platform rosa --subplatform terraform`
 
 ## Platforms Arguments
 

diff --git a/rosa-burner.ini → hcp-burner.ini b/rosa-burner.ini → hcp-burner.ini
@@ -22,11 +22,11 @@ delay_between_cleanup = 1
 
 [Logging]
 log_level = DEBUG
-log_file = /tmp/rosa-burner.log
+log_file = /tmp/hcp-burner.log
 
 [Elasticsearch]
 #es_url = https://elasticsearch.foo.bar
-#es_index = rosa-burner
+#es_index = hcp-burner
 #es_index_retry = 5
 #es_insecure = True
 

diff --git a/rosa-burner.py → hcp-burner.py b/rosa-burner.py → hcp-burner.py