github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/site/reference/schema/config-connector-status-convention/README.md (about)

     1  # Config Connector Status Convention
     2  
     3  `kpt` includes custom rules for [Config Connector] resources to make them easier to work
     4  with. This document describes how kpt uses fields and conditions on Config Connector
     5  resources to compute [reconcile status].
     6  
     7  Config Connector resources expose the `observedGeneration` field in the status
     8  object, and `kpt` will always report a resource as being `InProgress` if the
     9  `observedGeneration` doesn't match the value of `metadata.generation`.
    10  
    11  If the `Ready` condition is `True`, a Config Connector resource will be reported
    12  as `Current`, i.e it has been successfully reconciled.
    13  
    14  If the `Ready` condition is `False`, `kpt` will look at the `Reason` field on the
    15  condition object to determine whether the resource is making progress towards
    16  reconciliation. The possible values mirrors those used by [Config Connector events].
    17  If the value is one of the following, the resource is considered to have failed
    18  reconciliation:
    19  - `ManagementConflict`
    20  - `UpdateFailed`
    21  - `DeleteFailed`
    22  - `DependencyInvalid`
    23  
    24  Note that this doesn't necessarily mean it could never successfully reconcile. 
    25  The Config Connector controller will keep retrying. But it does mean that the
    26  resource is in a state where an external change is most likely needed to resolve
    27  the issue. Typical examples would be missing permissions or an API that has not
    28  been enabled.
    29  
    30  Similar to all other resources, a Config Connector resource will be in the `Terminating`
    31  state if the `metadata.deletionTimestamp` is set, and considered fully deleted when
    32  the resource no longer exists in the cluster.
    33  
    34  [reconcile status]: /book/06-deploying-packages/?id=reconcile-status
    35  [Config Connector]: https://cloud.google.com/config-connector/docs/overview
    36  [Config Connector events]: https://cloud.google.com/config-connector/docs/how-to/monitoring-your-resources