search

crossplane / docs

Repo for Crossplane documentation.
https://docs.crossplane.io
Other
49 stars 110 forks source link

Provide details about standard conditions used by Crossplane #750

Open jbw976 opened 5 months ago

jbw976 commented 5 months ago

URL

https://docs.crossplane.io/latest/concepts/managed-resources/#conditions

What's Wrong?

Discussed a bit in this PR: https://github.com/crossplane/crossplane/pull/5453#discussion_r1562242295

Our docs focus on the possible specific reasons for each condition, but don't seem to focus on the high level conditions themselves, e.g. Ready and Synced. What are their intent and semantics, what scenarios do they cover?

@negz quick write-up that is useful:

Today we have the following status conditions:

  • Ready - The external resource is ready to use, (where applicable) according to its API.
  • Synced - The managed resource's desired state has been successfully applied to the external resource.
plumbis commented 5 months ago

@jbw976 and @TerjeLafton I've added more details in a draft PR.

Preview: https://deploy-preview-752--crossplane.netlify.app/master/concepts/managed-resources/#conditions

If you're good with this I'll add the same content to the other versions as well.

TerjeLafton commented 5 months ago

@jbw976 and @TerjeLafton I've added more details in a draft PR.

Preview: https://deploy-preview-752--crossplane.netlify.app/master/concepts/managed-resources/#conditions

If you're good with this I'll add the same content to the other versions as well.

It looks good to me at least!