Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/advanced/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ The following add-ons are available in this version:
* [pcidevices-controller](./addons/pcidevices.md)
* [rancher-logging](../logging/harvester-logging.md)
* [rancher-monitoring](../monitoring/harvester-monitoring.md)
* [rancher-vcluster](./addons/rancher-vcluster.md) (Experimental)
* [rancher-vcluster](./addons/rancher-vcluster.md) (Deprecated)
* [vm-import-controller](./addons/vmimport.md)
* [virtual-machine-auto-balance](./addons/virtual-machine-auto-balance.md) (Experimental)
* [suse-observability-agent](./addons/suse-observability-agent.md) (Experimental)
* [rancher-k3k](./addons/rancher-k3k.md) (Experimental)

You can enable and disable add-ons on the **Add-ons** screen of the Harvester UI.

Expand Down
90 changes: 90 additions & 0 deletions docs/advanced/addons/rancher-k3k.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
sidebar_position: 13
sidebar_label: Rancher K3k
title: "Rancher K3k Addon"
Comment thread
ibrokethecloud marked this conversation as resolved.
Outdated
---

<head>
<link rel="canonical" href="https://docs.harvesterhci.io/v1.8/advanced/addons/rancher-k3k"/>
</head>

:::note

**rancher-k3k** is an *Experimental* add-on. It is not included in the Harvester ISO, but you can download it from the [experimental-addons repository](https://github.com/harvester/experimental-addons). For more information about experimental features, see [Feature Labels](../../getting-started/document-conventions.md#feature-labels).

:::

The **rancher-k3k** add-on allows you to run Rancher as a workload on the underlying Harvester cluster and is implemented using [k3k](https://github.com/rancher/k3k).

The add-on runs a nested K3s cluster in the **rancher-k3k** namespace and deploys Rancher to this cluster.

During the installation, the ingress for Rancher is synced to the Harvester cluster, allowing end users to access Rancher.
Comment thread
ibrokethecloud marked this conversation as resolved.
Outdated

## Installing the Add-on

If you are using the Harvester kubeconfig file, you can install the add-on by running the following commands:

### Install k3k Add-on
```
https://raw.githubusercontent.com/harvester/experimental-addons/refs/heads/v1.9/k3k/k3k.yaml
```

### Install rancher-k3k Add-on
```
kubectl apply -f https://raw.githubusercontent.com/harvester/experimental-addons/refs/heads/v1.9/rancher-k3k/rancher-k3k.yaml
```
Comment thread
ibrokethecloud marked this conversation as resolved.
Outdated

## Configuring the Add-on

After installation, configure the add-on using the Harvester UI.

1. Go to **Advanced** > **Add-ons**.

2. Locate the **k3k** add-on, and then select **:** -> **Enable**.

3. Wait a few minutes for add-on to be deployed and marked ready.

4. Locate the **rancher-k3k** add-on, and then select **⋮** > **Edit Yaml**.

5. Change the fields `hostname`, `bootstrapPassword` in **valuesContent** section

```
spec:
chart: rancher-k3k
enabled: false
repo: https://charts.harvesterhci.io
valuesContent: |-
certManagerVersion: "v1.20.2"
rancher:
hostname: ""
version: "v2.14.0"
replicas: 1
bootstrapPassword: "password"
k3kCluster:
servers: 1
version: v1.35.4-k3s1
storageClassName: "harvester-longhorn"
version: 1.9.0-rc5
```

6. Save changes and then select **:** > **Enable**.
Comment thread
ibrokethecloud marked this conversation as resolved.
Outdated

Once the add-on is deployed, Rancher can take a few minutes to become available.

You can then access Rancher via the hostname DNS record that you provided.

See [Rancher Integration](../../rancher/virtualization-management.md) for more information.
Comment thread
ibrokethecloud marked this conversation as resolved.
Outdated

:::note

**rancher-k3k** is deployed on a `k3k` cluster with `rancher` bootstrapped as part of cluster init.

When you disable the add-on, the PVC remains in the `rancher-k3k` namespace. If you enable the add-on again, the PVC is reused and Rancher's previous state is restored.

If you want to wipe the data, ensure that the PVC is deleted.
Comment thread
ibrokethecloud marked this conversation as resolved.
Outdated

:::

## Troubleshooting

See [Importing of Harvester Clusters into Rancher](../../troubleshooting/rancher.md#importing-of-harvester-clusters-into-rancher).
9 changes: 6 additions & 3 deletions docs/advanced/addons/rancher-vcluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 5
sidebar_label: Rancher Manager
title: "Rancher Manager (Experimental)"
sidebar_label: Rancher VCluster
title: "Rancher VCluster [Deprecated]"
---

<head>
Expand All @@ -10,8 +10,11 @@ title: "Rancher Manager (Experimental)"

:::note

**rancher-vcluster** is an *experimental* add-on. It is not included in the Harvester ISO, but you can download it from the [experimental-addons repository](https://github.com/harvester/experimental-addons). For more information about experimental features, see [Feature Labels](../../getting-started/document-conventions.md#feature-labels).
**Deprecated as of Harvester v1.9.0**

**rancher-vcluster** is an *experimental* add-on. It is not included in the Harvester ISO, but you can download it from the [experimental-addons repository](https://github.com/harvester/experimental-addons). For more information about experimental features, see [Feature Labels](../../getting-started/document-conventions.md#feature-labels).

Please use the [rancher-k3k addon](./rancher-k3k.md)
Comment thread
ibrokethecloud marked this conversation as resolved.
Outdated
:::

The **rancher-vcluster** add-on allows you to run Rancher as a workload on the underlying Harvester cluster and is implemented using [vCluster](https://www.vcluster.com).
Expand Down
Loading