1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Files
openshift-docs/modules/cli-manager-upgrading-plugin.adoc
2025-12-16 20:26:20 +00:00

62 lines
1.6 KiB
Plaintext

// 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}
[role="_abstract"]
You can upgrade a CLI plugin to a newer version with the {cli-manager} by directly editing the plugin's resource YAML file.
.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/<plugin_name>
----
. 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: <plugin_name> <1>
spec:
description: <description_of_plugin>
homepage: <plugin_homepage>
platforms:
- bin: <2>
files:
- from: <plugin_file_path>
to: .
image: <plugin_image>
imagePullSecret: <3>
platform: <platform> <4>
shortDescription: <short_description_of_plugin>
version: <version> <5>
----
+
where:
+
--
`<plugin_name>`:: Specifies the name of the plugin you plan to use in commands.
`bin`:: Specifies the path to the plugin executable.
`imagePullSecret`:: Optional field if the registry is not public to add a pull secret to access your plugin image.
`<platform>`:: Add the architecture for your system; for example, `linux/amd64`, `darwin/arm64`, `windows/amd64`, or another architecture.
`<version>`:: The version must be in v0.0.0 format.
--
. Save the file.