mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-26 13:08:11 +00:00
adding global config/install docs.
This commit is contained in:
Mark Bishop
committed by
Denise Schannon
Denise Schannon
parent
09fbbac0db
commit
6e3162a64b
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
title: Load Balancing Configuration
|
||||
draft: true
|
||||
tags: [ "tag", "tag", "tag", "tag" ]
|
||||
layout: single-left
|
||||
|
||||
@@ -1,5 +1,17 @@
|
||||
---
|
||||
title: Rancher Requirements
|
||||
draft: true
|
||||
tags: [ "tag", "tag", "tag", "tag" ]
|
||||
layout: single-left
|
||||
categories:
|
||||
- ""
|
||||
- ""
|
||||
---
|
||||
|
||||
# Rancher Requirements
|
||||
|
||||
Before you install {{< product >}}, wrangle up these requirements. Yip! Yip! Yah!
|
||||
|
||||
## Operating System Requirements
|
||||
|
||||
- Ubuntu 16.04 (64-bit)
|
||||
@@ -11,9 +23,9 @@
|
||||
- Memory: 4GB
|
||||
|
||||
|
||||
## Software requirements
|
||||
## Software Requirements
|
||||
|
||||
- Software: Docker
|
||||
- Docker
|
||||
|
||||
<a name="node-requirements"></a>**Supported Versions:**
|
||||
|
||||
@@ -35,25 +47,27 @@ When provisioning your Linux host, open the ports listed below so that your mast
|
||||
Protocol | Direction | Port Range | Purpose
|
||||
--|---|---|--
|
||||
TCP | Inbound | 22 | SSH server
|
||||
TCP | Inbound | 80 | Canal
|
||||
TCP | Inbound | 443 | Canal
|
||||
TCP | Inbound | 80 | ?
|
||||
TCP | Inbound | 443 | ?
|
||||
TCP | Inbound | 6443 | Kubernetes API server
|
||||
TCP | Inbound | 2379-2380 | etcd server client API
|
||||
TCP | Inbound | 10250 | kubelet API
|
||||
TCP | Inbound | 10251 | scheduler
|
||||
TCP | Inbound | 10252 | controller
|
||||
TCP | Inbound | 10256 | kubeproxy
|
||||
UDP | Inbound | 8472 | Canal
|
||||
|
||||
### Worker Nodes
|
||||
|
||||
Protocol | Direction | Port Range | Purpose
|
||||
--|---|---|--
|
||||
TCP | Inbound | 22 | SSH Server
|
||||
TCP | Inbound | 80 | Canal
|
||||
TCP | Inbound | 443 | Canal
|
||||
TCP | Inbound | 80 | ?
|
||||
TCP | Inbound | 443 | ?
|
||||
TCP | Inbound | 10250 | kubelet API
|
||||
TCP | Inbound | 10256 | kubeproxy
|
||||
TCP | Inbound | 30000-32767 | NodePort Services
|
||||
UDP | Inbound | 8472 | Canal
|
||||
|
||||
## Additional Requirements
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "Rancher Server Installation"
|
||||
date: {{ .Date }}
|
||||
title: Rancher Server Installation
|
||||
draft: true
|
||||
tags: [ "install" ]
|
||||
layout: list
|
||||
|
||||
+1
-2
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
title: Multi-Node Installation
|
||||
draft: true
|
||||
tags: [ "tag", "tag", "tag", "tag" ]
|
||||
layout: single-left
|
||||
@@ -1,18 +0,0 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
draft: true
|
||||
tags: [ "tag", "tag", "tag", "tag" ]
|
||||
layout: single-left
|
||||
categories:
|
||||
- ""
|
||||
- ""
|
||||
---
|
||||
|
||||
# Single Node Installation
|
||||
|
||||
## Option 1: Single Container Install
|
||||
|
||||
## Option 2: Single Container With External ETCD
|
||||
|
||||
## Option 3: Local Cluster Install
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Single Node Installation
|
||||
draft: true
|
||||
tags: [ "tag", "tag", "tag", "tag" ]
|
||||
layout: single-left
|
||||
categories:
|
||||
- ""
|
||||
- ""
|
||||
---
|
||||
# Single Container Install
|
||||
|
||||
{{< prereq_install >}}
|
||||
|
||||
## To Install Rancher Server
|
||||
|
||||
Install {{< product >}} by connecting to your Linux host and running the single container installation command.
|
||||
|
||||
1. Log in to your Linux host using your preferred shell, such as PuTTy or a remote Terminal connection.
|
||||
|
||||
2. From your shell, enter the following command:
|
||||
|
||||
```
|
||||
$ sudo docker run -d --restart=unless-stopped -p 80:80 -p 443:443 rancher/server
|
||||
```
|
||||
|
||||
>**Tip:** You can install different versions of {{< product >}} Server by using different [Server Tags](../../server-tags/).
|
||||
|
||||
**Result:** Rancher is installed.
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
title: Rancher Server Tags
|
||||
draft: true
|
||||
tags: [ "tag", "tag", "tag", "tag" ]
|
||||
layout: single-left
|
||||
@@ -10,3 +9,11 @@ categories:
|
||||
---
|
||||
|
||||
# Rancher Server Tags
|
||||
|
||||
{{< product >}} Server has two different tags that you can use during installation.
|
||||
|
||||
- `rancher/server:latest`: Our latest development builds. These builds are validated through our CI automation framework. These releases aren't for production environments.
|
||||
|
||||
- `rancher/server:stable`: Our latest stable release builds. This tag is recommended for production.
|
||||
|
||||
Please don't use any release with a `rc{n}` suffix. These rc builds are meant for the {{< product >}} team to test out builds.
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
title: SSL Configuration
|
||||
draft: true
|
||||
tags: [ "tag", "tag", "tag", "tag" ]
|
||||
layout: single-left
|
||||
|
||||
-87
@@ -1,87 +0,0 @@
|
||||
# Configuring User Authentication
|
||||
|
||||
You have three options for user authentication in {{< product >}}. We recommend using an external authentication method (i.e. Active Directory or GitHub) rather than local authentication. External authentication reduces upkeep of your users.
|
||||
|
||||
- **Active Directory**: Enterprises can use Active Directory (AD) for authentication, allowing users to sign in using their corporate credentials.
|
||||
|
||||
- **GitHub**: Open source projects or organizations that use GitHub for source control may prefer that users sign in using their GitHub accounts.
|
||||
|
||||
- **Local Authentication**: If you don't want to use external authentication, you can always add users directly to {{< product >}}. We recommend using external authentication over local authentication.
|
||||
|
||||
## Configure an Authentication Method
|
||||
|
||||
### To Configure Active Directory
|
||||
|
||||
>**Prerequisites:** Create a service account in Active Directory with **read-only** access. {{< product >}} uses this account to verify group membership when a user makes a request using an API key.
|
||||
|
||||
1. From the **Global** view, select **Security > Authentication** from the main menu.
|
||||
|
||||
2. Select **Active Directory**.
|
||||
|
||||
3. Complete the **Configure an Active Directory server** form.
|
||||
|
||||
You may need to log in to your domain controller to find the information requested in the form.
|
||||
|
||||
>**Using TLS?**
|
||||
>
|
||||
Make sure you have an [LDAP certificate installed](placeholder.md).
|
||||
|
||||
>**User Search Base vs. Group Search Base**
|
||||
>
|
||||
>When configuring AD authentication, you must enter a search base for your users. This base allows Rancher to search for users that are in your Active Directory.
|
||||
- If your users and groups are in the search base, complete only the User Search Base.
|
||||
- If your groups are in a different search base, you can optionally complete the Group Search Base. This field is dedicated to searching groups, but is not required.
|
||||
|
||||
4. If your Active Directory deviates from the standard AD schema, complete the **Customize Schema** form to match it. Otherwise, skip this step.
|
||||
|
||||
5. Enter your AD username and password in **Test and enable authentication** to confirm that Rancher is configured to use AD authentication.
|
||||
|
||||
### To Configure GitHub
|
||||
|
||||
1. From the **Global** view, select **Security > Authentication** from the main menu.
|
||||
|
||||
2. Select **GitHub**.
|
||||
|
||||
3. Follow the directions displayed to **Setup a GitHub Application**. Rancher redirects you to GitHub to complete registration.
|
||||
|
||||
>**What's an Authorization Callback URL?**
|
||||
>
|
||||
>The Authorization Callback URL is the URL where users to begin using your application (i.e. the splash screen).
|
||||
|
||||
>When you use external authentication, sign on authentication does not actually take place in your application. Instead, authentication takes place externally (in this case, GitHub). After this external authorization completes successfully, the Authorization Callback URL is the location that the user reenters your application.
|
||||
|
||||
4. From GitHub, copy the **Client ID** and **Client Secret**. Paste them into {{< product >}}.
|
||||
|
||||
>**Where do I find the Client ID and Client Secret?**
|
||||
>
|
||||
>From GitHub, select Settings > Developer Settings > OAuth Apps. The Client ID and Client Secret are displayed prominently.
|
||||
|
||||
5. Click **Authenticate with GitHub**.
|
||||
|
||||
6. Use the **Site Access** options to configure the scope of user authorization.
|
||||
|
||||
- **Allow any valid Users**
|
||||
|
||||
_Any_ GitHub user can access Rancher. We generally discourage use of this setting!
|
||||
|
||||
- **Allow members of Clusters, Projects, plus Authorized Users and Organizations**
|
||||
|
||||
Any GitHub user or group added as a **Cluster Member** or **Project Member** can log in to Rancher. Additionally, any GitHub user or group you add to the **Authorized Users and Organizations** list may log in to Rancher.
|
||||
|
||||
- **Restrict access to only Authorized Users and Organizations**
|
||||
|
||||
Only GitHub users or groups added to the Authorized Users and Organizations can log in to Rancher.
|
||||
<br/>
|
||||
7. Click **Save**.
|
||||
|
||||
**Result:**
|
||||
|
||||
- GitHub authentication is configured.
|
||||
- You are signed into Rancher with your GitHub account.
|
||||
- Your GitHub account is added to Rancher as an administrator.
|
||||
|
||||
### To Configure Local Authentication
|
||||
|
||||
1. From the **Global** view, select **Users** from the main menu.
|
||||
|
||||
2. Click **Add User**. Then complete the **Add User** form. Click **Create** when you're done.
|
||||
@@ -0,0 +1,19 @@
|
||||
# Node Drivers
|
||||
|
||||
## Adding Custom Node Drivers
|
||||
|
||||
If you create a cluster using a cloud provider that {{< product >}} doesn't support out-of-the-box, you may need to add the provider's drivers (or create them yourself) so that your nodes function properly.
|
||||
|
||||
1. From the **Global** view, select **Node Drivers** from the main menu.
|
||||
|
||||
2. Click **Add Node Driver**.
|
||||
|
||||
3. Complete the **Add Node Driver** form. Then click **Create**.
|
||||
|
||||
## Activating Node Drivers
|
||||
|
||||
Using the **Custom** option, you can create a cluster using virtually any cloud provider. However, by default, {{< product >}} only activates drivers for the most popular cloud providers. If you want to use another provider, you'll have to activate their drivers.
|
||||
|
||||
1. From the **Global** view, select **Node Drivers** from the main menu.
|
||||
|
||||
2. Select the inactive drivers that you want to use. Then click **Add Node Driver**.
|
||||
@@ -1,4 +1,4 @@
|
||||
<blockquote>
|
||||
<strong>Note:</strong>
|
||||
<p>As of {{< product >}} {{< version >}} GA, the Azure Container Service option is still in beta.</p>
|
||||
<p>As of Rancher v2.0 GA, the Azure Container Service option is still in beta.</p>
|
||||
</blockquote>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<blockquote>
|
||||
<p>
|
||||
<strong>Prerequisites:</strong> Review the [requirements](placeholder.md) for your Linux host.
|
||||
<strong>Prerequisites:</strong> Review the <a href="../../content/rancher/installation/requirements">Requirements</a> for your Linux host.
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
<div>
|
||||
<h2>Before You Start</h2>
|
||||
<p>Provision a Linux host according to our <a href="../../content/rancher/installation/requirements">Requirements</a>.</p>
|
||||
</div>
|
||||
Reference in New Issue
Block a user