Skip to content

Commit

Permalink
fix: various documentation updates for install
Browse files Browse the repository at this point in the history
  • Loading branch information
o11yguru committed Mar 21, 2024
1 parent 3d27a6c commit 346a961
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 3 deletions.
6 changes: 5 additions & 1 deletion src/install/aws/aws-env.md
Expand Up @@ -2,8 +2,12 @@

Navigate to the `values/aws.env` file and start inputting the environment configuration that's relevant to your AWS account.

<div class="warning">
Due to our engine's Load Balancer capabilities alongside security measures, we're only able to support full engine compatibility with a <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/application/listener-authenticate-users.html#cognito-requirements" target="_blank" rel="noreferrer noopener">limited list</a> of AWS Regions.
</div>

```
# region where the engine going to be installed
# region where the engine going to be installed.
AWS_REGION=
# AWS account to be used
Expand Down
1 change: 1 addition & 0 deletions src/install/aws/deploy.md
Expand Up @@ -15,6 +15,7 @@
```shell
make install
```

<div class="warning">
<b><em>Don't walk away just yet!</em></b>
<p>There's one more manual verification step required before CloudFormation will deploy all necessary infrastructure to get your engine up and running as soon as possible.</p>
Expand Down
20 changes: 19 additions & 1 deletion src/install/aws/ui-auth.md
Expand Up @@ -2,9 +2,27 @@

We knew it wouldn't be acceptable to leave your precious new resources unprotected and open to any user of the internet!

*Enter Cognito*
*...Enter Cognito...*

We've added the ability to connect [Amazon Cognito](https://aws.amazon.com/cognito/) easily to your new Engine to limit access for undesired users.

<div class="warning">
Cognito is not supported in all AWS Regions. If you run into issues
post-install, this is likely the reason. A typical error you would see looks like this:<br />
<code style="color: #d10707;">
Failed deploy model due to failed to create listener rule: ValidationError: Action type 'authenticate-cognito' must be one of 'redirect,fixed-response,forward,authenticate-oidc' status code: 400, request id: ########-####-####-####-############
</code><br /><br />
<b>The above error can be found in the AWS Console > EKS service.</b><br /><br />
You can access the ingress output manually:<br />
<code>
EKS > Clusters > [YOUR_CLUSTER] > Resources > Service and networking > Ingresses > ui-alb-ingress
</code><br /><br />
You can access the ingress output by hitting this link after updating the values in brackets:<br />
<code>
https://[AWS_REGION].console.aws.amazon.com/eks/home?region=[AWS_REGION]#/clusters/[YOUR_CLUSTER]/ingresses/ui-alb-ingress?namespace=default
</code><br />
</div>

Our installation includes the following resources upon creating an engine:

1. [User pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) `mdai-user-pool`
Expand Down
26 changes: 25 additions & 1 deletion src/install/local/quick-start.md
Expand Up @@ -16,7 +16,17 @@ You are going to learn to do the following in less than five minutes:

## Prerequisites

<div class="warning">
<b>System Dependencies</b>
<ul>
<li>These docs assume that you have <a href="https://brew.sh/" target="_blank">homebrew</a> installed.</li>
<li>If you're using MacOS, you'll also need <a href="https://mac.install.guide/commandlinetools/" target="_blank">XCode Commandline Tools</a> installed.</li>
<li>You will also need to have <a href="https://kubernetes.io/releases/download/" target="_blank">Kubernetes</a> installed.</li>
</ul>
</div>

### Automated installation

Our automated installation process is setting up all the required dependencies like
- Docker
- Kind cluster
Expand All @@ -25,7 +35,7 @@ Our automated installation process is setting up all the required dependencies l
- Go
- Helm

>_Note: Once the Engine installed your k8s context will be switched automatically to new cluster._
>_Note: Once the Engine installed your k8s context will be switched automatically to new cluster._
Here are installation steps:

Expand All @@ -35,20 +45,34 @@ Here are installation steps:
```bash
make -f ./make/Makefile-local-recipes create-mdai
```

<div class="warning">
<b>Other steps:</b>
While we install docker, you also need to ensure that the docker process is running. You can simply open the Docker app or start the Docker process to ensure the local runs flawlessly.
</a>

### Automated uninstall

Make sure your k8s context is set to `kind-mdai-local` cluster:

```bash
kubectl config get-contexts
```

Switch the context if needed:

```bash
kubectl cluster-info --context kind-mdai-local
```

Run automated de-installation script

```bash
make -f ./make/Makefile-local-recipes delete-mdai
```

If you want to remove all helm artifacts installed (you don't use it your other local setup), run the following

```bash
make -f ./make/Makefile-local-recipes delete-mdai-all
```
Expand Down

0 comments on commit 346a961

Please sign in to comment.