Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the crossplane.io/external-create-... annotations #688

Merged
merged 11 commits into from
Feb 1, 2024
Merged

Document the crossplane.io/external-create-... annotations #688

merged 11 commits into from
Feb 1, 2024

Commits on Jan 30, 2024

  1. Document the crossplane.io/external-create-... annotations 

    These annotations were introduced in crossplane/crossplane-runtime#283.

Per crossplane/crossplane#3037 folks find
these annotations hard to reason about. That's understandable, because
they're doing a lot of subtle things.

This section ended up super long, but I think this is an area where
folks really need to understand what's happening in order to make good
decisions when Crossplane refuses to proceed.

Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    6843995 View commit details
    Browse the repository at this point in the history

Commits on Jan 31, 2024

  1. Refactor external creation annotations section 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    6cc91a7 View commit details
    Browse the repository at this point in the history

  2. Be specific about circumstances where we'll leak 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    1341e35 View commit details
    Browse the repository at this point in the history

  3. Use kubectl get -o yaml to get YAML manifest 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    741929c View commit details
    Browse the repository at this point in the history

  4. Use 'lookup' rather than 'find' an MR in an external system 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    9a5ee38 View commit details
    Browse the repository at this point in the history

  5. Describe external name generation as nondeterministic, not unpredictable 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    26c4ff4 View commit details
    Browse the repository at this point in the history

  6. Don't explicitly mention that saving annotations is critical 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    c0dbc0f View commit details
    Browse the repository at this point in the history

  7. Use if-then for inspecting external system 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    ecaf5c2 View commit details
    Browse the repository at this point in the history

  8. Clarify that resuming reconciliation recreates MR 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    eafb527 View commit details
    Browse the repository at this point in the history

  9. Move hint about why we wait for human intervention 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    c50047e View commit details
    Browse the repository at this point in the history

  10. Don't say "think", restructure important note about dupes 

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    @negz
    negz committed Jan 31, 2024
    Configuration menu
    Copy the full SHA
    0aef9a6 View commit details
    Browse the repository at this point in the history