Skip to content

filter-resources.md

Latest commit

 

History

History
74 lines (45 loc) · 3.96 KB

filter-resources.md

File metadata and controls

74 lines (45 loc) · 3.96 KB
Raw

Filter, search, and paginate resources

The GitOps Console plugin provides search, filters, and client-side pagination on resource list pages. Pagination improves usability and browser performance for large lists. Available filters vary by resource type.

Prerequisites

  • You have access to the OpenShift web console.
  • The GitOps Console plugin is enabled.

Search

  1. In the OpenShift web console, navigate to GitOps and select a resource type.

  2. On the list page, use the search field to match resources by Name or Label.

  3. Choose the search mode from the dropdown next to the field (for example, Name with Search by name..., or Label).

    Search mode dropdown with Name and Label options

Search is separate from Filter. You can use search and filters together.

Filtering

  1. In the OpenShift web console, navigate to GitOps and select a resource type.

  2. On the list page, click Filter to narrow the displayed resources by status or other properties.

    The following filters are available depending on the resource type:

    • Applications: Filter by health status (Healthy, Progressing, Suspended, Degraded, Missing, Unknown) and sync status (Synced, OutOfSync, Unknown).

      Applications Filter menu with Sync Status and Health Status

    • ApplicationSets: Filter by health status (Healthy, Error, Unknown).

    • AppProjects: Filter by Description (Has Description, No Description), Applications (Has Applications, No Applications), Project Type (Default Project, Custom Projects), Source Repositories (Has Source Repos, No Source Repos), and Destinations (Has Destinations, No Destinations).

    • ImageUpdaters: Filter by:

      • Apps: Has Apps, No Apps
      • Ready: Ready, Not Ready

    • Rollouts: Filter by:

      • Rollout Status: Healthy, Paused, Progressing, Degraded

  3. Optional: Combine multiple filters to narrow the results further.

  4. To clear filters, click the Clear all filters link or remove individual filter selections.

    Clear all filters link below active filter chips

Pagination

Pagination keeps large result sets usable and improves browser performance. The console shows only one page of rows at a time so long lists are easier to scan and the browser does not render every row at once.

Pagination is available on the GitOps list pages (Applications, ApplicationSets, AppProjects, ImageUpdaters, and Rollouts) as soon as the table has rows.

When you use search or filters, pagination applies only to the matching resources. Changing the search or filters returns you to page 1.

The same pagination applies to these nested and details tables:

  • The Applications tab on an ApplicationSet details page
  • The Applications tab on an AppProject details page
  • Application details: Resources (list view), Sources, Sync Status (resources last synced), and History
  • AppProject details: Roles and Sync Windows
  • ImageUpdater details: Recent Updates
  • Rollout details: Pods

Behavior

  • Page size: Choose 10, 20, 50, or 100 items per page. The default is 50. There is no All option.

    Page size menu with 10, 20, 50, and 100 per page

  • Controls: Pagination appears above and below the table when the filtered list contains at least one row.

  • URL state: The current page and page size are stored in the URL (page and perPage) so you can refresh or share the view.

  • Reset: Changing filters, name or label search, or the selected project returns you to page 1. Changing the page size or sorting does not reset the page by itself; if the list shrinks, the page is clamped to the last valid page.

  • Client-side only: Pagination runs in the browser on the already loaded and filtered list. It does not use Kubernetes API limit or continue tokens.