Merge pull request #167 from rancher/status-fields-page
Combine status reference pages
This commit is contained in:
commit
56ffcb2181
|
|
@ -1,3 +1,32 @@
|
|||
build/
|
||||
node_modules/
|
||||
/public
|
||||
/resources/_gen
|
||||
.idea
|
||||
.DS_Store
|
||||
|
||||
# Dependencies
|
||||
/node_modules
|
||||
package-lock.json
|
||||
|
||||
# Production
|
||||
/build
|
||||
|
||||
# Generated files
|
||||
.docusaurus
|
||||
.cache-loader
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
Session.vim
|
||||
/contrib
|
||||
.ignore
|
||||
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
files_without_canonical.txt
|
||||
/tmp
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,13 @@
|
|||
# Cluster and Bundle State
|
||||
# Status Fields
|
||||
|
||||
This shows how status fields are propagated from one resource to another:
|
||||

|
||||
|
||||
## 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.
|
||||
|
|
@ -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.
|
||||
|
|
@ -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',
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Loading…
Reference in New Issue