CLI in-cluster management #137

sallyom · 2019-12-03T16:23:00Z

sdodson · 2019-12-06T13:40:51Z

/uncc

soltysh · 2019-12-09T10:53:30Z

/assign

soltysh

I'd consider this enhancement to be place at the root directory, since it's not about oc only, but we're trying to solve a higher level issue. oc will be merely one of the consumers.

enhancements/oc/cli_manager.md

siamaksade · 2020-01-10T22:39:22Z

enhancements/cli_manager.md

+index location from which the CLI manager will obtain the files.
+
+Two routes for index:    
+1.  Central index that has links to where artifacts are stored


If an index exists that has the list of CLIs and their location, what would be ConsoleCLIDownload used for?

The CRD will hold info for each CLI (available versions, download urls, description, other) that can be gathered via oc get climanageddownload okd -o yaml for example.
or run oc get consoleclidownloads oc-cli-downloads -o yaml to see the current consoleCLIDownload for oc.

I'd imagine we'd deprecate ConsoleCLIDownload in favour of the central index. All the tools serving that information should be using the new central repository.

Is there a case where an optional operator can not, or doesn't want to, ship their CLI through the central index?

+1 for the central index which would remove the requirement from the user to have access and be logged into a cluster when she wants to list or install plugins.

The cli-manager will be run within a cluster - so yes, users will have to be logged into a cluster to list or install CLI plugins. This way users will know they are using the CLI version that is known good with whatever version their cluster is. It will be possible to install CLIs outside a cluster, but not through cli-manager.

When I said The cli-manager will be run within a cluster that's not what I meant, really - each cluster will have its set of ClusterCLI CRs - those hold the the known-good CLIs (compatible or latest version, etc) for that cluster. oc will access those when connected to a cluster. Also, I've updated this proposal to move away from cli-manager since what we're actually proposing is extending/adding to oc something like oc clustercli list|search|install

siamaksade · 2020-01-10T22:40:19Z

enhancements/cli_manager.md

+
+Two routes for index:    
+1.  Central index that has links to where artifacts are stored
+2.  Central repository where all artifacts are stored 


Isn't this the existing mirror.openshift?
https://mirror.openshift.com/pub/openshift-v4/clients/

CLIs are already being published there today by the CLI creators.

I added that info.

sallyom · 2020-11-15T18:35:52Z

@smarterclayton ok to merge this now? Proposal is to keep current downloads (with new CRD instead of consol-cli-downloads) available via fileserver and adding option to install tools via oc (oc image extract logic and obtaining artifact mapping artifact info from CR)

smarterclayton · 2020-12-04T17:11:05Z

enhancements/cli-in-cluster-management.md

+### Goals
+
+Each component wishing to provide customers with their binaries will build and publish artifacts via an official channel to a central index.
+Each component wishing to provide customers with their binaries will provide a ClusterCLI CR and will also provide a mechanism (controller)    


I don't know what this means?

I'll clarify that. Maybe this is better
Each component wishing to provide customers with binaries will create a clustercli custom resource to provide an image name and the file path within that image for the binaries. Also a controller to manage that custom resource may be added (to at least ensure that CR exists? or not). The CLIs currently offered via console-cli-downloads will be included in the reference implementation of this enhancement . oc will gather clusterclis from the cluster, and also the fileserver will offer the binaries via the console by mounting the binaries from the location/image in each custom resource.

smarterclayton · 2020-12-04T17:13:05Z

enhancements/cli-in-cluster-management.md

+As a user, I want a CLI manager for various CLIs available for OpenShift and related services so that I can discover, install and list them
+The user will invoke the following commands:
+
+* `oc clustercli list` to view installed binaries


I'm not a fan of clustercli. Also, why do we need search? What is the difference between list and search?

we don't need search, i'll update

the crd name is currently clusterclis.config.openshift.io but the oc command can be whatever. clustercli captures the idea that these are clis offered from custom resources in a cluster, but it can be changed when i wire this into/create a new command for oc, haven't looked at that yet.

oh list was to view the binaries installed on one's system (at a known or given location) while search is to list available CLIs from cluster.

that's confusing though, don't need search, removing it

openshift-ci-robot · 2021-02-09T08:13:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JAORMX, soltysh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [soltysh]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sallyom · 2021-02-09T11:51:08Z

@smarterclayton ok to remove the hold on this and merge? As it's written now, this will be a mechanism to extract and un-compress supported clis from either the release payload or supported image registry to a designated location on a local system.

pweil- · 2021-03-31T14:47:12Z

enhancements/cli-in-cluster-management.md

+reviewers:
+  - "@soltysh"
+approvers:
+  - "@soltysh"


Please add @spadgett as an approver here.

I'm not sure I fully understood what or if there would be a migration path from the existing, console shipped resource to the other and if we're going to commit to supporting both for a time since we already have a published CRD for this. Or why we wouldn't just repurpose that resource with links pointing in cluster for anything not currently doing it. @spadgett will need to be involved with that.

(we're currently providing in-cluster downloads for each platform's oc client here right, Sam?)

Same for how we evolve the cli-downloads artifact we currently ship that supports those in-cluster downloads.

Overall I like the idea of shipping via images and providing it all in cluster to support the disconnected experience 👍

/cc @jhadvig - console operator maintainer :)

This has been on the back burner for quite awhile. I'll add a migration path, but yes, will be a seamless transition, and the CRD should be repurposed. The add is that for supported CLIs (those currently offered via cli-downloads) there will be an image (within release payload? as oc currently is) that will allow access to binaries from mirrored images if disconnected. I'll give this enhancement an update in the coming days, thanks

might start out as a cli plugin w/ a configurable list of cli images. again, will give this some thought and update this proposal

please keep in mind that we'll want a corresponding user experience via the console. Any logic you put in the plugin either needs to be in a sharable library or API or we'll end up having to duplicate the logic in the UI. Thanks!!

cmoulliard · 2021-04-02T14:24:31Z

enhancements/cli-in-cluster-management.md

+
+##### example:
+```
+$ oc clustercli list


I think that we need also a column showing what is the recommended version of the CLI to be used for the target cluster. That will help the users to figure out if they must upgrade some of their clients and to use the CLI matching the current cluster version.

How do you plan to check INSTALLED as that implies that you execute a command to check on the machine if the the CLI binary is present under by example $HOME/openshift/clients/cli1 ?

Will the user be informed that they must include a new path to access the CLIs (e.g $HOME/openshift/clients/) ?

Do you plan to support to install several versions of the same client or only one (easier to maintain) ?

How do you plan to set the UID/GROUPID of the user connected to the machine to define the correct owner (e.g. chown user1:group1 $HOME/openshift/clients/cli1) ?

cmoulliard · 2021-04-02T14:26:08Z

enhancements/cli-in-cluster-management.md

+The user will invoke the following commands:
+
+* `oc clustercli list` will access the connected OpenShift cluster, if connected,  and will retrieve information about available CLIs (clusterCLI CRs)
+* `oc clustercli install odo` will install `odo` to a user's home directory, as a standalone binary.


That should be great to have a command such as oc clustercli install kubetools able to install the recommended tools: helm, kubectl, oc, odo, k9s, ... - WDYT ?

openshift-bot · 2021-07-01T20:05:31Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

JAORMX · 2021-07-12T16:54:55Z

Is this still to be implemented? We'd still like to integrate with this :)

deboer-tim · 2021-07-12T19:07:48Z

The OpenShift Tools Installer (https://github.com/redhat-actions/openshift-tools-installer) has shown it's possible to dynamically scan mirror & github to build a list of all the current clis and their download URLs by OS. I've been playing with this data since it seems like we should be able to automate or simplify this w/o requiring each tool to provide a custom image or contribute to an index. Likewise, the same tool could support offline/cluster-provided clis vs latest install.

openshift-bot · 2021-08-12T00:02:06Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

jwmatthews · 2021-09-02T14:00:49Z

Interested to leverage this for OADP (OpenShift API for Data Protection) when it's available.

sallyom · 2021-09-19T14:06:48Z

Interested to leverage this for OADP (OpenShift API for Data Protection) when it's available.

@jwmatthews I am working on a poc here, and will keep you updated: https://github.com/sallyom/clustercli I'm only now getting back to this. I'll be updating this and and the poc this week, stay tuned.

openshift-bot · 2021-09-26T15:20:09Z

Rotten enhancement proposals close after 7d of inactivity.

See https://github.com/openshift/enhancements#life-cycle for details.

Reopen the proposal by commenting /reopen.
Mark the proposal as fresh by commenting /remove-lifecycle rotten.
Exclude this proposal from closing again by commenting /lifecycle frozen.

/close

openshift-ci · 2021-09-26T15:20:30Z

@openshift-bot: Closed this PR.

In response to this:

Rotten enhancement proposals close after 7d of inactivity.

See https://github.com/openshift/enhancements#life-cycle for details.

Reopen the proposal by commenting /reopen.
Mark the proposal as fresh by commenting /remove-lifecycle rotten.
Exclude this proposal from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

jwmatthews · 2021-09-27T18:25:26Z

@sallyom I see this was closed recently, should the stale lifecycle be removed and this reopened?

soltysh · 2021-09-29T14:19:11Z

@sallyom I see this was closed recently, should the stale lifecycle be removed and this reopened?

@deejross is working on a new version of this enhancement

openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 3, 2019

openshift-ci-robot requested review from adambkaplan and sdodson December 3, 2019 16:23

sallyom force-pushed the cli-manager branch 10 times, most recently from 7497bd9 to b1110a0 Compare December 5, 2019 21:09

openshift-ci-robot removed the request for review from sdodson December 6, 2019 13:40

openshift-ci-robot assigned soltysh Dec 9, 2019

soltysh suggested changes Dec 9, 2019

View reviewed changes

sallyom force-pushed the cli-manager branch 10 times, most recently from a1d3d6d to 2d7ee86 Compare December 9, 2019 19:28

siamaksade reviewed Jan 10, 2020

View reviewed changes

sallyom force-pushed the cli-manager branch 3 times, most recently from 598c515 to 8f8ee7e Compare November 15, 2020 15:22

sallyom force-pushed the cli-manager branch from 8f8ee7e to a72fcd7 Compare November 25, 2020 14:41

smarterclayton reviewed Dec 4, 2020

View reviewed changes

cli-manager proposal

e66fff2

sallyom force-pushed the cli-manager branch from a72fcd7 to e66fff2 Compare December 4, 2020 21:06

JAORMX approved these changes Feb 9, 2021

View reviewed changes

pweil- reviewed Mar 31, 2021

View reviewed changes

cmoulliard reviewed Apr 2, 2021

View reviewed changes

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 1, 2021

cfergeau mentioned this pull request Jul 9, 2021

[Epic] Dropdown in the tray to install CLI tools crc-org/crc#2506

Closed

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Aug 12, 2021

openshift-ci bot closed this Sep 26, 2021

soltysh mentioned this pull request Oct 15, 2021

CLI Manager #924

Merged

CLI in-cluster management #137

CLI in-cluster management #137

Conversation

sallyom commented Dec 3, 2019 • edited Loading

sdodson commented Dec 6, 2019

soltysh commented Dec 9, 2019

soltysh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sallyom Jan 15, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sallyom commented Nov 15, 2020

Choose a reason for hiding this comment

sallyom Dec 4, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openshift-ci-robot commented Feb 9, 2021

sallyom commented Feb 9, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openshift-bot commented Jul 1, 2021

JAORMX commented Jul 12, 2021

deboer-tim commented Jul 12, 2021

openshift-bot commented Aug 12, 2021

jwmatthews commented Sep 2, 2021

sallyom commented Sep 19, 2021

openshift-bot commented Sep 26, 2021

openshift-ci bot commented Sep 26, 2021

jwmatthews commented Sep 27, 2021

soltysh commented Sep 29, 2021

sallyom commented Dec 3, 2019 •

edited

Loading

sallyom Jan 15, 2020 •

edited

Loading

sallyom Dec 4, 2020 •

edited

Loading