CHAOS-4388 HCE onboard CLI #6199
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SmritiSatya
added
Review - SME
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://660e66f0ef5aaec5b2ddb4e7--harness-developer.netlify.app |
brian-r-fisher
previously approved these changes
Apr 4, 2024
| Onboard HCE AWS offers pre-compiled binaries that are available for download on our [releases page](https://github.com/harness/onboard_hce_aws/releases). | ||
|
|
||
| To install, follow these steps. | ||
| 1. Download the appropriate binary for your platform from the **"Assets"** section. |
There was a problem hiding this comment.
Suggested change
| 1. Download the appropriate binary for your platform from the **"Assets"** section. | |
| 1. Download the appropriate binary for your platform from the **Assets** section. |
|
|
||
| The `onboard_hce_aws` CLI streamlines and simplifies the HCE onboarding process. This tool also seamlessly integrates with your AWS account and executes HCE experiments. This CLI performs other tasks that streamline the onboarding process, such as: | ||
|
|
||
| 1. **ChaosInfra Setup:** The CLI installs the chaos infrastructure in the given namespace of your cluster using Harness APIs and Kubernetes permissions. After installation, it tests the activation of the infrastructure for a given timeout (default is 180 s). |
There was a problem hiding this comment.
Suggested change
| 1. **ChaosInfra Setup:** The CLI installs the chaos infrastructure in the given namespace of your cluster using Harness APIs and Kubernetes permissions. After installation, it tests the activation of the infrastructure for a given timeout (default is 180 s). | |
| - **ChaosInfra Setup:** The CLI installs the chaos infrastructure in the given namespace of your cluster using Harness APIs and Kubernetes permissions. After installation, it tests the activation of the infrastructure for a given timeout (default is 180 s). |
|
|
||
| 1. **ChaosInfra Setup:** The CLI installs the chaos infrastructure in the given namespace of your cluster using Harness APIs and Kubernetes permissions. After installation, it tests the activation of the infrastructure for a given timeout (default is 180 s). | ||
|
|
||
| 2. **Add OIDC Provider:** The CLI can be used to add the OIDC provider in the target account using the AWS credentials. If the given provider already exists, the CLI issues a warning and skips this step. |
There was a problem hiding this comment.
Suggested change
| 2. **Add OIDC Provider:** The CLI can be used to add the OIDC provider in the target account using the AWS credentials. If the given provider already exists, the CLI issues a warning and skips this step. | |
| - **Add OIDC Provider:** The CLI can be used to add the OIDC provider to the target account using the AWS credentials. If the given provider already exists, the CLI issues a warning and skips this step. |
|
|
||
| 2. **Add OIDC Provider:** The CLI can be used to add the OIDC provider in the target account using the AWS credentials. If the given provider already exists, the CLI issues a warning and skips this step. | ||
|
|
||
| 3. **AWS Roles:** Simplifies configuring HCE with AWS. If you wish to create a dedicated role for HCE, the CLI defines the required policies and permissions directly as CLI flags. Alternatively, if you already have a role, you can provide it as an input, and that role gets attached to the provider that you added previously. In addition, this CLI doesn't depend on other CLIs such as `aws` or `kubectl`. |
There was a problem hiding this comment.
Suggested change
| 3. **AWS Roles:** Simplifies configuring HCE with AWS. If you wish to create a dedicated role for HCE, the CLI defines the required policies and permissions directly as CLI flags. Alternatively, if you already have a role, you can provide it as an input, and that role gets attached to the provider that you added previously. In addition, this CLI doesn't depend on other CLIs such as `aws` or `kubectl`. | |
| - **AWS Roles:** Simplifies configuring HCE with AWS. If you wish to create a dedicated role for HCE, the CLI defines the required policies and permissions directly as CLI flags. Alternatively, if you already have a role, you can provide it as an input, and that role gets attached to the provider that you added previously. In addition, this CLI doesn't depend on other CLIs such as `aws` or `kubectl`. |
|
|
||
| 3. **AWS Roles:** Simplifies configuring HCE with AWS. If you wish to create a dedicated role for HCE, the CLI defines the required policies and permissions directly as CLI flags. Alternatively, if you already have a role, you can provide it as an input, and that role gets attached to the provider that you added previously. In addition, this CLI doesn't depend on other CLIs such as `aws` or `kubectl`. | ||
|
|
||
| 4. **Annotate Service Account:** The CLI will annotate the experiment service account on the cluster with AWS roleARN after all the configuration is done. |
There was a problem hiding this comment.
Suggested change
| 4. **Annotate Service Account:** The CLI will annotate the experiment service account on the cluster with AWS roleARN after all the configuration is done. | |
| - **Annotate Service Account:** The CLI will annotate the experiment service account on the cluster with AWS roleARN after all the configuration is done. |
|
|
||
| 6. **Flag support:** It supports a variety of flags thereby facilitating customization option for every step. | ||
|
|
||
| ## How to install the onboard HCE AWS? |
There was a problem hiding this comment.
Suggested change
| ## How to install the onboard HCE AWS? | |
| ## Install the onboard HCE AWS |
| 1. Download the appropriate binary for your platform from the **"Assets"** section. | ||
| 2. Rename the downloaded file to `onboard_hce_aws` (or `onboard_hce_aws.exe` for Windows). | ||
| 3. Move this file to your `$PATH` at your preferred binary installation directory. | ||
|
|
There was a problem hiding this comment.
Recommend adding tabs for the OS options. Added comments to remove colons if you keep these as headings and choose not to use tabs.
https://harness.atlassian.net/wiki/spaces/DOCS/pages/21544468526/Harness+documentation+style+guide#Headings%2C-titles
| 2. Rename the downloaded file to `onboard_hce_aws` (or `onboard_hce_aws.exe` for Windows). | ||
| 3. Move this file to your `$PATH` at your preferred binary installation directory. | ||
|
|
||
| ### For Linux: |
There was a problem hiding this comment.
Suggested change
| ### For Linux: | |
| #### Linux |
| chmod +x ./onboard_hce_aws | ||
| sudo mv ./onboard_hce_aws /usr/local/bin/onboard_hce_aws | ||
| ``` | ||
| ### For MacOS: |
There was a problem hiding this comment.
Suggested change
| ### For MacOS: | |
| #### MacOS |
| ## What is the HCE onboard CLI? | ||
|
|
||
| The `onboard_hce_aws` CLI streamlines and simplifies the HCE onboarding process. This tool also seamlessly integrates with your AWS account and executes HCE experiments. This CLI performs other tasks that streamline the onboarding process, such as: | ||
|
|
There was a problem hiding this comment.
Recommend using bullets instead of a numbered list here.
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6614d6f38ea8af6b565aed35--harness-developer.netlify.app |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
HCE onboard CLI, its usage