Add a specification for Composition Functions #4640
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a first pass at a 'formal' spec for a Composition Function. I think it will be important for all Functions to behave in a similar way in order for us to build tooling around them. Relates to https://github.com/crossplane/crossplane/issues/3714 Signed-off-by: Nic Cope <nicc@rk0n.org>
Signed-off-by: Nic Cope <nicc@rk0n.org>
Signed-off-by: Nic Cope <nicc@rk0n.org>
Signed-off-by: Nic Cope <nicc@rk0n.org>
|
@plumbis Added you as optional to review this for readability. |
phisco
reviewed
Sep 19, 2023
turkenh
reviewed
Sep 19, 2023
| A Function MUST NOT assume it is deployed in any particular way, for example | ||
| that it is running as a Kubernetes Pod in the same cluster as Crossplane. | ||
|
|
||
| A Function SHOULD fail gracefully if it does not have network access, for |
There was a problem hiding this comment.
Suggested change
| A Function SHOULD fail gracefully if it does not have network access, for | |
| A Function SHOULD fail gracefully if it needs but does not have network access, for |
I assume this is not relevant for an offline function.
plumbis
approved these changes
Sep 19, 2023
bobh66
approved these changes
Sep 19, 2023
| A Function MUST listen for gRPC requests on TCP port 9443, regardless of whether | ||
| they are using mTLS transport security or have transport security disabled. | ||
|
|
||
| A Function MUST not disable gRPC transport security unless the `--insecure` flag |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
Relates to crossplane/docs#579
This is a first pass at a 'formal' spec for a Composition Function. I think it will be important for all Functions to behave in a similar way in order for us to build tooling around them.
I have:
Runmake reviewableto ensure this PR is ready for review.Addedbackport release-x.ylabels to auto-backport this PR, if necessary.Opened a PR updating the docs, if necessary.