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

jerolimov · 2020-10-19T22:06:45Z

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

Extends the existing Console CRD with new type definitions to allow the admin to override the predefined catalog categories. See enhancement proposal PR openshift/enhancements#508

jerolimov · 2020-11-23T23:15:05Z

/assign @spadgett @jhadvig

jhadvig

Thanks for the PR ! 👍
Adding review for this CRD.

operator/v1/types_console.go

jhadvig

Couple of wording suggestions.

operator/v1/types_console.go

jerolimov · 2020-12-01T13:03:26Z

@jhadvig I have accepted all suggestions and rebased this PR.

spadgett · 2020-12-01T14:21:40Z

operator/v1/types_console.go

+	Tags []string `json:"tags,omitempty"`
+}
+
+// DeveloperConsoleCatalogCategory defines a top level category incl. label, filter tags


The comment here should match the API property instead of the name of the struct since this will be used for the CRD property description. I'd avoid the incl. abbreviation here since this is publicly facing doc.

@jhadvig Changed type messages to:

for DeveloperConsoleCatalogCustomization:

// developerCatalog allow the cluster admin to configure developer catalog.

for DeveloperConsoleCatalogCategoryMeta and DeveloperConsoleCatalogCategory:

// category for the developer console catalog.

operator/v1/types_console.go

spadgett · 2020-12-01T14:27:10Z

operator/v1/types_console.go

+	ID string `json:"id"`
+	// label defines a category display label.
+	Label string `json:"label"`
+	// tags in a list of strings that will match the category.


It would be good to put more detail about how this is matched against different kinds of resources.

tags in a list of strings that will match the category. A selected category
show all items which has at least one overlapping tag between category and item.

OK? As you said, the exact details depends on the kind of resources

operator/v1/types_console.go

jerolimov · 2020-12-01T15:58:58Z

Updated
/woof

openshift-ci-robot · 2020-12-01T15:58:59Z

@jerolimov:

In response to this:

Updated
/woof

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.

operator/v1/types_console.go

jhadvig · 2020-12-03T11:26:43Z

operator/v1/types_console.go

+type DeveloperConsoleCatalogCategoryMeta struct {
+	// ID is an identifier used in the URL to enable deep linking in console.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1


Should we also add max length validation ?

// +kubebuilder:validation:MinLength=32

or a regexp that would only allow certain chars?

// +kubebuilder:validation:Pattern=`...`

The same for Label

Sounds good, esp. for ID because we use this in URLs. Defined them now as:

// ID is an identifier used in the URL to enable deep linking in console. // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MinLength=32 // +kubebuilder:validation:Pattern=`^[A-Za-z0-9-_]+$` // +required ID string `json:"id"` // label defines a category display label. // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MinLength=64 // +required Label string `json:"label"`

operator/v1/types_console.go

spadgett · 2020-12-03T18:08:03Z

operator/v1/types_console.go

+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MinLength=32
+	// +kubebuilder:validation:Pattern=`^[A-Za-z0-9-_]+$`


You should describe the restriction on the ID in the API doc so people know.

Added them, but the pattern is also part of the CRD yaml and could not find any other doc where we add this to the description. Let me know if I should keep this or revert this.

operator/v1/types_console.go

spadgett · 2020-12-03T18:09:52Z

operator/v1/types_console.go

+	// ID is an identifier used in the URL to enable deep linking in console.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MinLength=32


MinLength 32? :) I assume you mean Max.

You should describe any restrictions in the API doc.

Yeah, good catch, thanks. Fixed.

spadgett · 2020-12-03T18:10:22Z

operator/v1/types_console.go

+	// label defines a category display label.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MinLength=64


Yep, thanks. Fixed.

spadgett

/lgtm

openshift-ci-robot · 2020-12-03T21:52:26Z

[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

jerolimov · 2023-05-05T10:00:06Z

/retitle ODC-5020: Add option to define (and customize) console catalog categories

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 19, 2020

openshift-ci-robot requested review from adambkaplan and sjenning October 19, 2020 22:07

jerolimov force-pushed the odc-5020 branch from 71e56df to 34c88e2 Compare October 20, 2020 08:48

jerolimov closed this Oct 20, 2020

jerolimov force-pushed the odc-5020 branch from 34c88e2 to 1e2e196 Compare October 20, 2020 14:08

jerolimov reopened this Oct 20, 2020

jerolimov force-pushed the odc-5020 branch from a833bb2 to 5392dff Compare October 20, 2020 14:43

jerolimov mentioned this pull request Oct 22, 2020

Add Customize Developer Catalog Categories enhancement openshift/enhancements#508

Merged

jerolimov force-pushed the odc-5020 branch 3 times, most recently from 213cc1b to 09d77e2 Compare October 23, 2020 17:17

jerolimov force-pushed the odc-5020 branch from 09d77e2 to 775f684 Compare November 6, 2020 16:00

jerolimov changed the title ~~[WIP] Add option to define (and customize) console catalog categories~~ Add option to define (and customize) console catalog categories Nov 6, 2020

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 odc-5020 branch from 775f684 to 83da4d6 Compare November 23, 2020 23:00

jerolimov mentioned this pull request Nov 23, 2020

Bump openshift/api to get customize catalog categories changes openshift/console-operator#484

Merged

openshift-ci-robot assigned jhadvig and spadgett Nov 23, 2020

jhadvig suggested changes Nov 24, 2020

View reviewed changes

operator/v1/types_console.go Show resolved Hide resolved

operator/v1/types_console.go Outdated Show resolved Hide resolved

operator/v1/types_console.go Outdated Show resolved Hide resolved

jerolimov force-pushed the odc-5020 branch 2 times, most recently from a963841 to 0ca542a Compare November 24, 2020 11:31

jerolimov requested a review from jhadvig November 24, 2020 13:41

jerolimov force-pushed the odc-5020 branch from 0ca542a to 6cafa97 Compare November 27, 2020 06:11

jhadvig suggested changes Dec 1, 2020

View reviewed changes

jerolimov force-pushed the odc-5020 branch 2 times, most recently from 4e1306e to 3a98fd1 Compare December 1, 2020 12:56

jerolimov requested a review from jhadvig December 1, 2020 13:21

spadgett reviewed Dec 1, 2020

View reviewed changes

jhadvig suggested changes Dec 1, 2020

View reviewed changes

operator/v1/types_console.go Show resolved Hide resolved

operator/v1/types_console.go Show resolved Hide resolved

operator/v1/types_console.go Show resolved Hide resolved

jhadvig reviewed Dec 1, 2020

View reviewed changes

operator/v1/types_console.go Show resolved Hide resolved

jerolimov force-pushed the odc-5020 branch from 3a98fd1 to 198988b Compare December 1, 2020 15:57

jerolimov requested review from jhadvig and spadgett December 1, 2020 16:47

jhadvig suggested changes Dec 3, 2020

View reviewed changes

operator/v1/types_console.go Outdated Show resolved Hide resolved

operator/v1/types_console.go Outdated Show resolved Hide resolved

operator/v1/types_console.go Outdated Show resolved Hide resolved

jhadvig reviewed Dec 3, 2020

View reviewed changes

operator/v1/types_console.go Outdated Show resolved Hide resolved

jhadvig reviewed Dec 3, 2020

View reviewed changes

operator/v1/types_console.go Outdated Show resolved Hide resolved

jerolimov force-pushed the odc-5020 branch 3 times, most recently from a9b27b0 to c3e53ac Compare December 3, 2020 17:44

spadgett reviewed Dec 3, 2020

View reviewed changes

Add option to define (and customize) console catalog categories

5893d0a

jerolimov force-pushed the odc-5020 branch from c3e53ac to 5893d0a Compare December 3, 2020 18:56

jerolimov requested review from jhadvig and spadgett December 3, 2020 19:54

spadgett approved these changes Dec 3, 2020

View reviewed changes

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

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

openshift-merge-robot merged commit 3fdbb93 into openshift:master Dec 3, 2020

jerolimov mentioned this pull request Dec 10, 2020

Bug 1906798: Export operator dev catalog customization to console-config ConfigMap openshift/console-operator#495

Merged

openshift-ci bot changed the title ~~Add option to define (and customize) console catalog categories~~ ODC-5020: Add option to define (and customize) console catalog categories May 5, 2023

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

jerolimov commented Oct 19, 2020 •

edited

jerolimov commented Nov 23, 2020

jhadvig left a comment

jhadvig left a comment

jerolimov commented Dec 1, 2020 •

edited

spadgett Dec 1, 2020

jerolimov Dec 1, 2020

spadgett Dec 1, 2020

jerolimov Dec 1, 2020

jerolimov commented Dec 1, 2020

openshift-ci-robot commented Dec 1, 2020

jhadvig Dec 3, 2020

jhadvig Dec 3, 2020

jerolimov Dec 3, 2020

spadgett Dec 3, 2020

jerolimov Dec 3, 2020

spadgett Dec 3, 2020

jerolimov Dec 3, 2020

spadgett Dec 3, 2020

jerolimov Dec 3, 2020

spadgett left a comment

openshift-ci-robot commented Dec 3, 2020

jerolimov commented May 5, 2023 •

edited by openshift-ci bot

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

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

Conversation

jerolimov commented Oct 19, 2020 • edited

jerolimov commented Nov 23, 2020

jhadvig left a comment

Choose a reason for hiding this comment

jhadvig left a comment

Choose a reason for hiding this comment

jerolimov commented Dec 1, 2020 • edited

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 Dec 1, 2020

openshift-ci-robot commented Dec 1, 2020

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

spadgett left a comment

Choose a reason for hiding this comment

openshift-ci-robot commented Dec 3, 2020

jerolimov commented May 5, 2023 • edited by openshift-ci bot

jerolimov commented Oct 19, 2020 •

edited

jerolimov commented Dec 1, 2020 •

edited

jerolimov commented May 5, 2023 •

edited by openshift-ci bot