Skip to content

Commit 3c85f83

Browse files
stevsmitstevsmit
authored
Merge pull request #103888 from cbippley/OSDOCS-16915
OSDOCS-16915 CLI Manager CQA
2 parents fc6de61 + f4b1ac7 commit 3c85f83

15 files changed

+137
-83
lines changed

‎cli_reference/cli_manager/cli-manager-install.adoc‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,8 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
[NOTE]
10-
====
11-
Krew always works with {oc-first} without the {cli-manager} installed. You can use the same commands outlined in this documentation to use Krew with `oc`. For more information, see link:https://krew.sigs.k8s.io/docs/[Krew documentation].
12-
====
13-
14-
//Brief explanation of what the cli manager is.
15-
You can run the {cli-manager} in both connected and disconnected environments. In particular, it eases the installation and management of CLI plugins in disconnected environments. The {cli-manager} makes Krew compatible with the `oc` CLI. Cluster administrators can use the {cli-manager} to add CLI plugin custom resources that can then be accessed in both connected and disconnected environments. Cluster administrators install and configure the {cli-manager}, and users then add the custom index to Krew and add CLI plugins to the {cli-manager}.
9+
[role="_abstract"]
10+
You can simplify the installation and management of CLI plugins in connected and disconnected environments with the {cli-manager}. The {cli-manager} makes Krew compatible with the `oc` CLI, allowing cluster administrators to manage custom CLI plugin resources.
1611

1712
:FeatureName: Using the {cli-manager} to install and manage plugins for the OpenShift CLI
1813
include::snippets/technology-preview.adoc[]

‎cli_reference/cli_manager/cli-manager-release-notes.adoc‎

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,21 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
With the {cli-manager}, you can install CLI plugins in both connected and disconnected environments.
9+
[role="_abstract"]
10+
Track the development of the {cli-manager} for {product-title}, which enables you to install CLI plugins in both connected and disconnected environments.
1011

1112
:FeatureName: Using the {cli-manager} to install and manage plugins for the OpenShift CLI
1213
include::snippets/technology-preview.adoc[]
1314

14-
These release notes track the development of the {cli-manager} for {product-title}.
15+
// cli manager 0.2.0 (Technology Preview)
16+
include::modules/cli-manager-rn-0-2-0.adoc[leveloffset=+1]
1517

16-
For more information about the {cli-manager}, see xref:../../cli_reference/cli_manager/index.adoc#cli-manager-overview[About the {cli-manager}].
18+
//cli manager 0.1.1 (Technology Preview)
19+
include::modules/cli-manager-rn-0-1-1.adoc[leveloffset=+1]
1720

18-
[id="cli-manager-release-notes-0-2-0_{context}"]
19-
== {cli-manager} 0.2.0 (Technology Preview)
21+
//{cli-manager} 0.1.0 (Technology Preview)
22+
include::modules/cli-manager-initial-release.adoc[leveloffset=+1]
2023

21-
Issued: 9 December 2025
24+
.Additional resources
2225

23-
The following advisory is available for the {cli-manager} 0.2.0:
24-
25-
* link:https://access.redhat.com/errata/RHBA-2025:22803[RHBA-2025:22803]
26-
27-
[id="cli-manager-0-2-0-new-features-and-enhancements_{context}"]
28-
=== New features and enhancements
29-
30-
* This release of the {cli-manager} updates the Kubernetes version to 1.34.
31-
32-
* The `readOnlyRootFilesystem` flag is set to `true` for additional hardening of {product-title} pods.
33-
34-
[id="cli-manager-release-notes-0-1-1_{context}"]
35-
== {cli-manager} 0.1.1 (Technology Preview)
36-
37-
Issued: 12 March 2025
38-
39-
The following advisory is available for the {cli-manager} 0.1.1:
40-
41-
* link:https://access.redhat.com/errata/RHEA-2025:2680[RHEA-2025:2680]
42-
43-
[id="cli-manager-0-1-1-new-features-and-enhancements_{context}"]
44-
=== New features and enhancements
45-
46-
This release of the CLI Manager updates the Kubernetes version to 1.32.
47-
48-
[id="cli-manager-release-notes-0-1-0_{context}"]
49-
== {cli-manager} 0.1.0 (Technology Preview)
50-
51-
Issued: 19 November 2024
52-
53-
The following advisory is available for the {cli-manager} 0.1.0:
54-
55-
* link:https://access.redhat.com/errata/RHEA-2024:8303[RHEA-2024:8303]
56-
57-
[id="cli-manager-0-1-0-new-features-and-enhancements_{context}"]
58-
=== New features and enhancements
59-
60-
* This version is the initial Technology Preview release of the {cli-manager}. For installation information, see xref:../../cli_reference/cli_manager/cli-manager-install.adoc#cli-manager-install[Installing the {cli-manager}].
61-
62-
//* No bug fixes or known issues to list
26+
* xref:../../cli_reference/cli_manager/index.adoc#cli-manager-overview[About the {cli-manager}]

‎cli_reference/cli_manager/cli-manager-using.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
After the cluster administrator sets up and configures the {cli-manager}, users can use it to install, update, and uninstall CLI plugins.
9+
[role="_abstract"]
10+
To install, update, and uninstall CLI plugins in {product-title}, you can set up and configure the {cli-manager}.
1011

1112
:FeatureName: Using the {cli-manager} to install and manage plugins for the OpenShift CLI
1213
include::snippets/technology-preview.adoc[]

‎cli_reference/cli_manager/index.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9+
[role="_abstract"]
10+
To install and update CLI plugins in both connected and disconnected environments, you can use the {cli-manager}.
11+
912
:FeatureName: Using the {cli-manager} to install and manage plugins for the OpenShift CLI
1013
include::snippets/technology-preview.adoc[]
1114

‎modules/cli-manager-about.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@
66
[id="cli-manager-about_{context}"]
77
= About the {cli-manager}
88

9+
[role="_abstract"]
10+
You can use the {cli-manager} to streamline the installation and management of CLI plugins, especially in disconnected environments.
11+
912
The {cli-manager} makes it easier to install and update CLI plugins. It runs in both connected and disconnected environments, and it is particularly useful in disconnected environments. Cluster administrators can add CLI plugins and plugin updates to the {cli-manager}, and users can then install and update CLI plugins when needed regardless of whether or not the environment is disconnected.

‎modules/cli-manager-adding-plugin-yaml.adoc‎

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
[id="cli-manager-adding-plugin-yamls_{context}"]
77
= Adding a plugin to the {cli-manager}
88

9-
You can add a CLI plugin to the {cli-manager} by using the YAML View.
9+
[role="_abstract"]
10+
You can add a CLI plugin to the {cli-manager} by creating a new plugin resource in the {product-title} web console's YAML view.
1011

1112
.Prerequisites
1213

@@ -34,26 +35,31 @@ You can add a CLI plugin to the {cli-manager} by using the YAML View.
3435
apiVersion: config.openshift.io/v1alpha1
3536
kind: Plugin
3637
metadata:
37-
name: <plugin_name> <1>
38+
name: <plugin_name>
3839
spec:
3940
description: <description_of_plugin>
4041
homepage: <plugin_homepage>
4142
platforms:
42-
- bin: <2>
43+
- bin:
4344
files:
4445
- from: <plugin_file_path>
4546
to: .
4647
image: <plugin_image>
47-
imagePullSecret: <3>
48-
platform: <platform> <4>
48+
imagePullSecret:
49+
platform: <platform>
4950
shortDescription: <short_description_of_plugin>
50-
version: <version> <5>
51+
version: <version>
5152
----
52-
<1> The name of the plugin you plan to use in commands.
53-
<2> `Bin` specifies the path to the plugin executable.
54-
<3> Optional: If the registry is not public, add a pull secret to access your plugin image.
55-
<4> Add the architecture for your system; for example, `linux/amd64`, `darwin/arm64`, `windows/amd64`, or another architecture.
56-
<5> Version must be in v0.0.0 format.
53+
+
54+
where:
55+
+
56+
--
57+
`<plugin_name>`:: Specifies the name of the plugin you plan to use in commands.
58+
`bin`:: Specifies the path to the plugin executable.
59+
`imagePullSecret`:: Optional field if the registry is not public to add a pull secret to access your plugin image.
60+
`<platform>`:: Add the architecture for your system; for example, `linux/amd64`, `darwin/arm64`, `windows/amd64`, or another architecture.
61+
`<version>`:: The version must be in v0.0.0 format.
62+
--
5763

5864
. Click *Save*.
5965

@@ -66,7 +72,8 @@ spec:
6672
$ oc get plugin/<plugin_name> -o yaml
6773
----
6874

69-
.Example output
75+
* Example output:
76+
7077
[source,terminal]
7178
----
7279
<plugin_name> ready to be served.

‎modules/cli-manager-custom-index-krew.adoc‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66
[id="cli-manager-custom-index_{context}"]
77
= Adding the {cli-manager} custom index to Krew
88

9-
You can use the terminal to add the CLI manager custom index to Krew. This procedure is required for the {cli-manager} to function correctly and needs to be done only once.
10-
11-
The custom index connects Krew to the {cli-manager} binaries and enables the {cli-manager} to work in disconnected environments.
9+
[role="_abstract"]
10+
You can use the terminal to add the {cli-manager} custom index to Krew so that the {cli-manager} will work in disconnected environments. This procedure is required for the {cli-manager} to function correctly and needs to be done only once.
1211

1312
[NOTE]
1413
====
@@ -42,7 +41,7 @@ $ oc krew index add <custom_index_name> https://$ROUTE/cli-manager
4241
----
4342
$ oc krew update
4443
----
45-
44+
+
4645
.Example output
4746
[source,terminal]
4847
----

‎modules/cli-manager-initial-release.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * cli_reference/cli_manager/cli-manager-release-notes.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="cli-manager-initial-release_{context}"]
7+
= {cli-manager} 0.1.0 (Technology Preview)
8+
9+
[role="_abstract"]
10+
Review the features, enhancements, and advisory for the initial Technology Preview release of {cli-manager} 0.1.0.
11+
12+
Issued: 19 November 2024
13+
14+
The following advisory is available for the {cli-manager} 0.1.0:
15+
16+
* link:https://access.redhat.com/errata/RHEA-2024:8303[RHEA-2024:8303]
17+
18+
[id="cli-manager-0-1-0-new-features-and-enhancements_{context}"]
19+
== New features and enhancements
20+
21+
* This version is the initial Technology Preview release of the {cli-manager}. For installation information, see xref:../../cli_reference/cli_manager/cli-manager-install.adoc#cli-manager-install[Installing the {cli-manager}].
22+
23+
//* No bug fixes or known issues to list

‎modules/cli-manager-installing-plugins.adoc‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66
[id="cli-manager-adding-plugins_{context}"]
77
= Installing CLI plugins with the {cli-manager}
88

9-
You can install CLI plugins using the {cli-manager}.
9+
[role="_abstract"]
10+
You can install CLI plugins with the {cli-manager} to extend OpenShift CLI functionality in both connected and disconnected environments.
1011

1112
.Prerequisites
1213

1314
* You have installed Krew by following the link:https://krew.sigs.k8s.io/docs/user-guide/setup/install/[installation procedure] in the Krew documentation.
14-
* The CLI Manager is installed.
15-
* The CLI Manager custom index has been added to Krew.
15+
* The {cli-manager} is installed.
16+
* The {cli-manager} custom index has been added to Krew.
1617
* You are using {product-title} 4.17 or later.
1718
1819
.Procedure

‎modules/cli-manager-installing.adoc‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@
66
[id="cli-manager-installing_{context}"]
77
= Installing the {cli-manager}
88

9-
Install the {cli-manager} to facilitate adding CLI plugins in both connected and disconnected environments.
9+
[role="_abstract"]
10+
You can install the {cli-manager} to facilitate adding CLI plugins in both connected and disconnected environments.
11+
12+
[NOTE]
13+
====
14+
Krew always works with {oc-first} without the {cli-manager} installed. You can use the same commands outlined in this documentation to use Krew with `oc`. For more information, see link:https://krew.sigs.k8s.io/docs/[Krew documentation].
15+
====
1016

1117
.Prerequisites
1218

0 commit comments

Comments
 (0)