Skip to content

Commit 7ce35d3

Browse files
committed
refactor wordings
Signed-off-by: andy.lee <[email protected]>
1 parent 5a4fa4e commit 7ce35d3

File tree

1 file changed

+46
-44
lines changed

1 file changed

+46
-44
lines changed

docs/rancher/harvester-ui-extension.md

+46-44
Original file line numberDiff line numberDiff line change
@@ -13,99 +13,101 @@ keywords:
1313
<link rel="canonical" href="https://docs.harvesterhci.io/v1.4/rancher/rancher-integration"/>
1414
</head>
1515

16-
Starting from Rancher 2.10.0, Harvester integration is provided by [Harvester UI Extension](https://github.com/harvester/harvester-ui-extension). The Harvester UI Extension is a standard Rancher extension that built on the[@rancher/shell](https://www.npmjs.com/package/@rancher/shell) library.
1716

17+
Rancher 2.10.0 and later versions integrate with Harvester using the [Harvester UI Extension](https://github.com/harvester/harvester-ui-extension), which is built on the[@rancher/shell](https://www.npmjs.com/package/@rancher/shell) library.
1818

19-
The original [Harvester dashboard](https://github.com/harvester/dashboard) will continue to support Harvester v1.3.x and v1.4.x releases. New features in future releases will be implemented in the Harvester UI Extension.
20-
19+
:::note
20+
The current [Harvester UI](https://github.com/harvester/dashboard) will continue to support Harvester v1.3.x and v1.4.x releases. New features in later releases will be implemented in the Harvester UI Extension.
21+
:::
2122

2223

2324

2425
## Support Matrix
2526

26-
Starting from v1.5.0, the Harvester UI Extension version will align with the Harvester release version.
27-
28-
:::caution
29-
Harvester UI Extension only supports Harvester cluster versions greater or equal to 1.3.0.
30-
:::
27+
Versions of the Harvester operating system and the Harvester UI Extension will align starting with v1.5.0.
3128

3229

3330
| Harvester Cluster | Harvester UI Extension | Minimum supported Rancher |
3431
| --------------------------| ------------------------------- | ------------------------ |
35-
| v1.3.0 / v1.3.1 / v1.3.2 | v1.0.2 | Rancher 2.10.1 |
32+
| v1.3.0, v1.3.1, v1.3.2 | v1.0.2 | Rancher 2.10.1 |
3633
| v1.4.1 | v1.0.3 | Rancher 2.10.1 |
3734
| v1.4.2 | v1.0.4 | Rancher 2.10.1 |
3835
| v1.5.0 | v1.5.0 | Rancher 2.11.0 |
3936

4037

4138
## Installation on Rancher 2.10
4239

43-
:::caution
44-
Rancher 2.8 and 2.9 do not support to install Harvester UI Extension, only Rancher 2.10.0 and later version support
45-
:::
46-
47-
4840
### Automatic Installation
4941

50-
We provide `auto install` process to install Harvester UI Extension with a single click.
42+
You can install the Harvester UI Extension with a single click.
5143

52-
1. In the Rancher UI, navigate to the **Virtualization Management** screen.
44+
1. On the Rancher UI, go to **Virtualization Management**.
45+
![](/img/v1.5/rancher/auto-install-ui-extension.png)
5346

54-
1. Click the `Install` button and allow some time for the extension to install. The page will automatically refresh once the installation is complete.
47+
1. On the **Harvester Clusters** tab, click **Install**.
48+
49+
Allow some time for the extension to be installed. The screen is automatically refreshed once the installation is completed.
5550

56-
Note: Do not navigate away during the installation process, as this may cause it to fail.
51+
:::info important
52+
Do not navigate away from the screen during the installation process.
53+
:::
5754

58-
![](/img/v1.5/rancher/auto-install-ui-extension.png)
55+
![](/img/v1.5/rancher/auto-install-ui-extension.png)
5956

6057

6158
### Manual Installation
62-
If the automatic installation fails, you can manually set up the Harvester UI Extension repository URL and install it.
59+
If the automatic installation fails, you can specify the Harvester UI Extension repository URL and then install the extension.
6360

64-
![](/img/v1.5/rancher/ui-extension-install-failed.png)
61+
![](/img/v1.5/rancher/ui-extension-install-failed.png)
6562

66-
67-
1. In the Rancher UI, go to **local > Apps > Repositories**.
63+
1. On the Rancher UI, go to **local > Apps > Repositories**, and then click **Create**.
6864

69-
1. Click the **Create** button, give a repository name and select `Git repository containing Helm chart or cluster template definitions`.
70-
71-
Enter the following properties:
72-
- Git Repo URL: **https://github.com/harvester/harvester-ui-extension**
73-
- Git Branch: **gh-pages**
74-
7565
![](/img/v1.5/rancher/ui-extension-app-repository-setup.png)
7666

77-
1. Navigate to the **Extensions** screen and click **Install** under the Available tab.
67+
1. Configure the following settings:
68+
- Name: Specify a name for the repository.
69+
- Target: Select **Git repository containing Helm chart or cluster template definitions**.
70+
- Git Repo URL: Specify **https://github.com/harvester/harvester-ui-extension**.
71+
- Git Branch: Specify **gh-pages**.
7872

73+
2. Click **Create**.
74+
75+
3. Go to **Extensions > Available**.
7976
![](/img/v1.5/rancher/ui-extension-available-tab.png)
8077

78+
4. Locate the extension named **Harvester**, and then click **Install**.
79+
8180

82-
## Upgrading Harvester UI Extension
81+
## Upgrades
8382

8483
### Automatic Upgrade
85-
1. In the Rancher UI, go to **Virtualization Management**.
8684

87-
1. The **Update** button will be visible when a new extension version is available.
85+
The **Update** button appears whenever a new version of the extension is available.
8886

89-
1. Click the **Update** button and allow some time for the extension to upgrade. The page will automatically refresh once the upgrade is complete.
87+
1. On the Rancher UI, go to **Virtualization Management**.
9088

91-
![](/img/v1.5/rancher/ui-extension-update.png)
89+
![](/img/v1.5/rancher/ui-extension-update.png)
9290

91+
1. Click **Update**.
92+
Allow some time for the extension to be upgraded. The screen is automatically refreshed once the upgrade is completed.
9393

94-
### Manual Upgrade
94+
### Manual Upgrades
9595

96-
1. In the Rancher UI, navigate to **local > Apps > Repositories**.
96+
1. On the Rancher UI, go to **local > Apps > Repositories**.
97+
98+
1. Locate the repository with the following settings, and then select **⋮ > Refresh**.
9799

98-
1. Locate the repository with the following properties:, and then select **⋮ > Refresh**.
99-
100100
- URL: **https://github.com/harvester/harvester-ui-extension**
101101
- Branch: **gh-pages**
102102

103-
![](/img/v1.4/upgrade/rancher-2.10.1-repository-page.png)
103+
![](/img/v1.4/upgrade/rancher-2.10.1-repository-page.png)
104+
105+
1. Go to **Extensions > Installed**.
104106

105-
1. Go to the **Extensions** screen.
107+
1. Locate the extension named **Harvester**, and then click **Update**.
106108

107109
1. Select the new version, and then click **Update**.
108-
109-
![](/img/v1.4/upgrade/update-harvester-ui-extension-modal.png)
110110

111-
1. Allow some time for the extension to update, then refresh the screen.
111+
![](/img/v1.4/upgrade/update-harvester-ui-extension-modal.png)
112+
113+
1. Allow some time for the extension to be upgraded, and then refresh the screen.

0 commit comments

Comments
 (0)