Implement custom plugin indexes

[chriskim06]

Here's a list of some of the remaining work regarding support for multiple indexes:

• update krew list to work with multi-index (cmd: refactor list to work with custom indexes #560)
• update krew info to work with multi-index (cmd/info: Support for multiple indexes #563)
• update krew search to work with multi-index (cmd: make krew search work with multiple indexes #574)
• update krew upgrade to work with multi-index (cmd: modify upgrade to work with multiple indexes #594)
• update krew update to work with multi-index (cmd: Update each index instead of just default #588)
• update krew install to work with multi-index (no work needed?)
• update krew remove to work with multi-index (Krew uninstall behavior for multi-index #579)
• implement krew index add|remove|list commands (Add index list command #537, Add index add command #545, cmd: Add 'index remove' command #552)
• refactor the code that shows updated/new plugins during update to also show index (Show new/updated plugins list after index updates #593)
• cleanup issues (cleanup: Do not use path calculation in multi-index integration tests #562, integration_test: Create helpers to initialize tests with custom indexes #565, Not friendly "upgrade" message for detached plugins #625)
• revisit --help messages to ensure examples reflect index/ syntax where applicable (Update help messages to reflect custom index syntax #597)
• discuss a strategy for index directory layout migration (Index directory layout migration #600)
• rethink how the "local plugin index is not initialized" message should read, or how we suggest users to add krew-index if there are no indexes? (multi-index: Add default index if none exists #595)
• write integration tests (like receiptsmigration) to ensure index migration happens v0.3.4 -> x (Index migration ci test #621)
• revisit commands to ensure they can cope with an unreachable index (or an index w/ malformed yaml) (Revisit commands to ensure they can cope with an unreachable index or malformed manifests #614)
• remove multi-index feature flag (Remove multi index flag #624)
• update user guide to add documentation on custom plugin indexes (site: custom index docs #618)
• update developer guide to add documentation on hosting custom plugin indexes + what to pay attention to (site: custom index docs #618)
• define trust model for custom indexes for users (Proposal: trust model around custom plugin indexes #576, Update security warning for custom indexes #615)
• make multi-index docs "not draft"
• tag a new release
• find solution to krew’s own first-time installation being "detached"

Proposal issue: #483
Proposal doc: link

/area multi-index

[ahmetb]

I'm scratching off these two for now as I see no work necessary there.

update krew install to work with multi-index (no work needed?)
update krew remove to work with multi-index (no work needed?)

"install" already works (correct me if I'm wrong), and "remove" has no notion of indexes (as it does not need to).

[chriskim06]

There was a small change required for install that was taken care of here. As for uninstall, that might still be pending. If we want to support krew uninstall foo/plugin that'll require a small change.

[corneliusweig]

I think what @chriskim06 is referring to is that plugins installed via --manifest now set a detached index name. I don't think this is worth mentioning though, because it only affects plugin developers and the change is primarily cosmetic.

On the other hand, the uninstall question is still pending so let's not tick it off :)

[chriskim06]

Sorry I should have been more explicit (also when I click the link I added it doesn't take me to the line that I linked, I have to scroll up a bit for some reason), I was referring more to how a plugin is loaded when its being installed: indexscanner.LoadPluginByName(paths.IndexPluginsPath(indexName), pluginName). We used to have indexscanner.LoadPluginByName(paths.IndexPluginsPath(constants.DefaultIndexName), pluginName) so things could only be installed from the default index until the arg passed to IndexPluginsPath was changed to use the index name passed by the user.

But this is pretty minor, tbh I don't even remember adding those 2 to this list 😅 so I think its totally fine to not include the install one on the list.

[ahmetb]

I don't even remember adding those 2 to this list 😅

I'm editing the list above as we go. :)

[ahmetb]

@chriskim06 I've checked off a few recently completed items above. Please take a look if we're up to date.

[chriskim06]

So I linked your most recent PR to this bullet:

rethink how the "local plugin index is not initialized" message should read, or how we suggest users to add krew-index if there are no indexes? (#595)

Does that seem reasonable to check off since that was merged or did you have something else in mind?

Besides that the list looks up to date to me!

[chriskim06]

@ahmetb for this bullet:

write integration tests (like receiptsmigration) to ensure index migration happens v0.3.4 -> x

did you mean something like the verify-receipts-upgrade-migration.sh step of the ci workflow or just like standard cmd line integration tests?

[ahmetb]

Yeah similar to that script. We'd install old krew, install a couple of plugins, and then run the binary compiled as part of the build. Upon doing so, we verify (1) .krew/index/default/ exists (2) "krew index list" cmd works.

Don't spend too much effort, as these are temporary. (Btw if we removed receipsmigration, we should remove that test, too)

[chriskim06]

Sounds good. I'll try to get to that soon. And ya I removed that script and the step in the ci

[ahmetb]

/close
N I C E

[k8s-ci-robot]

@ahmetb: Closing this issue.

In response to this:

/close
N I C E

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.

[corneliusweig]

Great work @chriskim06! Thanks for pushing krew forward. 🍾