From c267445d5648a89e85ddbd9647516b390fb08b44 Mon Sep 17 00:00:00 2001 From: Chris Kim Date: Mon, 6 Aug 2018 09:45:22 -0700 Subject: [PATCH 1/2] Adding Amazon AWS Quickstart Documentation --- .../en/quick-start-guide/deployment/_index.md | 2 + .../deployment/amazon-aws-qs/_index.md | 58 +++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md diff --git a/content/rancher/v2.x/en/quick-start-guide/deployment/_index.md b/content/rancher/v2.x/en/quick-start-guide/deployment/_index.md index cfccadb294d..4ce36eb9634 100644 --- a/content/rancher/v2.x/en/quick-start-guide/deployment/_index.md +++ b/content/rancher/v2.x/en/quick-start-guide/deployment/_index.md @@ -7,6 +7,8 @@ The following are the current guides for provisioning Rancher Server and a clust - [DigitalOcean Quick Start](./digital-ocean-qs) - We provide you with a Terraform configuration file that completely automates the set up of the Rancher Server and registers a cluster for you to get started with. +- [Amazon AWS Quick Start](./amazon-aws-qs) - We provide you with an Amazon-specific Terraform configuration file that completely automates the set up of the Rancher Server and registers a cluster for you to get started with. + - [Vagrant Quick Start](./quickstart-vagrant) - We provide you with a Vagrant configuration that again completely automates the set up of the Rancher Server and registers a cluster for you to get started with. - [Manual Quick Start](./quickstart-manual-setup) - This will guide you through the process and requirements of manually setting up Rancher in any environment. diff --git a/content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md b/content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md new file mode 100644 index 00000000000..c074bcdeea4 --- /dev/null +++ b/content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md @@ -0,0 +1,58 @@ +--- +title: Amazon AWS Quick Start +weight: 100 +--- +The following steps will quickly deploy a Rancher Server with a single node cluster attached + +## Prerequisites + +>**Note** +>Deploying to Amazon AWS will incur charges. + +- [Amazon AWS Account](https://aws.amazon.com/account/): An Amazon AWS Account is required to create resources for deploying Rancher and Kubernetes +- [Amazon AWS Access Key](https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html): Use this link to follow a tutorial to create an Amazon AWS Access Key if you don't have one yet. +- [Terraform](https://www.terraform.io/downloads.html): Used to provision the server and cluster in Amazon AWS. + + +## Getting Started + +1. Clone [Rancher Quickstart](https://github.com/rancher/quickstart) to a folder using `git clone https://github.com/rancher/quickstart`. + +2. Go into the AWS folder containing the terraform file by executing `cd quickstart/aws`. + +3. Rename the `terraform.tfvars.example` file to `terraform.tfvars`. + +4. Edit `terraform.tfvars` and customize the following variables at minimum. To change node counts and sizes, see node sizes + + - `aws_access_key` - Amazon AWS Access Key + - `aws_secret_key` - Amazon AWS Secret Key + - `ssh_key_name` - Amazon AWS Key Pair Name + - `prefix` - Resource Prefix + +5. *Optional* Modify the count of the various node types within `terraform.tfvars`. See the [Quickstart Readme](https://github.com/rancher/quickstart) for more information on the variables. + +6. Run `terraform init`. + +7. To initiate the creation of the environment, run `terraform apply`. Then wait for the following output: + + ``` + Apply complete! Resources: 3 added, 0 changed, 0 destroyed. + Outputs: + rancher-url = [ + https://xxx.xxx.xxx.xxx + ] + ``` + +8. Paste the `rancher-url` from the output above into the browser. Log in when prompted (default password is `admin`). + +**Result:** Rancher Server and your Kubernetes cluster is installed in Amazon AWS. + +### What's Next? + +Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/workload). + +## Destroying the Environment + +1. From the `quickstart/aws` folder, execute `terraform destroy --auto-approve`. + +2. Wait for confirmation that all resources have been destroyed. From 188bc77d79f9b95348972bc5fb25fba56b339caf Mon Sep 17 00:00:00 2001 From: Mark Bishop <37810556+MBishop17@users.noreply.github.com> Date: Wed, 15 Aug 2018 17:02:47 -0700 Subject: [PATCH 2/2] Made a couple grammar and style tweaks. Added a few missing periods. --- .../quick-start-guide/deployment/amazon-aws-qs/_index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md b/content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md index c074bcdeea4..ed8c6e56580 100644 --- a/content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md +++ b/content/rancher/v2.x/en/quick-start-guide/deployment/amazon-aws-qs/_index.md @@ -2,14 +2,14 @@ title: Amazon AWS Quick Start weight: 100 --- -The following steps will quickly deploy a Rancher Server with a single node cluster attached +The following steps will quickly deploy a Rancher Server with a single node cluster attached. ## Prerequisites >**Note** >Deploying to Amazon AWS will incur charges. -- [Amazon AWS Account](https://aws.amazon.com/account/): An Amazon AWS Account is required to create resources for deploying Rancher and Kubernetes +- [Amazon AWS Account](https://aws.amazon.com/account/): An Amazon AWS Account is required to create resources for deploying Rancher and Kubernetes. - [Amazon AWS Access Key](https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html): Use this link to follow a tutorial to create an Amazon AWS Access Key if you don't have one yet. - [Terraform](https://www.terraform.io/downloads.html): Used to provision the server and cluster in Amazon AWS. @@ -22,14 +22,14 @@ The following steps will quickly deploy a Rancher Server with a single node clus 3. Rename the `terraform.tfvars.example` file to `terraform.tfvars`. -4. Edit `terraform.tfvars` and customize the following variables at minimum. To change node counts and sizes, see node sizes +4. Edit `terraform.tfvars` and customize the following variables at minimum. To change node counts and sizes, see `node sizes`. - `aws_access_key` - Amazon AWS Access Key - `aws_secret_key` - Amazon AWS Secret Key - `ssh_key_name` - Amazon AWS Key Pair Name - `prefix` - Resource Prefix -5. *Optional* Modify the count of the various node types within `terraform.tfvars`. See the [Quickstart Readme](https://github.com/rancher/quickstart) for more information on the variables. +5. **Optional:** Modify the count of the various node types within `terraform.tfvars`. See the [Quickstart Readme](https://github.com/rancher/quickstart) for more information on the variables. 6. Run `terraform init`.