Add option to define (and customize) console catalog categories

openshift · Dec 1, 2020 · 3a98fd1 · 3a98fd1
1 parent 8494fe8
commit 3a98fd1
Show file tree

Hide file tree

Showing 4 changed files with 182 additions and 1 deletion.
diff --git a/operator/v1/0000_70_console-operator.crd.yaml b/operator/v1/0000_70_console-operator.crd.yaml
@@ -82,6 +82,56 @@ spec:
                       in page titles, logo alt text, and the about dialog instead
                       of the normal OpenShift product name.
                     type: string
+                  developerCatalog:
+                    description: developerCatalog allows to configure the shown developer
+                      catalog categories.
+                    type: object
+                    properties:
+                      categories:
+                        description: categories which are shown the in the devconsole.
+                        type: array
+                        items:
+                          description: DeveloperConsoleCatalogCategory defines a top
+                            level category incl. label, filter tags and subcategories
+                            for the developer console catalog.
+                          type: object
+                          properties:
+                            id:
+                              description: ID is an identifier used in the URL to
+                                enable deep linking in console.
+                              type: string
+                            label:
+                              description: label defines a category display label.
+                              type: string
+                            subcategories:
+                              description: subcategories defines a list of child categories.
+                              type: array
+                              items:
+                                description: DeveloperConsoleCatalogCategoryMeta defines
+                                  a category incl. label and filter tags for the developer
+                                  console catalog.
+                                type: object
+                                properties:
+                                  id:
+                                    description: ID is an identifier used in the URL
+                                      to enable deep linking in console.
+                                    type: string
+                                  label:
+                                    description: label defines a category display
+                                      label.
+                                    type: string
+                                  tags:
+                                    description: tags in a list of strings that will
+                                      match the category.
+                                    type: array
+                                    items:
+                                      type: string
+                            tags:
+                              description: tags in a list of strings that will match
+                                the category.
+                              type: array
+                              items:
+                                type: string
                   documentationBaseURL:
                     description: documentationBaseURL links to external documentation
                       are shown in various sections of the web console.  Providing

diff --git a/operator/v1/types_console.go b/operator/v1/types_console.go
@@ -106,6 +106,38 @@ type ConsoleCustomization struct {
 	// SVG format preferred
 	// +optional
 	CustomLogoFile configv1.ConfigMapFileReference `json:"customLogoFile,omitempty"`
+	// developerCatalog allows to configure the shown developer catalog categories.
+	// +optional
+	DeveloperCatalog DeveloperConsoleCatalogCustomization `json:"developerCatalog,omitempty"`
+}
+
+// DeveloperConsoleCatalogCustomization allow the cluster admin to configure developer catalog.
+type DeveloperConsoleCatalogCustomization struct {
+	// categories which are shown the in the devconsole.
+	// +optional
+	Categories []DeveloperConsoleCatalogCategory `json:"categories,omitempty"`
+}
+
+// DeveloperConsoleCatalogCategoryMeta defines a category incl. label and filter tags
+// for the developer console catalog.
+type DeveloperConsoleCatalogCategoryMeta struct {
+	// ID is an identifier used in the URL to enable deep linking in console.
+	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.
+	// +optional
+	Tags []string `json:"tags,omitempty"`
+}
+
+// DeveloperConsoleCatalogCategory defines a top level category incl. label, filter tags
+// and subcategories for the developer console catalog.
+type DeveloperConsoleCatalogCategory struct {
+	// defines top level category ID, label and filter tags.
+	DeveloperConsoleCatalogCategoryMeta `json:",inline"`
+	// subcategories defines a list of child categories.
+	// +optional
+	Subcategories []DeveloperConsoleCatalogCategoryMeta `json:"subcategories,omitempty"`
 }
 
 // Brand is a specific supported brand within the console.

diff --git a/operator/v1/zz_generated.deepcopy.go b/operator/v1/zz_generated.deepcopy.go
diff --git a/operator/v1/zz_generated.swagger_doc_generated.go b/operator/v1/zz_generated.swagger_doc_generated.go