Skip to content

Commit

Permalink
Removed misleading section of the README (#153)
Browse files Browse the repository at this point in the history
* The CLI now performs the cdk-bootstrap for the user and it isn't
  possible for them to perform it themselves due to the special
  arguments that must be passed.  Having a section of the README
  imply that the user can perform this action will just cause pain.

Signed-off-by: Chris Helma <[email protected]>
  • Loading branch information
chelma authored Jan 17, 2024
1 parent 7cdf68a commit a1aec22
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ The CDK is used to perform infrastructure specification, setup, management, and
- [Quick Start Guide](#quick-start-guide)
- [Architecture and Design](#architecture-and-design)
- [How to Run the AWS All-in-One CLI](#how-to-run-the-aws-all-in-one-cli)
- [Performing CDK Bootstrap](#performing-cdk-bootstrap)
- [Setting up your Arkime Cluster](#setting-up-your-arkime-cluster)
- [Setting up capture for a VPC in the Cluster account](#setting-up-capture-for-a-vpc-in-the-cluster-account)
- [Setting up capture for a VPC in another account](#setting-up-capture-for-a-vpc-in-another-account)
Expand Down Expand Up @@ -86,19 +85,6 @@ Why each of these needed:

NOTE: By default, the CDK CLI will use the AWS Region specified as default in your AWS Configuration file; you can set this using the `aws configure` command. It will also use the AWS Account your credentials are associated with.


### Performing CDK Bootstrap

Before deploying AWS Resources to your account using the CDK, you must first perform a bootstrapping step. The management CLI should take care of this for you, but the following is provided in case you want/need to do this manually.

At a high level the CDK needs some existing resources in your AWS account before it deploys your target infrastructure, which you can [learn more about here](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html). Examples include an AWS S3 bucket to stage deployment resources and an AWS ECR repo to receive/house locally-defined Docker images.

You can bootstrap your AWS Account/Region like so:

```
cdk bootstrap
```

### Setting up your Arkime Cluster

You can deploy the Arkime Cluster into your AWS account like so:
Expand Down

0 comments on commit a1aec22

Please sign in to comment.