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.

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

Include ConnectionDetailsTypes in the Connection Details documentation #768

Open
richbalf opened this issue May 12, 2024 · 0 comments
Open

Comments

@richbalf
Copy link

richbalf commented May 12, 2024

ConnectionDetail Types

When using XR Pipeline mode, it is required that ConnectionDetails are explicitly defined (ex. [0]) with their types which is a change in behaviour from the default mode that allows for details to be define implicitly as per the current documentation [1].

With the Crossplane Function in beta release, I would propose that a section be added to documentation that outlines the available ConnectionDetailType types [2] which include:

  • Unknown
  • FromConnectionSecretKey
  • FromFieldPath
  • FromValue

[0]

crossplane: error: cannot render composite resource: pipeline step "base-patch-and-transform" returned a fatal result: invalid Function input: resources[0].connectionDetails[0].type: Required value: connection detail type is required

[1] https://github.com/crossplane/docs/blob/master/content/master/concepts/connection-details.md
[2] https://github.com/crossplane/crossplane/blob/eec86c928f62b4b710f7f9db8d411efbc1791a86/apis/apiextensions/v1/composition_types.go#L771

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant