-
Task
-
Resolution: Done
-
Undefined
-
None
-
False
-
None
-
False
-
-
-
No
Prerequisite: Start with what we have
This change is part of users customizing the search console:
Describe the changes in the doc and link to your dev story
Provide info for the following steps:
1. - [x] Mandatory Add the required version to the Fix version/s field.
2. - [x] Mandatory Choose the type of documentation change.
- [x] New topic in an existing section or new section
- [ ] Update to an existing topic
3. - [ ] Mandatory for GA content:
- [ ] Add steps and/or other important conceptual information here:
Users now have the ability to configure the suggested searches section. By default, the suggested searches section will display the suggested searches from previous releases.
If a user wants to add / edit / remove searches from this section they will need to create a ConfigMap named "console-search-config". The console will read whatever the user has defined in this Configmap and display only what is present in the ConfigMap.
The ConfigMap will require the data.suggestedSearches field.
The suggestedSearches field accepts a string value of the suggested searches array. Each suggested search object needs an id, name, and searchText with an optional description.
Example ConfigMap:
kind: ConfigMap apiVersion: v1 metadata: name: console-search-config namespace: open-cluster-management data: suggestedSearches: |- [ { "id": "search.suggested.workloads.name", "name": "Workloads", "description": "Show workloads running on your fleet", "searchText": "kind:DaemonSet,Deployment,Job,StatefulSet,ReplicaSet" }, { "id": "search.suggested.unhealthy.name", "name": "Unhealthy pods", "description": "Show pods with unhealthy status", "searchText": "kind:Pod status:Pending,Error,Failed,Terminating,ImagePullBackOff,CrashLoopBackOff,RunContainerError,ContainerCreating" }, { "id": "search.suggested.createdLastHour.name", "name": "Created last hour", "description": "Show resources created within the last hour", "searchText": "created:hour" }, { "id": "search.suggested.virtualmachines.name", "name": "Virtual Machines", "description": "Show virtual machine resources", "searchText": "kind:VirtualMachine" } ]
- [ ] Add Required access level for the user to complete the task here:
User must have auth to create/edit a ConfigMap.
- [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
Users can verify the change by navigating to Home -> Search and confirming the suggested searches section only displays the user configured suggested searches.
- [x] Add link to dev story here: