public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 04:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

resolve installation page conflicts

Browse Source
This commit is contained in:
Jason Greathouse
2018-08-15 14:17:31 -05:00
parent ab118d891d aecef1306e
commit 87c6f60e1b
19 changed files with 444 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files
config.toml
+8 -1
View File
@@ -1,6 +1,7 @@
baseURL = ""
languageCode = "en-us"
title = "Rancher Labs"
theme = "rancher-website-theme"
themesDir = "node_modules"
pluralizeListTitles = false
@@ -122,10 +123,16 @@ pre = "<i class='material-icons'>keyboard_arrow_down</i>"
#url = "https://rancher.com//customers/"
#weight = "3"
[[menu.main]]
identifier = "customers"
name = "Customers"
url = "/customers/"
weight = "4"
[[menu.main]]
identifier = "learn"
name = "Learn"
weight = "4"
weight = "5"
pre = "<i class='material-icons'>keyboard_arrow_down</i>"
[[menu.main]]
content/os/v1.x/en/about/recovery-console/_index.md
+85
View File
@@ -0,0 +1,85 @@
---
title: How to use recovery console
weight: 304
---
### Test Environment
In order to demonstrate how to use the recovery console, we choose a scene that the disk space is full and the OS cannot boot.
| Term | Definition |
|-----------------------|--------------------------------------------------|
| RancherOS | v1.4.0 |
| Platform | Virtualbox |
| Root Disk | 2GB |
| CPU | 1C |
| MEM | 2GB |
### Fill up the disk
Start this VM to check disk usage:
```
/dev/sda1 ext4 1.8G 567.2M 1.2G 32% /opt
/dev/sda1 ext4 1.8G 567.2M 1.2G 32% /mnt
...
...
```
Fill the remaining space with `dd`:
```
$ cd /opt/
$ dd if=/dev/zero of=2GB.img bs=1M count=2000
dd: writing '2GB.img': No space left on device
1304+0 records in
1302+1 records out
$ ls -ahl
total 1334036
drwxr-xr-x 2 root root 4.0K Jul 19 07:32 .
drwxr-xr-x 1 root root 4.0K Jul 19 06:58 ..
-rw-r--r-- 1 root root 1.3G Jul 19 07:32 2GB.img
```
At this point you cannot reboot in the OS, but you can reboot via Virtualbox:
```
$ shutdown -h now
Failed to write to log, write /var/log/boot/shutdown.log: no space left on device
[ ] shutdown:info: Setting shutdown timeout to 60 (rancher.shutdown_timeout set to 60)
Failed to write to log, write /var/log/boot/shutdown.log: no space left on device
Failed to write to log, write /var/log/boot/shutdown.log: no space left on device
.[ ] shutdown:fatal: Error response from daemon: {"message":"mkdir /var/lib/system-docker/overlay2/7c7dffbed40e7b0ed4c68d5630b17a179751643ca7b7a4ac183e48a767071684-init: no space left on device"}
Failed to write to log, write /var/log/boot/shutdown.log: no space left on device
```
After rebooting, you will not be able to enter the OS and there will be a kernel panic.
![](https://ws1.sinaimg.cn/mw1024/006tNc79ly1ftf8071p5sj31kw0s14or.jpg)
### Boot with recovery console
When you can access the bootloader, you should select the `Recovery console` and press `<Tab>` to edit:
![](https://ws3.sinaimg.cn/mw1024/006tNc79ly1ftf7mpir3fj312u0i4a9z.jpg)
You need add `rancher.autologin=tty1` to the end, then press `<Enter>`. If all goes well, you will automatically login to the recovery console.
### How to recover
We need to mount the root disk in the recovery console and delete some data:
```
$ mkdir /mnt/root-disk
$ mount /dev/sda1 /mnt/root-disk
# delete data previously generated using dd
$ ls -ahl /mnt/root-disk/opt
-rw-r--r-- 1 root root 1.3G Jul 19 07:32 2GB.img
$ rm -f /mnt/root-disk/opt/2GB.img
```
After rebooting, you can enter the OS normally.
content/rancher/v2.x/en/contributing/_index.md
+23 -7
View File
@@ -7,16 +7,32 @@ aliases:
### Repositories
All of repositories are located within our main GitHub organization. There are many repositories used for Rancher, but we’ll provide descriptions of some of the main ones used in Rancher.
All of repositories are located within our main GitHub organization. There are many repositories used for Rancher, but we'll provide descriptions of some of the main ones used in Rancher.
- [Rancher Repo](https://github.com/rancher/rancher): This repository is the main source code for Rancher 2.x.
Repository | URL | Description
-----------|-----|-------------
Rancher | https://github.com/rancher/rancher | This repository is the main source code for Rancher 2.x.
Types | https://github.com/rancher/types | This repository is the repository that has all the API types for Rancher 2.x.
API Framework | https://github.com/rancher/norman | This repository is an API framework for building Rancher style APIs backed by Kubernetes Custom Resources.
User Interface | https://github.com/rancher/ui | This repository is the source of the UI.
(Rancher) Docker Machine | https://github.com/rancher/machine | This repository is the source of the Docker Machine binary used when using Node Drivers. This is a fork of the `docker/machine` repository.
machine-package | https://github.com/rancher/machine-package | This repository is used to build the Rancher Docker Machine binary.
kontainer-engine | https://github.com/rancher/kontainer-engine | This repository is the source of kontainer-engine, the tool to provision hosted Kubernetes clusters.
RKE repository | https://github.com/rancher/rke | This repository is the source of Rancher Kubernetes Engine, the tool to provision Kubernetes clusters on any machine.
CLI | https://github.com/rancher/cli | This repository is the source code for the Rancher CLI used in Rancher 2.x.
(Rancher) Helm repository | https://github.com/rancher/helm | This repository is the source of the packaged Helm binary. This is a fork of the `helm/helm` repository.
Telemetry repository | https://github.com/rancher/telemetry | This repository is the source for the Telemetry binary.
loglevel repository | https://github.com/rancher/loglevel | This repository is the source of the loglevel binary, used to dynamically change log levels.
- [Rancher Types Repo](https://github.com/rancher/types): This repository is the repo that has all the API types for Rancher 2.x.
To see all libraries/projects used in Rancher, see the `vendor.conf` in the `rancher/rancher repository.
- [Rancher API Framework Repo](https://github.com/rancher/norman): This repository is an API framework for building Rancher style APIs backed by Kubernetes Custom Resources.
### Building
- [Rancher CLI Repo](https://github.com/rancher/cli): This repository is the source code for the Rancher CLI used in Rancher 2.x.
Every repository should have a Makefile and can be built using the `make` command. The `make` targets are based on the scripts in the `/scripts` directory in the repository (plus additional `trash` commands, please see below for more information about using `trash`), and each target will use [Dapper](https://github.com/rancher/dapper) to run the target in an isolated environment. The `Dockerfile.dapper` will be used for this process, and includes all the necessary build tooling needed.
The default target is `ci`, and will run `./scripts/validate`, `./scripts/build`, `./scripts/test` and `./scripts/package`. The resulting binaries of the build will be in `./build/bin` and are usually also packaged in a Docker image.
Dependencies on other libraries/projects are managed using [Trash](https://github.com/rancher/trash). See the [Trash README](https://github.com/rancher/trash/blob/master/README.md) to discover how it can be used. In short, it uses a `vendor.conf` file to specify the source repository and revision to fetch, checkout and copy to the `./vendor` directory. After updating `vendor.conf`, you can run `make trash` to update dependencies for your change. When the dependencies are updated, you can build the project again using `make` so that it will be built using the updated dependencies.
### Bugs, Issues or Questions
@@ -70,6 +86,6 @@ If you are experiencing performance issues, please provide as much of data (file
If you have any updates to our documentation, please make any pull request to our docs repo.
- [Rancher 2.x Docs Repo](https://github.com/rancher/docs): This repo is where all the docs for Rancher 2.x are located. They are located in the `content` folder in the repo.
- [Rancher 2.x Docs repository](https://github.com/rancher/docs): This repo is where all the docs for Rancher 2.x are located. They are located in the `content` folder in the repo.
- [Rancher 1.x Docs Repo](https://github.com/rancher/rancher.github.io): This repo is where all the docs for Rancher 1.x are located. They are located in the `rancher` folder in the repo.
- [Rancher 1.x Docs repository](https://github.com/rancher/rancher.github.io): This repo is where all the docs for Rancher 1.x are located. They are located in the `rancher` folder in the repo.
content/rancher/v2.x/en/tools/logging/_index.md
+42 -3
View File
@@ -5,6 +5,45 @@ aliases:
- /rancher/v2.x/en/tasks/logging/
---
Rancher has the capability to push out cluster and project logs to an external
log monitoring tool such as Splunk or a Syslog server. This allows you to be
alerted of errors and warnings in your Kubernetes infrastructure.
Rancher can integrate with a variety of popular logging services and tools that exist outside of your Kubernetes clusters.
Rancher supports the following services:
- [Elasticsearch]({{< baseurl >}}/rancher/v2.x/en/tools/logging/elasticsearch)
- [Splunk]({{< baseurl >}}/rancher/v2.x/en/tools/logging/splunk)
- [Kafka]({{< baseurl >}}/rancher/v2.x/en/tools/logging/kafka)
- [Syslog]({{< baseurl >}}/rancher/v2.x/en/tools/logging/syslog)
## Advantages
Setting up a logging service to collect logs from your cluster/project is helpful several ways:
- Logs errors and warnings in your Kubernetes infrastructure to a stream. The stream informs you of events like a container crashing, a pod eviction, or a node dying.
- Allows you to capture and analyze the state of your cluster and look for trends in your environment using the log stream.
- Helps you when troubleshooting or debugging.
- Saves your logs to a safe location outside of your cluster, so that you can still access them even if your cluster encounters issues.
## Logging Scope
You can configure logging at either cluster or project level.
>**Note:** You can only configure one logging service per cluster or project.
- If you're a [cluster owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) who works in operations or security, configure cluster logging.
Cluster logging writes logs for every pod in the cluster and, in [RKE clusters]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters), Kubernetes system components. Logs from the following locations are sent to your logging service:
- The `/var/log/containers` path for pod logging.
- The `/var/lib/rancher/rke/logs/` path for Kubernetes system components.
- If you're a [project owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#project-roles) who works on an application, configure project logging.
Project logging writes logs for every pod in the project (`/var/log/containers`).
After collection, all logs are stored by your logging service. Log into your service to view them.
## Related Links
[Logging Architecture](https://kubernetes.io/docs/concepts/cluster-administration/logging/)
content/rancher/v2.x/en/tools/logging/elasticsearch/_index.md
+63
View File
@@ -0,0 +1,63 @@
---
title: Elasticsearch
weight: 200
---
If your organization uses [Elasticsearch](https://www.elastic.co/), either on premise or in the cloud, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Elasticsearch deployment to view logs for your cluster or container.
## Configuring Elasticsearch Logging
You can configure Rancher to send logs from your cluster or project to your instance of Elasticsearch.
>**Prerequisites:** Configure an [Elasticsearch deployment](https://www.elastic.co/guide/en/cloud/saas-release/ec-create-deployment.html).
1. Browse to the cluster or project that you want to log.
{{% accordion id="cluster" label="To Configure Cluster Logging:" %}}
If you're a [cluster owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) who works in operations or security, configure cluster logging.
1. From the **Global** view, open the cluster that you want to configure logging for.
1. From the main menu, select **Tools > Logging**.
{{% /accordion %}}
{{% accordion id="project" label="To Configure Project Logging:" %}}
If you're a [project owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#project-roles) who works on an application, configure project logging.
1. From the **Global** view, open the project that you want to configure logging for.
1. From the main menu, select **Resources > Logging**.
{{% /accordion %}}
1. Select **Elasticsearch**.
1. Complete the **Elasticsearch Configuration** form.
1. From the **Endpoint** field, enter the IP address and port for your Elasticsearch instance. You can copy this information from the dashboard of your Elasticsearch deployment. Elasticsearch usually uses port `9243`.
1. If you are using [X-Pack Security](https://www.elastic.co/guide/en/x-pack/current/xpack-introduction.html), enter your Elasticsearch **Username** and **Password** for authentication.
1. Enter an [Index Pattern](https://www.elastic.co/guide/en/kibana/current/index-patterns.html).
1. If your instance of Elasticsearch uses SSL, complete the **SSL Configuration** form.
1. Enter a private key and client certificate. Either copy and paste them or browse to them using **Read from a file**. This certificate will be installed on your logging server.
You can use either a self-signed certificate or one provided by a certificate authority.
You can generate a self-signed certificate using an openssl command. For example:
openssl req -x509 -newkey rsa:2048 -keyout myservice.key -out myservice.cert -days 365 -nodes -subj "/CN=myservice.example.com"
1. Enter your private key password.
1. If you are using a certificate from a certificate authority (and not a self-signed certificate), select the **Enabled - Input trusted server certificate** option and then enter your **Trusted Server Certificate**.
1. Complete the **Additional Logging Configuration** form.
1. **Optional:** Use the **Add Field** button to add custom log fields to your logging configuration. These fields are key value pairs (such as `foo=bar`) that you can use to filter the logs from another system.
1. Enter a **Flush Interval**. This value determines how often [Fluentd](https://www.fluentd.org/) flushes data to the logging server. Intervals are measured in seconds.
1. Click **Save**.
**Result:** Rancher is now configured to send cluster and container logs to Elasticsearch. Log into Elasticsearch or Kibana to view your cluster/project logs.
content/rancher/v2.x/en/tools/logging/kafka/_index.md
+48
View File
@@ -0,0 +1,48 @@
---
title: Kafka
weight: 400
---
You can configure Rancher to send cluster or project logs to a [Kafka](https://kafka.apache.org/) server.
## Configuring Kafka Logging
>**Prerequisite:** You must have a Kafka server configured.
1. Browse to the cluster or project that you want to log.
{{% accordion id="cluster" label="To Configure Cluster Logging:" %}}
If you're a [cluster owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) who works in operations or security, configure cluster logging.
1. From the **Global** view, open the cluster that you want to configure logging for.
1. From the main menu, select **Tools > Logging**.
{{% /accordion %}}
{{% accordion id="project" label="To Configure Project Logging:" %}}
If you're a [project owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#project-roles) who works on an application, configure project logging.
1. From the **Global** view, open the project that you want to configure logging for.
1. From the main menu, select **Resources > Logging**.
{{% /accordion %}}
1. Select **Kafka**.
1. Complete the **Kafka Configuration** form.
1. From **Endpoint Type**, select the type of Kafka server you are using: **Zookeeper** or **Broker**.
1. From the **Endpoint** field, enter the IP address and port for your Kafka server.
By default, Kafka uses port `9092`.
1. From the **Topic** field, enter the name of a Kafka [topic](https://kafka.apache.org/documentation/#basic_ops_add_topic) that your Kubernetes cluster submits logs to.
1. Complete the **Additional Logging Configuration** form.
1. **Optional:** Use the **Add Field** button to add custom log fields to your logging configuration. These fields are key value pairs (such as `foo=bar`) that you can use to filter the logs from another system.
1. Enter a **Flush Interval**. This value determines how often [Fluentd](https://www.fluentd.org/) flushes logs to the logging server. Intervals are measured in seconds.
1. Click **Save**.
**Result:** Rancher is now configured to send logs to Kafka. View your Kafka stream to view logs for your cluster and containers.
content/rancher/v2.x/en/tools/logging/splunk/_index.md
+44 -60
View File
@@ -1,85 +1,74 @@
---
title: Splunk
weight: 3725
weight: 300
aliases:
- /rancher/v2.x/en/tasks/logging/splunk/
---
The following guide will demonstrate how to monitor your container
infrastructure using Splunk.
If your organization uses [Splunk](https://www.splunk.com/), you can configure Rancher to send it cluster or project logs. Afterwards logs are sent, you can use Splunk to view them.
## Configure HTTP Event Collector
## Configuring Splunk Logging
The first step is to identify what port Splunk is using for the HTTP Event
collector. Usually the port is either **8088** or **8089**. HEC is used to
send log data from Rancher to Splunk using HTTP or HTTPS.
You can configure Rancher to send Kubernetes logs to your instance of Splunk.
Login to Splunk and go to:
>**Prerequisites:**
>
>- Configure HTTP event collection for your Splunk Server (Splunk Enterprise or Splunk Cloud).
>- Enable all tokens, and then create a new token.
>
>For more information, see [Splunk Documentation](http://docs.splunk.com/Documentation/Splunk/7.1.2/Data/UsetheHTTPEventCollector#About_Event_Collector_tokens).
Settings > Data inputs > HTTP Event Collector > **Global Settings**
1. Browse to the cluster or project that you want to log.
{{% accordion id="cluster" label="To Configure Cluster Logging:" %}}
If you're a [cluster owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) who works in operations or security, configure cluster logging.
![Configure Splunk]({{< baseurl >}}/img/rancher/splunk/splunk1.jpg)
1. From the **Global** view, open the cluster that you want to configure logging for.
Make sure to click on **Enabled** for all tokens. By default it is set to
disabled. This will allow Splunk to collect HTTP Event data sent from Rancher.
1. From the main menu, select **Tools > Logging**.
{{% /accordion %}}
{{% accordion id="project" label="To Configure Project Logging:" %}}
If you're a [project owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#project-roles) who works on an application, configure project logging.
Click on **Save** to update the HEC settings.
1. From the **Global** view, open the project that you want to configure logging for.
## Generate Token
1. From the main menu, select **Resources > Logging**.
{{% /accordion %}}
This step might not be applicable, if you already have a token. Now we will
generate the token that will be used by Rancher to send HTTP Event data.
1. Select **Splunk**.
- Click Settings > Data inputs > HTTP Event Collector > **New Token**
- Click monitor
- Select HTTP Event Collector
- In the Name field, enter a name for the token (ex. **rancher**)
- Click Next
- Select the indexe(s) desired (history, main, and summary)
- You can also create a new index and add it to the step above
- Click Review
- Confirm that all settings for the token are what you want
- Click Submit to generate the token
1. Complete the **Splunk HTTP Event Collector Configuration** form.
&nbsp;
1. From the **Endpoint** field, enter the IP address and port for you Splunk instance (i.e. `http://splunk-server:8088`)
Splunk usually uses port `8088`. If you're using Splunk Cloud, you'll need to work with [Splunk support](https://www.splunk.com/en_us/support-and-services.html) to get an endpoint URL.
Congratulations you now are ready to feed Splunk with HTTP Event data. You
should see a page like the one below with your generated token. This is the
token that will be used in Rancher to communicate with Splunk.
1. Enter the **Token** you obtained while completing the prerequisites (i.e., when you created a token in Splunk).
![Token Created]({{< baseurl >}}/img/rancher/splunk/splunk2.jpg)
1. From the **Source** field, enter the name of the token as entered in Splunk.
## Configure Cluster Logging
1. **Optional:** Enter one or more [index](http://docs.splunk.com/Documentation/Splunk/7.1.2/Indexer/Aboutindexesandindexers) that's allowed for your token.
In this section we will configure and enable Splunk cluster logging in Rancher.
1. Complete the **Additional Logging Configuration** form.
- Head on over to local > Tools > **Logging**
- Select Splunk
- Enter the Splunk endpoint using the port specified for **HEC** (ex. http://splunk-server:8088)
- Enter the token generated above (ex. 8da70994-b1b0-4a79-b154-bfaae8f93432)
- Enter the Source, name of the token created earlier (ex. **rancher**)
- You can also enter an index, this is optional (ex. **main**)
1. **Optional:** Use the **Add Field** button to add custom log fields to your logging configuration. These fields are key value pairs (such as `foo=bar`) that you can use to filter the logs from another system.
&nbsp;
1. Enter a **Flush Interval**. This value determines how often [Fluentd](https://www.fluentd.org/) flushes event data to the logging server. Intervals are measured in seconds.
![Configure Rancher Cluster Logging]({{< baseurl >}}/img/rancher/splunk/splunk3.jpg)
1. Click **Save**.
Repeat the same step for Project Logging, if desired. This is not required and is optional.
**Result:** Rancher is now configured to send logs to Splunk. Log into your Spunk instance to view events for your cluster and containers.
## View Logs
## Viewing Logs
You should now be receiving logging data from your cluster. Head on over to
Splunk to view your logs.
1. Log into your Splunk server.
Click on **Search & Reporting**, you should see **Indexed Events** increasing.
Click on Data Summary and select the Sources tab.
1. Click on **Search & Reporting**. The number of **Indexed Events** listed should be increasing.
![View Logs]({{< baseurl >}}/img/rancher/splunk/splunk4.jpg)
1. Click on Data Summary and select the Sources tab.
![View Logs]({{< baseurl >}}/img/rancher/splunk/splunk4.jpg)
To view the actual logs click on the source that you declared earlier
(ex. rancher -> http:**rancher**)
![View Logs]({{< baseurl >}}/img/rancher/splunk/splunk5.jpg)
1. To view the actual logs, click on the source that you declared earlier.
![View Logs]({{< baseurl >}}/img/rancher/splunk/splunk5.jpg)
## Troubleshooting
@@ -91,12 +80,7 @@ $ curl http://splunk-server:8088/services/collector/event \
-d '{"event": "hello world"}'
```
You should see **json** data returning Success code 0. You should be able
to send logging data to HEC. If you received an error, check your configuration
in Splunk & Rancher Cluster Logging.
If Splunk is configured correctly, you should receive **json** data returning `success code 0`. You should be able
to send logging data to HEC.
## Reference
For more information on Splunk, you can check out the following reference:
[Splunk -> HTTP Event Collector](http://docs.splunk.com/Documentation/Splunk/7.0.0/Data/UsetheHTTPEventCollector)
If you received an error, check your configuration in Splunk and Rancher.
content/rancher/v2.x/en/tools/logging/syslog/_index.md
+65
View File
@@ -0,0 +1,65 @@
---
title: Syslog
weight: 500
---
You can configure Rancher to send Kubernetes logs to a [Syslog](https://tools.ietf.org/html/rfc5424) server.
## Configuring Syslog
You can configure Rancher to send cluster or project logs to Syslog.
>**Prerequisite:** You must have a Syslog server configured.
1. Browse to the cluster or project that you want to log.
{{% accordion id="cluster" label="To Configure Cluster Logging:" %}}
If you're a [cluster owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) who works in operations or security, configure cluster logging.
1. From the **Global** view, open the cluster that you want to configure logging for.
1. From the main menu, select **Tools > Logging**.
{{% /accordion %}}
{{% accordion id="project" label="To Configure Project Logging:" %}}
If you're a [project owner or member]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#project-roles) who works on an application, configure project logging.
1. From the **Global** view, open the project that you want to configure logging for.
1. From the main menu, select **Resources > Logging**.
{{% /accordion %}}
1. Select **Syslog**.
1. Complete the **Syslog Configuration** form.
1. From the **Endpoint** field, enter the IP address and port for your Syslog server. Additionally, select the protocol that your Syslog server uses from the drop-down.
1. From the **Program** field, enter the name of the application sending logs to your Syslog server (i.e., Rancher).
1. If you are using a cloud logging service (i.e., [Sumologic](https://www.sumologic.com/)), enter a **Token** that authenticates with your Syslog server. Use the cloud logging service to create this token.
1. Select a **Log Severity** for events that are logged to the Syslog server. For more information on each severity level, see the [Syslog protocol documentation](https://tools.ietf.org/html/rfc5424#page-11).
1. If your Syslog server uses **TCP** protocol, complete the **SSL Configuration** form.
1. Enter a private key and client certificate. Either copy and paste them or browse to them using **Read from a file**. This certificate will be installed on your logging server.
You can use either a self-signed certificate or one provided by a certificate authority.
You can generate a self-signed certificate using an openssl command. For example:
openssl req -x509 -newkey rsa:2048 -keyout myservice.key -out myservice.cert -days 365 -nodes -subj "/CN=myservice.example.com"
1. If you are using a certificate from a certificate authority (and not a self-signed certificate), select the **Enabled - Input trusted server certificate** option and then enter your **Trusted Server Certificate**.
1. Complete the **Additional Logging Configuration** form.
1. **Optional:** Use the **Add Field** button to add custom log fields to your logging configuration. These fields are key value pairs (such as `foo=bar`) that you can use to filter the logs from another system.
1. Enter a **Flush Interval**. This value determines how often [Fluentd](https://www.fluentd.org/) flushes data to the logging server. Intervals are measured in seconds.
1. Click **Save**.
**Result:** Rancher is now configured to send logs to your Syslog server. View your Syslog stream to view logs for your cluster and containers.
content/rancher/v2.x/en/upgrades/single-node-upgrade/_index.md
+2 -2
View File
@@ -58,12 +58,12 @@ docker run -d --volumes-from rancher-data --restart=unless-stopped \
><br/>
>**Note:** After upgrading Rancher Server, data from your upgraded server is now saved to the `rancher-data` container for use in future upgrades.
1. Log into Rancher. Confirm that the upgrade succeeded by checking the version displayed in the bottom-left corner of the browser window.
1. Remove the previous Rancher Server container.
If you only stop the previous Rancher Server container (and don't remove it), the container may restart after the next server reboot.
1. Log into Rancher. Confirm that the upgrade succeeded by checking the version displayed in the bottom-left corner of the browser window.
**Result:** Rancher Server is upgraded to the latest version.
>**Note:** If your upgrade does not complete successfully, you can roll Rancher Server and its data back to its last healthy state. For more information, see [Restoring Backups—Single Node Installs]({{< baseurl >}}/rancher/v2.x/en/backups/restorations/single-node-restoration/).
content/rancher/v2.x/en/user-settings/_index.md
+6 -5
View File
@@ -7,10 +7,11 @@ aliases:
Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu.
![User Settings Menu]({{< baseurl >}}/img/rancher/user-settings.png)
The available user settings are:
- [API & Keys]({{< baseurl >}}/rancher/v2.x/en/user-settings/api-keys/)
<!-- - Node Templates
- Preferences -->
- [API & Keys]({{< baseurl >}}/rancher/v2.x/en/user-settings/api-keys/): If you want to interact with Rancher programmatically, you need an API key. Follow the directions in this section to obtain a key.
- [Node Templates]({{< baseurl >}}/rancher/v2.x/en/user-settings/node-templates): Manage templates [used by Rancher to provision nodes for clusters]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters).
- [Preferences]({{< baseurl >}}/rancher/v2.x/en/user-settings/preferences): Sets superficial preferences for the Rancher UI.
- Log Out: Ends your user session.
content/rancher/v2.x/en/user-settings/node-templates/_index.md
+1 -1
View File
@@ -3,7 +3,7 @@ title: Managing Node Templates
weight: 7010
---
when you provision a [node pool]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools) cluster, [node templates]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine commands to configure an operating system image and setting/parameters for the node. You can create node templates in two contexts:
When you provision a [node pool]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools) cluster, [node templates]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts:
- While [provisioning a node pool cluster]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools).
- At any time, from your [user settings](#creating-a-node-template-from-user-settings).
content/rancher/v2.x/en/user-settings/preferences/_index.md
+14 -1
View File
@@ -1,5 +1,18 @@
---
title: User Preferences
weight: 7010
draft: true
---
Each user can choose preferences to personalize their Rancher experience. To change preference settings, open the **User Settings** menu and then select **Preferences**.
## Theme
Choose your background color for the Rancher UI. If you choose **Auto**, the background color changes from light to dark at 6 PM, and then changes back at 6 AM.
## My Account
This section displays the **Name** (your display name) and **Username** (your login) used for your session. To change your login's current password, click the **Change Password** button.
## Table Row per Page
On pages that display system objects like clusters or deployments in a table, you can set the number of objects that display on the page before you must paginate. The default setting is `50`.
content/rke/v0.1.x/en/config-options/add-ons/ingress-controllers/_index.md
+1 -1
View File
@@ -39,7 +39,7 @@ ingress:
```
## Configuring NGINX Ingress Controller
For the configuration of nginx, there are configuration options available in Kubernetes. There are a [list of options for the NGINX config map](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/configmap.md) , [command line extra_args](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/cli-arguments.md) and [annotations](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/).
For the configuration of nginx, there are configuration options available in Kubernetes. There are a [list of options for the NGINX config map](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/configmap.md) , [command line extra_args](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/cli-arguments.md) and [annotations](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/).
```yaml
ingress:
content/rke/v0.1.x/en/config-options/nodes/_index.md
+1 -1
View File
@@ -47,7 +47,7 @@ The `internal_address` provides the ability to have nodes with multiple addresse
### Overriding the Hostname
The `hostname_override` is used to be able to provide a friendly name for RKE to use when registering the node in Kubernetes. This hostname doesn't need to be a routable address. If the `hostname_override` isn't set, then the `address` directive is used when registering the node in Kubernetes.
The `hostname_override` is used to be able to provide a friendly name for RKE to use when registering the node in Kubernetes. This hostname doesn't need to be a routable address, but it must be a valid [Kubernetes resource name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). If the `hostname_override` isn't set, then the `address` directive is used when registering the node in Kubernetes.
> **Note:** When [cloud providers]({{< baseurl >}}/rke/v0.1.x/en/config-options/cloud-providers/) are configured, you may need to override the hostname in order to use the cloud provider correctly. There is an exception for the [AWS cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#aws), where the `hostname_override` field will be explicitly ignored.
content/rke/v0.1.x/en/config-options/system-images/_index.md
+1 -1
View File
@@ -46,7 +46,7 @@ system_images:
# Ingress Options
ingress: rancher/nginx-ingress-controller:0.10.2-rancher3
ingressBackend: rancher/nginx-ingress-controller-defaultbackend:1.4
ingress_backend: rancher/nginx-ingress-controller-defaultbackend:1.4
```
Prior to `v0.1.6`, instead of using the `rancher/rke-tools` image, we used the following images:
content/rke/v0.1.x/en/installation/etcd-snapshots/_index.md → content/rke/v0.1.x/en/etcd-snapshots/_index.md
+3 -1
View File
@@ -1,6 +1,8 @@
---
title: Backups and Disaster Recovery
weight: 65
weight: 150
aliases:
- /rke/v0.1.x/en/installation/etcd-snapshots/
---
As of v0.1.7, you can configure a RKE cluster to automatically take snapshots of etcd. In a disaster scenario, you can restore these snapshots, which are stored on other nodes in the cluster.
content/rke/v0.1.x/en/installation/_index.md
+1 -1
View File
@@ -5,7 +5,7 @@ weight: 50
RKE is a fast, versatile Kubernetes installer that you can use to install Kubernetes on your Linux hosts. You can get started in a couple of quick and easy steps:
1. [Download the RKE Binary](#download-the-rke-bindary)
1. [Download the RKE Binary](#download-the-rke-binary)
2. [Prepare the Nodes for the Kubernetes Cluster](#prepare-the-nodes-for-the-kubernetes-cluster)
3. [Creating the Cluster Configuration File](#creating-the-cluster-configuration-file)
4. [Deploying Kubernetes with RKE](#deploying-kubernetes-with-rke)
content/rke/v0.1.x/en/installation/managing-clusters/_index.md → content/rke/v0.1.x/en/managing-clusters/_index.md
+5 -3
View File
@@ -1,6 +1,8 @@
---
title: Managing RKE Clusters
weight: 60
title: Adding and Removing Nodes in RKE Clusters
weight: 175
aliases:
- /rke/v0.1.x/en/installation/managing-clusters/
---
### Adding/Removing Nodes
@@ -17,7 +19,7 @@ After you've made changes to add/remove nodes, run `rke up` with the updated `cl
You can add/remove only worker nodes, by running `rke up --update-only`. This will ignore everything else in the `cluster.yml` except for any worker nodes.
### Removing Kubernetes Clusters from Nodes
### Removing Kubernetes Components from Nodes
In order to remove the Kubernetes components from nodes, you use the `rke remove` command.
content/rke/v0.1.x/en/installation/os/_index.md → content/rke/v0.1.x/en/os/_index.md
+31 -6
View File
@@ -1,7 +1,32 @@
---
title: Operating System Requirements
weight: 55
title: Requirements
weight: 5
aliases:
- /rke/v0.1.x/en/installation/os
---
**In this section:**
<!-- TOC -->
- [Operating System](#operating-system)
- [RedHat Enterprise Linux (RHEL) / Oracle Enterprise Linux (OEL) / CentOS](#redhat-enterprise-linux-rhel--oracle-enterprise-linux-oel--centos)
- [Using upstream Docker](#using-upstream-docker)
- [Using RHEL/CentOS packaged Docker](#using-rhelcentos-packaged-docker)
- [Software](#software)
- [Ports](#ports)
- [Opening port TCP/6443 using `iptables``](#opening-port-tcp6443-using-iptables)
- [Opening port TCP/6443 using `firewalld`](#opening-port-tcp6443-using-firewalld)
- [Notes about Atomic Nodes](#notes-about-atomic-nodes)
- [Container Volumes](#container-volumes)
- [OpenSSH version](#openssh-version)
- [Creating a Docker Group](#creating-a-docker-group)
<!-- /TOC -->
## Operating System
RKE runs on almost any Linux OS with Docker installed. Most of the development and testing of RKE occurred on Ubuntu 16.04. However, some OS's have restrictions and specific requirements.
@@ -105,7 +130,7 @@ $ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
```
### Software
## Software
- Docker - Each Kubernetes version supports different Docker versions.
@@ -147,14 +172,14 @@ Server:
- OpenSSH 7.0+ - In order to SSH into each node, OpenSSH must be installed on each node.
### Ports
## Ports
{{< requirements_ports_rke >}}
If you are using an external firewall, make sure you have this port opened between the machine you are using to run `rke` and the nodes that you are going to use in the cluster.
#### Opening port TCP/6443 using `iptables``
### Opening port TCP/6443 using `iptables``
```
# Open TCP/6443 for all
@@ -164,7 +189,7 @@ iptables -A INPUT -p tcp --dport 6443 -j ACCEPT
iptables -A INPUT -p tcp -s your_ip_here --dport 6443 -j ACCEPT
```
#### Opening port TCP/6443 using `firewalld`
### Opening port TCP/6443 using `firewalld`
```
# Open TCP/6443 for all