mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 12:38:05 +00:00
fixing single node install content per Denise's feedback
This commit is contained in:
Mark Bishop
committed by
Denise Schannon
Denise Schannon
parent
daa6b625a5
commit
b1df99f1f5
@@ -10,53 +10,41 @@ For development environments, we recommend installing Rancher by running a singl
|
||||
>**Want to use an external load balancer?**
|
||||
> See [Single Node Install with an External Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/single-node-install-external-lb) instead.
|
||||
|
||||
|
||||
## 1. Provision Linux Host
|
||||
|
||||
Provision a single Linux host to launch your {{< product >}} Server.
|
||||
Provision a single Linux host to launch your Rancher Server.
|
||||
|
||||
### Requirements
|
||||
|
||||
|
||||
{{% accordion id="os" label="Operating Systems" %}}
|
||||
{{% tabs %}}
|
||||
{{% tab "Operating Systems" %}}
|
||||
{{< requirements_os >}}
|
||||
{{% /accordion %}}
|
||||
{{% accordion id="hardware" label="Hardware" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "Hardware" %}}
|
||||
{{< requirements_hardware >}}
|
||||
{{% /accordion %}}
|
||||
{{% accordion id="software" label="Software" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "Software" %}}
|
||||
{{< requirements_software >}}
|
||||
{{< note_server-tags >}}
|
||||
{{% /accordion %}}
|
||||
{{% accordion id="ports" label="Ports" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "Ports" %}}
|
||||
The following diagram depicts the basic port requirements for Rancher. For a comprehensive list, see [Port Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/references/).
|
||||
|
||||
|
||||
{{% /accordion %}}
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
|
||||
## 2. Choose an SSL Option and Install Rancher
|
||||
|
||||
For security purposes, SSL (Secure Sockets Layer) is required when using Rancher. SSL secures all Rancher network communication, like when you login or interact with a cluster.
|
||||
|
||||
>**Attention Air Gap Users:**
|
||||
> If you are visiting this page to complete an [Air Gap Installation]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL in front of `rancher/rancher:latest`.
|
||||
>**Do you want to...**
|
||||
>
|
||||
> Example:
|
||||
```
|
||||
<REGISTRY.DOMAIN.COM:PORT>/rancher/rancher:latest
|
||||
```
|
||||
|
||||
|
||||
>**Want records of all transactions with the Rancher API?**
|
||||
>- Complete an Air Gap Installation?
|
||||
>- Record all transactions with the Rancher API?
|
||||
>
|
||||
>Enable the [API Auditing]({{< baseurl >}}/rancher/v2.x/en/installation/api-auditing) feature by adding the flags below into your install command.
|
||||
>```
|
||||
-e AUDIT_LEVEL=1 \
|
||||
-e AUDIT_LOG_PATH=/var/log/auditlog/rancher-api-audit.log \
|
||||
-e AUDIT_LOG_MAXAGE=20 \
|
||||
-e AUDIT_LOG_MAXBACKUP=20 \
|
||||
-e AUDIT_LOG_MAXSIZE=100 \
|
||||
```
|
||||
>See [Advanced Options](#advanced-options) below before continuing.
|
||||
|
||||
Choose from the following options:
|
||||
|
||||
@@ -83,7 +71,7 @@ In development or testing environments where your team will access your Rancher
|
||||
After creating your certificate, run the Docker command below to install Rancher. Use the `-v` flag and provide the path to your certificates to mount them in your container.
|
||||
|
||||
- Replace `<CERT_DIRECTORY>` with the directory path to your certificate file.
|
||||
- Replace `<FULL_CHAIN.pem>`,'<PRIVATE_KEY.pem>', and `<CA_CERTS>` with your certificate names.
|
||||
- Replace `<FULL_CHAIN.pem>`,`<PRIVATE_KEY.pem>`, and `<CA_CERTS>` with your certificate names.
|
||||
|
||||
```
|
||||
docker run -d --restart=unless-stopped \
|
||||
@@ -105,7 +93,7 @@ After obtaining your certificate, run the Docker command below.
|
||||
- Use the `-v` flag and provide the path to your certificates to mount them in your container. Because your certificate is signed by a recognized CA, mounting an additional CA certificate file is unnecessary.
|
||||
|
||||
- Replace `<CERT_DIRECTORY>` with the directory path to your certificate file.
|
||||
- Replace `<FULL_CHAIN.pem>` and '<PRIVATE_KEY.pem>' with your certificate names.
|
||||
- Replace `<FULL_CHAIN.pem>` and `<PRIVATE_KEY.pem>` with your certificate names.
|
||||
|
||||
- Use the `--no-cacerts` as argument to the container to disable the default CA certificate generated by Rancher.
|
||||
|
||||
@@ -171,9 +159,7 @@ After you fulfill the prerequisites, you can install Rancher using a Let's Encry
|
||||
{{% /accordion %}}
|
||||
|
||||
|
||||
## What's Next?
|
||||
|
||||
- **Recommended First:** Create a backup of your Rancher Server in case of a disaster scenario: [Single Node Backup and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups-and-restoration/single-node-backup-and-restoration/).
|
||||
- **Recommended:** Review [Single Node Backup and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups-and-restoration/single-node-backup-and-restoration/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use.
|
||||
- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/).
|
||||
|
||||
<br/>
|
||||
@@ -182,11 +168,31 @@ After you fulfill the prerequisites, you can install Rancher using a Let's Encry
|
||||
|
||||
{{< ssl_faq_single >}}
|
||||
|
||||
## Persistent Data
|
||||
## Advanced Options
|
||||
|
||||
### API Auditing
|
||||
|
||||
If you want to record all transations with the Rancher API, enable the [API Auditing]({{< baseurl >}}/rancher/v2.x/en/installation/api-auditing) feature by adding the flags below into your install command.
|
||||
|
||||
-e AUDIT_LEVEL=1 \
|
||||
-e AUDIT_LOG_PATH=/var/log/auditlog/rancher-api-audit.log \
|
||||
-e AUDIT_LOG_MAXAGE=20 \
|
||||
-e AUDIT_LOG_MAXBACKUP=20 \
|
||||
-e AUDIT_LOG_MAXSIZE=100 \
|
||||
|
||||
### Air Gap
|
||||
|
||||
If you are visiting this page to complete an [Air Gap Installation]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL in front of `rancher/rancher:latest`.
|
||||
|
||||
**Example:**
|
||||
|
||||
<REGISTRY.DOMAIN.COM:PORT>/rancher/rancher:latest
|
||||
|
||||
### Persistent Data
|
||||
|
||||
{{< persistentdata >}}
|
||||
|
||||
## Running `rancher/rancher` and `rancher/rancher-agent` on the Same Node
|
||||
### Running `rancher/rancher` and `rancher/rancher-agent` on the Same Node
|
||||
|
||||
In the situation where you want to use a single node to run Rancher and to be able to add the same node to a cluster, you have to adjust the host ports mapped for the `rancher/rancher` container.
|
||||
|
||||
|
||||
+28
-19
@@ -47,23 +47,14 @@ The following diagram depicts the basic port requirements for Rancher. For a com
|
||||
|
||||
For security purposes, SSL (Secure Sockets Layer) is required when using Rancher. SSL secures all Rancher network communication, like when you login or interact with a cluster.
|
||||
|
||||
>**Attention Air Gap Users:**
|
||||
> If you are visiting this page to complete [Air Gap Installation]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/), you must prepend your private registry URL to the server tag when running the installation command in the option that you choose. Replace `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL.
|
||||
>**Do you want to...**
|
||||
>
|
||||
> Example:
|
||||
```
|
||||
<REGISTRY.DOMAIN.COM:PORT>/rancher/rancher:latest
|
||||
```
|
||||
>- Complete an Air Gap Installation?
|
||||
>- Record all transactions with the Rancher API?
|
||||
>
|
||||
>See [Advanced Options](#advanced-options) below before continuing.
|
||||
|
||||
>**Want records of all transactions with the Rancher API?**
|
||||
>
|
||||
>Enable the [API Auditing]({{< baseurl >}}/rancher/v2.x/en/installation/api-auditing) feature by adding the flags below into your install command.
|
||||
>
|
||||
>-e AUDIT_LEVEL=1 \
|
||||
>-e AUDIT_LOG_PATH=/var/log/auditlog/rancher-api-audit.log \
|
||||
>-e AUDIT_LOG_MAXAGE=20 \
|
||||
>-e AUDIT_LOG_MAXBACKUP=20 \
|
||||
>-e AUDIT_LOG_MAXSIZE=100 \
|
||||
Choose from the following options:
|
||||
|
||||
{{% accordion id="option-a" label="Option A-Bring Your Own Certificate: Self-Signed" %}}
|
||||
If you elect to use a self-signed certificate to encrypt communication, you must install the certificate on your load balancer (which you'll do later) and your Rancher container. Run the docker command to deploy Rancher, pointing it toward your certificate.
|
||||
@@ -171,9 +162,7 @@ server {
|
||||
|
||||
## What's Next?
|
||||
|
||||
You have a couple of options:
|
||||
|
||||
- Create a backup of your Rancher Server in case of a disaster scenario: [Single Node Backup and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups-and-restoration/single-node-backup-and-restoration/).
|
||||
- **Recommended:** Review [Single Node Backup and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups-and-restoration/single-node-backup-and-restoration/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use.
|
||||
- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/).
|
||||
|
||||
<br/>
|
||||
@@ -182,6 +171,26 @@ You have a couple of options:
|
||||
|
||||
{{< ssl_faq_single >}}
|
||||
|
||||
## Persistent Data
|
||||
## Advanced Options
|
||||
|
||||
### API Auditing
|
||||
|
||||
If you want to record all transations with the Rancher API, enable the [API Auditing]({{< baseurl >}}/rancher/v2.x/en/installation/api-auditing) feature by adding the flags below into your install command.
|
||||
|
||||
-e AUDIT_LEVEL=1 \
|
||||
-e AUDIT_LOG_PATH=/var/log/auditlog/rancher-api-audit.log \
|
||||
-e AUDIT_LOG_MAXAGE=20 \
|
||||
-e AUDIT_LOG_MAXBACKUP=20 \
|
||||
-e AUDIT_LOG_MAXSIZE=100 \
|
||||
|
||||
### Air Gap
|
||||
|
||||
If you are visiting this page to complete an [Air Gap Installation]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL in front of `rancher/rancher:latest`.
|
||||
|
||||
**Example:**
|
||||
|
||||
<REGISTRY.DOMAIN.COM:PORT>/rancher/rancher:latest
|
||||
|
||||
### Persistent Data
|
||||
|
||||
{{< persistentdata >}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong></p>
|
||||
|
||||
<p>The <code>rancher/rancher</code> container is hosted on <a href="https://hub.docker.com/r/rancher/rancher/tags/">DockerHub</a>. If you don't have access to DockerHub, or you are installing Rancher without an Internet connection, refer to how to prepare for an <a href="/docs/rancher/v2.x/en/installation/air-gap-installation/">Air Gap Installation</a>.</p>
|
||||
<p><strong>Note:</strong></p>
|
||||
<p>For a list of other Rancher Server tags available, refer to <a href="/docs/rancher/v2.x/en/installation/server-tags/">Rancher Server Tags</a>.</p>
|
||||
|
||||
<p><strong>Notes:</strong></p>
|
||||
<ul>
|
||||
<li>If you are using RancherOS, make sure you switch the Docker engine to a supported version using <code>sudo ros engine switch docker-17.03.2-ce</code>
|
||||
</li>
|
||||
<li>The <code>rancher/rancher</code> container is hosted on <a href="https://hub.docker.com/r/rancher/rancher/tags/">DockerHub</a>. If you don't have access to DockerHub, or you are installing Rancher without an Internet connection, refer to how to prepare for an <a href="/docs/rancher/v2.x/en/installation/air-gap-installation/">Air Gap Installation</a>.</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
<div>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Docker</p>
|
||||
<blockquote><strong>Note:</strong>If you are using RancherOS, make sure you switch the Docker engine to a supported version using <code>sudo ros engine switch docker-17.03.2-ce</code></blockquote>
|
||||
<p><strong>Supported Versions</strong></p>
|
||||
|
||||
<p>A supported version of <a href="https://www.docker.com/">Docker</a> is required.</p>
|
||||
<p>Supported Versions:</p>
|
||||
<ul>
|
||||
<li><code>1.12.6</code></li>
|
||||
<li><code>1.13.1</code></li>
|
||||
@@ -11,6 +9,5 @@
|
||||
</ul>
|
||||
<br/>
|
||||
<p><a href="https://docs.docker.com/install/">Docker Documentation: Installation Instructions</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user