Merge pull request #3407 from catherineluse/branding

Document branding options
This commit is contained in:
Catherine Luse
2021-07-20 10:44:50 -07:00
committed by GitHub
10 changed files with 89 additions and 8 deletions
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Rancher 2.5.7-2.5.8+ (Latest)
title: Rancher 2.5.7-2.5.8+
weight: 1
showBreadcrumb: false
---
@@ -1,6 +1,6 @@
---
title: Authentication
weight: 1115
weight: 10
aliases:
- /rancher/v2.6/en/concepts/global-configuration/authentication/
- /rancher/v2.6/en/tasks/global-configuration/authentication/
@@ -0,0 +1,81 @@
---
title: Custom Branding
weight: 90
---
Rancher v2.6 introduced the ability to customize Ranchers branding and navigation links.
- [Changing Brand Settings](#changing-brand-settings)
- [Custom Navigation Links in Cluster Explorer](#custom-navigation-links-in-cluster-explorer)
# Changing Brand Settings
To configure the brand settings,
1. Click **≡ > Global settings**.
2. Click **Branding**.
# Brand Configuration
### Private Label Company Name
This option replaces “Rancher” with the value you provide in most places. Files that need to have Rancher in the name, such as “rancher-compose.yml”, will not be changed.
### Support Links
Use a url address to send new "File an Issue" reports instead of sending users to the Github issues page. Optionally show Rancher community support links.
### Logo
Upload light and dark logos to replace the Rancher logo in the top-level navigation header.
### Primary Color
You can override the primary color used throughout the UI with a custom color of your choice.
### Fixed Banners
Display a custom fixed banner in the header, footer, or both.
# Custom Navigation Links in Cluster Explorer
The links in the left navigation menu in Cluster Explorer can be customized.
It can be useful to add a link for quick access to services installed on a cluster. For example, you could add a link to the Kiali UI for clusters with Istio installed, or you could add a link to the Grafana UI for clusters with Rancher monitoring installed.
The custom links don't affect who has access to each service.
Links can be created at the top level and multiple links can be grouped together.
### Adding a Custom Navigation Link
1. In Rancher, go to the Cluster Explorer view where you would like to add custom navigation links.
2. In the top navigation menu, click **🔍 (Resource Search)**.
3. Type **Nav** and click **Nav Links**.
4. Click **Create from YAML.**
5. Create a new navigation link with these fields:
```
Name: linkname
group: GroupName
toURL: https://example.com
```
6. Click **Create.**
### Example
This example NavLink YAML shows an example of configuring a NavLink to a Grafana dashboard:
```yaml
apiVersion: ui.cattle.io/v1
kind: NavLink
metadata:
name: grafana
spec:
group: "Monitoring Dashboards"
toURL: https://<RANCHER_SERVER_URL>/api/v1/namespaces/cattle-monitoring-system/services/http:rancher-monitoring-grafana:80/proxy/?orgId=1
```
Adding the above YAML results in a link to Grafana being created, as shown in the following screenshot:
![Screenshot of Grafana Link]({{< baseurl >}}/img/rancher/example-grafana-link.png)
@@ -1,6 +1,6 @@
---
title: Configuring a Global Default Private Registry
weight: 400
weight: 40
aliases:
---
@@ -1,6 +1,6 @@
---
title: Provisioning Drivers
weight: 1140
weight: 70
---
Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) or [nodes in an infrastructure provider]({{<baseurl>}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) to allow Rancher to deploy and manage Kubernetes.
@@ -1,6 +1,6 @@
---
title: Upgrading Kubernetes without Upgrading Rancher
weight: 1120
weight: 30
---
The RKE metadata feature allows you to provision clusters with new versions of Kubernetes as soon as they are released, without upgrading Rancher. This feature is useful for taking advantage of patch versions of Kubernetes, for example, if you want to upgrade to Kubernetes v1.14.7 when your Rancher server originally supported v1.14.6.
@@ -1,6 +1,6 @@
---
title: Pod Security Policies
weight: 1135
weight: 60
aliases:
- /rancher/v2.6/en/concepts/global-configuration/pod-security-policies/
- /rancher/v2.6/en/tasks/global-configuration/pod-security-policies/
@@ -1,6 +1,6 @@
---
title: Role-Based Access Control (RBAC)
weight: 1120
weight: 20
aliases:
- /rancher/v2.6/en/concepts/global-configuration/users-permissions-roles/
---
@@ -1,6 +1,6 @@
---
title: RKE Templates
weight: 7010
weight: 80
---
RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters.
Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB