diff --git a/docs/gitrepo-content.md b/docs/gitrepo-content.md index fb3e12e12..aead54376 100644 --- a/docs/gitrepo-content.md +++ b/docs/gitrepo-content.md @@ -218,7 +218,7 @@ using YAML syntax. ## Cluster and Bundle State -See [Cluster and Bundle state](./cluster-bundles-state.md). +See [Cluster and Bundle state](./ref-status-fields.md). ## Nested GitRepo CRs diff --git a/docs/ref-bundle-stages.md b/docs/ref-bundle-stages.md index f30b9a765..1045208ca 100644 --- a/docs/ref-bundle-stages.md +++ b/docs/ref-bundle-stages.md @@ -5,7 +5,7 @@ A bundle is an internal resource used for the orchestration of resources from gi To demonstrate the life cycle of a Fleet bundle, we will use [multi-cluster/helm](https://github.com/rancher/fleet-examples/tree/master/multi-cluster/helm) as a case study. 1. User will create a [GitRepo](./gitrepo-add.md#create-gitrepo-instance) that points to the multi-cluster/helm repository. -2. The `gitjob-controller` will sync changes from the GitRepo and detect changes from the polling or [webhook event](./webhook.md). With every commit change, the `gitjob-controller` will create a job that clones the git repository, reads content from the repo such as `fleet.yaml` and other manifests, and creates the Fleet [bundle](./cluster-bundles-state.md#bundles). +2. The `gitjob-controller` will sync changes from the GitRepo and detect changes from the polling or [webhook event](./webhook.md). With every commit change, the `gitjob-controller` will create a job that clones the git repository, reads content from the repo such as `fleet.yaml` and other manifests, and creates the Fleet [bundle](./ref-status-fields.md#bundles). >**Note:** The job pod with the image name `rancher/tekton-utils` will be under the same namespace as the GitRepo. diff --git a/docs/cluster-bundles-state.md b/docs/ref-status-fields.md similarity index 60% rename from docs/cluster-bundles-state.md rename to docs/ref-status-fields.md index 056d1d38a..5946e8bfb 100644 --- a/docs/cluster-bundles-state.md +++ b/docs/ref-status-fields.md @@ -1,8 +1,13 @@ -# Cluster and Bundle State +# Status Fields + +This shows how status fields are propagated from one resource to another: +![Status Propagation](/img/FleetStatusSource.png) + +## Cluster and Bundle States Clusters and Bundles have different states in each phase of applying Bundles. -## Bundles +### Bundles **Ready**: Bundles have been deployed and all resources are ready. @@ -18,7 +23,7 @@ Clusters and Bundles have different states in each phase of applying Bundles. **Modified**: Bundles have been deployed and all resources are ready, but there are some changes that were not made from the Git Repository. -## Clusters +### Clusters **WaitCheckIn**: Waiting for agent to report registration information and cluster status back. @@ -35,3 +40,29 @@ Clusters and Bundles have different states in each phase of applying Bundles. **Modified**: There are bundles in this cluster that are in Modified state. **Ready**: Bundles in this cluster have been deployed and all resources are ready. + +## Resources List + +The resources lists contain 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. diff --git a/docs/resource-counts-and-resources-list.md b/docs/resource-counts-and-resources-list.md index 852ae6eb3..e69de29bb 100644 --- a/docs/resource-counts-and-resources-list.md +++ b/docs/resource-counts-and-resources-list.md @@ -1,25 +0,0 @@ -# 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. diff --git a/sidebars.js b/sidebars.js index 3e946f73e..9c099eace 100644 --- a/sidebars.js +++ b/sidebars.js @@ -69,8 +69,7 @@ module.exports = { {type: 'doc', id: 'cli/fleet-controller/fleet-manager_cleanup'}, ], }, - {type:'doc', id:'cluster-bundles-state'}, - {type:'doc', id:'resource-counts-and-resources-list'}, + {type:'doc', id:'ref-status-fields'}, 'ref-registration', 'ref-configuration', 'ref-resources', diff --git a/static/img/FleetStatusSource.png b/static/img/FleetStatusSource.png new file mode 100644 index 000000000..5a42e100b Binary files /dev/null and b/static/img/FleetStatusSource.png differ