Skip to content

Commit 3810d63

Browse files
committed
Add pagination docs
Signed-off-by: Atif Ali <atali@redhat.com>
1 parent 5504573 commit 3810d63

11 files changed

Lines changed: 51 additions & 16 deletions

docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ You can use these pages to:
2727
* Create resources by using YAML templates
2828
* Edit labels and annotations
2929
* Filter resources by status, where applicable
30+
* Paginate large filtered lists and details tables (10, 20, 50, or 100 items per page; default 50)
3031
* Access related resources and events
3132

3233
The GitOps Console plugin integrates with the console navigation, allowing you to navigate between related resources and access contextual actions for each resource type.
@@ -46,7 +47,7 @@ The GitOps Console plugin provides search and template capabilities:
4647
* [AppProjects in the GitOps Console](appprojects-rbac.md)
4748
* [ImageUpdaters in the GitOps Console](image-updaters.md)
4849
* [Rollouts in the GitOps Console](rollouts.md)
49-
* [Filter resources](filter-resources.md)
50+
* [Filter and paginate resources](filter-resources.md)
5051
* [Getting started](getting-started.md)
5152
* [Troubleshooting](troubleshooting.md)
5253

docs/_sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
- [AppProjects in the GitOps Console](appprojects-rbac.md)
77
- [ImageUpdaters in the GitOps Console](image-updaters.md)
88
- [Rollouts in the GitOps Console](rollouts.md)
9-
- [Filter resources](filter-resources.md)
9+
- [Filter and paginate resources](filter-resources.md)
1010
- [Troubleshooting](troubleshooting.md)
1111
- [1.22 GA release notes](release-notes-ga.md)

docs/applications.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The Applications list page displays all Applications with the following features
1313
* **Table columns**: name, namespace, sync status, health, revision, AppProject, and actions
1414
* **Filtering**: Filter Applications by health status (Healthy, Progressing, Degraded, Missing) and sync status (Synced, OutOfSync, Unknown)
1515
* **Sorting and search**: Sort columns and search by name
16+
* **Pagination**: After filters and search, browse results in pages of 10, 20, 50, or 100 items (default 50). Page and page size are stored in the URL. See [Filter and paginate resources](filter-resources.md).
1617
* **Create action**: Click **Create Application** to open the YAML editor with a starter template that includes repository URL, destination, and sync policy placeholders
1718
* **Namespace view**: From the GitOps Operator namespace path, an optional control can list operands in all namespaces for operator-focused workflows
1819

@@ -22,15 +23,16 @@ The Application details page provides the following tabs:
2223

2324
* **Details tab**: Displays summary information, health and sync indicators, revision links, destination and project information, conditions, toggles for automated sync, self-heal, and prune (when you have update permission), and detection of an Argo CD Route so you can open the Argo CD UI for the same application when routing is configured.
2425
* **YAML tab**: Provides a live manifest editor for the Application resource.
25-
* **Sources tab**: Displays repository sources with icons and metadata for Helm, Git, and OCI sources.
26+
* **Sources tab**: Displays repository sources with icons and metadata for Helm, Git, and OCI sources. The sources table supports pagination.
2627
* **Resources tab**: Combines a resource table with an interactive topology graph:
2728
* The graph shows immediate managed resources for the Application, not the full Argo CD resource tree.
2829
* Use the Argo CD link on the tab to open the complete resource hierarchy in the Argo CD UI.
2930
* Pan, zoom, and select resources in the graph; status filters apply to both table and graph.
31+
* In list view, the resources table supports filtering, sorting, and pagination like other GitOps tables. See [Filter and paginate resources](filter-resources.md).
3032
* Context-menu actions on graph nodes include viewing details, editing labels and annotations, deleting resources, and viewing resources in Argo CD.
3133
* Related resources of the same kind can be grouped or ungrouped in the graph.
32-
* **Sync Status tab**: Provides fine-grained sync and operation status information for the Application.
33-
* **History tab**: Displays the deployment and sync history for the Application.
34+
* **Sync Status tab**: Provides fine-grained sync and operation status information for the Application, including a paginated table of resources last synced.
35+
* **History tab**: Displays the deployment and sync history for the Application in a paginated table (newest first by default; column sort keeps the selected direction).
3436
* **Events tab**: Shows Kubernetes events for the Application object.
3537

3638
## Additional features

docs/applicationsets.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The ApplicationSets list page follows the same list patterns as other custom res
88

99
* **Table columns**: Standard columns for custom resources
1010
* **Filtering**: Filter ApplicationSets by health status (Healthy, Error, Unknown)
11+
* **Pagination**: After filters and search, browse results in pages of 10, 20, 50, or 100 items (default 50). See [Filter and paginate resources](filter-resources.md).
1112
* **Create action**: Click **Create ApplicationSet** to open the YAML editor with a default ApplicationSet template
1213

1314
> **NOTE**
@@ -21,5 +22,5 @@ The ApplicationSet details page provides the following tabs:
2122
* **Details tab**: Displays status information, generator counts, conditions, links to the Generators and Applications tabs, and shows the number of generated applications of related Applications.
2223
* **YAML tab**: Provides a live manifest editor for the ApplicationSet resource.
2324
* **Generators tab**: Provides a structured view of generator configuration, including list, merge, and union generators.
24-
* **Applications tab**: Displays the list of applications generated by the ApplicationSet with a Graphical View showing visual representation of the generated applications, progressive sync visualization that shows the progressive sync flow from step to step when progressive sync is enabled, a filter widget to filter by health and sync status, and an applications table with the same rich columns as the main Application list page.
25+
* **Applications tab**: Displays the list of applications generated by the ApplicationSet with a Graphical View showing visual representation of the generated applications, progressive sync visualization that shows the progressive sync flow from step to step when progressive sync is enabled, a filter widget to filter by health and sync status, and an applications table with the same rich columns, filtering, and pagination as the main Application list page.
2526
* **Events tab**: Shows Kubernetes events for the ApplicationSet object.

docs/appprojects-rbac.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The AppProjects list page displays all project-scoped AppProjects with the follo
88

99
* **Table columns**: Standard columns for custom resources
1010
* **Filtering**: Filter projects by Description, Applications, Project Type, Source Repositories, and Destinations
11+
* **Pagination**: After filters and search, browse results in pages of 10, 20, 50, or 100 items (default 50). See [Filter and paginate resources](filter-resources.md).
1112
* **Create action**: Click **Create AppProject** to open the YAML editor with a default AppProject template
1213

1314
## Details page
@@ -17,9 +18,9 @@ The AppProject details page provides the following tabs:
1718
* **Details tab**: Displays project summary, destinations, policies, and related metadata.
1819
* **YAML tab**: Provides a live manifest editor for the AppProject resource.
1920
* **Allow/Deny tab**: Displays resource allow and deny lists for cluster-scoped and namespace-scoped kinds.
20-
* **Applications tab**: Shows Applications that belong to this project. The table provides the same experience as the main Application list, filtered by project.
21-
* **Roles tab**: Displays Argo CD project roles and bindings.
22-
* **Sync Windows tab**: Shows configured sync windows for the project.
21+
* **Applications tab**: Shows Applications that belong to this project. The table provides the same experience as the main Application list, including filtering and pagination, scoped to this project.
22+
* **Roles tab**: Displays Argo CD project roles and bindings in a paginated table. See [Filter and paginate resources](filter-resources.md).
23+
* **Sync Windows tab**: Shows configured sync windows for the project in a paginated table.
2324
* **Events tab**: Shows Kubernetes events for the AppProject object.
2425

2526
## Mapping OpenShift RBAC to AppProject permissions

docs/filter-resources.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Filter resources
1+
# Filter and paginate resources
22

3-
The GitOps Console plugin provides filters to narrow the resource list based on specific properties. The available filter options vary by resource type.
3+
The GitOps Console plugin provides filters to narrow the resource list based on specific properties. Large filtered lists use client-side pagination that matches the OpenShift web console list experience. The available filter options vary by resource type.
44

55
## Prerequisites
66

77
* You have access to the OpenShift web console.
88
* The GitOps Console plugin is enabled.
99

10-
## Procedure
10+
## Filtering
1111

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

@@ -25,6 +25,28 @@ The GitOps Console plugin provides filters to narrow the resource list based on
2525

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

28+
## Pagination
29+
30+
List pages for Applications, ApplicationSets, AppProjects, ImageUpdaters, and Rollouts paginate rows after filters and search are applied.
31+
32+
Pagination also applies to nested and details tables that use the same shared table:
33+
34+
* The **Applications** tab on an ApplicationSet details page
35+
* The **Applications** tab on an AppProject details page
36+
* Application details: **Resources** (list view), **Sources**, **Sync Status** (resources last synced), and **History**
37+
* AppProject details: **Roles** and **Sync Windows**
38+
* ImageUpdater details: **Recent Updates**
39+
* Rollout details: **Pods**
40+
41+
### Behavior
42+
43+
* **Page size**: Choose **10**, **20**, **50**, or **100** items per page. The default is **50**. There is no **All** option.
44+
* **Controls**: Pagination appears above and below the table when the filtered list contains at least one row.
45+
* **URL state**: The current page and page size are stored in the URL (`page` and `perPage`) so you can refresh or share the view.
46+
* **Reset**: Changing filters, name or label search, or the selected namespace 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.
47+
* **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.
48+
2849
## Verification
2950

3051
* Verify that the resource list displays only items matching your selected filter criteria.
52+
* Verify that the pagination controls show the correct total for the filtered list and that changing the page size updates the table.

docs/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,4 @@ ImageUpdaters and Rollouts appear when those CRDs are installed on the cluster.
5050

5151
* [Enable the GitOps Console plugin](admin-enable-plugin.md)
5252
* [Applications](applications.md)
53+
* [Filter and paginate resources](filter-resources.md)

docs/image-updaters.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ The ImageUpdaters list page displays ImageUpdater resources with the following f
88

99
* **Table columns**: name, namespace, applications matched, images managed, last checked, ready, labels, and actions
1010
* **Filtering**: Filter by applications (Has Apps, No Apps) and ready status (Ready, Not Ready)
11+
* **Pagination**: After filters and search, browse results in pages of 10, 20, 50, or 100 items (default 50). See [Filter and paginate resources](filter-resources.md).
1112
* **Create action**: Click **Create ImageUpdater** to open the YAML editor with a starter template
1213

1314
## Details page
1415

1516
The ImageUpdater details page provides the following tabs:
1617

1718
* **Details tab**: Displays ready status, applications matched, images managed, last checked and last updated times, observed generation, and conditions.
18-
* **Recent Updates tab**: Displays updates from the last reconciliation cycle, including alias, image, new version, applications updated, time, and message.
19+
* **Recent Updates tab**: Displays updates from the last reconciliation cycle, including alias, image, new version, applications updated, time, and message, in a paginated table. See [Filter and paginate resources](filter-resources.md).
1920
* **YAML tab**: Provides a live manifest editor for the ImageUpdater resource.

docs/release-notes-ga.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ This feature includes:
99
+
1010
* List and details pages for Applications, ApplicationSets, AppProjects, ImageUpdaters, and Rollouts
1111
* Filters for health, sync, and resource-specific status
12+
* Client-side pagination for list pages and details tables (10, 20, 50, or 100 items per page; default 50) after filters and search, with page state in the URL
1213
* Graphical views for Applications and ApplicationSets
1314
* Rollout topology in the OpenShift Console Topology view, including revision rollback
1415
* YAML templates for creating resources
1516
* Links between the OpenShift Console and the Argo CD UI
1617
+
17-
Known limitations: The Application kebab does not include Sync or Rollback actions. ApplicationSet creation uses YAML, not a form. The Application resource graph shows immediate managed resources, not the full Argo CD tree.
18+
Known limitations: The Application kebab does not include Sync or Rollback actions. ApplicationSet creation uses YAML, not a form. The Application resource graph shows immediate managed resources, not the full Argo CD tree. Pagination is client-side on the loaded result set and does not use Kubernetes API `limit` or `continue` tokens.
1819

1920
Support matrix: Technology Preview in 1.21.0. General Availability in 1.22.0.

docs/rollouts.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The Rollouts list page displays all Argo Rollout resources with the following fe
88

99
* **Table columns**: Standard columns for Rollout resources
1010
* **Filtering**: Filter Rollouts by rollout status (Healthy, Paused, Progressing, Degraded)
11+
* **Pagination**: After filters and search, browse results in pages of 10, 20, 50, or 100 items (default 50). See [Filter and paginate resources](filter-resources.md).
1112
* **Create action**: Click **Create Rollout** to open the YAML editor with a default Rollout template
1213

1314
## Topology integration
@@ -30,5 +31,5 @@ The Rollout details page provides the following tabs:
3031
* Pod status and health
3132

3233
This view provides the same information as the `oc argo rollouts get rollout` CLI command, including the functionality of the `--watch` option, allowing you to monitor rollout progress directly from the console. **Rollback** is available on a non-current revision when you have patch permission.
33-
* **Pods tab**: Shows pods for the rollout with pod-level actions.
34+
* **Pods tab**: Shows pods for the rollout with pod-level actions. The pods table supports filtering, sorting, and pagination. See [Filter and paginate resources](filter-resources.md).
3435
* **Events tab**: Shows Kubernetes events for the Rollout object.

0 commit comments

Comments
 (0)