diff --git a/cli_reference/cli_manager/cli-manager-using.adoc b/cli_reference/cli_manager/cli-manager-using.adoc index 7c7036f152..1ac0ef14f9 100644 --- a/cli_reference/cli_manager/cli-manager-using.adoc +++ b/cli_reference/cli_manager/cli-manager-using.adoc @@ -14,6 +14,9 @@ include::snippets/technology-preview.adoc[] // Installing a CLI plugin with the CLI Manager include::modules/cli-manager-installing-plugins.adoc[leveloffset=+1] +// Upgrading a CLI plugin with the CLI Manager +include::modules/cli-manager-upgrading-plugin.adoc[leveloffset=+1] + // Updating a cli plugin with the CLI Manager include::modules/cli-manager-updating-plugin.adoc[leveloffset=+1] diff --git a/modules/cli-manager-upgrading-plugin.adoc b/modules/cli-manager-upgrading-plugin.adoc new file mode 100644 index 0000000000..b8dba27da2 --- /dev/null +++ b/modules/cli-manager-upgrading-plugin.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * cli_reference/cli_manager/cli-manager-using.adoc + +:_mod-docs-content-type: PROCEDURE +[id="cli-manager-upgrading-plugin-yamls_{context}"] += Upgrading a plugin with the {cli-manager} + +You can upgrade a CLI plugin to a newer version with the {cli-manager}. + +.Prerequisites + +* You are logged in to {product-title} as a user with the `cluster-admin` role. +* The {cli-manager} is installed. +* The plugin you are upgrading is installed. + +.Procedure + +. Using the CLI, enter the following command: + +[source,terminal] +---- +oc edit plugin/ +---- + +. Edit the YAML file to include the new specifications for your plugin. + +.Example YAML file to upgrade a plugin + +[source,yaml] +---- +apiVersion: config.openshift.io/v1alpha1 +kind: Plugin +metadata: + name: <1> +spec: + description: + homepage: + platforms: + - bin: <2> + files: + - from: + to: . + image: + imagePullSecret: <3> + platform: <4> + shortDescription: + version: <5> +---- +<1> The name of the plugin you plan to use in commands. +<2> `Bin` specifies the path to the plugin executable. +<3> Optional: If the registry is not public, add a pull secret to access your plugin image. +<4> Add the architecture for your system platform; for example, `linux/amd64`, `darwin/arm64`, `windows/amd64`, or another architecture. +<5> Version of the plugin, in v0.0.0 format. + +. Save the file. \ No newline at end of file