Skip to content

Commit

Permalink
update readme docs and version
Browse files Browse the repository at this point in the history
  • Loading branch information
krumware committed Apr 7, 2024
1 parent 744f50f commit b478b48
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 8 deletions.
56 changes: 51 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,58 @@
<h1 align="center">Krum Rancher Extensions Demo</h1>
# Krum Rancher Extensions

The App Launcher is intended to fill a large gap in functionality for non-operator users of Rancher. Currently, if a user wants to access a software application running in Rancher/kubernetes, they need to dig deep into the services/ingress section in Rancher, or learn how to build the proxy URL or on their own. Otherwise, operators need to use an ingress to create convenient access for users.
This collection of Rancher extensions is designed to provide additional functionality to the Rancher dashboard, particularly to fill user-experience gaps for non-operator users.

However, the proxy URL can be a powerful tool in Rancher. It allows a user with appropriate access to a namespaced resource to access that resource/application without ingress.
## App Launcher

The App Launcher will expose a top-level directory of service/ingress objects, and pre-build proxy URLs. It will also provide an option to launch that ingress, if available.
Currently, if a user wants to access a software application running in Rancher/kubernetes, they need to dig deep into the services/ingress section in Rancher, or learn how to build the proxy URL or on their own. Otherwise, operators need to use an ingress to create convenient access for users.

## Setup
However, the proxy URL can be a powerful tool in Rancher. It allows a user with appropriate access to a namespaced resource to access that resource/application without ingress.

The App Launcher will expose a top-level directory of service/ingress objects, and will assemble proxy URLs. It will also provide an option to launch that ingress, if available.

## Pirate Language (unreleased)

This extension, for fun, is intended to demonstrate internationalization (i18n) for Rancher via Rancher extensions, as an homage to the Google search pirate translation from years ago.

This is currently unreleased, but will be available in the future. Contributions are welcome.

# Install for Rancher

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](./images/extensions_link.png)

3. Open the dropdown in the top right corner and select "Manage Repositories"

![Add Repositories Link](./images/manage_repositories.png)

4. Click Create

5. Enter the repository information

a. Name: krum-extensions

b. http(s) URL to an index generated by helm

c. Index URL: `https://krumio.github.io/krum-rancher-extensions/`

d. Authentication: None

![Fill out repository details](./images/add_repository.png)

6. Return to the Extensions page

7. Click the Available tab

8. Install the extensions you would like to install

Profit!

# Setup for Development

### Node
We recommend managing node versions with [nvm](https://github.com/nvm-sh/nvm).
Expand Down
Binary file added images/add_repository.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extensions_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manage_repositories.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "krum-rancher-extensions-demo",
"version": "0.1.5",
"name": "krum-rancher-extensions",
"version": "1.0.0",
"private": true,
"engines": {
"node": "16.19.1"
Expand Down Expand Up @@ -29,4 +29,4 @@
"@types/lodash": "4.14.184",
"css-loader": "6.7.3"
}
}
}

0 comments on commit b478b48

Please sign in to comment.