Skip to content

Commit

Permalink
[Docs] Update AWS install pre-requisite and text (mlrun#2926)
Browse files Browse the repository at this point in the history
  • Loading branch information
gilad-shaham authored Jan 16, 2023
1 parent 5307ab6 commit 7b90bf9
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions docs/install/aws-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,29 @@ For AWS users, the easiest way to install MLRun is to use a native AWS deploymen

## Prerequisites

An AWS account with permissions that include the ability to:
- Run a CloudFormation stack
- Create an EKS cluster
- Create EC2 instances
- Create VPC
- Create S3 buckets
- Deploy and pull images from ECR
1. An AWS account with permissions that include the ability to:
- Run a CloudFormation stack
- Create an EKS cluster
- Create EC2 instances
- Create VPC
- Create S3 buckets
- Deploy and pull images from ECR

For the full set of required permissions, **{Download}`download the IAM policy<./aws_policy.json>`** or expand & copy the IAM policy below:
For the full set of required permissions, **{Download}`download the IAM policy<./aws_policy.json>`** or expand & copy the IAM policy below:

````{dropdown} show the IAM policy
```{literalinclude} ./aws_policy.json
:language: json
```
````
````{dropdown} show the IAM policy
```{literalinclude} ./aws_policy.json
:language: json
```
````

For more information, see [how to create a new AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/) and [policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html).
For more information, see [how to create a new AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/) and [policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html).


2. You need to have a Route53 domain configured in the same AWS account and specify the full domain name in **Route 53 hosted DNS domain** configuration (See [Step 11](#route53_config) below). External domain registration is currently not supported. For more information see [What is Amazon Route 53?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html).

```{admonition} Notes
- To access the instances, you need to have at least one key pair for SSH keys (**See step 9** in [Configuration settings](#configuration-settings)). For more information see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html).
- You need to have a Route53 domain configured (**See step 11** in [Configuration settings](#configuration-settings) in Configuration settings). External domain registration is currently not supported. For more information see [What is Amazon Route 53?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html).
- The MLRun software is free of charge, however, there is a cost for the AWS infrastructure services such as EKS, EC2, S3 and ECR. The actual pricing depends on a large set of factors including, for example, the region, the number of EC2 instances, the amount of storage consumed, and the data transfer costs. Other factors include, for example, reserved instance configuration, saving plan, and AWS credits you have associated with your account. It is recommended to use the [AWS pricing calculator](https://calculator.aws) to calculate the expected cost, as well as the [AWS Cost Explorer](https://aws.amazon.com/aws-cost-management/aws-cost-explorer/) to manage the cost, monitor and set-up alerts.
The MLRun software is free of charge, however, there is a cost for the AWS infrastructure services such as EKS, EC2, S3 and ECR. The actual pricing depends on a large set of factors including, for example, the region, the number of EC2 instances, the amount of storage consumed, and the data transfer costs. Other factors include, for example, reserved instance configuration, saving plan, and AWS credits you have associated with your account. It is recommended to use the [AWS pricing calculator](https://calculator.aws) to calculate the expected cost, as well as the [AWS Cost Explorer](https://aws.amazon.com/aws-cost-management/aws-cost-explorer/) to manage the cost, monitor and set-up alerts.
```

## Post deployment expectations
Expand All @@ -48,7 +48,7 @@ Make sure you are logged in to the correct AWS account.

**Click the button below to deploy MLRun.**

<a href="https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateUrl=https%3A%2F%2Fmlrun-ce-cfn.s3.us-east-2.amazonaws.com%2Fquickstart-amazon-eks%2Ftemplates%2Figuazio-mlrun-kit-entrypoint-new-vpc.template.yaml&stackName=MLrun-community&param_AdditionalEKSAdminUserArn=&param_AvailabilityZones%5B%5D=&param_ClusterDomain=&param_DeployMLRunKit=true&param_EKSClusterName=&param_KeyPairName=&param_MLrunKitVersion=&param_NodeInstanceFamily=Standard&param_NodeInstanceType=m5.2xlarge&param_NumberOfAZs=3&param_MaxNumberOfNodes=3&param_ProvisionBastionHost=Enabled&param_RegistryDomainName=index.docker.io&param_RegistryEmail=&param_RegistrySuffix=%2Fv1%2F&param_RegistryUsername=&param_RemoteAccessCIDR="><img src="../_static/images/aws_launch_stack.png"></img></a>
<a href="https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateUrl=https%3A%2F%2Fmlrun-ce-cfn.s3.us-east-2.amazonaws.com%2Fquickstart-amazon-eks%2Ftemplates%2Figuazio-mlrun-kit-entrypoint-new-vpc.template.yaml&stackName=mlrun-community"><img src="../_static/images/aws_launch_stack.png"></img></a>

After clicking the icon, the browser directs you to the CloudFormation stack page in your AWS account, or redirects you to the AWS login page if you are not currently logged in.

Expand All @@ -72,24 +72,26 @@ You must fill in fields marked as mandatory (m) for the configuration to complet
**Amazon EKS configuration**

6. **Additional EKS admin ARN (IAM user)** (o) &mdash; add an additional admin user to the instance. Users can be added after the stack has been created. For more information see [Create a kubeconfig for Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html).
7. **Instance type** (m) &mdash; select from the dropdown list. The default is m5.2xlarge. For size considerations see [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/).
7. **Instance type** (m) &mdash; select from the dropdown list. The default is m5.4xlarge. For size considerations see [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/).
8. **Maximum Number of Nodes** (m) &mdash; maximum number of nodes in the cluster. The minimum value of this parameter must match the number of **Availability Zones**. The number of nodes combined with the **Instance type** determines the AWS infrastructure cost.

**Amazon EC2 configuration**

9. **SSH key name** (m) &mdash; select from the stored keys in the dropdown. The list is based on the SSH keys that are in your account. For more information about SSH Keys see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html).
9. **SSH key name** (o) &mdash; Users who wish to access the EC2 instance via SSH can enter an existing key. If left empty, it is possible to access the EC2 instance using the AWS Systems Manager Session Manager. For more information about SSH Keys see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html).

10. **Provision bastion host** (m) &mdash; create a bastion host for SSH access to the Kubernetes nodes. The default is enabled. This allows ssh access to your EKS EC2 instances through a public IP.

**Iguazio MLRun configuration**

<a id="route53_config" />

11. **Route 53 hosted DNS domain** (m) &mdash; Enter the name of your registered Route53 domain. **Only route53 domains are acceptable.**

12. **The URL of your REDIS database** (o) &mdash; This is only required if you're using Redis with the online feature store. See [how to configure the online feature store](#configure-online-feature-store) for more details.

**Other parameters**

13. **MLrunCeVersion** (m) &mdash; the MLRun Community Edition version to install. Leave the default value for the latest CE release.
13. **MLRun CE Helm Chart version** (m) &mdash; the MLRun Community Edition version to install. Leave the default value for the latest CE release.

**Capabilities**

Expand Down

0 comments on commit 7b90bf9

Please sign in to comment.