rke

README

rke

This file is auto-generated from README-template.md, please make any changes there.

Rancher Kubernetes Engine, an extremely simple, lightning fast Kubernetes installer that works everywhere.

Latest Release

• v1.4
  • v1.4.4 - Read the full release notes.
• v1.3
  • v1.3.19 - Read the full release notes.
• v1.2
  • v1.2.23 - Read the full release notes.

Download

Please check the releases page.

Requirements

Please review the OS requirements for each node in your Kubernetes cluster.

Getting Started

Please refer to our RKE docs for information on how to get started! For cluster config examples, refer to RKE cluster.yml examples

Installing Rancher HA using rke

Please use High Availability (HA) Install to install Rancher in a high-availability configuration.

Building

RKE can be built using the make command, and will use the scripts in the scripts directory as subcommands. The default subcommand is ci and will use scripts/ci. Cross compiling can be enabled by setting the environment variable CROSS=1. The compiled binaries can be found in the build/bin directory. Dependencies are managed by Go modules and can be found in go.mod.

RKE now fetches data.json from https://github.com/rancher/kontainer-driver-metadata. To fetch data.json and compile it in rke, run

go generate

# Change RANCHER_METADATA_URL to an external URL instead of using https://releases.rancher.com/kontainer-driver-metadata/dev-v2.6/data.json by default
RANCHER_METADATA_URL=${URL} go generate

# Or load it from local file
RANCHER_METATDATA_URL=./local/data.json go generate

# Compile RKE
make

To specify RANCHER_METADATA_URL in runtime, populate the environment variable when running rke CLI. For example:

RANCHER_METADATA_URL=${URL} rke [commands] [options]

RANCHER_METADATA_URL=${./local/data.json} rke [commands] [options]

RANCHER_METADATA_URL defaults to https://releases.rancher.com/kontainer-driver-metadata/dev-v2.6/data.json.

License

Copyright (c) 2023 Rancher Labs, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.