public/harvester-ui-extension
1
0
Fork 0
mirror of https://github.com/harvester/harvester-ui-extension.git synced 2025-12-13 21:21:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #40 from a110605/update_readme

Browse Source 
Update README integration mode block and add minimal required node version
This commit is contained in:
Francesco Torchia 2024-11-25 09:37:43 +01:00 committed by GitHub
commit 36dd2b4541
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -2,7 +2,9 @@
Rancher Extension used in [rancher/dashboard](https://github.com/rancher/dashboard) for [Harvester](https://harvesterhci.io) Dashboard UI.
`
From Rancher 2.10.0, Harvester integration is provided by this new Harvester UI Extension.
`
## Installation
@ -25,6 +27,11 @@ To install the Harvester UI Extension in Rancher 2.10.0 and newer:
This is what you probably want to get started.
### Prerequisite
Nodejs version >= 20
### Standalone Mode
For development, serve with hot reload at https://localhost:8005
@ -46,16 +53,15 @@ RANCHER_ENV=harvester VUE_APP_SERVER_VERSION=your-harvester-server-version API=h
RANCHER_ENV=harvester VUE_APP_SERVER_VERSION=v1.4.0 API=https://192.168.1.123 yarn dev
```
### Integration Mode
### Rancher Integration Mode
In this mode, you need to have Rancher and import Harvester, more detail in [Harvester Integration | Rancher](https://ranchermanager.docs.rancher.com/v2.6/integrations-in-rancher/harvester).
In this mode, you need to have Rancher and run Harvester UI Extension as Rancher extension, see more detail in [Rancher UI extension](https://extensions.rancher.io/extensions/next/extensions-getting-started#running-the-app).
```bash
# build harvester plugin
yarn build-pkg harvester && yarn serve-pkgs
API=https://your-rancher-ip yarn dev
# Open another terminal window
HARVESTER_PKG_URL=http://127.0.0.1:4500/harvester-${version}/harvester-${version}.umd.min.js API=https://your-rancher-ip RANCHER_ENV=harvester yarn mem-dev
# Example
API=https://192.168.1.123 yarn dev
```
## Contributing