Introduce reference documentation for resource counts and resources list in status

This commit is contained in:
Rubhan Azeem 2024-06-27 14:03:19 +02:00
parent 7f3299f2c6
commit 2bbd73ae55
2 changed files with 26 additions and 0 deletions

View File

@ -0,0 +1,25 @@
# Resources List
This document outlines the deployed resources, categorized under `Bundles` and `GitRepos`.
## Bundles
The deployed resources within bundles can be found in `status.ResourceKey`. This key represents the actual resources deployed via `bundleDeployments`.
## GitRepos
Similar to bundles, the deployed resources in `GitRepos` are listed in `status.Resources`. This list is also derived from `bundleDeployments`.
# Resource Counts
## GitRepos
The `status.ResourceCounts` list for GitRepos is derived from `bundleDeployments`.
## Clusters
In Clusters, the `status.ResourceCounts` list is derived from GitRepos.
## ClusterGroups
In ClusterGroups, the `status.ResourceCounts` list is also derived from GitRepos.

View File

@ -70,6 +70,7 @@ module.exports = {
],
},
{type:'doc', id:'cluster-bundles-state'},
{type:'doc', id:'resource-counts-and-resources-list'},
'ref-registration',
'ref-configuration',
'ref-resources',