-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for plugin development #4276
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Plugin Docs | ||
|
|
||
| * [Installation](#installation) | ||
| * [Compiling Plugins](#compiling-plugins) | ||
| * [Registering Plugin](#registering-plugin) | ||
| * [Creating ConfigMap](#creating-configmap) | ||
|
|
||
| ### Installation | ||
|
|
||
| To enable plugin support in the dashboard you must register a custom [CRD](../../aio/test-resources/plugin-crd.yml) in your cluster. | ||
| ``` | ||
| kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/master/aio/test-resources/plugin-crd.yml | ||
| ``` | ||
|
|
||
| ### Compiling Plugins | ||
|
|
||
| In order to take advantage of AOT compilation, sharing the code across plugins and not ship the core Angular packages with the plugin bundle, there is a custom build process to compile the plugins. | ||
| You can clone this repository and checkout to [`plugin/base`](https://github.com/kubernetes/dashboard/tree/plugin/base) branch. The build process is specified under [`builders`](https://github.com/kubernetes/dashboard/tree/plugin/base/builders) directory. | ||
|
|
||
| On this branch, you can compile the plugin with following command | ||
| ``` | ||
| ng build plugin && ng build --project custom-plugin --prod --modulePath=k8s-plugin#PluginModule --pluginName=k8s-plugin --outputPath=./dist/bundle | ||
| ng build --project custom-plugin --prod --modulePath=./plugin1/plugin1.module#Plugin1Module --pluginName=plugin1 --sharedLibs=k8s-plugin --outputPath=./dist/bundle | ||
| ``` | ||
|
|
||
| The key thing here is that we specify the `custom-plugin` project in the `angular.json` to use our custom builder. Make sure to keep the config similar when developing your own plugins. | ||
|
|
||
| ### Registering Plugin | ||
|
|
||
| Once the custom CRD is registered we can now create [instances](../../aio/test-resources/plugin-test.yml) of the CRD which will hold the spec for plugin. | ||
|
|
||
| ``` | ||
| kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/master/aio/test-resources/plugin-test.yml | ||
| ``` | ||
|
|
||
| > Note: The backend reads the compiled plugin source from a ConfigMap and we need to create that also. | ||
|
|
||
| ### Creating ConfigMap | ||
|
|
||
| We can now create config-maps to hold the compiled plugin source code. | ||
|
|
||
| ``` | ||
| kubectl create configmap k8s-plugin-src --from-file=./dist/bundle/k8s-plugin.js | ||
| kubectl create configmap plugin1-src --from-file=./dist/bundle/plugin1.js | ||
| ``` | ||
|
|
||
| After following all the above steps, your new plugin should be available in the dashboard. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
kubernetes configmap has size limitation, (<=1MB), so the compiled plugin javascript file should not exceed 1MB. That is the limitation of this plugin solution, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, you're right. We can look into other ways to obtain the compiled plugin file instead of just configmap. We wanted to keep dashboard stateless and using configmaps was the easiest way to tackle this for now.