Plugin Management using XL CLI

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

Download and Install the XL CLI

See Install the XL CLI.

xl plugin release

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

Usage

xl plugin release [command] [flags]

Available Commands

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

Flags

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

xl plugin release repository

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

xl plugin release list

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

xl plugin release install

• Use the xl plugin release install command for installation or upgrading of Digital.ai Release plugin.
• Run the xl plugin release 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 release list --xl-release-authmethod http \
  --xl-release-url http://localhost:5516 \
  --xl-release-username admin --xl-release-password admin

# install plugin by using file with http login
xl plugin release install --xl-release-authmethod http \
  --xl-release-url http://localhost:5516 \
  --xl-release-username admin --xl-release-password admin \
  -f /home/vpugardev/workspace/notes/docs/digitalai/plugins/xlr-argocd-integration-23.3.1.zip 

• Basic auth

# list current installed plugins with basic auth
xl plugin release list --xl-release-authmethod basic \
  --xl-release-url http://localhost:5516 \
  --xl-release-username admin --xl-release-password admin

# install plugin by using file with basic auth
xl plugin release install --xl-release-authmethod basic \
  --xl-release-url http://localhost:5516 \
  --xl-release-username admin --xl-release-password admin \
  -f /home/vpugardev/workspace/notes/docs/digitalai/plugins/xlr-argocd-integration-23.3.1.zip 

• PAT

# list current installed plugins with PAT
xl plugin release list --xl-release-authmethod token \
  --xl-release-url http://localhost:5516 \
  --xl-release-token rpa_01234567890123456789012345678901234567890

# install plugin by using file with http login
xl plugin release install --xl-release-authmethod token \
  --xl-release-url http://localhost:5516 \
  --xl-release-token rpa_01234567890123456789012345678901234567890 \
  -f /home/vpugardev/workspace/notes/docs/digitalai/plugins/xlr-argocd-integration-23.3.1.zip 

After installation, restart the Release

After installation, you will need to restart Release pods (in the case of zip plugins, restart is not needed):

kubectl rollout restart sts dai-xlr-digitalai-release -n digitalai

xl plugin release cancel-install

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