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

[docs] Convention Server Open API spec #74

Merged
merged 13 commits into from
Apr 26, 2022
Merged

[docs] Convention Server Open API spec #74

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0101202
Document the webhook contract
katmutua Apr 5, 2022
ec8da7c
Bump codecov/codecov-action from 2 to 3 (#72)
dependabot[bot] Apr 5, 2022
381a307
Switch component label to app.kubernetes.io/component (#73)
scothis Apr 6, 2022
58d1dbb
Add an initial draft for the spec
katmutua Apr 12, 2022
453616b
Remove kubernetes io reference
katmutua Apr 13, 2022
1815ab6
Merge branch 'main' into document-webhook-contract
katmutua Apr 14, 2022
026b44f
Update webhook helper section
katmutua Apr 14, 2022
0d00e34
Update descriptions and add examples
katmutua Apr 18, 2022
79c721f
Specify expected format of raw field in a BOM object
katmutua Apr 19, 2022
a81c519
Resolve comments and include suggestions
katmutua Apr 20, 2022
d06b20d
Add detail on how to configure the webhook path
katmutua Apr 21, 2022
b444ae0
Add detail on how to configure the webhook path
katmutua Apr 21, 2022
c3af6d0
Reference the ClusterPodConvetion and associated components
katmutua Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- [PodIntent (conventions.carto.run/v1alpha1)](#podintent-conventionscartorunv1alpha1)
- [ClusterPodConvention (conventions.carto.run/v1alpha1)](#clusterpodconvention-conventionscartorunv1alpha1)
- [PodConventionContext (webhooks.conventions.carto.run/v1alpha1)](#podconventioncontext-webhooksconventionscartorunv1alpha1)
- [Webhook contract](#webhook-contract)
- [Lifecycle](#lifecycle)
- [Security](#security)
- [Supportability](#supportability)
Expand Down Expand Up @@ -237,6 +238,21 @@ status: # the response

In the future other mechanisms may be defined to provide conventions other than webhooks. In particular, mechanisms that are safe to execute within the controller process like a YTT overlay or WebAssembly. Each mechanism will define the specifics of its own contract similar in scope to the `PodConventionContext`.

#### Webhook Contract
katmutua marked this conversation as resolved.
Show resolved Hide resolved

In order for the conventions controller to apply a set of conventions, it requires these conventions to be authored in the form of a webhook.

The authored webhook is registered as follows:
```
http.HandleFunc(< url >, webhook.ConventionHandler(ctx, conventions_name))
katmutua marked this conversation as resolved.
Show resolved Hide resolved
```
The convention controller handler function expects a `ctx Context` and a function describing conventions to be applied. See [springboot-convetions example](../samples/spring-convention-server/server.go)
katmutua marked this conversation as resolved.
Show resolved Hide resolved
```
http.HandleFunc("/", webhook.ConventionHandler(ctx, addSpringBootConventions))
```

The ```HandleFunc``` in ```cartographer-conventions``` is therefore responsible for invoking various reconcilers to apply the various conventions ordered by priority.
katmutua marked this conversation as resolved.
Show resolved Hide resolved

## Lifecycle

Cartographer Conventions lives entirely within the user space of a Kubernetes cluster. It can be installed, upgraded and removed like any other CRDs with a controller. Upgrade instructions will be included with each release.
Expand Down