Extending the Rancher ui

shlomi · September 19, 2022, 7:26am

Hi,
Is there any recommendations on how to extend rancher ui without rebuilding rancher?
I already saw some old posts, but these didn’t clear enough and maybe outdated as well

rak-phillip · September 22, 2022, 3:43pm

We can provide a better recommendation for your options with a better idea of what you’re trying to accomplish. For example, are you looking to add a new menu item to something like Cluster Management, are you looking to customize an existing page, or do you have larger ambitions? It also might help to know which version of Rancher you’re running

shlomi · September 22, 2022, 4:25pm

Hi, thanks for your replay !
Im using rancher 2.5.8 and 2.6.3
Im looking for both, some menu button and some new pages

rak-phillip · September 26, 2022, 3:19pm

It’s still pretty early on but you might want to keep an eye on work being done around plugins for the latest versions of Rancher and consider if it might be worth updating to get those features:

github.com

rancher/dashboard/blob/master/docusaurus/docs/guide/plugins.md

# Plugins

During the transition to the new folder structured in 2.6.5 required by the plugin work ...
- Run the script `./scripts/rejig` to move folders to their new location in the `shell` folder and update the appropriate import statements
  Use this to convert older PRs to the new format
- Run the script `./scripts/rejig -d` to move folders to their old location and update imports again
  Use this to convert newer branches to the old format (possibly useful for branches)
  > IMPORTANT - This script contains a `git reset --hard`

## Step 1
The basis of this step 1 is to move the majority of the code under the `shell` folder. Additionally, the top-level `nuxt.config.js` is updated
to extend a base version now located within the `shell` folder. This includes updated nuxt and webpack configuration to get everything working with the
moved folders.

Note that this represents the minimum to get things working - the next step would be to move the Rancher and Harvester code out from the `shell` folder into a number
of UI Package folders under the top-level `pkg` folder. This would then reduce the scope of what's in the `shell` folder to be the core common UI that we would
want to share across our UIs. So, bear in mind, that ultimately, we wouldn't just be moving all of the code under `shell`.

The rework supports a number of use cases, which we will talk through below.

This file has been truncated. show original

We’re also starting to put together a repository with some examples:

I suggest you take a look, hopefully this is something that might benefit you.

shlomi · September 27, 2022, 4:40pm

@rak-phillip this is great !
In the next few days hopefully i will clone the repos and try practice it.
Thanks again

Topic		Replies	Views
Extend UI for CRD Rancher	1	797	October 3, 2018
How can I customize UI? Rancher 1.x	8	5988	December 29, 2017
Customizing the Rancher UI Rancher 1.x	7	4510	February 11, 2016
Customizing Rancher Rancher 1.x	6	1742	January 14, 2016
A Few qeustions for the UI Rancher	1	792	November 16, 2018

Extending the Rancher ui

Related topics