mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-12 12:07:20 +00:00
Merge pull request #62 from vincent99/master
More folders for all the things
This commit is contained in:
Vincent Fiduccia
+4
-4
@@ -14,21 +14,21 @@ description: ""
|
||||
</div>
|
||||
<div class="row middle-xs center-xs">
|
||||
<div class="col-md">
|
||||
<h3 class="bg-default m-a-0 p-a-sm">Rancher 2.0</h3>
|
||||
<h3 class="bg-default m-a-0 p-a-sm">Rancher 2.x</h3>
|
||||
<div class="box p-a-sm">
|
||||
<a href="{{< baseurl >}}/rancher" class="btn bg-link">Read the Docs</a>
|
||||
<a href="{{< baseurl >}}/rancher/v2.x/en/" class="btn bg-link">Read the Docs</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-md">
|
||||
<h3 class="bg-default m-a-0 p-a-sm">Rancher 1.6</h3>
|
||||
<div class="box p-a-sm">
|
||||
<a href="https://rancher.com/docs/rancher/v1.6/en/?__hstc=181257784.c8b72d5c7559a0d146f232f140b2ff44.1506613584438.1524944375438.1524949037449.122&__hssc=181257784.2.1524949037449&__hsfp=2613135925" target="_blank" class="btn bg-link">Read the Docs</a>
|
||||
<a href="https://rancher.com/docs/rancher/v1.6/en/" target="_blank" class="btn bg-link">Read the Docs</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-md">
|
||||
<h3 class="bg-default m-a-0 p-a-sm">RancherOS</h3>
|
||||
<div class="box p-a-sm">
|
||||
<a href="{{< baseurl >}}/os" class="btn bg-link">Read the Docs</a>
|
||||
<a href="{{< baseurl >}}/os/v1.x/en/" class="btn bg-link">Read the Docs</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
+2
-42
@@ -1,45 +1,5 @@
|
||||
---
|
||||
title: RancherOS Documentation
|
||||
shortTitle: RancherOS
|
||||
description: RancherOS is a simplified Linux distribution built from containers, for containers. These documents describe how to install and use RancherOS.
|
||||
title: RancherOS
|
||||
weight: 1
|
||||
showBreadcrumb: false
|
||||
---
|
||||
|
||||
## Overview of RancherOS
|
||||
---
|
||||
RancherOS is the smallest, easiest way to run Docker in production. Everything in RancherOS is a container managed by Docker. This includes system services such as `udev` and `syslog`. Because it only includes the services necessary to run Docker, RancherOS is dramatically smaller than most traditional operating systems. By removing unnecessary libraries and services, requirements for security patches and other maintenance are dramatically reduced. This is possible because, with Docker, users typically package all necessary libraries into their containers.
|
||||
|
||||
Another way in which RancherOS is designed specifically for running Docker is that it always runs the latest version of Docker. This allows users to take advantage of the latest Docker capabilities and bug fixes.
|
||||
|
||||
Like other minimalist Linux distributions, RancherOS boots incredibly quickly, generally in 5-10 seconds. Starting Docker containers is nearly instant, similar to starting any other process. This quickness is ideal for organizations adopting microservices and autoscaling.
|
||||
|
||||
Docker is an open-source platform designed for developers, system admins, and DevOps, it is used to build, ship, and run containers, using simple yet powerful CLI (Command Line Interface), you can get started with Docker from [Docker user guide](https://docs.docker.com/engine/userguide/).
|
||||
|
||||
### Hardware Requirements
|
||||
|
||||
* x86_64 server with at least 512MB of RAM.
|
||||
|
||||
> **Note:** If you are planning on [installing to disk]({{< baseurl >}}/os/installation/running-rancheros/server/install-to-disk/), you will need at least 1024MB of RAM.
|
||||
|
||||
|
||||
### How this works
|
||||
|
||||
Everything in RancherOS is a Docker container. We accomplish this by launching two instances of Docker. One is what we call **System Docker**, the first process on the system. All other system services, like `ntpd`, `syslog`, and `console`, are running in Docker containers. System Docker replaces traditional init systems like `systemd`, and can be used to launch [additional system services]({{< baseurl >}}/os/installation/system-services/adding-system-services/).
|
||||
|
||||
System Docker runs a special container called **Docker**, which is another Docker daemon responsible for managing all of the user’s containers. Any containers that you launch as a user from the console will run inside this Docker. This creates isolation from the System Docker containers, and ensures normal user commands don’t impact system services.
|
||||
|
||||
We created this separation because it seemed logical and also it would really be bad if somebody did
|
||||
`docker rm -f $(docker ps -qa)` and deleted the entire OS.
|
||||
|
||||
|
||||
|
||||
### Running RancherOS
|
||||
|
||||
To find out more about installing RancherOS, jump to our [Quick Start Guide]({{< baseurl >}}/os/quick-start-guide/).
|
||||
|
||||
### Latest Release
|
||||
|
||||
Please check our repository for the latest release in our [README](https://github.com/rancher/os/blob/master/README.md).
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: v1.x
|
||||
showBreadcrumb: false
|
||||
---
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: RancherOS Documentation
|
||||
shortTitle: RancherOS
|
||||
description: RancherOS is a simplified Linux distribution built from containers, for containers. These documents describe how to install and use RancherOS.
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Overview of RancherOS
|
||||
---
|
||||
RancherOS is the smallest, easiest way to run Docker in production. Everything in RancherOS is a container managed by Docker. This includes system services such as `udev` and `syslog`. Because it only includes the services necessary to run Docker, RancherOS is dramatically smaller than most traditional operating systems. By removing unnecessary libraries and services, requirements for security patches and other maintenance are dramatically reduced. This is possible because, with Docker, users typically package all necessary libraries into their containers.
|
||||
|
||||
Another way in which RancherOS is designed specifically for running Docker is that it always runs the latest version of Docker. This allows users to take advantage of the latest Docker capabilities and bug fixes.
|
||||
|
||||
Like other minimalist Linux distributions, RancherOS boots incredibly quickly, generally in 5-10 seconds. Starting Docker containers is nearly instant, similar to starting any other process. This quickness is ideal for organizations adopting microservices and autoscaling.
|
||||
|
||||
Docker is an open-source platform designed for developers, system admins, and DevOps, it is used to build, ship, and run containers, using simple yet powerful CLI (Command Line Interface), you can get started with Docker from [Docker user guide](https://docs.docker.com/engine/userguide/).
|
||||
|
||||
### Hardware Requirements
|
||||
|
||||
* x86_64 server with at least 512MB of RAM.
|
||||
|
||||
> **Note:** If you are planning on [installing to disk]({{< baseurl >}}/os/installation/running-rancheros/server/install-to-disk/), you will need at least 1024MB of RAM.
|
||||
|
||||
|
||||
### How this works
|
||||
|
||||
Everything in RancherOS is a Docker container. We accomplish this by launching two instances of Docker. One is what we call **System Docker**, the first process on the system. All other system services, like `ntpd`, `syslog`, and `console`, are running in Docker containers. System Docker replaces traditional init systems like `systemd`, and can be used to launch [additional system services]({{< baseurl >}}/os/installation/system-services/adding-system-services/).
|
||||
|
||||
System Docker runs a special container called **Docker**, which is another Docker daemon responsible for managing all of the user’s containers. Any containers that you launch as a user from the console will run inside this Docker. This creates isolation from the System Docker containers, and ensures normal user commands don’t impact system services.
|
||||
|
||||
We created this separation because it seemed logical and also it would really be bad if somebody did
|
||||
`docker rm -f $(docker ps -qa)` and deleted the entire OS.
|
||||
|
||||
|
||||
|
||||
### Running RancherOS
|
||||
|
||||
To find out more about installing RancherOS, jump to our [Quick Start Guide]({{< baseurl >}}/os/quick-start-guide/).
|
||||
|
||||
### Latest Release
|
||||
|
||||
Please check our repository for the latest release in our [README](https://github.com/rancher/os/blob/master/README.md).
|
||||
|
||||
<br>
|
||||
<br>
|
||||
+2
-109
@@ -1,112 +1,5 @@
|
||||
---
|
||||
title: Rancher 2.0 Documentation
|
||||
shortTitle: Rancher 2.0
|
||||
title: Rancher
|
||||
weight: 1
|
||||
showBreadcrumb: false
|
||||
---
|
||||
|
||||
# Rancher 2.0 Documentation
|
||||
|
||||
## Rancher Overview
|
||||
|
||||
Rancher is a container management platform built for organizations that deploy containers in production. Rancher makes it easy to run Kubernetes everywhere, meet IT requirements, and empower DevOps teams.
|
||||
|
||||
### Run Kubernetes Everywhere
|
||||
|
||||
Kubernetes has become the container orchestration standard. Most cloud and virtualization vendors now offer it as standard infrastructure. Rancher users have the choice of creating Kubernetes clusters with Rancher Kubernetes Engine (RKE) or cloud Kubernetes services, such as GKE, AKS, and EKS. Rancher users can also import and manage their existing Kubernetes clusters created using any Kubernetes distribution or installer.
|
||||
|
||||
### Meet IT requirements
|
||||
|
||||
Rancher supports centralized authentication for all Kubernetes clusters under its control. For example, you can:
|
||||
|
||||
- Use your Active Directory credentials to access Kubernetes clusters hosted by cloud vendors, such as GKE.
|
||||
- Setup and enforce access control and security policies across all users, groups, projects, clusters, and clouds.
|
||||
- View the health and capacity of your Kubernetes clusters from a single-pane-of-glass.
|
||||
|
||||
### Empower DevOps Teams
|
||||
|
||||
Rancher provides an intuitive user interface for DevOps engineers to manage their application workload. The user does not need to have in-depth knowledge of Kubernetes concepts to start using Rancher. Rancher catalog contains a set of useful DevOps tools. Rancher is certified with a wide selection of cloud native ecosystem products, including, for example, security tools, monitoring systems, container registries, and storage and networking drivers.
|
||||
|
||||
The following figure illustrates the role Rancher plays in IT and DevOps organizations. Each team deploys their applications on the public or private clouds they choose. IT administrators gain visibility and enforce policies across all users, clusters, and clouds.
|
||||
|
||||
|
||||
|
||||
|
||||
## What's New?
|
||||
|
||||
The previous version of Rancher, version 1.6, was a container management platform built on Docker. Rancher 2.0 builds on the success and experience of Rancher 1.6.
|
||||
|
||||
However, for version 2.0, most of Rancher has been redesigned to work on Kubernetes. Rancher 2.0 retains the user-friendly features of version 1.6, such as the UI and catalog. However, 2.0 now includes many new features such as:
|
||||
|
||||
- Built-in CI pipeline
|
||||
- Alerts and log aggregation
|
||||
- Multi-cluster management
|
||||
- Rancher Kubernetes Engine (RKE)
|
||||
- Integration with cloud Kubernetes services, such as GKE, EKS, and AKS.
|
||||
|
||||
# Rancher Architecture
|
||||
|
||||
Before explaining Rancher architecture, it is useful to present some background information on two fundamental technologies Rancher build on: Docker and Kubernetes.
|
||||
|
||||
## Docker
|
||||
|
||||
Docker is the de-facto container packaging and runtime standard. Developers build container images from Dockerfiles and distribute container images from Docker registries. Docker Hub (hub.docker.com) is the most popular public registry. Many organizations also setup private Docker registries.
|
||||
|
||||
Docker is primarily used to manage containers on individual nodes. The Docker Swarm clustering technology are not as widely used as Kubernetes. Rancher 1.6 supported Docker Swarm. Rancher 2.0 no longer does.
|
||||
|
||||
## Kubernetes
|
||||
|
||||
Kubernetes is the de-facto container cluster management standard. YAML files specify containers and other resources that form an application. Kubernetes performs functions such as scheduling, scaling, service discovery, health check, secret and configuration management.
|
||||
|
||||
A Kubernetes cluster consists of multiple nodes.
|
||||
|
||||
- The etcd database. Although you can run etcd on just one node, it typically takes 3, 5 or more nodes to create an HA configuration.
|
||||
|
||||
- Master nodes. Master nodes are stateless and are used to run the API server, scheduler, and controllers.
|
||||
|
||||
- Worker nodes. Application workload runs on worker nodes.
|
||||
|
||||
## Rancher
|
||||
|
||||
We now cover high-level Rancher architecture.
|
||||
|
||||
Majority of Rancher 2.0 software runs on the Rancher server. Rancher server includes all the software components used to manage the entire Rancher deployment.
|
||||
|
||||
The figure below illustrates the high-level architecture of Rancher 2.0. The figure depicts a Rancher server installation that manages two Kubernetes clusters: one Kubernetes cluster created by RKE and another Kubernetes cluster created by GKE.
|
||||
|
||||
|
||||
|
||||
In this section we describe the functionalities of each Rancher server components.
|
||||
|
||||
#### Rancher API Server
|
||||
|
||||
Rancher API server is built on top of an embedded Kubernetes API server and etcd database. It implements the following functionalities:
|
||||
|
||||
1. User management. Rancher API server manages user identities that correspond to external authentication providers like Active Directory or GitHub.
|
||||
|
||||
2. Authorization. Rancher API server manages access control and security policies.
|
||||
|
||||
3. Projects. A project is a grouping of multiple namespaces and access control policies within a cluster.
|
||||
|
||||
4. Nodes. Rancher API server tracks identities of all the nodes in all clusters.
|
||||
|
||||
#### Cluster Controller and Agents
|
||||
|
||||
The cluster controller and cluster agents implement the business logic required to manage Kubernetes clusters. All the logic that is global to the entire Rancher install is implemented by the cluster controller. A separate cluster agent instance implements the logic required for the corresponding cluster.
|
||||
|
||||
Cluster agents perform the following activities:
|
||||
|
||||
- Manage workload. This includes, for example, creating pods and deployments in each cluster.
|
||||
|
||||
- Applying roles and bindings that are defined in global policies into every cluster.
|
||||
|
||||
- Propagate information from cluster to rancher server: events, stats, node info, and health.
|
||||
|
||||
The cluster controller performs the following activities:
|
||||
|
||||
- Configures access control policies to clusters and projects.
|
||||
|
||||
- Provisions clusters by invoking the necessary Docker machine drivers and invoking Kubernetes engines like RKE and GKE.
|
||||
|
||||
#### Authentication Proxy
|
||||
|
||||
The authentication proxy proxies all Kubernetes API calls. It integrates with authentication services like local authentication, Active Directory, and GitHub. On every Kubernetes API call, the authentication proxy authenticates the caller and sets the proper Kubernetes impersonation headers before forwarding the call to Kubernetes masters. Rancher communicates with Kubernetes clusters using a service account.
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: v2.x
|
||||
showBreadcrumb: false
|
||||
---
|
||||
@@ -0,0 +1,113 @@
|
||||
---
|
||||
title: Rancher 2.0 Documentation
|
||||
shortTitle: Rancher 2.0
|
||||
insertOneSix: true
|
||||
weight: 1
|
||||
---
|
||||
|
||||
# Rancher 2.0 Documentation
|
||||
|
||||
## Rancher Overview
|
||||
|
||||
Rancher is a container management platform built for organizations that deploy containers in production. Rancher makes it easy to run Kubernetes everywhere, meet IT requirements, and empower DevOps teams.
|
||||
|
||||
### Run Kubernetes Everywhere
|
||||
|
||||
Kubernetes has become the container orchestration standard. Most cloud and virtualization vendors now offer it as standard infrastructure. Rancher users have the choice of creating Kubernetes clusters with Rancher Kubernetes Engine (RKE) or cloud Kubernetes services, such as GKE, AKS, and EKS. Rancher users can also import and manage their existing Kubernetes clusters created using any Kubernetes distribution or installer.
|
||||
|
||||
### Meet IT requirements
|
||||
|
||||
Rancher supports centralized authentication for all Kubernetes clusters under its control. For example, you can:
|
||||
|
||||
- Use your Active Directory credentials to access Kubernetes clusters hosted by cloud vendors, such as GKE.
|
||||
- Setup and enforce access control and security policies across all users, groups, projects, clusters, and clouds.
|
||||
- View the health and capacity of your Kubernetes clusters from a single-pane-of-glass.
|
||||
|
||||
### Empower DevOps Teams
|
||||
|
||||
Rancher provides an intuitive user interface for DevOps engineers to manage their application workload. The user does not need to have in-depth knowledge of Kubernetes concepts to start using Rancher. Rancher catalog contains a set of useful DevOps tools. Rancher is certified with a wide selection of cloud native ecosystem products, including, for example, security tools, monitoring systems, container registries, and storage and networking drivers.
|
||||
|
||||
The following figure illustrates the role Rancher plays in IT and DevOps organizations. Each team deploys their applications on the public or private clouds they choose. IT administrators gain visibility and enforce policies across all users, clusters, and clouds.
|
||||
|
||||
|
||||
|
||||
|
||||
## What's New?
|
||||
|
||||
The previous version of Rancher, version 1.6, was a container management platform built on Docker. Rancher 2.0 builds on the success and experience of Rancher 1.6.
|
||||
|
||||
However, for version 2.0, most of Rancher has been redesigned to work on Kubernetes. Rancher 2.0 retains the user-friendly features of version 1.6, such as the UI and catalog. However, 2.0 now includes many new features such as:
|
||||
|
||||
- Built-in CI pipeline
|
||||
- Alerts and log aggregation
|
||||
- Multi-cluster management
|
||||
- Rancher Kubernetes Engine (RKE)
|
||||
- Integration with cloud Kubernetes services, such as GKE, EKS, and AKS.
|
||||
|
||||
# Rancher Architecture
|
||||
|
||||
Before explaining Rancher architecture, it is useful to present some background information on two fundamental technologies Rancher build on: Docker and Kubernetes.
|
||||
|
||||
## Docker
|
||||
|
||||
Docker is the de-facto container packaging and runtime standard. Developers build container images from Dockerfiles and distribute container images from Docker registries. Docker Hub (hub.docker.com) is the most popular public registry. Many organizations also setup private Docker registries.
|
||||
|
||||
Docker is primarily used to manage containers on individual nodes. The Docker Swarm clustering technology are not as widely used as Kubernetes. Rancher 1.6 supported Docker Swarm. Rancher 2.0 no longer does.
|
||||
|
||||
## Kubernetes
|
||||
|
||||
Kubernetes is the de-facto container cluster management standard. YAML files specify containers and other resources that form an application. Kubernetes performs functions such as scheduling, scaling, service discovery, health check, secret and configuration management.
|
||||
|
||||
A Kubernetes cluster consists of multiple nodes.
|
||||
|
||||
- The etcd database. Although you can run etcd on just one node, it typically takes 3, 5 or more nodes to create an HA configuration.
|
||||
|
||||
- Master nodes. Master nodes are stateless and are used to run the API server, scheduler, and controllers.
|
||||
|
||||
- Worker nodes. Application workload runs on worker nodes.
|
||||
|
||||
## Rancher
|
||||
|
||||
We now cover high-level Rancher architecture.
|
||||
|
||||
Majority of Rancher 2.0 software runs on the Rancher server. Rancher server includes all the software components used to manage the entire Rancher deployment.
|
||||
|
||||
The figure below illustrates the high-level architecture of Rancher 2.0. The figure depicts a Rancher server installation that manages two Kubernetes clusters: one Kubernetes cluster created by RKE and another Kubernetes cluster created by GKE.
|
||||
|
||||
|
||||
|
||||
In this section we describe the functionalities of each Rancher server components.
|
||||
|
||||
#### Rancher API Server
|
||||
|
||||
Rancher API server is built on top of an embedded Kubernetes API server and etcd database. It implements the following functionalities:
|
||||
|
||||
1. User management. Rancher API server manages user identities that correspond to external authentication providers like Active Directory or GitHub.
|
||||
|
||||
2. Authorization. Rancher API server manages access control and security policies.
|
||||
|
||||
3. Projects. A project is a grouping of multiple namespaces and access control policies within a cluster.
|
||||
|
||||
4. Nodes. Rancher API server tracks identities of all the nodes in all clusters.
|
||||
|
||||
#### Cluster Controller and Agents
|
||||
|
||||
The cluster controller and cluster agents implement the business logic required to manage Kubernetes clusters. All the logic that is global to the entire Rancher install is implemented by the cluster controller. A separate cluster agent instance implements the logic required for the corresponding cluster.
|
||||
|
||||
Cluster agents perform the following activities:
|
||||
|
||||
- Manage workload. This includes, for example, creating pods and deployments in each cluster.
|
||||
|
||||
- Applying roles and bindings that are defined in global policies into every cluster.
|
||||
|
||||
- Propagate information from cluster to rancher server: events, stats, node info, and health.
|
||||
|
||||
The cluster controller performs the following activities:
|
||||
|
||||
- Configures access control policies to clusters and projects.
|
||||
|
||||
- Provisions clusters by invoking the necessary Docker machine drivers and invoking Kubernetes engines like RKE and GKE.
|
||||
|
||||
#### Authentication Proxy
|
||||
|
||||
The authentication proxy proxies all Kubernetes API calls. It integrates with authentication services like local authentication, Active Directory, and GitHub. On every Kubernetes API call, the authentication proxy authenticates the caller and sets the proper Kubernetes impersonation headers before forwarding the call to Kubernetes masters. Rancher communicates with Kubernetes clusters using a service account.
|
||||
+1
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Quick Start
|
||||
weight: 25
|
||||
aliases: [/docs/rancher/v2.0/en/quick-start-guide]
|
||||
---
|
||||
|
||||
# Quick Start Guide
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user