Plugin Management using XL CLI

From 23.3 plugin management is possible with XL CLI utility. For more information, see Plugin Manager CLI.

Note: This topic uses the default namespace, digitalai, for illustrative purposes. Use your own namespace if you have installed Deploy in a custom namespace.

Download and Install the XL CLI

See Install the XL CLI.

xl plugin deploy

• The xl plugin deploy command installs, upgrades, or cleans Digital.ai Deploy plugins.
• This command uses the Plugin Management Rest API on the Deploy master.

Usage

xl plugin deploy [command] [flags]

Available Commands

Command	Description
cancel-install	Cancel install plugins that are in 'READY FOR INSTALL' status
install	Install or update Deploy plugins
list	List Deploy plugins
repository	View repositories and plugins

Flags

Flag	Description
-h, --help	Help for the xl kube command

xl plugin deploy repository

• Use the xl plugin deploy repository command for list plugin repositories and list of plugins in the selected repository.
• Run the xl plugin deploy repository --help command for more information about the available flags and usage examples for this command.

xl plugin deploy list

• Use the xl plugin deploy list command for list of Digital.ai Deploy plugin that are currently installed on Deploy.
• Run the xl plugin deploy list --help command for more information about the available flags and usage examples for this command.

xl plugin deploy install

• Use the xl plugin deploy install command for installation or upgrading of Digital.ai Deploy plugin.
• Run the xl plugin deploy install --help command for more information about the available flags and usage examples for this command.

Examples of installing a plugin based on different auth types

• HTTP login

# list current installed plugins with http login
xl plugin deploy list --xl-deploy-authmethod http \
  --xl-deploy-url http://localhost:4516 \
  --xl-deploy-username admin --xl-deploy-password admin

# install plugin by using file with http login
xl plugin deploy install --xl-deploy-authmethod http \
  --xl-deploy-url http://localhost:4516 \
  --xl-deploy-username admin --xl-deploy-password admin \ 
  -f /home/vpugardev/workspace/notes/docs/digitalai/plugins/xld-terraform-enterprise-plugin-23.3.1.xldp

• Basic auth

# list current installed plugins with http login
xl plugin deploy list --xl-deploy-authmethod basic \
  --xl-deploy-url http://localhost:4516 \
  --xl-deploy-username admin --xl-deploy-password admin

# install plugin by using file with http login
xl plugin deploy install --xl-deploy-authmethod basic \
  --xl-deploy-url http://localhost:4516 \
  --xl-deploy-username admin --xl-deploy-password admin \
  -f /home/vpugardev/workspace/notes/docs/digitalai/plugins/xld-terraform-enterprise-plugin-23.3.1.xldp

After installation, restart the Deploy

After installation, you will need to restart Master and Worker:

kubectl delete sts dai-xld-digitalai-deploy-master -n digitalai
kubectl delete sts dai-xld-digitalai-deploy-worker -n digitalai

xl plugin deploy cancel-install

• Use the xl plugin deploy cancel-install command for canceling installation of Deploy plugins. It can only perform cancel installation to the plugins which are in 'READY FOR INSTALL' status.
• Run the xl plugin deploy cancel-install --help command for more information about the available flags and usage examples for this command.