From eeb8f68a0d7174e6471f5f79784b7f1602e843ac Mon Sep 17 00:00:00 2001 From: morenod Date: Tue, 31 Oct 2023 11:17:40 +0100 Subject: [PATCH] Add docs and workflow for pusblish them --- .github/workflows/docs.yml | 30 +++++ .../workflows/{release.yml_ => release.yml} | 7 -- .gitignore | 1 + .markdownlint.json | 4 + README.md | 105 +--------------- docs/css/extra.css | 3 + docs/development/ci.md | 13 ++ docs/development/ci/pullrequest.md | 80 ++++++++++++ docs/development/ci/release.md | 19 +++ docs/development/ci/tests.md | 16 +++ docs/development/index.md | 0 docs/index.md | 119 ++++++++++++++++++ docs/measurements.md | 73 +++++++++++ .../README.md => docs/platforms/index.md | 6 +- .../platforms/rosa/hypershift.md | 5 +- .../README.md => docs/platforms/rosa/index.md | 0 .../platforms/rosa/terraform.md | 4 - libs/platforms/rosa/terraform/terraform.py | 2 +- mkdocs.yml | 92 ++++++++++++++ 19 files changed, 456 insertions(+), 123 deletions(-) create mode 100644 .github/workflows/docs.yml rename .github/workflows/{release.yml_ => release.yml} (51%) create mode 100644 .markdownlint.json mode change 100644 => 120000 README.md create mode 100644 docs/css/extra.css create mode 100644 docs/development/ci.md create mode 100644 docs/development/ci/pullrequest.md create mode 100644 docs/development/ci/release.md create mode 100644 docs/development/ci/tests.md create mode 100644 docs/development/index.md create mode 100644 docs/index.md create mode 100644 docs/measurements.md rename libs/platforms/README.md => docs/platforms/index.md (73%) rename libs/platforms/rosa/hypershift/README.md => docs/platforms/rosa/hypershift.md (95%) rename libs/platforms/rosa/README.md => docs/platforms/rosa/index.md (100%) rename libs/platforms/rosa/terraform/README.md => docs/platforms/rosa/terraform.md (57%) create mode 100644 mkdocs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..1a4ba8c --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,30 @@ +name: Deploy docs +on: + workflow_call: +jobs: + deploy-docs: + runs-on: ubuntu-latest + steps: + - name: Check out code + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Set up python + uses: actions/setup-python@v4 + with: + python-version: 3.x + + - name: Setup doc deploy + run: | + git config --global user.name Docs deploy + git config --global user.email docs@dummy.bot.com + + - name: Install dependencies + run: pip install mkdocs-material mkdocs-include-markdown-plugin mike + + - name: Deploy docs + run: mike deploy --push -m "Update docs to version ${{ github.ref_name }}" --update-aliases ${{ github.ref_name }} latest + + - name: Set latest as default doc branch + run: mike set-default --push latest diff --git a/.github/workflows/release.yml_ b/.github/workflows/release.yml similarity index 51% rename from .github/workflows/release.yml_ rename to .github/workflows/release.yml index 7a11c52..d7a0b17 100644 --- a/.github/workflows/release.yml_ +++ b/.github/workflows/release.yml @@ -4,12 +4,5 @@ on: tags: - "*" # triggers only if push new tag version jobs: - release-build: - uses: ./.github/workflows/gorelease.yml - - image-upload: - uses: ./.github/workflows/image-upload.yml - secrets: inherit - deploy-docs: uses: ./.github/workflows/docs.yml diff --git a/.gitignore b/.gitignore index de35933..dcf5c51 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ __pycache__/ **/__pycache__/ +site/ diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..a4e43a1 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD013": false, + "MD007": {"indent": 4} +} diff --git a/README.md b/README.md deleted file mode 100644 index f7328ae..0000000 --- a/README.md +++ /dev/null @@ -1,104 +0,0 @@ -# What is rosa-burner - -Rosa-burner is a wrapper to automate create-use-destroy of OCP clusters in the different managed platforms. - -## How works rosa-burner - -Following helpers are available for every platform: -- Schedulers: - - Install: - - Execute Workloads - - Cleanup - -Every platform needs to overload following functions to be integrated in the cluster: -- Initialize -- Create Cluster -- Delete Cluster -- Platform Cleanup -- Watcher - -## Available Platforms -Following platforms are available at this moment: -- Rosa - - Hypershift - -# Arguments, parameters and configuration options - -Almost all the parameters can be defined in three ways: -- Wrapper parameters: -`rosa-burner.py --cluster-count 100` -- Environment Variable: -`ROSA_BURNER_CLUSTER_COUNT=100 rosa-burner.py` -- Configuration File: -`rosa-burner.py --config-file ./rosa-burner.conf` - -**Only parameters --platform and --subplatform must be defined as wrapper arguments, platform is always required but subplatform is optional** - -To add any other parameter to the config file, remove `--` from the argument and change `_` to `_`, for example: - -**--cluster-name-seed** will be: -``` -[Defaults] -cluster_name_seed = test -``` - -Full version of a config file can be found on **rosa-burner.conf** file - -## Preference - -All parameters will have following preference when they will be defined in more than one place: - -Argument > Environment Variable > Config File - -## Common arguments - -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 | -| --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 | -| --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 | -| --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 | -| --cleanup-clusters | | | | -| --wait-before-cleanup | 0 | | ROSA_BURNER_WAIT_BEFORE_CLEANUP| -| --delay-between-cleanup | 0 | | ROSA_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-insecure | | | | - -# Logging arguments - -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 | diff --git a/README.md b/README.md new file mode 120000 index 0000000..e892330 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +docs/index.md \ No newline at end of file diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..bebeae8 --- /dev/null +++ b/docs/css/extra.css @@ -0,0 +1,3 @@ +.mermaid { + text-align: center; +} \ No newline at end of file diff --git a/docs/development/ci.md b/docs/development/ci.md new file mode 100644 index 0000000..16566d7 --- /dev/null +++ b/docs/development/ci.md @@ -0,0 +1,13 @@ +# Continuous Integration Documentation + +This documentation provides an overview of the different jobs and their execution in the CI workflow. The CI workflow consists of several jobs that automate various tasks such as linters, executing tests, generating and deploying documentation and creating releases. Each job is triggered based on specific events. + +## Pull Request workflow +--- + +{% include-markdown "development/ci/pullrequest.md" %} + +## Release workflow +--- + +{% include-markdown "development/ci/release.md" %} diff --git a/docs/development/ci/pullrequest.md b/docs/development/ci/pullrequest.md new file mode 100644 index 0000000..1cb6781 --- /dev/null +++ b/docs/development/ci/pullrequest.md @@ -0,0 +1,80 @@ +The pull Request Workflow, defined in the `pullrequest.yml` file, is triggered on `pull_request_target` events to the branches `master` and `main`. It has three jobs: **linters**, **build**, **tests**, and **report_results**. + +```mermaid +graph LR + A[pull_request_target] --> B[linters] --> C[tests]; +``` + +### Linters + +This job performs the following steps: + +1. Checks out the code +1. Installs pre-commit. +1. Runs pre-commit hooks to execute code linting based on `.pre-commit-config.yaml` file + +#### Running local pre-commit + +!!! info + Main purpose for pre-commit is to allow developers to pass the Lint Checks before commiting the code. Same checks will be executed on all the commits once they are pushed to GitHub + +--- + +To install pre-commit checks locally, follow these steps: + +1. Install [pre-commit](https://pre-commit.com/) by running the following command: + + ```console + pip install pre-commit + ``` + +1. `ruby` is required for running the Markdown Linter, installation will depends on your Operating System, for example, on Fedora: + + ```console + dnf install -y ruby + ``` + +1. Initialize pre-commit on the repo: + + ```console + pre-commit install + ``` + +--- + +To run pre-commit manually for all files, you can use: + +```console +$ pre-commit run --all-files +markdownlint.............................................................Passed +Test shell scripts with shellcheck.......................................Passed +check json...............................................................Passed +flake8...................................................................Passed +pylint...................................................................Passed +``` + +Or you can run against an especific file: + +```console +$ pre-commit run --files docs/index.md +markdownlint.............................................................Passed +Test shell scripts with shellcheck...................(no files to check)Skipped +check json...........................................(no files to check)Skipped +flake8...............................................(no files to check)Skipped +pylint...............................................(no files to check)Skipped +``` + +Pre-commit hooks can be updated using `pre-commit autoupdate`: + +```console +$ pre-commit autoupdate +[https://github.com/igorshubovych/markdownlint-cli] already up to date! +[https://github.com/jumanjihouse/pre-commit-hooks] already up to date! +[https://github.com/pre-commit/pre-commit-hooks] already up to date! +[https://github.com/PyCQA/flake8] already up to date! +[https://github.com/PyCQA/pylint] already up to date! +``` + +### Tests + +{% include-markdown "development/ci/tests.md" %} diff --git a/docs/development/ci/release.md b/docs/development/ci/release.md new file mode 100644 index 0000000..7ac5511 --- /dev/null +++ b/docs/development/ci/release.md @@ -0,0 +1,19 @@ +The Release workflow, defined in the `release.yml` file, when a new tag is pushed it triggers: **release-build** and **image-upload**. + +```mermaid +graph LR + A[new tag pushed] --> B[deploy-docs]; +``` + +The `deploy-docs` job is triggered when a new release is `published`, this is done by the `release_build` job. + +### Docs Update + +Uses the `Deploy docs` workflow defined in the `docs.yml` file to generate and deploy the documentation performing the following steps: + +1. Checks out the code. +1. Sets up Python 3.x. +1. Exports the release tag version as an environment variable. +1. Sets up the Git configuration for documentation deployment. +1. Installs the required dependencies, including mkdocs-material and mike. +1. Deploys the documentation using the mike deploy command, with specific parameters for updating aliases and including the release tag version in the deployment message. diff --git a/docs/development/ci/tests.md b/docs/development/ci/tests.md new file mode 100644 index 0000000..d2f82a0 --- /dev/null +++ b/docs/development/ci/tests.md @@ -0,0 +1,16 @@ +The Tests Workflow, defined in the `tests.yml` file, has one job: **test-rosa** which includes a matrix on each subplatforms, **hypershift** and **terraform**. + +Before installing the clusters, the automation prepares the environment with following tasks: + +- Checkout code +- Download tools (ocm, rosa, terraform and aws cli) +- Create AWS account file +- Install python requirements with pip + +#### Test Hypershift + +It deploys one Hosted Cluster on the Service Cluster assigned to Perf&Scale + +#### Test Terraform + +It deploys one Rosa Cluster using the terraform ocm provider on Stage Environment diff --git a/docs/development/index.md b/docs/development/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e2e5791 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,119 @@ +--- +title: Rosa Burner Docs +--- + +## What is rosa-burner + +Rosa-burner is a wrapper to automate create-use-destroy of OCP clusters in the different managed platforms. + +## How rosa-burner works + +Following helpers are available for every platform: + +- Schedulers: + - Install + - Execute Workloads + - Cleanup + +Every platform needs to overload following functions to be integrated in the cluster: + +- Initialize +- Create Cluster +- Delete Cluster +- Platform Cleanup +- Watcher + +## Available Platforms + +As mentioned on [Red Hat Cloud Services](https://www.redhat.com/en/technologies/cloud-computing/openshift/cloud-services?pfe-w7qvu3n4p=Platform+services#services), The foundation of Red Hat Cloud Services is Red Hat OpenShift®, a comprehensive application platform. In addition to self-managed offerings, Red Hat OpenShift is available as a cloud service directly from Red Hat as well as from major cloud providers. + +This wrapper will be adapted to run on every platform where Red Hat Openshift will be available as Cloud Service. On that purpose, we have establish a tree of platform - subplatform structure to fill that requirement. A platform will match every cloud provider and a subplatform will be an installation method of Openshift on that cloud provider. + +Following platforms are available at this moment: + +- [Rosa](https://cloud.redhat.com/learn/getting-started-red-hat-openshift-service-aws-rosa?extIdCarryOver=true&sc_cid=701f2000001OH7EAAW) (AWS) + - [Hypershift](https://cloud.redhat.com/blog/hosted-control-planes-is-here-as-tech-preview) (Hosted Control Planes) + - [Terraform](https://cloud.redhat.com/blog/rosa-joins-the-terraform-ecosystem) (ROSA installed using Terraform Provider) + + + +## Arguments, parameters and configuration options + +Almost all the parameters can be defined in three ways: +- Wrapper parameters: +`rosa-burner.py --cluster-count 100` +- Environment Variable: +`ROSA_BURNER_CLUSTER_COUNT=100 rosa-burner.py` +- Configuration File: +`rosa-burner.py --config-file ./rosa-burner.conf` + +**Only parameters --platform and --subplatform must be defined as wrapper arguments, platform is always required but subplatform is optional** + +To add any other parameter to the config file, remove `--` from the argument and change `_` to `_`, for example: + +**--cluster-name-seed** will be: +``` +[Defaults] +cluster_name_seed = test +``` + +Full version of a config file can be found on **rosa-burner.conf** file + +## Preference + +All parameters will have following preference when they will be defined in more than one place: + +Argument > Environment Variable > Config File + +## Common arguments + +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 | +| --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 | +| --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 | +| --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 | +| --cleanup-clusters | | | | +| --wait-before-cleanup | 0 | | ROSA_BURNER_WAIT_BEFORE_CLEANUP| +| --delay-between-cleanup | 0 | | ROSA_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-insecure | | | | + +## Logging arguments + +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 | diff --git a/docs/measurements.md b/docs/measurements.md new file mode 100644 index 0000000..eb86431 --- /dev/null +++ b/docs/measurements.md @@ -0,0 +1,73 @@ +Installation timers are collected for every cluster installation. + +Timers could be global or platform-subplatform related depending on the tools or procedures used to obtain them. We can define following timers collected at this moment: + + +## Preflight Checks + +| | | +|:-------------:|:------:| +| Platform | ROSA | +| Subplatform | ALL | + +Just after the cluster installation is launched on ROSA, it transitions for diferent stages (Pending, Waiting, Installing & Ready). + +We measure (during 60 minutes) the time on each stage. + +## Cluster Access + +| | | +|:-------------:|:------:| +| Platform | ROSA | +| Subplatform | ALL | + +Once the cluster is ready, we create a user on it, login on the cluster, and perform an admin operation, collecting following timers: + + +| Timer | Operation | +|:-------------:|------| +| cluster_admin_create | Time to execute `rosa create admin` | +| cluster_admin_login | Time to execute `oc login` using the admin user | +| cluster_oc_adm | Time to execute `oc adm top images` on the cluster + +## Namespace Waiting + +| | | +|:-------------:|:------:| +| Platform | ROSA | +| Subplatform | Hypershift | + +On hypershift, namespaces are created on Management & Service Clusters for each Hosted Cluster, we measure the time needed for them to be created + +| Timer | Operation | +|:-------------:|------| +| sc_namespace_timing | Time for namespace on Service Cluster to be created | +| mc_namespace_timing | Time for namespace on Management Cluster to be created | + +## Workers Ready + +| | | +|:-------------:|:------:| +| Platform | ROSA | +| Subplatform | Hypershift | + +Cluster is considered installed when the installation process is completed and cluster is ready. We also measure the time required for all the workers required by the installation are created and ready on the OCP side + +| Timer | Operation | +|:-------------:|------| +| workers_ready | All workers from default machinepool are Ready | +| extra_pool_workers_ready | If extra machinepool is created, time for workers on it to be Ready | + +## Cleanup + +| | | +|:-------------:|:------:| +| Platform | ROSA | +| Subplatform | Hypershift | + +Times related to destroy clusters + +| Timer | Operation | +|:-------------:|------| +| destroy_duration | Time to execute `rosa delete cluster` | +| destroy_all_duration | Time to execute `rosa delete cluster` + STS resources| diff --git a/libs/platforms/README.md b/docs/platforms/index.md similarity index 73% rename from libs/platforms/README.md rename to docs/platforms/index.md index fe8aaf6..d01d297 100644 --- a/libs/platforms/README.md +++ b/docs/platforms/index.md @@ -1,9 +1,9 @@ # Platforms -Each platform must contain two classes, one to define the methods of the platform, and another one to define the arguments of the platform. +Each platform must contain two classes, one to define the methods of the platform, and another one to define the arguments. -Parent Platform (Platform) defines the methods and variables used by all the platform. -This is the platform where to define ocm related commands, like `ocm login` because (at this moment) it is being used by all the child platforms. +Parent Platform (Platform) defines the methods and variables used by all the platforms. +This is the platform where to define, for example, ocm related commands, like `ocm login` because (at this moment) it is being used by all the child platforms. ## Platforms Arguments diff --git a/libs/platforms/rosa/hypershift/README.md b/docs/platforms/rosa/hypershift.md similarity index 95% rename from libs/platforms/rosa/hypershift/README.md rename to docs/platforms/rosa/hypershift.md index 8df1c6d..ae0be30 100644 --- a/libs/platforms/rosa/hypershift/README.md +++ b/docs/platforms/rosa/hypershift.md @@ -1,12 +1,9 @@ -# Hypershift Subplatform - - 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` -## Platforms Arguments +### Arguments To use the config file, define parameters related to platform under the `[Platform:Rosa:Hypershift]` section diff --git a/libs/platforms/rosa/README.md b/docs/platforms/rosa/index.md similarity index 100% rename from libs/platforms/rosa/README.md rename to docs/platforms/rosa/index.md diff --git a/libs/platforms/rosa/terraform/README.md b/docs/platforms/rosa/terraform.md similarity index 57% rename from libs/platforms/rosa/terraform/README.md rename to docs/platforms/rosa/terraform.md index 69f52c9..ef3605c 100644 --- a/libs/platforms/rosa/terraform/README.md +++ b/docs/platforms/rosa/terraform.md @@ -12,8 +12,4 @@ 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 | | --terraform-retry | 5 | | | -| --service-cluster | | hypershift_service_cluster | ROSA_BURNER_HYPERSHIFT_SERVICE_CLUSTER | -| --delete-vpcs | | | | diff --git a/libs/platforms/rosa/terraform/terraform.py b/libs/platforms/rosa/terraform/terraform.py index 6332316..47c3c04 100644 --- a/libs/platforms/rosa/terraform/terraform.py +++ b/libs/platforms/rosa/terraform/terraform.py @@ -270,5 +270,5 @@ def __init__(self, parser, config_file, environment): config = configparser.ConfigParser() config.read(config_file) defaults = {} - defaults.update(dict(config.items("Platform:Rosa:Hypershift"))) + defaults.update(dict(config.items("Platform:Rosa:Terraform"))) parser.set_defaults(**defaults) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c895f73 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,92 @@ +docs_dir: docs/ +repo_url: https://github.com/cloud-bulldozer/rosa-burner +nav: +- Home: index.md +- Platforms: + - platforms/index.md + - Rosa: + - platforms/rosa/index.md + - Terraform: platforms/rosa/terraform.md + - Hypershift: platforms/rosa/hypershift.md +- Measurements: measurements.md +- Development: + - development/index.md + - CI: development/ci.md + - Tests: development/ci/tests.md +site_name: Rosa-burner +plugins: + - search + - include-markdown +extra: + version: + provider: mike +extra_css: + - css/extra.css +theme: + name: material + font: + text: Roboto + code: Roboto Mono + palette: + # Palette toggle for light mode + - scheme: default + media: "(prefers-color-scheme: light)" + primary: indigo + toggle: + icon: material/weather-night + name: Switch to dark mode + # Palette toggle for dark mode + - scheme: slate + media: "(prefers-color-scheme: dark)" + primary: indigo + toggle: + icon: material/weather-sunny + features: + - navigation.instant + - navigation.tracking + - navigation.indexes + - navigation.top + - navigation.footer + - toc.integrate + - search.suggest + - search.highlight + - search.share + - content.code.copy + icon: + repo: fontawesome/brands/github +markdown_extensions: + # Python Markdown + - abbr + - admonition + - attr_list + - def_list + - footnotes + - md_in_html + - toc: + permalink: true + + # Python Markdown Extensions + - pymdownx.arithmatex: + generic: true + - pymdownx.betterem: + smart_enable: all + - pymdownx.caret + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde