Documentation
¶
Overview ¶
The CR syncer syncs custom resources between a remote Kubernetes cluster and the local Kubernetes cluster. The spec part is copied from upstream to downstream, and the status part is copied from downstream to upstream.
The behaviour can be customized by annotations on the CRDs.
Annotation "filter-by-robot-name"
cr-syncer.cloudrobotics.com/filter-by-robot-name: <bool>
If true, only sync CRs that have a label 'cloudrobotics.com/robot-name: <robot-name>' that matches the robot-name arg given on the command line.
Annotation "status-subtree"
cr-syncer.cloudrobotics.com/status-subtree: <string>
If specified, only sync the given subtree of the Status field. This is useful if resources have a shared status.
Annotation "spec-source"
cr-syncer.cloudrobotics.com/spec-source: <string>
If set to "cloud", the source of truth for object existence and specs (upstream) is the remote cluster and for status it's local (downstream). If set to "", the CRD is ignored.
NOTE: Previously, this could be set to "robot", but support was removed as it was unused and the required auth setup is more complex, and would need changes to cr-syncer-auth-webhook to validate CR creation as well.
Source Files