diff --git a/dashboard/README.md b/dashboard/README.md index 3b5acb9..d986981 100644 --- a/dashboard/README.md +++ b/dashboard/README.md @@ -23,5 +23,44 @@ Node 16.15.0 or lower, `yarn` 1) Run `yarn install` 1) Run `EXCLUDES_PKG=harvester,rancher-components EXCLUDE_OPERATOR_PKG=true RANCHER_ENV=epinio API=https://localhost:5443 yarn dev` -## Getting Started - Run in embedded Mode -Update to follow \ No newline at end of file +## Getting Started - Extension + +### Installation + +To install the extension, you will need Rancher 2.7.6 or later. + +1. Go to the Rancher dashboard (as an administrator) + +2. Open the hamburger menu in the top left corner, and select Extensions + +![Rancher Extensions Link](../docs/images/extensions_link.png) + +3. Open the dropdown in the top right corner and select "Manage Repositories" + +![Add Repositories Link](../docs/images/manage_repositories.png) + +4. Click Create + +5. Enter the repository information + + a. Name: `epinio-extension` + + b. http(s) URL to an index generated by helm + + c. Index URL: `https://epinio.github.io/ui/` + + d. Authentication: None + +![Fill out repository details](../docs/images/repository_details.png) + +6. Return to the Extensions page + +7. Click the Available tab + +8. Install the Epinio extension + +![Install Epinio extension](../docs/images/install_extension.png) + +9. Epinio will now be available in the Global Apps list + +![Epinio global apps link](../docs/images/global_apps.png) \ No newline at end of file diff --git a/dashboard/pkg/epinio/package.json b/dashboard/pkg/epinio/package.json index 32e5c7c..5739cf4 100644 --- a/dashboard/pkg/epinio/package.json +++ b/dashboard/pkg/epinio/package.json @@ -2,9 +2,16 @@ "name": "epinio", "description": "Application Development Engine for Kubernetes", "icon": "https://raw.githubusercontent.com/rancher/dashboard/0b6cbe93e9ed3292294da178f119a500cc494db9/pkg/epinio/assets/logo-epinio.svg", - "version": "1.11.0-2", + "version": "1.11.0-3", "private": false, - "rancher": true, + "rancher": { + "annotations": { + "catalog.cattle.io/rancher-version": ">= 2.8.0-0 < v2.9.0-0", + "catalog.cattle.io/kube-version": ">= v1.16.0-0 < v1.29.0-0", + "catalog.cattle.io/display-name": "Epinio (alpha)", + "catalog.cattle.io/ui-version": ">= 2.7.2 < v2.9.0-0" + } + }, "license": "Apache-2.0", "author": "SUSE", "scripts": { @@ -19,9 +26,9 @@ }, "devDependencies": { "@types/js-yaml": "^4.0.5", - "@vue/cli-plugin-babel": "4.5.18", - "@vue/cli-plugin-typescript": "4.5.18", - "@vue/cli-service": "4.5.18" + "@vue/cli-plugin-babel": "5.0.8", + "@vue/cli-service": "5.0.8", + "@vue/cli-plugin-typescript": "5.0.8" }, "browserslist": [ "> 1%", diff --git a/docs/images/extensions_link.png b/docs/images/extensions_link.png new file mode 100644 index 0000000..d1ed939 Binary files /dev/null and b/docs/images/extensions_link.png differ diff --git a/docs/images/global_apps.png b/docs/images/global_apps.png new file mode 100644 index 0000000..9309c57 Binary files /dev/null and b/docs/images/global_apps.png differ diff --git a/docs/images/install_extension.png b/docs/images/install_extension.png new file mode 100644 index 0000000..79c7e8b Binary files /dev/null and b/docs/images/install_extension.png differ diff --git a/docs/images/manage_repositories.png b/docs/images/manage_repositories.png new file mode 100644 index 0000000..19213f6 Binary files /dev/null and b/docs/images/manage_repositories.png differ diff --git a/docs/images/repository_details.png b/docs/images/repository_details.png new file mode 100644 index 0000000..86c09f9 Binary files /dev/null and b/docs/images/repository_details.png differ