You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/aws/deploy/install-kubeflow.md
+31-18
Original file line number
Diff line number
Diff line change
@@ -17,50 +17,64 @@ deploy Kubeflow on Amazon Web Services (AWS).
17
17
* Enter your preferred AWS Region and default output options.
18
18
* Install [eksctl](https://github.com/weaveworks/eksctl) (version 0.1.31 or newer) and the [aws-iam-authenticator](https://docs.aws.amazon.com/eks/latest/userguide/install-aws-iam-authenticator.html).
19
19
20
-
You do not need to have an existing Amazon Elastic Container Service for Kubernetes (Amazon EKS) cluster. The deployment process will create a cluster for you.
20
+
## EKS cluster
21
+
There're many ways to provision EKS cluster, using AWS EKS CLI, CloudFormation or Terraform, AWS CDK or eksctl.
22
+
Here, we highly recommend you to create an EKS cluster using [eksctl](https://github.com/weaveworks/eksctl).
23
+
24
+
You are required to have an existing Amazon Elastic Container Service for Kubernetes (Amazon EKS) cluster before moving the next step.
21
25
22
26
The installation tool uses the `eksctl` command and doesn't support the `--profile` option in that command.
23
27
If you need to switch role, use the `aws sts assume-role` commands. See the AWS guide to [using temporary security credentials to request access to AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).
24
28
25
29
26
30
## Kubeflow installation
31
+
In order to deploy Kubeflow on your existing Amazon EKS cluster, you need to provide `AWS_CLUSTER_NAME`, `cluster region` and `worker roles`.
32
+
27
33
28
34
1. Download the latest `kfctl` golang binary from [Kubeflow release page](https://github.com/kubeflow/kubeflow/releases) and unpack it.
29
35
30
-
```
36
+
```shell
31
37
# Add kfctl to PATH, to make the kfctl binary easier to use.
*`kfctl_aws.yaml` is one of setup manifests, please check [kfctl_aws_cognito.yaml](https://github.com/kubeflow/kubeflow/blob/master/bootstrap/config/kfctl_aws_cognito.yaml) for the template to enable authentication.
45
47
46
-
- If you plan to use `kfctl` to create a new eks cluster, please remove follow lines in the manifest file.
47
-
- If you want to install on existing EKS cluster, please change roles to your worker node group roles. See [existing cluster](/docs/aws/deploy/existing-cluster) for details.
48
+
1. Customize your config file. Retrieve the Amazon EKS cluster name, AWS Region, and IAM role name for your worker nodes.
1. Run the following commandsto set up your environment and initialize the cluster.
55
+
> Note: To get your Amazon EKS worker node IAM role name, you can check IAM setting by running the following commands. This command assumes that you used `eksctl`to create your cluster. If you use other provisioning tools to create your worker node groups, please find the role that is associated with your worker nodes in the Amazon EC2 console.
55
56
56
-
Since there're many ways to create your cluster, we highly recommend you to get our own eks cluster ready.
57
+
```shell
58
+
aws iam list-roles \
59
+
| jq -r ".Roles[] \
60
+
| select(.RoleName \
61
+
| startswith(\"eksctl-$AWS_CLUSTER_NAME\") and contains(\"NodeInstanceRole\")) \
62
+
.RoleName"
57
63
58
-
Note: If you would like to install Kubeflow on your existing EKS cluster,
59
-
please skip this step and follow the setup instructions for an [existing cluster](/docs/aws/deploy/existing-cluster) instead.
> If you have multiple node groups, you will see corresponding number of node group roles. In that case, please provide the role names as an array.
63
74
75
+
1. Run the following commands to set up your environment and initialize the cluster.
76
+
77
+
```shell
64
78
kfctl init ${KFAPP} --config=${CONFIG} -V
65
79
cd${KFAPP}
66
80
@@ -71,7 +85,6 @@ If you need to switch role, use the `aws sts assume-role` commands. See the AWS
71
85
* KFAPP - Use a relative directory name here rather than absolute path, such as `kfapp`. It will be used as eks cluster name.
72
86
* CONFIG - Path to the configuration file
73
87
74
-
75
88
*Important!!!* By default, these scripts create an AWS Application Load Balancer for Kubeflow that is open to public. This is good for development testing and for short term use, but we do not recommend that you use this configuration for production workloads.
76
89
77
90
To secure your installation, Follow the [instructions](/docs/aws/authentication) to add authentication.
Copy file name to clipboardExpand all lines: content/docs/aws/deploy/uninstall-kubeflow.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,11 @@ weight = 10
5
5
+++
6
6
7
7
8
-
## Uninstall Kubeflow and delete your Amazon EKS cluster.
8
+
## Uninstall Kubeflow
9
9
10
10
```
11
11
cd ${KFAPP}
12
12
kfctl delete all -V
13
13
```
14
14
15
-
> Note: If you installed Kubeflow on an existing Amazon EKS cluster, these scripts won't tear down your cluster in this step. In this case, you must manually delete your cluster.
15
+
> Note: If you installed Kubeflow on an existing Amazon EKS cluster, these scripts won't tear down your cluster in this step. If you want to shutdown EKS cluster, you must manually delete it by yourself.
0 commit comments