From 35634b781caa1a4073e601b2e7b6ee02319bc3cd Mon Sep 17 00:00:00 2001 From: Chris Urwin Date: Wed, 11 Jul 2018 13:43:33 +0100 Subject: [PATCH] Updates following feedback --- .../deployment/digital-ocean-qs/_index.md | 31 ++++++++++--------- .../deployment/quickstart-vagrant/_index.md | 24 +++++++------- .../_index.md | 16 +++++----- .../_index.md | 2 +- 4 files changed, 38 insertions(+), 35 deletions(-) diff --git a/content/rancher/v2.x/en/quick-start-guide/deployment/digital-ocean-qs/_index.md b/content/rancher/v2.x/en/quick-start-guide/deployment/digital-ocean-qs/_index.md index 33f5d811453..ecef799ca86 100644 --- a/content/rancher/v2.x/en/quick-start-guide/deployment/digital-ocean-qs/_index.md +++ b/content/rancher/v2.x/en/quick-start-guide/deployment/digital-ocean-qs/_index.md @@ -2,28 +2,31 @@ title: Digital Ocean Quick Start weight: 100 --- -The following steps will allow you to quickly deploy a Rancher Server with a 3 node cluster attached in about 5 minutes +The following steps will allow you to quickly deploy a Rancher Server with a 3-node cluster attached. >**Note** ->Using this will incur charges at Digital Ocean +>Deploying to Digital Ocean will incur charges. ## Prerequisites -- [Digital Ocean Account](https://www.digitalocean.com) - You will require an account on Digital Ocean as this is where the server and cluster will run -- [Terraform](https://www.terraform.io/downloads.html) - This is used to provision the server and cluster to Digital Ocean +- [Digital Ocean Account](https://www.digitalocean.com) - You will require an account on Digital Ocean as this is where the server and cluster will run. +- [Digital Ocean Access Key](https://www.digitalocean.com/community/tutorials/how-to-create-a-digitalocean-space-and-api-key) - Use this link to create a Digital Ocean Access Key if you don't have one. +- [Terraform](https://www.terraform.io/downloads.html) - Used to provision the server and cluster to Digital Ocean. -## Getting going +## Getting Going -1. Clone [Rancher Quickstart](https://github.com/rancher/quickstart) to a folder using `git clone https://github.com/rancher/quickstart` +1. Clone [Rancher Quickstart](https://github.com/rancher/quickstart) to a folder using `git clone https://github.com/rancher/quickstart`. -2. Go into the folder containing the terraform file by executing `cd quickstart/do` +2. Go into the folder containing the terraform file by executing `cd quickstart/do`. -3. Move the file `terraform.tfvars.example` to `terraform.tfvars` and edit (see inline explanation, the minimum you will need to do is add your Digital Ocean Access Key) +3. Rename file `terraform.tfvars.example` to `terraform.tfvars`. -4. For the first time run you will need to run `terraform init` +4. Edit `terraform.tfvars` to include your Digital Ocean Access Key. -5. To initiate the creation of the environment run `terraform apply` +5. For the first time run you will need to run `terraform init`. + +6. To initiate the creation of the environment run `terraform apply`. >**Wait for the the following** > ``` @@ -34,10 +37,10 @@ The following steps will allow you to quickly deploy a Rancher Server with a 3 n ] ``` -6. Paste the URL into the browser and log in (default password is `admin`) +6. Paste the URL into the browser and log in (default password is `admin`). -## Destroying the environment +## Destroying the Environment -1. From the `quickstart/do` folder execute `terraform destroy --force` +1. From the `quickstart/do` folder execute `terraform destroy --force` . -2. Wait for it to confirm that all resources have been destroyed \ No newline at end of file +2. Wait for confirmation that all resources have been destroyed. \ No newline at end of file diff --git a/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-vagrant/_index.md b/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-vagrant/_index.md index 4863b54d3ee..fbd9ae4c848 100644 --- a/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-vagrant/_index.md +++ b/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-vagrant/_index.md @@ -2,29 +2,29 @@ title: Vagrant Quick Start weight: 200 --- -The following steps will allow you to quickly deploy a Rancher Server with a 3 node cluster attached in about 10 minutes +The following steps will allow you to quickly deploy a Rancher Server with a 3-node cluster attached. ## Prerequisites -- [Vagrant](https://www.vagrantup.com) - Vagrant is required as this is used to provision the machine based on the Vagrantfile -- [Virtualbox](https://www.virtualbox.org) - The Virtual Machines that Vagrant provisions need to be provisioned to VirtualBox -- At least 6GB of free RAM +- [Vagrant](https://www.vagrantup.com) - Vagrant is required as this is used to provision the machine based on the Vagrantfile. +- [Virtualbox](https://www.virtualbox.org) - The Virtual Machines that Vagrant provisions need to be provisioned to VirtualBox. +- At least 6GB of free RAM. -## Getting going +## Getting Going -1. Clone [Rancher Quickstart](https://github.com/rancher/quickstart) to a folder using `git clone https://github.com/rancher/quickstart` +1. Clone [Rancher Quickstart](https://github.com/rancher/quickstart) to a folder using `git clone https://github.com/rancher/quickstart`. -2. Go into the folder containing the terraform file by executing `cd quickstart/vagrant` +2. Go into the folder containing the terraform file by executing `cd quickstart/vagrant`. -3. Edit the config.yaml if required (you can change the number of nodes and the memory allocations if required) +3. Edit the config.yaml if required (you can change the number of nodes and the memory allocations if required). -4. To initiate the creation of the environment run `vagrant up` +4. To initiate the creation of the environment run `vagrant up`. -5. Once provisioning has finished go to `https://172.22.101.100` in the browser (default user/password is `admin/password1` you can change this in the config.yaml prior to running the `vagrant up` command) +5. Once provisioning has finished go to `https://172.22.101.100` in the browser (default user/password is `admin/password1` you can change this in the config.yaml prior to running the `vagrant up` command). ## Destroying the environment -1. From the `quickstart/vagrant` folder execute `vagrant destroy -f` +1. From the `quickstart/vagrant` folder execute `vagrant destroy -f` . -2. Wait for it to confirm that all resources have been destroyed \ No newline at end of file +2. Wait for the confirmation that all resources have been destroyed. \ No newline at end of file diff --git a/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md b/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md index ceb3dfa3692..bbc8eb84b69 100644 --- a/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md +++ b/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md @@ -5,7 +5,7 @@ weight: 100 ### Assumptions -- You have a running cluster with at least 1 node +- You have a running cluster with at least 1 node. ### Deploy a Workload @@ -36,9 +36,9 @@ For this workload, you'll be deploying the application Rancher Hello-World. * Your workload is deployed. This process might take a few minutes to complete. * When your workload completes deployment, it's assigned a state of **Active**. You can view this status from the project's **Workloads** page. -### Expose the workload via an ingress +### Expose The Application Via An Ingress -Now that the application is up and running you want to expose it so that browsers and other services can hit it +Now that the application is up and running it needs to be exposed so that otther services can connect. 1. From the **Clusters** page, open the cluster that you just created. @@ -50,19 +50,19 @@ Now that the application is up and running you want to expose it so that browser 5. Click **Add Ingress**. -6. Enter a name i.e. **hello** +6. Enter a name i.e. **hello**. -7. In the **Target* field, drop down the list and choose the name that you set for your service. +7. In the **Target** field, drop down the list and choose the name that you set for your service. 8. Enter `80` in the **Port** field. -9. Leave everything else as default and click **Save** +9. Leave everything else as default and click **Save**. -10. This will create a `xip.io` address that may take a minute or two to populate +10. This will create a `xip.io` address that may take a minute or two to populate. ### View Your Application -From the **Load Balancing** page, click the target link which will look something like **hello.default.xxx.xxx.xxx.xxx.xip.io > hello-world** +From the **Load Balancing** page, click the target link which will look something like **hello.default.xxx.xxx.xxx.xxx.xip.io > hello-world**. Your application will open in a seperate window. diff --git a/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md b/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md index 3b5c8788fe7..8ed84d52c29 100644 --- a/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md +++ b/content/rancher/v2.x/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md @@ -5,7 +5,7 @@ weight: 200 ### Assumptions -- You have a running cluster with at least 1 node +- You have a running cluster with at least 1 node. ### Deploy a Workload