* canonicized aws-marketplace quickstart * canonicized aws quickstart * canonicized azure quickstart * canonicized digital-ocean quickstart * canonicized equinix quickstart * canonicized gcp quickstart
3.8 KiB
title, description
| title | description |
|---|---|
| Rancher DigitalOcean Quick Start Guide | Read this step by step Rancher DigitalOcean guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached. |
The following steps will quickly deploy a Rancher server on DigitalOcean in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.
:::caution
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.
:::
Prerequisites
:::caution
Deploying to DigitalOcean will incur charges.
:::
- DigitalOcean Account: You will require an account on DigitalOcean as this is where the server and cluster will run.
- DigitalOcean Access Key: Use this link to create a DigitalOcean Access Key if you don't have one.
- Terraform: Used to provision the server and cluster to DigitalOcean.
Getting Started
-
Clone Rancher Quickstart to a folder using
git clone https://github.com/rancher/quickstart. -
Go into the DigitalOcean folder containing the Terraform files by executing
cd quickstart/rancher/do. -
Rename the
terraform.tfvars.examplefile toterraform.tfvars. -
Edit
terraform.tfvarsand customize the following variables:do_token- DigitalOcean access keyrancher_server_admin_password- Admin password for created Rancher server (minimum 12 characters)
-
Optional: Modify optional variables within
terraform.tfvars. See the Quickstart Readme and the DO Quickstart Readme for more information. Suggestions include:do_region- DigitalOcean region, choose the closest instead of the default (nyc1)prefix- Prefix for all created resourcesdroplet_size- Droplet size used, minimum iss-2vcpu-4gbbuts-4vcpu-8gbcould be used if within budget
-
Run
terraform init. -
To initiate the creation of the environment, run
terraform apply --auto-approve. Then wait for output similar to the following:Apply complete! Resources: 15 added, 0 changed, 0 destroyed. Outputs: rancher_node_ip = xx.xx.xx.xx rancher_server_url = https://rancher.xx.xx.xx.xx.sslip.io workload_node_ip = yy.yy.yy.yy -
Paste the
rancher_server_urlfrom the output above into the browser. Log in when prompted (default username isadmin, use the password set inrancher_server_admin_password). -
ssh to the Rancher Server using the
id_rsakey generated inquickstart/rancher/do.
Result
Two Kubernetes clusters are deployed into your DigitalOcean account, one running Rancher Server and the other ready for experimentation deployments. Please note that while this setup is a great way to explore Rancher functionality, a production setup should follow our high availability setup guidelines. SSH keys for the VMs are auto-generated and stored in the module directory.
What's Next?
Use Rancher to create a deployment. For more information, see Creating Deployments.
Destroying the Environment
-
From the
quickstart/rancher/dofolder, executeterraform destroy --auto-approve. -
Wait for confirmation that all resources have been destroyed.