Add Customize Developer Catalog Categories enhancement #508

jerolimov · 2020-10-22T12:32:02Z

Issue: https://issues.redhat.com/browse/ODC-5033

Rendered preview: https://github.com/jerolimov/openshift-enhancements/blob/catalog-categories/enhancements/console/catalog-categories.md

API CRD change PR (also WIP): openshift/api#763

/cc @spadgett @christianvogt @rohitkrai03

spadgett

Is this planned for 4.7? I ask because if dev console becomes a dynamic plugin in 4.8, we might want this to be part of the dev console operator config.

spadgett · 2020-10-23T16:50:47Z

enhancements/console/catalog-categories.md

+
+### Goals
+
+- Extract the Developer Catalog categories into a CRD to allow cluster admins to customize them.


This makes it sound like we're creating a new CRD instead of just updating the console config. I'd probably phrase it just to say we're adding a configuration option for customizing the categories.

Updated this to

Add configuration options to allow cluster admins to customize catalog categories.

Provide a list of default values to the admin

spadgett · 2020-10-23T16:52:51Z

enhancements/console/catalog-categories.md

+
+* `id: string`, identifier used in the URL to enable deeplinking in console
+* `label: string`, category display label
+* `disabled: boolean`, flag to hide this category from the sidebar so that the admin is not required to remove a complete section to hide an unused category


We typically don't have this flag in our APIs. The presence of an item indicates whether something is enabled or not.

I'd assume if a category doesn't have any items it's already hidden in the UI. If this is what you mean by unused, it might be taken care of already.

I removed this disabled flag. The overall proposal changed a little bit to simplify things.

We can keep the existing default categories in the dev console code and will use them as fallback if there is no customization available. This makes upgrades / downgrades easier, as well we don't need to keep disabled categories in the CRD.

Christian comes with the idea of providing a code snippet to restore the current defaults when editing the Console CRD. Wdyt?

spadgett · 2020-10-23T16:53:40Z

enhancements/console/catalog-categories.md

+
+* `subcategories:` a list of Categories
+
+If a category has subcategories the dev console will show all tags from a selected category and all subcategories.


If an item has a tag from the top-level categories, but doesn't match any tags from the subcategories, what is the behavior?

The idea is that a (top level) category shows all items which are shown when you go through all subcategories.

For example:

├── Languages │ ├── Java (tags: java) │ └── Go (tags: go)

If you select languages we want show both languages without the need to add both tags also to "Languages". Wdyt?

spadgett · 2020-10-23T16:54:18Z

enhancements/console/catalog-categories.md

+spec:
+  customization:
+    brand: online
+    devcatalog:


Suggested change

devcatalog:

developerCatalog:

Changed. Did you think we should keep developerCatalog.categories?
Or maybe more structured developer.catalog.categories?
Or in a case when thinking about one catalog for both sides maybe only catalog.categories?

But changed this to your recommendation for now. Thanks

spadgett · 2020-10-23T16:56:03Z

enhancements/console/catalog-categories.md

+
+### Upgrade / Downgrade Strategy
+
+When updating to 4.7 we need to ensure that the default types was automatically added to the existing Console CR.


It's probably simpler to just hard code the defaults in the console code and use those if the stanza isn't present in the config CR. This is better as well if we add new default categories later, which would be hard if we add the defaults to the config CR.

Yep, your rigtht. I changed the proposal to keep the hard coded default values in console and "just" allow the admin to override this default so that we use the CR or static version. No merging. No migrating.

spadgett · 2020-10-23T16:56:24Z

enhancements/console/catalog-categories.md

+  customization:
+    brand: online
+    devcatalog:
+      categories:


Does this completely replace the categories or just add new categories?

Updated the document that we use the hard coded version OR the customization version. Ok?

This will completely replace the dev catalog categories.

spadgett · 2020-10-23T16:57:48Z

enhancements/console/catalog-categories.md

+
+## Drawbacks
+
+- A bigger `Console` CR must fetches by the console before the Developer Catalog is opened.


We wouldn't be fetching the CR in the frontend code. The operator will watch the config, and then wire through the values to the console backend through its config map in the openshift-console namespace.

Thanks 👍 Changed the document to make it clear that the frontend reads the data from the ConfigMap.

christianvogt · 2020-11-09T20:24:13Z

enhancements/console/catalog-categories.md

+  customization:
+    brand: online
+    devcatalog:
+      categories:


This will completely replace the dev catalog categories.

enhancements/console/catalog-categories.md

jerolimov · 2020-11-10T08:33:19Z

Wow, thanks @christianvogt. 👍 Applied all changes from you and marked your changes as resolved for the next round. 😏

jerolimov · 2020-11-13T16:47:37Z

@spadgett @christianvogt Dropped the section "Fetching data from ConfigMap" completely because it suggests a wrong approach.

Fetching data from ConfigMap

An update to the Console CR will update the console deployment and update a corresponding ConfigMap.

The console will read this customization from the ConfigMap "console-config" (in namespace "openshift-console").

If there is any categories defined in the ConfigMap this will override the predefined (static) list of categories. The two lists are not merged.

Anything else to-do here?

jerolimov · 2020-11-13T16:49:41Z

/assign @spadgett @christianvogt @rohitkrai03

christianvogt · 2020-11-13T16:49:46Z

lgtm

@spadgett could you please have a look

spadgett

/lgtm

openshift-ci-robot · 2020-11-13T17:04:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerolimov, spadgett

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~~ [spadgett]

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

openshift-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 22, 2020

openshift-ci-robot requested review from christianvogt and spadgett October 22, 2020 12:32

jerolimov force-pushed the catalog-categories branch 3 times, most recently from 34f3431 to 95ebf0a Compare October 23, 2020 16:00

spadgett reviewed Oct 23, 2020

View reviewed changes

jerolimov force-pushed the catalog-categories branch from 95ebf0a to ef7b774 Compare November 6, 2020 11:10

jerolimov changed the title ~~[WIP] Add Customize Developer Catalog Categories enhancement~~ Add Customize Developer Catalog Categories enhancement Nov 6, 2020

jerolimov requested a review from spadgett November 6, 2020 11:11

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 6, 2020

jerolimov force-pushed the catalog-categories branch from ef7b774 to 3d62395 Compare November 6, 2020 11:30

jerolimov mentioned this pull request Nov 6, 2020

ODC-5020: Add option to define (and customize) console catalog categories openshift/api#763

Merged

christianvogt reviewed Nov 9, 2020

View reviewed changes

jerolimov force-pushed the catalog-categories branch from 3d62395 to 5eb7479 Compare November 10, 2020 08:24

jerolimov force-pushed the catalog-categories branch from 5eb7479 to 669cb3f Compare November 10, 2020 08:33

jerolimov requested a review from christianvogt November 10, 2020 08:34

jerolimov mentioned this pull request Nov 12, 2020

Get customized catalog categories in dev catalog from server flags openshift/console#7196

Merged

4 tasks

Add Customize Developer Catalog Categories enhancement

ffb854d

jerolimov force-pushed the catalog-categories branch from 669cb3f to ffb854d Compare November 13, 2020 16:48

openshift-ci-robot assigned christianvogt, rohitkrai03 and spadgett Nov 13, 2020

spadgett approved these changes Nov 13, 2020

View reviewed changes

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 13, 2020

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 13, 2020

openshift-merge-robot merged commit 0ae0bb4 into openshift:master Nov 13, 2020

spadgett mentioned this pull request Dec 7, 2020

Developer catalog GUI : Customization of menu openshift/console#5171

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Customize Developer Catalog Categories enhancement #508

Add Customize Developer Catalog Categories enhancement #508

jerolimov commented Oct 22, 2020 •

edited

spadgett left a comment

spadgett Oct 23, 2020

jerolimov Nov 6, 2020

spadgett Oct 23, 2020

jerolimov Nov 6, 2020

spadgett Oct 23, 2020

jerolimov Nov 6, 2020

spadgett Oct 23, 2020

jerolimov Nov 6, 2020

spadgett Oct 23, 2020

jerolimov Nov 6, 2020

spadgett Oct 23, 2020

jerolimov Nov 6, 2020

christianvogt Nov 9, 2020

spadgett Oct 23, 2020

jerolimov Nov 6, 2020

christianvogt Nov 9, 2020

jerolimov commented Nov 10, 2020

jerolimov commented Nov 13, 2020 •

edited

jerolimov commented Nov 13, 2020

christianvogt commented Nov 13, 2020

spadgett left a comment

openshift-ci-robot commented Nov 13, 2020


		### Goals

		- Extract the Developer Catalog categories into a CRD to allow cluster admins to customize them.


		* `subcategories:` a list of Categories

		If a category has subcategories the dev console will show all tags from a selected category and all subcategories.


		### Upgrade / Downgrade Strategy

		When updating to 4.7 we need to ensure that the default types was automatically added to the existing Console CR.


		## Drawbacks

		- A bigger `Console` CR must fetches by the console before the Developer Catalog is opened.

Add Customize Developer Catalog Categories enhancement #508

Add Customize Developer Catalog Categories enhancement #508

Conversation

jerolimov commented Oct 22, 2020 • edited

spadgett left a 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerolimov commented Nov 10, 2020

jerolimov commented Nov 13, 2020 • edited

jerolimov commented Nov 13, 2020

christianvogt commented Nov 13, 2020

spadgett left a comment

Choose a reason for hiding this comment

openshift-ci-robot commented Nov 13, 2020

jerolimov commented Oct 22, 2020 •

edited

jerolimov commented Nov 13, 2020 •

edited