@headlamp-k8s/ pluginctl (英语)
用于管理 Headlamp 插件的轻量级 CLI 工具.
目的
这个软件包为管理 Headlamp 插件提供了一个最小,重点突出的工具. 这是理想的:
- 从ArtifactHub 安装插件
- 管理插件配置
- 通过配置文件执行批量插件操作
使用量
pluginctl.js <command>
Commands:
pluginctl.js extract <pluginPackages> Copies folders of packages from plug
<outputPlugins> inPackages/packageName/dist/main.js
to
outputPlugins/packageName/main.js.
pluginctl.js package [pluginPath] Creates a tarball of the plugin
[outputDir] package in the format Headlamp
expects.
pluginctl.js install [URL] Install plugin(s) from a
configuration file or a plugin
artifact Hub URL
pluginctl.js update <pluginName> Update a plugin to the latest
version
pluginctl.js uninstall <pluginName> Uninstall a plugin
pluginctl.js list List installed plugins
Options:
--version Show version number [boolean]
--help Show help [boolean]
配置文件格式
插件 。 雅姆尔:
plugins:
- name: my-plugin
source: https://artifacthub.io/packages/headlamp/test-123/my-plugin
version: 1.0.0
- name: another-plugin
source: https://artifacthub.io/packages/headlamp/test-123/another-plugin
dependencies:
- my-plugin
installOptions:
parallel: true
maxConcurrent: 3
可用类
该套件输出以下类别供方案使用:
PluginManager: 管理单个插件的核心类MultiPluginManager: 处理多个插件及其依赖性的分类
示例用法:
const { PluginManager, MultiPluginManager } = require('@headlamp-k8s/pluginctl');
// Create a plugin manager instance
const manager = new PluginManager();
// Create a multi-plugin manager for handling multiple plugins
const multiManager = new MultiPluginManager();
使用 npm 链接促进发展
要测试您的本地更改到 pluginctl 其他软件包中:
- 创建全局并联 :
cd plugins/pluginctl
npm link
- 在您想要使用本地版本的项目中 :
npm link @headlamp-k8s/pluginctl
这将创建一个与您本地开发版本的并联链接,而不是使用已发布的软件包 。 这对于:
- 发布前测试更改
- 调试问题
- 开发需要两个软件包改变的特性
取消链接 :
npm unlink @headlamp-k8s/pluginctl
与 @ kinvolk/ headlamp- plugin 的关系
pluginctl 是一个仅专注于插件管理操作的最小工具。 它提供下列核心功能:
- 安装插件
- 更新插件
- 删除插件
- 列出已安装的插件
相比之下, @kinvolk/headlamp-plugin 综合一揽子计划包括:
- 插件ctl 的所有插件管理特性
- 插件开发工具
- 建设和测试基础设施
- 代码质量工具
选择 pluginctl 如果您只需要插件管理特性,或者 headlamp-plugin 如果您需要完整的开发工具包.