crossplane / crossplane/docs

Include ConnectionDetailsTypes in the Connection Details documentation

Open
#768 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
SCSS
Stars
60
Forks
163
Avg merge
15h 20m
Merged PRs (30d)
9

Description

### 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.