mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 12:38:05 +00:00
formatted quickstart
This commit is contained in:
Mark Bishop
Denise
@@ -3,16 +3,12 @@ title: Quick Start Guides
|
||||
short title: Quick Start Index
|
||||
weight: 25
|
||||
---
|
||||
>**Note:** The intent of these quick start guides is to get you up and running in a sandbox environment quickly. It is not intended for a production environment. For more comprehensive instructions, see [Installation]({{< baseurl >}}/rancher/v2.x/en/installation/).
|
||||
|
||||
We are going to continue to grow the content of these quick starts to give you a jump start in deploying and testing Rancher 2.0!
|
||||
|
||||
The current areas covered by quick starts are:
|
||||
|
||||
- **[Deploying Rancher Server]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/deployment/)**: Guides to get you running Rancher via different methods.
|
||||
|
||||
- **[Deploying Workloads]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide//workload/)**: Guides for deploying workloads and exposing it to be accessed externally.
|
||||
>**Note:** The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{< baseurl >}}/rancher/v2.x/en/installation/).
|
||||
|
||||
Howdy buckaroos! Use this section of the docs to jump start your deployment and testing of Rancher 2.0! It contains instructions for a simple Rancher setup and some common use cases. We plan on adding more content to this section in the future.
|
||||
|
||||
We have Quick Start Guides for:
|
||||
|
||||
- [Deploying Rancher Server]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/deployment/): Get started running Rancher using the method most convenient for you.
|
||||
|
||||
- [Deploying Workloads]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide//workload/): Deploy a simple workload and expose it, letting you access it from outside the cluster.
|
||||
|
||||
@@ -1,35 +1,34 @@
|
||||
---
|
||||
title: Digital Ocean Quick Start
|
||||
title: DigitalOcean Quick Start
|
||||
weight: 100
|
||||
---
|
||||
The following steps will allow you to quickly deploy a Rancher Server with a 3-node cluster attached.
|
||||
The following steps will quickly deploy a Rancher Server with a 3-node cluster attached.
|
||||
|
||||
>**Note**
|
||||
>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.
|
||||
- [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.
|
||||
- [Digital Ocean Account](https://www.digitalocean.com): You will require an account on DigitalOcean 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 DigitalOcean Access Key if you don't have one.
|
||||
- [Terraform](https://www.terraform.io/downloads.html): Used to provision the server and cluster to DigitalOcean.
|
||||
|
||||
|
||||
## Getting Going
|
||||
## 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 folder containing the terraform file by executing `cd quickstart/do`.
|
||||
2. Go into the DigitalOcean folder containing the terraform file by executing `cd quickstart/do`.
|
||||
|
||||
3. Rename file `terraform.tfvars.example` to `terraform.tfvars`.
|
||||
3. Rename the `terraform.tfvars.example` file to `terraform.tfvars`.
|
||||
|
||||
4. Edit `terraform.tfvars` to include your Digital Ocean Access Key.
|
||||
|
||||
5. For the first time run you will need to run `terraform init`.
|
||||
5. Run `terraform init`.
|
||||
|
||||
6. To initiate the creation of the environment run `terraform apply`.
|
||||
6. To initiate the creation of the environment, run `terraform apply`. Then wait for the the following output:
|
||||
|
||||
>**Wait for the the following**
|
||||
> ```
|
||||
```
|
||||
Apply complete! Resources: 4 added, 0 changed, 0 destroyed.
|
||||
Outputs:
|
||||
rancher-url = [
|
||||
@@ -37,10 +36,16 @@ 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 `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 on DigitalOcean.
|
||||
|
||||
### 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/do` folder execute `terraform destroy --force` .
|
||||
1. From the `quickstart/do` folder, execute `terraform destroy --force`.
|
||||
|
||||
2. Wait for confirmation that all resources have been destroyed.
|
||||
+32
-27
@@ -12,23 +12,20 @@ Howdy Partner! This tutorial walks you through:
|
||||
|
||||
This Quick Start Guide is divided into different tasks for easier consumption.
|
||||
|
||||
1. [Provision a Linux Host](#provision-a-linux-host)
|
||||
<!-- TOC -->
|
||||
|
||||
Begin by provisioning a Linux host.
|
||||
|
||||
2. [Install Rancher](#install-rancher)
|
||||
1. [Provision a Linux Host](#1-provision-a-linux-host)
|
||||
|
||||
From your Linux host, run the Docker command for installing Rancher.
|
||||
1. [Install Rancher](#2-install-rancher)
|
||||
|
||||
3. [Log In](#log-in)
|
||||
1. [Log In](#3-log-in)
|
||||
|
||||
Browse to your Linux host to access the Rancher UI.
|
||||
1. [Create the Cluster](#4-create-the-cluster)
|
||||
|
||||
4. [Create the Cluster](#create-the-cluster)
|
||||
|
||||
Use the versatile **Custom** option to add your Linux host into a new Kubernetes cluster.
|
||||
|
||||
### Provision a Linux Host
|
||||
<!-- /TOC -->
|
||||
<br/>
|
||||
### 1. Provision a Linux Host
|
||||
|
||||
Begin creation of a custom cluster by provisioning a Linux host. Your host can be:
|
||||
|
||||
@@ -43,15 +40,14 @@ This Quick Start Guide is divided into different tasks for easier consumption.
|
||||
|
||||
Provision the host according to the requirements below.
|
||||
|
||||
{{% accordion id="os" label="Operating System" %}}
|
||||
{{< requirements_os >}}
|
||||
|
||||
**Hardware Requirements**
|
||||
|
||||
- Memory: 4GB
|
||||
|
||||
**Software Requirements**
|
||||
|
||||
- Software: Docker
|
||||
{{% /accordion %}}
|
||||
{{% accordion id="hardware" label="Hardware" %}}
|
||||
Memory: 4GB
|
||||
{{% /accordion %}}
|
||||
{{% accordion id="software" label="Software" %}}
|
||||
Docker
|
||||
|
||||
<a name="node-requirements"></a>**Supported Docker versions:**
|
||||
|
||||
@@ -62,9 +58,10 @@ This Quick Start Guide is divided into different tasks for easier consumption.
|
||||
>**Notes:**
|
||||
>
|
||||
> - For Docker installation instructions, visit their [documentation](https://docs.docker.com/install/).
|
||||
> - Docker requirements apply to both your Linux host and your cluster nodes.
|
||||
|
||||
### Install Rancher
|
||||
> - Docker requirements apply to both your Linux host and your cluster nodes.
|
||||
{{% /accordion %}}
|
||||
<br/>
|
||||
### 2. Install Rancher
|
||||
|
||||
To install Rancher on your host, connect to it and then use a shell to install.
|
||||
|
||||
@@ -78,18 +75,21 @@ To install Rancher on your host, connect to it and then use a shell to install.
|
||||
|
||||
**Result:** Rancher is installed.
|
||||
|
||||
### Log In
|
||||
### 3. Log In
|
||||
|
||||
Log in to Rancher to begin using the application. After you log in, you'll make some one-time configurations.
|
||||
|
||||
1. Open a web browser and enter the IP address of your host: `https://<SERVER_IP>`.<br/><br/>
|
||||
1. Open a web browser and enter the IP address of your host: `https://<SERVER_IP>`.
|
||||
|
||||
Replace `<SERVER_IP>` with your host IP address.
|
||||
|
||||
2. When prompted, create a password for the default `admin` account there cowpoke!
|
||||
|
||||
3. Set the **Rancher Server URL**. The URL can either be an IP address or a host name. However, each node added to your cluster must be able to connect to this URL.<br/><br/>If you use a hostname in the URL, this hostname must be resolvable by DNS on the nodes you want to add to you cluster.
|
||||
|
||||
### Create the Cluster
|
||||
<br/>
|
||||
|
||||
### 4. Create the Cluster
|
||||
|
||||
Welcome to Rancher! You are now able to create your first Kubernetes cluster.
|
||||
|
||||
@@ -118,7 +118,12 @@ In this task, you can use the versatile **Custom** option. This option lets you
|
||||
11. When you finish running the command on your Linux host, click **Done**.
|
||||
|
||||
{{< result_create-cluster >}}
|
||||
|
||||
## Finished
|
||||
<br/>
|
||||
<br/>
|
||||
#### Finished
|
||||
|
||||
Congratulations! You have created your first cluster.
|
||||
|
||||
#### What's Next?
|
||||
|
||||
Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/workload).
|
||||
|
||||
@@ -2,29 +2,37 @@
|
||||
title: Vagrant Quick Start
|
||||
weight: 200
|
||||
---
|
||||
The following steps will allow you to quickly deploy a Rancher Server with a 3-node cluster attached.
|
||||
The following steps 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.
|
||||
- [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 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 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. **Optional:** Edit `config.yaml` to:
|
||||
|
||||
4. To initiate the creation of the environment run `vagrant up`.
|
||||
- Change the number of nodes and the memory allocations, if required.
|
||||
- Change the default user and password for logging into Rancher.
|
||||
|
||||
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).
|
||||
4. To initiate the creation of the environment run, `vagrant up`.
|
||||
|
||||
## Destroying the environment
|
||||
5. Once provisioning finishes, go to `https://172.22.101.100` in the browser. The default user/password is `admin/password1`.
|
||||
|
||||
1. From the `quickstart/vagrant` folder execute `vagrant destroy -f` .
|
||||
**Result:** Rancher Server and your Kubernetes cluster is installed on VirtualBox.
|
||||
|
||||
### 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/vagrant` folder execute `vagrant destroy -f`.
|
||||
|
||||
2. Wait for the confirmation that all resources have been destroyed.
|
||||
@@ -3,6 +3,8 @@ title: Deploying Workloads
|
||||
weight: 200
|
||||
---
|
||||
|
||||
1. [Deploying a workload exposed via an Ingress](./quickstart-deploy-workload-ingress) - This will guide you through creating a workload and exposing it via an Ingress
|
||||
These Quick Start Guides will walk you through deployment of an application. Then they will show you how to expose the application so that you can access it from outside the cluster.
|
||||
|
||||
2. [Deploying a workload exposed via a Nodeport](./quickstart-deploy-workload-nodeport) - This will guide you through creating a workload and exposing it via a Nodeport
|
||||
- [Workload with Ingress Quick Start](./quickstart-deploy-workload-ingress): Create a workload and then expose it using an Ingress.
|
||||
|
||||
- [Workload with NodePort Quick Start](./quickstart-deploy-workload-nodeport): Create a workload and then expose it using a Nodeport.
|
||||
+17
-9
@@ -3,11 +3,11 @@ title: Workload with Ingress Quick Start
|
||||
weight: 100
|
||||
---
|
||||
|
||||
### Assumptions
|
||||
### Prerequisite
|
||||
|
||||
- You have a running cluster with at least 1 node.
|
||||
You have a running cluster with at least 1 node.
|
||||
|
||||
### Deploy a Workload
|
||||
### 1. Deploying a Workload
|
||||
|
||||
You're ready to create your first _workload_. A workload is an object that includes pods along with other files and info needed to deploy your application.
|
||||
|
||||
@@ -36,9 +36,10 @@ 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 Application Via An Ingress
|
||||
<br/>
|
||||
### 2. Expose The Application Via An Ingress
|
||||
|
||||
Now that the application is up and running it needs to be exposed so that otther services can connect.
|
||||
Now that the application is up and running it needs to be exposed so that other services can connect.
|
||||
|
||||
1. From the **Clusters** page, open the cluster that you just created.
|
||||
|
||||
@@ -58,14 +59,21 @@ Now that the application is up and running it needs to be exposed so that otther
|
||||
|
||||
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.
|
||||
**Result:** The application is assigned a `xip.io` address and exposed. It 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.
|
||||
Your application will open in a separate window.
|
||||
|
||||
## Finished
|
||||
#### Finished
|
||||
|
||||
Congratulations! You have successfully deployed a workload exposed via an ingress.
|
||||
|
||||
#### What's Next?
|
||||
|
||||
When you're done using your sandbox, destroy the Rancher Server and your cluster. See one of the following:
|
||||
|
||||
- [DigitalOcean: Destroying the Environment]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment)
|
||||
- [Vagrant: Destroying the Environment]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment)
|
||||
+18
-9
@@ -3,11 +3,11 @@ title: Workload with NodePort Quick Start
|
||||
weight: 200
|
||||
---
|
||||
|
||||
### Assumptions
|
||||
### Prerequisite
|
||||
|
||||
- You have a running cluster with at least 1 node.
|
||||
You have a running cluster with at least 1 node.
|
||||
|
||||
### Deploy a Workload
|
||||
### 1. Deploying a Workload
|
||||
|
||||
You're ready to create your first _workload_. A workload is an object that includes pods along with other files and info needed to deploy your application.
|
||||
|
||||
@@ -50,15 +50,17 @@ 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.
|
||||
|
||||
### View Your Application
|
||||
<br/>
|
||||
|
||||
### 2. Viewing Your Application
|
||||
|
||||
From the **Workloads** page, click the link underneath your workload. If your deployment succeeded, your application opens.
|
||||
|
||||
>**Note**
|
||||
> When using a cloud-hosted virtual machine, you may not have access to the port running the container. In this event, you can test Nginx in an ssh session on the local machine. Use the port number after the `:` in the link under your workload, which is 31568 in this example.
|
||||
>
|
||||
>```sh
|
||||
### Attention: Cloud-Hosted Sandboxes
|
||||
|
||||
When using a cloud-hosted virtual machine, you may not have access to the port running the container. In this event, you can test Nginx in an ssh session on the local machine. Use the port number after the `:` in the link under your workload, which is `31568` in this example.
|
||||
|
||||
```sh
|
||||
gettingstarted@rancher:~$ curl http://localhost:31568
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
@@ -139,6 +141,13 @@ gettingstarted@rancher:~$
|
||||
|
||||
```
|
||||
|
||||
## Finished
|
||||
### Finished
|
||||
|
||||
Congratulations! You have successfully deployed a workload exposed via a NodePort.
|
||||
|
||||
#### What's Next?
|
||||
|
||||
When you're done using your sandbox, destroy the Rancher Server and your cluster. See one of the following:
|
||||
|
||||
- [DigitalOcean: Destroying the Environment]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment)
|
||||
- [Vagrant: Destroying the Environment]({{< baseurl >}}/rancher/v2.x/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment)
|
||||
Reference in New Issue
Block a user