Skip to content

Add skip permissions option to ApiServerSource #6288

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

Merged
merged 3 commits into from
Jul 22, 2025
Merged

Add skip permissions option to ApiServerSource #6288

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18cc997
Add skip permissions option to ApiServerSource
rh-hemartin Jul 10, 2025
92f660c
Rename annotation
rh-hemartin Jul 21, 2025
b91db0f
Move page to reference.md
rh-hemartin Jul 22, 2025
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
30 changes: 30 additions & 0 deletions docs/eventing/sources/apiserversource/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ An ApiServerSource definition supports the following fields:
| [`apiVersion`][kubernetes-overview] | Specifies the API version, for example `sources.knative.dev/v1`. | Required |
| [`kind`][kubernetes-overview] | Identifies this resource object as an ApiServerSource object. | Required |
| [`metadata`][kubernetes-overview] | Specifies metadata that uniquely identifies the ApiServerSource object. For example, a `name`. | Required |
| [`metadata.annotations`][#features] | Specifies metadata that enables certain features. See the related section. | Optional |
| [`spec`][kubernetes-overview] | Specifies the configuration information for this ApiServerSource object. | Required |
| [`spec.resources`](#resources-parameter) | The resources that the source tracks so it can send related lifecycle events from the Kubernetes ApiServer. Includes an optional label selector to help filter. | Required |
| `spec.mode` | EventMode controls the format of the event. Set to `Reference` to send a `dataref` event type for the resource being watched. Only a reference to the resource is included in the event payload. Set to `Resource` to have the full resource lifecycle event in the payload. Defaults to `Reference`. | Optional |
Expand Down Expand Up @@ -315,6 +316,35 @@ spec:
{ "extensions": { "extra": "this is an extra attribute", "additional": "42" } }
```

### Features

The ApiServerSource uses annotations to the enable certain features.

#### Skipping Permissions Check

This feature disables the RBAC permissions check done before creating
the Deployment. By default three SubjectAccessReview requests are
created per combination of resource and namespace tracked.

When enabled, this feature removes the creation of SubjectAccessReview,
reducing the pressure to the Kubernetes API when a large number of
resources or namespaces are tracked by the ApiServerSource. In this
case the ApiServerSource Deployment does not retry watch connections.

To enable it, set it to `"true"`:

```yaml
apiVersion: sources.knative.dev/v1
kind: ApiServerSource
metadata:
name: <apiserversource>
namespace: <namespace>
annotations:
features.knative.dev/apiserversource-skip-permissions-check: "true"
spec:
...
```

[kubernetes-overview]:
https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
[kubernetes-kinds]:
Expand Down
Loading