Merge pull request #300 from StrongMonkey/fleet-patch

Add bundle and cluster state, jsonPointer example
rancher · Mar 1, 2021 · adbf94f · adbf94f
2 parents 8a429f0 + 0351906
commit adbf94f
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 2 deletions.
diff --git a/docs/gitrepo-add.md b/docs/gitrepo-add.md
@@ -150,8 +150,9 @@ diff:
     operations:
     - {"op":"remove", "path":"/spec/template/spec/hostNetwork"}
     - {"op":"remove", "path":"/spec/template/spec/nodeSelector"}
-    - {"op":"remove", "path":"/spec/template/spec/priorityClassName"}
-    - {"op":"remove", "path":"/spec/template/spec/tolerations"}
+    jsonPointers: # jsonPointers allows to ignore diffs at certain json path
+    - "/spec/template/spec/priorityClassName"
+    - "/spec/template/spec/tolerations" 
 ```
 
 To determine which operations should be removed, observe the logs from `fleet-agent` on the target cluster. You should see entries similar to the following:

diff --git a/docs/gitrepo-structure.md b/docs/gitrepo-structure.md
@@ -207,3 +207,40 @@ will target `deployment.yaml`.  The patch will be applied using JSON Merge, Stra
 Which strategy is used is based on the file content. Even though JSON strategies are used, the files can be written
 using YAML syntax.
 
+## Cluster and Bundle state
+
+Clusters and Bundles have different states in each phase of applying Bundles.
+
+For Bundles:
+
+**Ready**: Bundles have been deployed and all resources are ready.
+
+**NotReady**: Bundles have been deployed and some resources are not ready.
+
+**WaitApplied**: Bundles have been synced from Fleet controller and downstream cluster, but are waiting to be deployed.
+
+**ErrApplied**: Bundles have been synced from the Fleet controller and the downstream cluster, but there were some errors when deploying the Bundle.
+
+**OutOfSync**: Bundles have been synced from Fleet controller, but downstream agent hasn't synced the change yet.
+
+**Pending**: Bundles are being processed by Fleet controller.
+
+**Modified**: Bundles have been deployed and all resources are ready, but there are some changes that were not made from the Git Repository.
+
+For Clusters:
+
+**WaitCheckIn**: Waiting for agent to report registration information and cluster status back.
+
+**NotReady**: There are bundles in this cluster that are in NotReady state. 
+
+**WaitApplied**: There are bundles in this cluster that are in WaitApplied state.
+
+**ErrApplied**: There are bundles in this cluster that are in ErrApplied state.
+
+**OutOfSync**: There are bundles in this cluster that are in OutOfSync state.
+
+**Pending**: There are bundles in this cluster that are in Pending state.
+
+**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.