Skip to content

Commit

Permalink
docs: update docs per PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
o11yguru committed Mar 22, 2024
1 parent 4d12ba8 commit 3c5829e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
5 changes: 4 additions & 1 deletion src/install/aws/aws-sso.md
Expand Up @@ -2,10 +2,13 @@

To deploy an MDAI Engine, you'll need to use the AWS CLI.

>**Note:** Our install steps use the recommended AWS CLI access method, AWS SSO. There are other [AWS CLI Access options](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html) that you can use to interact with your AWS account.
#### Login via the CLI

```shell
aws configure sso
# Assumes your machine is already configured access to AWS via `aws configure sso`.
aws sso login --profile <AWS_PROFILE>
```

#### Choose the right AWS Account and AWS Role
Expand Down
2 changes: 2 additions & 0 deletions src/install/aws/prerequisites.md
Expand Up @@ -13,6 +13,8 @@ export GOBIN=${GOBIN:-$(go env GOPATH)/bin}
```
- Install [node](https://nodejs.org/en/download).

>**Note:** We do install Helm automatically, however, it's important to note that we support [Helm v3.13.0](https://github.com/helm/helm/releases/tag/v3.13.0) and later. If you have helm installed, but at an earlier version, we cannot guarantee our install process will work as expected.
### AWS Requirements

- Install [AWS CDK Toolkit](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install)
Expand Down
2 changes: 1 addition & 1 deletion src/install/local/quick-start.md
Expand Up @@ -33,7 +33,7 @@ Our automated installation process is setting up all the required dependencies l
- Npm
- Aws CDK
- Go
- Helm
- Helm (we support [Helm v3.13.0](https://github.com/helm/helm/releases/tag/v3.13.0) and later)

>_Note: Once the Engine installed your k8s context will be switched automatically to new cluster._
Expand Down

0 comments on commit 3c5829e

Please sign in to comment.