-
Notifications
You must be signed in to change notification settings - Fork 119
deprecate rancher-vcluster and add docs for rancher-k3k addon #1106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ibrokethecloud
wants to merge
2
commits into
harvester:main
Choose a base branch
from
ibrokethecloud:k3k-addon
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+61
−5
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| --- | ||
|
|
||
| <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. | ||
|
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 | ||
| ``` | ||
|
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**. | ||
|
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. | ||
|
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. | ||
|
ibrokethecloud marked this conversation as resolved.
Outdated
|
||
|
|
||
| ::: | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| See [Importing of Harvester Clusters into Rancher](../../troubleshooting/rancher.md#importing-of-harvester-clusters-into-rancher). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.