mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-27 13:38:07 +00:00
Fix tabs: add import statements, specify value, spacing
This commit is contained in:
Billy Tat
@@ -4,6 +4,9 @@ description: Create a Keycloak SAML client and configure Rancher to work with Ke
|
||||
weight: 1200
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
If your organization uses Keycloak Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials.
|
||||
|
||||
## Prerequisites
|
||||
@@ -35,11 +38,13 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati
|
||||
## Getting the IDP Metadata
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Keycloak 5 and earlier">
|
||||
<TabItem value="Keycloak 5 and earlier">
|
||||
|
||||
To get the IDP metadata, export a `metadata.xml` file from your Keycloak client.
|
||||
From the **Installation** tab, choose the **SAML Metadata IDPSSODescriptor** format option and download your file.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Keycloak 6-13">
|
||||
<TabItem value="Keycloak 6-13">
|
||||
|
||||
1. From the **Configure** section, click the **Realm Settings** tab.
|
||||
1. Click the **General** tab.
|
||||
@@ -78,7 +83,7 @@ You are left with something similar as the example below:
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Keycloak 14+">
|
||||
<TabItem value="Keycloak 14+">
|
||||
|
||||
1. From the **Configure** section, click the **Realm Settings** tab.
|
||||
1. Click the **General** tab.
|
||||
@@ -117,7 +122,7 @@ The following is an example process for Firefox, but will vary slightly for othe
|
||||
Rancher redirects you to the IdP login page. Enter credentials that authenticate with Keycloak IdP to validate your Rancher Keycloak configuration.
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
You may have to disable your popup blocker to see the IdP login page.
|
||||
|
||||
:::
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Custom Branding
|
||||
weight: 90
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
Rancher v2.6 introduced the ability to customize Rancher’s branding and navigation links.
|
||||
|
||||
- [Changing Brand Settings](#changing-brand-settings)
|
||||
@@ -19,7 +22,7 @@ You will need to have at least cluster member permissions.
|
||||
|
||||
:::
|
||||
|
||||
To configure the brand settings,
|
||||
To configure the brand settings,
|
||||
|
||||
1. Click **☰ > Global settings**.
|
||||
2. Click **Branding**.
|
||||
@@ -45,10 +48,13 @@ You can override the primary color used throughout the UI with a custom color of
|
||||
### Fixed Banners
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Rancher before v2.6.4">
|
||||
<TabItem value="Rancher before v2.6.4">
|
||||
|
||||
Display a custom fixed banner in the header, footer, or both.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Rancher v2.6.4+">
|
||||
<TabItem value="Rancher v2.6.4+">
|
||||
|
||||
Display a custom fixed banner in the header, footer, or both.
|
||||
|
||||
As of Rancher v2.6.4, configuration of fixed banners has moved from the **Branding** tab to the **Banners** tab.
|
||||
@@ -57,12 +63,13 @@ To configure banner settings,
|
||||
|
||||
1. Click **☰ > Global settings**.
|
||||
2. Click **Banners**.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
# Custom Navigation Links
|
||||
|
||||
In this section, you'll learn how to configure the links in the left navigation bar of the **Cluster Dashboard**. To get to the cluster dashboard,
|
||||
In this section, you'll learn how to configure the links in the left navigation bar of the **Cluster Dashboard**. To get to the cluster dashboard,
|
||||
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. On the **Clusters** page, go to the cluster where you want custom navigation links and click **Explore**.
|
||||
@@ -96,7 +103,7 @@ You will need to have at least cluster member or project member permissions.
|
||||
|
||||
# Link Configuration
|
||||
|
||||
### `name`
|
||||
### `name`
|
||||
|
||||
Display name for the link. Required.
|
||||
|
||||
@@ -124,7 +131,7 @@ data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAgAElEQVR4Ae
|
||||
|
||||
A Kubernetes annotation for the NavLink custom resource.
|
||||
|
||||
### `label`
|
||||
### `label`
|
||||
|
||||
A Kubernetes label for the NavLink custom resource.
|
||||
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Cluster and Project Roles
|
||||
weight: 1127
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
Cluster and project roles define user authorization inside a cluster or project.
|
||||
|
||||
To manage these roles,
|
||||
@@ -16,7 +19,7 @@ The projects and clusters accessible to non-administrative users is determined b
|
||||
|
||||
When you create a cluster or project, Rancher automatically assigns you as the `Owner` for it. Users assigned the `Owner` role can assign other users roles in the cluster or project.
|
||||
|
||||
:::note
|
||||
:::note
|
||||
|
||||
Non-administrative users cannot access any existing projects/clusters by default. A user with appropriate permissions (typically the owner) must explicitly assign the project and cluster membership.
|
||||
|
||||
@@ -89,21 +92,25 @@ To assign a custom role to a new cluster member, you can use the Rancher UI. To
|
||||
To assign the role to a new cluster member,
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Rancher before v2.6.4">
|
||||
<TabItem value="Rancher before v2.6.4">
|
||||
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Go to the cluster where you want to assign a role to a member and click **Explore**.
|
||||
1. Click **RBAC > Cluster Members**.
|
||||
1. Click **Add**.
|
||||
1. In the **Cluster Permissions** section, choose the custom cluster role that should be assigned to the member.
|
||||
1. Click **Create**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Rancher v2.6.4+">
|
||||
<TabItem value="Rancher v2.6.4+">
|
||||
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Go to the cluster where you want to assign a role to a member and click **Explore**.
|
||||
1. Click **Cluster > Cluster Members**.
|
||||
1. Click **Add**.
|
||||
1. In the **Cluster Permissions** section, choose the custom cluster role that should be assigned to the member.
|
||||
1. Click **Create**.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
@@ -131,7 +138,7 @@ _Project roles_ are roles that can be used to grant users access to a project. T
|
||||
These users can manage project-scoped resources like namespaces and workloads, but cannot manage other project members.
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
By default, the Rancher role of `project-member` inherits from the `Kubernetes-edit` role, and the `project-owner` role inherits from the `Kubernetes-admin` role. As such, both `project-member` and `project-owner` roles will allow for namespace management, including the ability to create and delete namespaces.
|
||||
|
||||
:::
|
||||
@@ -141,7 +148,7 @@ _Project roles_ are roles that can be used to grant users access to a project. T
|
||||
These users can view everything in the project but cannot create, update, or delete anything.
|
||||
|
||||
:::note danger
|
||||
|
||||
|
||||
Users assigned the `Owner` or `Member` role for a project automatically inherit the `namespace creation` role. However, this role is a [Kubernetes ClusterRole](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole), meaning its scope extends to all projects in the cluster. Therefore, users explicitly assigned the `owner` or `member` role for a project can create namespaces in other projects they're assigned to, even with only the `Read Only` role assigned.
|
||||
|
||||
:::
|
||||
|
||||
+6
-3
@@ -3,19 +3,22 @@ title: API
|
||||
weight: 24
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## How to use the API
|
||||
|
||||
The API has its own user interface accessible from a web browser. This is an easy way to see resources, perform actions, and see the equivalent cURL or HTTP request & response. To access it:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Rancher v2.6.4+">
|
||||
<TabItem value="Rancher v2.6.4+">
|
||||
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click **Account & API Keys**.
|
||||
1. Under the **API Keys** section, find the **API Endpoint** field and click the link. The link will look something like `https://<RANCHER_FQDN>/v3`, where `<RANCHER_FQDN>` is the fully qualified domain name of your Rancher deployment.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Rancher before v2.6.4">
|
||||
<TabItem value="Rancher before v2.6.4">
|
||||
|
||||
Go to the URL endpoint at `https://<RANCHER_FQDN>/v3`, where `<RANCHER_FQDN>` is the fully qualified domain name of your Rancher deployment.
|
||||
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Certificate Rotation
|
||||
weight: 2040
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::caution
|
||||
|
||||
Rotating Kubernetes certificates may result in your cluster being temporarily unavailable as components are restarted. For production environments, it's recommended to perform this action during a maintenance window.
|
||||
@@ -14,7 +17,7 @@ By default, Kubernetes clusters require certificates and Rancher launched Kubern
|
||||
Certificates can be rotated for the following services:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="RKE">
|
||||
<TabItem value="RKE">
|
||||
|
||||
- etcd
|
||||
- kubelet (node certificate)
|
||||
@@ -25,7 +28,7 @@ Certificates can be rotated for the following services:
|
||||
- kube-controller-manager
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE2">
|
||||
<TabItem value="RKE2">
|
||||
|
||||
- admin
|
||||
- api-server
|
||||
@@ -66,12 +69,12 @@ Rancher launched Kubernetes clusters have the ability to rotate the auto-generat
|
||||
### Additional Notes
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="RKE">
|
||||
<TabItem value="RKE">
|
||||
|
||||
Even though the RKE CLI can use custom certificates for the Kubernetes cluster components, Rancher currently doesn't allow the ability to upload these in Rancher launched Kubernetes clusters.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE2">
|
||||
<TabItem value="RKE2">
|
||||
|
||||
In RKE2, both etcd and control plane nodes are treated as the same `server` concept. As such, when rotating certificates of services specific to either of these components will result in certificates being rotated on both. The certificates will only change for the specified service, but you will see nodes for both components go into an updating state. You may also see worker only nodes go into an updating state. This is to restart the workers after a certificate change to ensure they get the latest client certs.
|
||||
|
||||
|
||||
@@ -4,6 +4,9 @@ description: Learn about cluster cleanup when removing nodes from your Rancher-l
|
||||
weight: 2055
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
This section describes how to disconnect a node from a Rancher-launched Kubernetes cluster and remove all of the Kubernetes components from the node. This process allows you to use the node for other purposes.
|
||||
|
||||
When you use Rancher to install Kubernetes on new nodes in an infrastructure provider, resources (containers/virtual network interfaces) and configuration items (certificates/configuration files) are created.
|
||||
@@ -60,7 +63,8 @@ For registered clusters, the process for removing Rancher is a little different.
|
||||
After the registered cluster is detached from Rancher, the cluster's workloads will be unaffected and you can access the cluster using the same methods that you did before the cluster was registered into Rancher.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="By UI / API">
|
||||
<TabItem value="By UI / API">
|
||||
|
||||
:::danger
|
||||
|
||||
This process will remove data from your cluster. Make sure you have created a backup of files you want to keep before executing the command, as data will be lost.
|
||||
@@ -78,7 +82,8 @@ After you initiate the removal of a registered cluster using the Rancher UI (or
|
||||
**Result:** All components listed for registered clusters in [What Gets Removed?](#what-gets-removed) are deleted.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="By Script">
|
||||
<TabItem value="By Script">
|
||||
|
||||
Rather than cleaning registered cluster nodes using the Rancher UI, you can run a script instead.
|
||||
|
||||
:::note Prerequisite:
|
||||
@@ -102,7 +107,7 @@ Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
|
||||
1. From the same directory, run the script and provide the `rancher/rancher-agent` image version which should be equal to the version of Rancher used to manage the cluster. (`<RANCHER_VERSION>`):
|
||||
|
||||
:::tip
|
||||
|
||||
|
||||
Add the `-dry-run` flag to preview the script's outcome without making changes.
|
||||
```
|
||||
./user-cluster.sh rancher/rancher-agent:<RANCHER_VERSION>
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Node Requirements for Rancher Managed Clusters
|
||||
weight: 1
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
This page describes the requirements for the Rancher managed Kubernetes clusters where your apps and services will be installed. These downstream clusters should be separate from the three-node cluster running Rancher.
|
||||
|
||||
:::note
|
||||
@@ -37,7 +40,7 @@ Some distributions of Linux derived from RHEL, including Oracle Linux, may have
|
||||
:::note
|
||||
|
||||
In RHEL 8.4, two extra services are included on the NetworkManager: `nm-cloud-setup.service` and `nm-cloud-setup.timer`. These services add a routing table that interferes with the CNI plugin's configuration. If these services are enabled, you must disable them using the command below, and then reboot the node to restore connectivity:
|
||||
|
||||
|
||||
```
|
||||
systemctl disable nm-cloud-setup.service nm-cloud-setup.timer
|
||||
reboot
|
||||
@@ -54,7 +57,7 @@ SUSE Linux may have a firewall that blocks all ports by default. In that situati
|
||||
When [Launching Kubernetes with Rancher]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) using Flatcar Container Linux nodes, it is required to use the following configuration in the [Cluster Config File]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file)
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Canal">
|
||||
<TabItem value="Canal">
|
||||
|
||||
```yaml
|
||||
rancher_kubernetes_engine_config:
|
||||
@@ -69,9 +72,9 @@ rancher_kubernetes_engine_config:
|
||||
extra_args:
|
||||
flex-volume-plugin-dir: /opt/kubernetes/kubelet-plugins/volume/exec/
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Calico">
|
||||
</TabItem>
|
||||
<TabItem value="Calico">
|
||||
|
||||
```yaml
|
||||
rancher_kubernetes_engine_config:
|
||||
@@ -86,6 +89,7 @@ rancher_kubernetes_engine_config:
|
||||
extra_args:
|
||||
flex-volume-plugin-dir: /opt/kubernetes/kubelet-plugins/volume/exec/
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
@@ -4,6 +4,9 @@ shortTitle: Azure
|
||||
weight: 2220
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
In this section, you'll learn how to install an [RKE]({{<baseurl>}}/rke/latest/en/) Kubernetes cluster in Azure through Rancher.
|
||||
|
||||
First, you will set up your Azure cloud credentials in Rancher. Then you will use your cloud credentials to create a node template, which Rancher will use to provision new nodes in Azure.
|
||||
@@ -48,7 +51,7 @@ The creation of this service principal returns three pieces of identification in
|
||||
# Creating an Azure Cluster
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="RKE">
|
||||
<TabItem value="RKE">
|
||||
|
||||
1. [Create your cloud credentials](#1-create-your-cloud-credentials)
|
||||
2. [Create a node template with your cloud credentials](#2-create-a-node-template-with-your-cloud-credentials)
|
||||
@@ -89,7 +92,7 @@ Use Rancher to create a Kubernetes cluster in Azure.
|
||||
1. Click **Create**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE2">
|
||||
<TabItem value="RKE2">
|
||||
|
||||
### 1. Create your cloud credentials
|
||||
|
||||
|
||||
@@ -3,6 +3,10 @@ title: Creating a DigitalOcean Cluster
|
||||
shortTitle: DigitalOcean
|
||||
weight: 2215
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
In this section, you'll learn how to use Rancher to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in DigitalOcean.
|
||||
|
||||
First, you will set up your DigitalOcean cloud credentials in Rancher. Then you will use your cloud credentials to create a node template, which Rancher will use to provision new nodes in DigitalOcean.
|
||||
@@ -10,7 +14,7 @@ First, you will set up your DigitalOcean cloud credentials in Rancher. Then you
|
||||
Then you will create a DigitalOcean cluster in Rancher, and when configuring the new cluster, you will define node pools for it. Each node pool will have a Kubernetes role of etcd, controlplane, or worker. Rancher will install RKE Kubernetes on the new nodes, and it will set up each node with the Kubernetes role defined by the node pool.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="RKE">
|
||||
<TabItem value="RKE">
|
||||
|
||||
1. [Create your cloud credentials](#1-create-your-cloud-credentials)
|
||||
2. [Create a node template with your cloud credentials](#2-create-a-node-template-with-your-cloud-credentials)
|
||||
@@ -49,7 +53,7 @@ Creating a [node template]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/rk
|
||||
1. Click **Create**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE2">
|
||||
<TabItem value="RKE2">
|
||||
|
||||
### 1. Create your cloud credentials
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@ shortTitle: Amazon EC2
|
||||
description: Learn the prerequisites and steps required in order for you to create an Amazon EC2 cluster using Rancher
|
||||
weight: 2210
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
In this section, you'll learn how to use Rancher to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in Amazon EC2.
|
||||
|
||||
First, you will set up your EC2 cloud credentials in Rancher. Then you will use your cloud credentials to create a node template, which Rancher will use to provision new nodes in EC2.
|
||||
@@ -24,7 +28,7 @@ Then you will create an EC2 cluster in Rancher, and when configuring the new clu
|
||||
The steps to create a cluster differ based on your Rancher version.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="RKE">
|
||||
<TabItem value="RKE">
|
||||
|
||||
1. [Create your cloud credentials](#1-create-your-cloud-credentials)
|
||||
2. [Create a node template with your cloud credentials and information from EC2](#2-create-a-node-template-with-your-cloud-credentials-and-information-from-ec2)
|
||||
@@ -54,7 +58,7 @@ Creating a [node template]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/rk
|
||||
1. Click **Create**.
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{<baseurl>}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration.
|
||||
|
||||
:::
|
||||
@@ -71,15 +75,15 @@ Add one or more node pools to your cluster. For more information about node pool
|
||||
1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. Refer to [Selecting Cloud Providers]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) to configure the Kubernetes Cloud Provider. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options)
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{<baseurl>}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
1. Click **Create**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE2">
|
||||
<TabItem value="RKE2">
|
||||
|
||||
### 1. Create your cloud credentials
|
||||
|
||||
|
||||
@@ -4,6 +4,9 @@ description: Learn how to install Rancher in development and production environm
|
||||
weight: 2
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI.
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
@@ -179,8 +182,7 @@ This final command to install Rancher requires a domain name that forwards traff
|
||||
:::
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Rancher-generated Certificates">
|
||||
|
||||
<TabItem value="Rancher-generated Certificates">
|
||||
|
||||
The default is for Rancher to generate a CA and uses `cert-manager` to issue the certificate for access to the Rancher server interface.
|
||||
|
||||
@@ -207,7 +209,7 @@ deployment "rancher" successfully rolled out
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Let's Encrypt">
|
||||
<TabItem value="Let's Encrypt">
|
||||
|
||||
This option uses `cert-manager` to automatically request and renew [Let's Encrypt](https://letsencrypt.org/) certificates. This is a free service that provides you with a valid certificate as Let's Encrypt is a trusted CA.
|
||||
|
||||
@@ -245,7 +247,7 @@ deployment "rancher" successfully rolled out
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Certificates from Files">
|
||||
<TabItem value="Certificates from Files">
|
||||
In this option, Kubernetes secrets are created from your own certificates for Rancher to use.
|
||||
|
||||
When you run this command, the `hostname` option must match the `Common Name` or a `Subject Alternative Names` entry in the server certificate or the Ingress controller will fail to configure correctly.
|
||||
@@ -283,6 +285,7 @@ helm install rancher rancher-<CHART_REPO>/rancher \
|
||||
```
|
||||
|
||||
Now that Rancher is deployed, see [Adding TLS Secrets]({{<baseurl>}}/rancher/v2.6/en/installation/resources/tls-secrets/) to publish the certificate files so Rancher and the Ingress controller can use them.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
+10
-4
@@ -3,6 +3,9 @@ title: '3. Install Kubernetes (Skip for Docker Installs)'
|
||||
weight: 300
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::note
|
||||
|
||||
Skip this section if you are installing Rancher on a single node with Docker.
|
||||
@@ -16,7 +19,7 @@ Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes
|
||||
The steps to set up an air-gapped Kubernetes cluster on RKE, RKE2, or K3s are shown below.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="K3s">
|
||||
<TabItem value="K3s">
|
||||
|
||||
In this guide, we are assuming you have created your nodes in your air gapped environment and have a secure Docker private registry on your bastion server.
|
||||
|
||||
@@ -100,7 +103,7 @@ K3s additionally provides a `--resolv-conf` flag for kubelets, which may help wi
|
||||
|
||||
When you installed K3s on each Rancher server node, a `kubeconfig` file was created on the node at `/etc/rancher/k3s/k3s.yaml`. This file contains credentials for full access to the cluster, and you should save this file in a secure location.
|
||||
|
||||
To use this `kubeconfig` file,
|
||||
To use this `kubeconfig` file,
|
||||
|
||||
1. Install [kubectl,](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) a Kubernetes command-line tool.
|
||||
2. Copy the file at `/etc/rancher/k3s/k3s.yaml` and save it to the directory `~/.kube/config` on your local machine.
|
||||
@@ -143,8 +146,9 @@ Upgrading an air-gap environment can be accomplished in the following manner:
|
||||
1. Download the new air-gap images (tar file) from the [releases](https://github.com/k3s-io/k3s/releases) page for the version of K3s you will be upgrading to. Place the tar in the `/var/lib/rancher/k3s/agent/images/` directory on each node. Delete the old tar file.
|
||||
2. Copy and replace the old K3s binary in `/usr/local/bin` on each node. Copy over the install script at https://get.k3s.io (as it is possible it has changed since the last release). Run the script again just as you had done in the past with the same environment variables.
|
||||
3. Restart the K3s service (if not restarted automatically by installer).
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE2">
|
||||
<TabItem value="RKE2">
|
||||
|
||||
In this guide, we are assuming you have created your nodes in your air-gapped environment and have a secure Docker private registry on your bastion server.
|
||||
|
||||
@@ -283,8 +287,9 @@ Upgrading an air-gap environment can be accomplished in the following manner:
|
||||
1. Download the new air-gap artifacts and install script from the [releases](https://github.com/rancher/rke2/releases) page for the version of RKE2 you will be upgrading to.
|
||||
2. Run the script again just as you had done in the past with the same environment variables.
|
||||
3. Restart the RKE2 service.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE">
|
||||
<TabItem value="RKE">
|
||||
We will create a Kubernetes cluster using Rancher Kubernetes Engine (RKE). Before being able to start your Kubernetes cluster, you’ll need to install RKE and create a RKE config file.
|
||||
|
||||
### 1. Install RKE
|
||||
@@ -363,6 +368,7 @@ Save a copy of the following files in a secure location:
|
||||
- `rancher-cluster.yml`: The RKE cluster configuration file.
|
||||
- `kube_config_cluster.yml`: The [Kubeconfig file]({{<baseurl>}}/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster.
|
||||
- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file]({{<baseurl>}}/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates.<br/><br/>_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
+6
-3
@@ -3,6 +3,9 @@ title: '2. Collect and Publish Images to your Private Registry'
|
||||
weight: 200
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
This section describes how to set up your private registry so that when you install Rancher, Rancher will pull all the required images from this registry.
|
||||
|
||||
By default, all images used to [provision Kubernetes clusters]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/) or launch any tools in Rancher, e.g. monitoring, pipelines, alerts, are pulled from Docker Hub. In an air gapped installation of Rancher, you will need a private registry that is located somewhere accessible by your Rancher server. Then, you will load the registry with all the images.
|
||||
@@ -20,7 +23,7 @@ If the registry has certs, follow [this K3s documentation](https://rancher.com/d
|
||||
:::
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Linux Only Clusters">
|
||||
<TabItem value="Linux Only Clusters">
|
||||
|
||||
For Rancher servers that will only provision Linux clusters, these are the steps to populate your private registry.
|
||||
|
||||
@@ -119,8 +122,9 @@ The `rancher-images.txt` is expected to be on the workstation in the same direct
|
||||
```plain
|
||||
./rancher-load-images.sh --image-list ./rancher-images.txt --registry <REGISTRY.YOURDOMAIN.COM:PORT>
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Linux and Windows Clusters">
|
||||
<TabItem value="Linux and Windows Clusters">
|
||||
|
||||
For Rancher servers that will provision Linux and Windows clusters, there are distinctive steps to populate your private registry for the Windows images and the Linux images. Since a Windows cluster is a mix of Linux and Windows nodes, the Linux images pushed into the private registry are manifests.
|
||||
|
||||
@@ -304,7 +308,6 @@ The image list, `rancher-images.txt` or `rancher-windows-images.txt`, is expecte
|
||||
--registry <REGISTRY.YOURDOMAIN.COM:PORT>
|
||||
```
|
||||
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
+8
-3
@@ -3,6 +3,9 @@ title: '1. Set up Infrastructure and Private Registry'
|
||||
weight: 100
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
In this section, you will provision the underlying infrastructure for your Rancher management server in an air gapped environment. You will also set up the private Docker registry that must be available to your Rancher node(s).
|
||||
|
||||
An air gapped environment is an environment where the Rancher server is installed offline or behind a firewall.
|
||||
@@ -12,7 +15,8 @@ The infrastructure depends on whether you are installing Rancher on a K3s Kubern
|
||||
Rancher can be installed on any Kubernetes cluster. The RKE and K3s Kubernetes infrastructure tutorials below are still included for convenience.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="K3s">
|
||||
<TabItem value="K3s">
|
||||
|
||||
We recommend setting up the following infrastructure for a high-availability installation:
|
||||
|
||||
- **Two Linux nodes,** typically virtual machines, in the infrastructure provider of your choice.
|
||||
@@ -85,8 +89,9 @@ Rancher supports air gap installs using a private registry. You must have your o
|
||||
In a later step, when you set up your K3s Kubernetes cluster, you will create a [private registries configuration file]({{<baseurl>}}/k3s/latest/en/installation/private-registry/) with details from this registry.
|
||||
|
||||
If you need help with creating a private registry, please refer to the [official Docker documentation.](https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry)
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="RKE">
|
||||
<TabItem value="RKE">
|
||||
|
||||
To install the Rancher management server on a high-availability RKE cluster, we recommend setting up the following infrastructure:
|
||||
|
||||
@@ -153,7 +158,7 @@ In a later step, when you set up your RKE Kubernetes cluster, you will create a
|
||||
If you need help with creating a private registry, please refer to the [official Docker documentation.](https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry)
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Docker">
|
||||
<TabItem value="Docker">
|
||||
|
||||
:::note Notes:
|
||||
|
||||
|
||||
+12
-8
@@ -3,6 +3,9 @@ title: Upgrading Rancher Installed with Docker
|
||||
weight: 1010
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The following instructions will guide you through upgrading a Rancher server that was installed with Docker.
|
||||
|
||||
:::caution
|
||||
@@ -134,7 +137,7 @@ To see the command to use when starting the new Rancher server container, choose
|
||||
- Docker Upgrade for Air Gap Installs
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Docker Upgrade">
|
||||
<TabItem value="Docker Upgrade">
|
||||
|
||||
Select which option you had installed Rancher server
|
||||
|
||||
@@ -166,7 +169,7 @@ Privileged access is [required.]({{<baseurl>}}/rancher/v2.6/en/installation/othe
|
||||
|
||||
If you have selected to bring your own self-signed certificate, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to have access to the same certificate that you had originally installed with.
|
||||
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
|
||||
The certificate files must be in PEM format. In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates.
|
||||
|
||||
@@ -201,7 +204,7 @@ Privileged access is [required.]({{<baseurl>}}/rancher/v2.6/en/installation/othe
|
||||
|
||||
If you have selected to use a certificate signed by a recognized CA, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to have access to the same certificates that you had originally installed with. Remember to include `--no-cacerts` as an argument to the container to disable the default CA certificate generated by Rancher.
|
||||
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
|
||||
The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{<baseurl>}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting)
|
||||
|
||||
@@ -240,7 +243,7 @@ Let's Encrypt provides rate limits for requesting new certificates. Therefore, l
|
||||
|
||||
If you have selected to use [Let's Encrypt](https://letsencrypt.org/) certificates, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to provide the domain that you had used when you originally installed Rancher.
|
||||
|
||||
:::note Reminder of the Cert Prerequisites:
|
||||
:::note Reminder of the Cert Prerequisites:
|
||||
|
||||
- Create a record in your DNS that binds your Linux host IP address to the hostname that you want to use for Rancher access (`rancher.mydomain.com` for example).
|
||||
- Open port `TCP/80` on your Linux host. The Let's Encrypt http-01 challenge can come from any source IP address, so port `TCP/80` must be open to all IP addresses.
|
||||
@@ -266,7 +269,7 @@ Privileged access is [required.]({{<baseurl>}}/rancher/v2.6/en/installation/othe
|
||||
{{% /accordion %}}
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Docker Air Gap Upgrade">
|
||||
<TabItem value="Docker Air Gap Upgrade">
|
||||
|
||||
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.
|
||||
|
||||
@@ -302,7 +305,7 @@ Privileged access is [required.]({{<baseurl>}}/rancher/v2.6/en/installation/othe
|
||||
|
||||
If you have selected to bring your own self-signed certificate, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to have access to the same certificate that you had originally installed with.
|
||||
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
|
||||
The certificate files must be in PEM format. In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{<baseurl>}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting)
|
||||
|
||||
@@ -337,8 +340,8 @@ Privileged access is [required.]({{<baseurl>}}/rancher/v2.6/en/installation/othe
|
||||
|
||||
If you have selected to use a certificate signed by a recognized CA, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to have access to the same certificates that you had originally installed with.
|
||||
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
|
||||
:::note Reminder of the Cert Prerequisite:
|
||||
|
||||
The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{<baseurl>}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting)
|
||||
|
||||
:::
|
||||
@@ -371,6 +374,7 @@ docker run -d --volumes-from rancher-data \
|
||||
```
|
||||
privileged access is [required.]({{<baseurl>}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher)
|
||||
{{% /accordion %}}
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
@@ -4,6 +4,9 @@ description: Read about port requirements needed in order for Rancher to operate
|
||||
weight: 300
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes.
|
||||
|
||||
- [Rancher Nodes](#rancher-nodes)
|
||||
@@ -301,7 +304,7 @@ When using the [AWS EC2 node driver]({{<baseurl>}}/rancher/v2.6/en/cluster-provi
|
||||
SUSE Linux may have a firewall that blocks all ports by default. To open the ports needed for adding the host to a custom cluster,
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="SLES 15 / openSUSE Leap 15">
|
||||
<TabItem value="SLES 15 / openSUSE Leap 15">
|
||||
1. SSH into the instance.
|
||||
1. Start YaST in text mode:
|
||||
```
|
||||
@@ -320,7 +323,7 @@ UDP Ports
|
||||
1. When all required ports are enter, select **Accept**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="SLES 12 / openSUSE Leap 42">
|
||||
<TabItem value="SLES 12 / openSUSE Leap 42">
|
||||
1. SSH into the instance.
|
||||
1. Edit /`etc/sysconfig/SuSEfirewall2` and open the required ports. In this example, ports 9796 and 10250 are also opened for monitoring:
|
||||
```
|
||||
@@ -332,6 +335,7 @@ UDP Ports
|
||||
```
|
||||
SuSEfirewall2
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Choosing a Rancher Version
|
||||
weight: 1
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
This section describes how to choose a Rancher version.
|
||||
|
||||
For a high-availability installation of Rancher, which is recommended for production, the Rancher server is installed using a **Helm chart** on a Kubernetes cluster. Refer to the [Helm version requirements]({{<baseurl>}}/rancher/v2.6/en/installation/resources/helm-version) to choose a version of Helm to install Rancher.
|
||||
@@ -10,7 +13,7 @@ For a high-availability installation of Rancher, which is recommended for produc
|
||||
For Docker installations of Rancher, which is used for development and testing, you will install Rancher as a **Docker image**.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Helm Charts">
|
||||
<TabItem value="Helm Charts">
|
||||
|
||||
When installing, upgrading, or rolling back Rancher Server when it is [installed on a Kubernetes cluster]({{<baseurl>}}/rancher/v2.6/en/installation/install-rancher-on-k8s/), Rancher server is installed using a Helm chart on a Kubernetes cluster. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must add a Helm chart repository that contains the charts for installing Rancher.
|
||||
|
||||
@@ -81,8 +84,9 @@ Because the rancher-alpha repository contains only alpha charts, switching betwe
|
||||
```
|
||||
|
||||
4. Continue to follow the steps to [upgrade Rancher]({{<baseurl>}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades) from the new Helm chart repository.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Docker Images">
|
||||
<TabItem value="Docker Images">
|
||||
When performing [Docker installs]({{<baseurl>}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher.
|
||||
|
||||
### Server Tags
|
||||
@@ -102,5 +106,5 @@ Rancher Server is distributed as a Docker image, which have tags attached to the
|
||||
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
@@ -4,6 +4,9 @@ shortTitle: GKE
|
||||
weight: 3
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
In this section, you'll learn how to install Rancher using Google Kubernetes Engine.
|
||||
|
||||
If you already have a GKE Kubernetes cluster, skip to the step about [installing an ingress.](#7-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{<baseurl>}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart)
|
||||
@@ -59,8 +62,8 @@ To install `gcloud` and `kubectl`, perform the following steps:
|
||||
```
|
||||
source ~/.bash_profile
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# 3. Configure the gcloud CLI
|
||||
|
||||
@@ -70,7 +73,7 @@ To install `gcloud` and `kubectl`, perform the following steps:
|
||||
- Using gcloud config, to individually set your project ID, zone, and region.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Using gcloud init">
|
||||
<TabItem value="Using gcloud init">
|
||||
|
||||
1. Run gcloud init and follow the directions:
|
||||
|
||||
@@ -84,8 +87,9 @@ To install `gcloud` and `kubectl`, perform the following steps:
|
||||
```
|
||||
2. Follow the instructions to authorize gcloud to use your Google Cloud account and select the new project that you created.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Using gcloud config">
|
||||
<TabItem value="Using gcloud config">
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
@@ -4,6 +4,9 @@ shortTitle: Receivers
|
||||
weight: 1
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configuration/#configuration-file) Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus.
|
||||
|
||||
:::note
|
||||
@@ -39,7 +42,7 @@ This section assumes familiarity with how monitoring components work together. F
|
||||
To create notification receivers in the Rancher UI,
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Rancher v2.6.5+">
|
||||
<TabItem value="Rancher v2.6.5+">
|
||||
|
||||
1. Go to the cluster where you want to create receivers. Click **Monitoring -> Alerting -> AlertManagerConfigs**.
|
||||
1. Ciick **Create**.
|
||||
@@ -49,7 +52,7 @@ To create notification receivers in the Rancher UI,
|
||||
1. Click **Create**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Rancher before v2.6.5">
|
||||
<TabItem value="Rancher before v2.6.5">
|
||||
|
||||
1. Go to the cluster where you want to create receivers. Click **Monitoring** and click **Receiver**.
|
||||
2. Enter a name for the receiver.
|
||||
|
||||
@@ -4,6 +4,9 @@ shortTitle: Routes
|
||||
weight: 5
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The route configuration is the section of the Alertmanager custom resource that controls how the alerts fired by Prometheus are grouped and filtered before they reach the receiver.
|
||||
|
||||
When a Route is changed, the Prometheus Operator regenerates the Alertmanager custom resource to reflect the changes.
|
||||
@@ -47,7 +50,7 @@ The route needs to refer to a [receiver](#receiver-configuration) that has alrea
|
||||
### Grouping
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Rancher v2.6.5+">
|
||||
<TabItem value="Rancher v2.6.5+">
|
||||
|
||||
:::note
|
||||
|
||||
@@ -63,7 +66,7 @@ As of Rancher v2.6.5, `Group By` now accepts a list of strings instead of key-va
|
||||
| Repeat Interval | 4h | How long to wait before re-sending a given alert that has already been sent. |
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Rancher before v2.6.5">
|
||||
<TabItem value="Rancher before v2.6.5">
|
||||
|
||||
| Field | Default | Description |
|
||||
|-------|--------------|---------|
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Persistent Grafana Dashboards
|
||||
weight: 6
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
To allow the Grafana dashboard to persist after the Grafana instance restarts, add the dashboard configuration JSON into a ConfigMap. ConfigMaps also allow the dashboards to be deployed with a GitOps or CD based approach. This allows the dashboard to be put under version control.
|
||||
|
||||
- [Creating a Persistent Grafana Dashboard](#creating-a-persistent-grafana-dashboard)
|
||||
@@ -11,7 +14,7 @@ To allow the Grafana dashboard to persist after the Grafana instance restarts, a
|
||||
# Creating a Persistent Grafana Dashboard
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Rancher v2.5.8+">
|
||||
<TabItem value="Rancher v2.5.8+">
|
||||
|
||||
:::note Prerequisites:
|
||||
|
||||
@@ -33,7 +36,7 @@ To use your own dashboard:
|
||||
1. Log in to Grafana. Note: The default Admin username and password for the Grafana instance is `admin/prom-operator`. Alternative credentials can also be supplied on deploying or upgrading the chart.
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
Regardless of who has the password, in order to access the Grafana instance, you still need at least the <b>Manage Services</b> or <b>View Monitoring</b> permissions in the project that Rancher Monitoring is deployed into. Alternative credentials can also be supplied on deploying or upgrading the chart.
|
||||
|
||||
:::
|
||||
@@ -43,7 +46,7 @@ To use your own dashboard:
|
||||
|
||||
### 2. Create a ConfigMap using the Grafana JSON model
|
||||
|
||||
Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. cattle-dashboards by default).
|
||||
Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. cattle-dashboards by default).
|
||||
|
||||
The ConfigMap should look like this:
|
||||
|
||||
@@ -90,10 +93,10 @@ grafana.sidecar.dashboards.searchNamespace=ALL
|
||||
Note that the RBAC roles exposed by the Monitoring chart to add Grafana Dashboards are still restricted to giving permissions for users to add dashboards in the namespace defined in `grafana.dashboards.namespace`, which defaults to `cattle-dashboards`.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Rancher before v2.5.8">
|
||||
<TabItem value="Rancher before v2.5.8">
|
||||
|
||||
:::note Prerequisites:
|
||||
|
||||
|
||||
- The monitoring application needs to be installed.
|
||||
- You must have the cluster-admin ClusterRole permission.
|
||||
|
||||
@@ -106,11 +109,11 @@ Note that the RBAC roles exposed by the Monitoring chart to add Grafana Dashboar
|
||||
1. Log in to Grafana. Note: The default Admin username and password for the Grafana instance is `admin/prom-operator`. Alternative credentials can also be supplied on deploying or upgrading the chart.
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
Regardless of who has the password, cluster administrator permission in Rancher is still required to access the Grafana instance.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
1. Go to the dashboard that you want to persist. In the top navigation menu, go to the dashboard settings by clicking the gear icon.
|
||||
1. In the left navigation menu, click **JSON Model**.
|
||||
1. Copy the JSON data structure that appears.
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Pipelines
|
||||
weight: 10
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::note Notes
|
||||
|
||||
- As of Rancher v2.5, Git-based deployment pipelines are now deprecated. We recommend handling pipelines with Rancher Continuous Delivery powered by [Fleet]({{<baseurl>}}/rancher/v2.6/en/deploy-across-clusters/fleet). To get to Fleet in Rancher, click <b>☰ > Continuous Delivery</b>.
|
||||
@@ -22,7 +25,7 @@ After configuring Rancher and GitHub, you can deploy containers running Jenkins
|
||||
- Build your application from code to image.
|
||||
- Validate your builds.
|
||||
- Deploy your build images to your cluster.
|
||||
- Run unit tests.
|
||||
- Run unit tests.
|
||||
- Run regression tests.
|
||||
|
||||
:::note
|
||||
@@ -64,7 +67,7 @@ When you configure a pipeline in one of your projects, a namespace specifically
|
||||
The pipeline's build engine. Because project users do not directly interact with Jenkins, it's managed and locked.
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
There is no option to use existing Jenkins deployments as the pipeline engine.
|
||||
|
||||
:::
|
||||
@@ -78,7 +81,7 @@ When you configure a pipeline in one of your projects, a namespace specifically
|
||||
Minio storage is used to store the logs for pipeline executions.
|
||||
|
||||
:::note
|
||||
|
||||
|
||||
The managed Jenkins instance works statelessly, so don't worry about its data persistency. The Docker Registry and Minio instances use ephemeral volumes by default, which is fine for most use cases. If you want to make sure pipeline logs can survive node failures, you can configure persistent volumes for them, as described in [data persistency for pipeline components]({{<baseurl>}}/rancher/v2.6/en/pipelines/storage).
|
||||
|
||||
:::
|
||||
@@ -120,7 +123,7 @@ Before you can start configuring a pipeline for your repository, you must config
|
||||
Select your provider's tab below and follow the directions.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="GitHub">
|
||||
<TabItem value="GitHub">
|
||||
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. Go to the cluster where you want to configure pipelines and click **Explore**.
|
||||
@@ -133,7 +136,7 @@ Select your provider's tab below and follow the directions.
|
||||
1. Click **Authenticate**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="GitLab">
|
||||
<TabItem value="GitLab">
|
||||
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. Go to the cluster where you want to configure pipelines and click **Explore**.
|
||||
@@ -148,13 +151,13 @@ Select your provider's tab below and follow the directions.
|
||||
|
||||
:::note Notes:
|
||||
|
||||
1. Pipeline uses Gitlab [v4 API](https://docs.gitlab.com/ee/api/v3_to_v4.html) and the supported Gitlab version is 9.0+.
|
||||
1. Pipeline uses Gitlab [v4 API](https://docs.gitlab.com/ee/api/v3_to_v4.html) and the supported Gitlab version is 9.0+.
|
||||
2. If you use GitLab 10.7+ and your Rancher setup is in a local network, enable the **Allow requests to the local network from hooks and services** option in GitLab admin settings.
|
||||
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Bitbucket Cloud">
|
||||
<TabItem value="Bitbucket Cloud">
|
||||
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. Go to the cluster where you want to configure pipelines and click **Explore**.
|
||||
@@ -167,7 +170,7 @@ Select your provider's tab below and follow the directions.
|
||||
1. Click **Authenticate**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Bitbucket Server">
|
||||
<TabItem value="Bitbucket Server">
|
||||
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. Go to the cluster where you want to configure pipelines and click **Explore**.
|
||||
@@ -231,7 +234,7 @@ Now that repositories are added to your project, you can start configuring the p
|
||||
|
||||
1. Set up the trigger rules for the pipeline.
|
||||
|
||||
1. Enter a **Timeout** for the pipeline.
|
||||
1. Enter a **Timeout** for the pipeline.
|
||||
|
||||
1. When all the stages and steps are configured, click **Done**.
|
||||
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Configuring Persistent Data for Pipeline Components
|
||||
weight: 600
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The pipelines' internal Docker registry and the Minio workloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes.
|
||||
|
||||
This section assumes that you understand how persistent storage works in Kubernetes. For more information, refer to the section on [how storage works.]({{<baseurl>}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/how-storage-works/)
|
||||
@@ -27,35 +30,26 @@ This section assumes that you understand how persistent storage works in Kuberne
|
||||
- **Add Volume > Use an existing persistent volume (claim)**
|
||||
|
||||
1. Complete the form that displays to choose a persistent volume for the internal Docker registry.
|
||||
<Tabs>
|
||||
<TabItem label="Add a new persistent volume">
|
||||
<br/>
|
||||
1. Enter a **Name** for the volume claim.
|
||||
<Tabs>
|
||||
<TabItem value="Add a new persistent volume">
|
||||
|
||||
1. Select a volume claim **Source**:
|
||||
1. Enter a **Name** for the volume claim.
|
||||
1. Select a volume claim **Source**:
|
||||
- If you select **Use a Storage Class to provision a new persistent volume**, select a storage class and enter a **Capacity**.
|
||||
- If you select **Use an existing persistent volume**, choose a **Persistent Volume** from the drop-down.
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
1. Click **Define**.
|
||||
|
||||
- If you select **Use a Storage Class to provision a new persistent volume**, select a storage class and enter a **Capacity**.
|
||||
</TabItem>
|
||||
<TabItem value="Use an existing persistent volume">
|
||||
|
||||
- If you select **Use an existing persistent volume**, choose a **Persistent Volume** from the drop-down.
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
1. Enter a **Name** for the volume claim.
|
||||
1. Choose a **Persistent Volume Claim** from the dropdown.
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
1. Click **Define**.
|
||||
|
||||
1. Click **Define**.
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Use an existing persistent volume">
|
||||
<br/>
|
||||
1. Enter a **Name** for the volume claim.
|
||||
|
||||
1. Choose a **Persistent Volume Claim** from the dropdown.
|
||||
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
|
||||
1. Click **Define**.
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
1. From the **Mount Point** field, enter `/var/lib/registry`, which is the data storage path inside the Docker registry container.
|
||||
|
||||
@@ -74,34 +68,26 @@ This section assumes that you understand how persistent storage works in Kuberne
|
||||
- **Add Volume > Use an existing persistent volume (claim)**
|
||||
|
||||
1. Complete the form that displays to choose a persistent volume for the internal Docker registry.
|
||||
<Tabs>
|
||||
<Tabs>
|
||||
<TabItem value="Add a new persistent volume">
|
||||
|
||||
<TabItem label="Add a new persistent volume">
|
||||
<br/>
|
||||
1. Enter a **Name** for the volume claim.
|
||||
1. Enter a **Name** for the volume claim.
|
||||
1. Select a volume claim **Source**:
|
||||
- If you select **Use a Storage Class to provision a new persistent volume**, select a storage class and enter a **Capacity**.
|
||||
- If you select **Use an existing persistent volume**, choose a **Persistent Volume** from the drop-down.
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
1. Click **Define**.
|
||||
|
||||
1. Select a volume claim **Source**:
|
||||
</TabItem>
|
||||
<TabItem value="Use an existing persistent volume">
|
||||
|
||||
- If you select **Use a Storage Class to provision a new persistent volume**, select a storage class and enter a **Capacity**.
|
||||
1. Enter a **Name** for the volume claim.
|
||||
1. Choose a **Persistent Volume Claim** from the drop-down.
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
1. Click **Define**.
|
||||
|
||||
- If you select **Use an existing persistent volume**, choose a **Persistent Volume** from the drop-down.
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
|
||||
1. Click **Define**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Use an existing persistent volume">
|
||||
<br/>
|
||||
1. Enter a **Name** for the volume claim.
|
||||
|
||||
1. Choose a **Persistent Volume Claim** from the drop-down.
|
||||
|
||||
1. From the **Customize** section, choose the read/write access for the volume.
|
||||
|
||||
1. Click **Define**.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
1. From the **Mount Point** field, enter `/data`, which is the data storage path inside the Minio container.
|
||||
|
||||
|
||||
+8
-5
@@ -3,6 +3,9 @@ title: Helm CLI Quick Start
|
||||
weight: 300
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
These instructions capture a quick way to set up a proof-of-concept Rancher installation.
|
||||
|
||||
These instructions assume you have a Linux virtual machine that you will communicate with from your local workstation. Rancher will be installed on the Linux machine. You will need to retrieve the IP address of that machine so that you can access Rancher from your local workstation. Rancher is designed to manage Kubernetes clusters remotely, so any Kubernetes cluster that Rancher manages in the future will also need to be able to reach this IP address.
|
||||
@@ -29,14 +32,14 @@ Save the IP of the Linux machine.
|
||||
The kubeconfig file is important for accessing the Kubernetes cluster. Copy the file at `/etc/rancher/k3s/k3s.yaml` from the Linux machine and save it to your local workstation in the directory `~/.kube/config`. One way to do this is by using the `scp` tool and run this command on your local machine:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Mac and Linux">
|
||||
<TabItem value="Mac and Linux">
|
||||
|
||||
```
|
||||
scp root@<IP_OF_LINUX_MACHINE>:/etc/rancher/k3s/k3s.yaml ~/.kube/config
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Windows">
|
||||
<TabItem value="Windows">
|
||||
|
||||
By default, "scp" is not a recognized command, so we need to install a module first.
|
||||
|
||||
@@ -58,7 +61,7 @@ scp root@<IP_OF_LINUX_MACHINE>:/etc/rancher/k3s/k3s.yaml $env:USERPROFILE\.kube\
|
||||
In the kubeconfig file, you will need to change the value of the `server` field to `<IP_OF_LINUX_NODE>:6443`. The Kubernetes API server will be reached at port 6443, while the Rancher server will be reached at ports 80 and 443. This edit is needed so that when you run Helm or kubectl commands from your local workstation, you will be able to communicate with the Kubernetes cluster that Rancher will be installed on.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Mac and Linux">
|
||||
<TabItem value="Mac and Linux">
|
||||
|
||||
One way to open the kubeconfig file for editing is to use Vim:
|
||||
|
||||
@@ -68,8 +71,9 @@ vi ~/.kube/config
|
||||
|
||||
Press `i` to put Vim in insert mode. To save your work, press `Esc`. Then press `:wq` and press `Enter`.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Windows">
|
||||
<TabItem value="Windows">
|
||||
|
||||
In Windows Powershell, you can use `notepad.exe` for editing the kubeconfig file:
|
||||
|
||||
@@ -79,7 +83,6 @@ notepad.exe $env:USERPROFILE\.kube\config
|
||||
|
||||
Once edited, either press `ctrl+s` or go to `File > Save` to save your work.
|
||||
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user