added custom registry content and fixed doc bugs

This commit is contained in:
Mark Bishop
2018-04-29 20:05:14 -07:00
parent b135168608
commit 05124fa372
11 changed files with 47 additions and 31 deletions

View File

@@ -1,5 +1,5 @@
---
title: Load Balancer Configuration
title: Load Balancing
weight: 300
---

View File

@@ -1,8 +1,8 @@
---
title: Option 1—Amazon ALB
title: Configure Amazon ALB
weight: 305
---
# Option 1-Amazon ALB
# Configure Amazon ALB
Amazon Elastic Load Balancing offers a couple of different load balancers that we're tested. This procedure provides step-by-step instruction for configuring Amazon Application Load Balancer (ALB) with your Rancher Server.

View File

@@ -1,8 +1,8 @@
---
title: Option 2—Amazon NLB
title: Configure Amazon NLB
weight: 310
---
# Option 2-Amazon NLB
# Configure Amazon NLB
Amazon Elastic Load Balancing offers a couple of different load balancers that we're tested. This procedure provides step-by-step instruction for configuring Amazon Network Load Balancer (NLB) with your Rancher Server.

View File

@@ -1,8 +1,8 @@
---
title: Option 3—NGINX
title: Configure NGINX
weight: 315
---
# Option 3-NGINX
# Configure NGINX
NGINX is a popular application platform that can be used as a load balancer. Rancher supports use of NGINX with ngx_http_v2_module enabled, which isn't enabled by default. Use the following parameter when setting up NGINX to enable the module: `--with-http_v2_module`.

View File

@@ -1,8 +1,21 @@
---
title: No-Internet Installation
title: Installing From a Private Registry
weight: 350
draft: true
---
# No-Internet Installation
# Installing From a Private Registry
Coming Soon!
If you have a private registry, you can move Rancher into that registry and install it from there.
>**Prerequisite:** It is assumed you either have your own private registry or other means of distributing docker images to your machine. If you need help with creating a private registry, please refer to the [Docker documentation for private registries](https://docs.docker.com/registry/).
1. Browse to https://github.com/rancher/rancher/releases/tag/v2.0.0-beta4-rc2 and download all files in the release.
2. Run rancher-save-images.sh in an environment that has access to dockerhub. This script will download all images into a file rancher-images.tar.gz.
3. Copy file to private network (it's a big file).
4. Run rancher-load-images.sh in the same directory as rancher-images.tar.gz to load the archive into private registry.
5. Change /v3/settings/system-default-registry to your private registry. The setting will be added to the UI, not currently there though.

View File

@@ -1,5 +1,5 @@
---
title: Server Installation
title: Rancher Server Installation
weight: 225
---
@@ -8,3 +8,6 @@ weight: 225
This section contains instructions for setting up Rancher Server in development and production environments. The section also contains supplementary documentation for configuring load balancers and SSL certificates to work with Rancher.
Choose from the options below:
- [Install Using Docker](/rancher/installation/server-installation/install-using-docker/)
- [Install Using Kubernettes](/rancher/installation/server-installation/install-using-kubernetes/)

View File

@@ -1,10 +1,10 @@
---
title: Option 1—Install by Docker Container
title: Install Using Docker
weight: 250
description: For development environments, we recommend installing Rancher by deploying a single Docker container.
---
# Install by Docker Container
# Install by Docker
For development environments, we recommend installing Rancher by deploying a single Docker container. In this installation scenario, you'll install Docker on a single Linux host, and then install Rancher on your host using a single Docker container.

View File

@@ -1,8 +1,8 @@
---
title: Option 2—Install by RKE
title: Install Using Kubernetes
weight: 275
---
# Install by RKE
# Install Using Kubernetes
You can deploy Rancher using the Rancher Kubernetes Engine (RKE). RKE is Rancher's own fast and light-weight Kubernetes installer. Rancher installation using RKE is the best install option for two different use cases:

View File

@@ -11,19 +11,19 @@ Rancher is secure by default. This means that SSL is required when interacting w
There are two places where you certificates can be stored and used:
- Inside the `rancher/server` container
- Inside the `rancher/rancher` container
- Using an external loadbalancer or proxy
## Options for inside the `rancher/server` container
## Options for inside the `rancher/rancher` container
### Automatically generated default self signed certificate
By running the `rancher/server` container without any additional parameters or configuration, a self-signed certificate will automatically be created on startup.
By running the `rancher/rancher` container without any additional parameters or configuration, a self-signed certificate will automatically be created on startup.
<u>Example command:</u>
```
docker run -d -p 80:80 -p 443:443 rancher/server:v2.0.0
docker run -d -p 80:80 -p 443:443 rancher/rancher:v2.0.0
```
### Providing your own self-signed certificates to the container
@@ -43,7 +43,7 @@ docker run -d -p 80:80 -p 443:443 \
-v /etc/your_certificate_directory/fullchain.pem:/etc/rancher/ssl/cert.pem \
-v /etc/your_certificate_directory/privkey.pem:/etc/rancher/ssl/key.pem \
-v /etc/your_certificate_directory/cacerts.pem:/etc/rancher/ssl/cacerts.pem \
rancher/server:v2.0.0
rancher/rancher:v2.0.0
```
### Providing your own certificates from a recognized Certificate Authority to the container
@@ -61,19 +61,19 @@ If the certificates you want to use are signed by a recognized Certificate Autho
docker run -d -p 80:80 -p 443:443 \
-v /etc/your_certificate_directory/fullchain.pem:/etc/rancher/ssl/cert.pem \
-v /etc/your_certificate_directory/privkey.pem:/etc/rancher/ssl/key.pem \
rancher/server:v2.0.0
rancher/rancher:v2.0.0
```
### Using automatically requested Let's Encrypt certificates
Rancher supports requesting Let's Encrypt certificates out-of-the-box. This is done using the **http-01 challenge**, this means that the hostname you want to use for accessing Rancher (for example, `rancher.mydomain.com`) will have to point to the IP of the machine it is running on. This can be done by creating an A record in DNS.
As the Let's Encrypt challenge can come from any source IP address, port **TCP/80** needs to be open for every source IP address. You enable the Let's Encrypt functionality by passing the parameter `--acme-domain rancher.mydomain.com` when running the `rancher/server` container.
As the Let's Encrypt challenge can come from any source IP address, port **TCP/80** needs to be open for every source IP address. You enable the Let's Encrypt functionality by passing the parameter `--acme-domain rancher.mydomain.com` when running the `rancher/rancher` container.
<u>Example command:</u>
```
docker run -d -p 80:80 -p 443:443 rancher/server:v2.0.0 --acme-domain rancher.mydomain.com
docker run -d -p 80:80 -p 443:443 rancher/rancher:v2.0.0 --acme-domain rancher.mydomain.com
```
*Note: Let's Encrypt provides rate limits for requesting new certificates, keep this in mind when creating and destroying the container multiple times. Read more on this in the [Let's Encrypt documentation on rate limits](https://letsencrypt.org/docs/rate-limits/).*
@@ -82,11 +82,11 @@ docker run -d -p 80:80 -p 443:443 rancher/server:v2.0.0 --acme-domain rancher.my
### Terminating SSL at loadbalancer or proxy
#### Instructions for the `rancher/server` container
#### Instructions for the `rancher/rancher` container
**Self signed certificates**
When using self signed certificates, you still need to supply the CA certificate to the `rancher/server` container. This will be used to validate connections to Rancher.
When using self signed certificates, you still need to supply the CA certificate to the `rancher/rancher` container. This will be used to validate connections to Rancher.
| Type | Location in container |
| ---------------------------- | ---------------------------: |
@@ -97,7 +97,7 @@ When using self signed certificates, you still need to supply the CA certificate
```
docker run -d -p 80:80 -p 443:443 \
-v /etc/your_certificate_directory/cacerts.pem:/etc/rancher/ssl/cacerts.pem \
rancher/server:v2.0.0
rancher/rancher:v2.0.0
```
**Certificates by a well known Certificate Authority**
@@ -106,7 +106,7 @@ If the certificates you want to use are signed by a recognized Certificate Autho
#### Instructions for the loadbalancer or proxy
When using a loadbalancer or proxy in front of the `rancher/server` container, there is no need for the `rancher/server` container to redirect port **TCP/80** (HTTP) to port **TCP/443** (HTTPS). By passing the header `X-Forwarded-Proto: https` header, this redirect will be disabled.
When using a loadbalancer or proxy in front of the `rancher/rancher` container, there is no need for the `rancher/rancher` container to redirect port **TCP/80** (HTTP) to port **TCP/443** (HTTPS). By passing the header `X-Forwarded-Proto: https` header, this redirect will be disabled.
The loadbalancer or proxy has to be configured to support the following:
@@ -115,7 +115,7 @@ The loadbalancer or proxy has to be configured to support the following:
| Header | Value | Description |
| -------------------- | ----------------------------------------- | :----------------------------------------------------------- |
| `Host` | Domain name that is used to reach Rancher | To identify the server requested by the client |
| `X-Forwarded-Proto` | `https` | To identify the protocol that a client used to connect to the loadbalancer or proxy<br />*If this Header is present, `rancher/server` will not redirect HTTP to HTTPS* |
| `X-Forwarded-Proto` | `https` | To identify the protocol that a client used to connect to the loadbalancer or proxy<br />*If this Header is present, `rancher/rancher` will not redirect HTTP to HTTPS* |
| `X-Forwarded-Port` | Port used to reach Rancher | To identify the protocol that client used to connect to the loadbalancer or proxy |
| `X-Forwarded-For` | IP of the client connection | To identify the originating IP address of a client |
@@ -168,7 +168,7 @@ server {
- How do I validate my certificate chain?
You can validate the certificate chain by using the `openssl` binary. If the output ends with `Verify return code: 0 (ok)`, your certificate chain is valid. The `ca.pem` file should be the same as you supplied to the `rancher/server` container. When using a certificate signed by a well known Certificate Authority, you can omit the `-CAfile` parameter.
You can validate the certificate chain by using the `openssl` binary. If the output ends with `Verify return code: 0 (ok)`, your certificate chain is valid. The `ca.pem` file should be the same as you supplied to the `rancher/rancher` container. When using a certificate signed by a well known Certificate Authority, you can omit the `-CAfile` parameter.
<u>Example command:</u>
```

View File

@@ -82,7 +82,7 @@ To install Rancher on your host, connect to it and then use a shell to install.
2. From your shell, enter the following command:
```
$ sudo docker run -d --restart=unless-stopped -p 80:80 -p 443:443 rancher/server
$ sudo docker run -d --restart=unless-stopped -p 80:80 -p 443:443 rancher/rancher
```
**Result:** Rancher is installed.

View File

@@ -7,7 +7,7 @@ weight: 3350
You can use Rancher to create a cluster using Microsoft Azure Container Service.
{{< beta-note_azure >}}
{{< beta-note_azure >}
1. From the **Clusters** page, click **Add Cluster**.