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

Add basic doc for eventing OIDC feature #5822

Merged
merged 6 commits into from
Jan 22, 2024
Merged

Add basic doc for eventing OIDC feature #5822

merged 6 commits into from
Jan 22, 2024

Conversation

creydr
Copy link
Member

@creydr creydr commented Jan 22, 2024

Fixes #5799

Proposed Changes

  • 🎁 Add basic documentation for eventing authentication-oidc feature flag

@netlify Netlify
Copy link

netlify bot commented Jan 22, 2024 •
edited
Loading

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 43fae6f
🔍 Latest deploy log https://app.netlify.com/sites/knative/deploys/65ae94bb40c46e000849734e
😎 Deploy Preview https://deploy-preview-5822--knative.netlify.app/docs/eventing/experimental-features/sender-identity
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 22, 2024
@knative-prow knative-prow bot requested a review from snneji January 22, 2024 13:48
@knative-prow knative-prow bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 22, 2024
@creydr
Copy link
Member Author

creydr commented Jan 22, 2024

/cc @AryanParashar24

@knative-prow Knative Prow
Copy link

knative-prow bot commented Jan 22, 2024

@creydr: GitHub didn't allow me to request PR reviews from the following users: AryanParashar24.

Note that only knative members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @AryanParashar24

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Cali0707
Cali0707 suggested changes Jan 22, 2024
View reviewed changes
Copy link
Member

@Cali0707 Cali0707 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @creydr would you be able to update

docs/config/nav.yml

Lines 278 to 286 in 9767277

- Experimental Features:
- About Eventing experimental features: eventing/experimental-features/README.md
- DeliverySpec.Timeout field: eventing/experimental-features/delivery-timeout.md
- DeliverySpec.RetryAfterMax field: eventing/experimental-features/delivery-retryafter.md
- New Trigger Filters: eventing/experimental-features/new-trigger-filters.md
- KReference.Group field: eventing/experimental-features/kreference-group.md
- Knative reference mapping: eventing/experimental-features/kreference-mapping.md
- EventType auto creation: eventing/experimental-features/eventtype-auto-creation.md
- Transport Encryption: eventing/experimental-features/transport-encryption.md
so that the new page you've added is properly included in the site navigation?

@creydr
Copy link
Member Author

creydr commented Jan 22, 2024

Hey @creydr would you be able to update

docs/config/nav.yml

Lines 278 to 286 in 9767277

- Experimental Features:
- About Eventing experimental features: eventing/experimental-features/README.md
- DeliverySpec.Timeout field: eventing/experimental-features/delivery-timeout.md
- DeliverySpec.RetryAfterMax field: eventing/experimental-features/delivery-retryafter.md
- New Trigger Filters: eventing/experimental-features/new-trigger-filters.md
- KReference.Group field: eventing/experimental-features/kreference-group.md
- Knative reference mapping: eventing/experimental-features/kreference-mapping.md
- EventType auto creation: eventing/experimental-features/eventtype-auto-creation.md
- Transport Encryption: eventing/experimental-features/transport-encryption.md

so that the new page you've added is properly included in the site navigation?

ah sure. Sorry forgot it...

@knative-prow Knative Prow
Copy link

knative-prow bot commented Jan 22, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: creydr

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@creydr creydr requested a review from Cali0707 January 22, 2024 14:51
@creydr creydr force-pushed the add-basic-eventing-oidc-doc branch from c39db7c to 28b67a2 Compare January 22, 2024 14:52
@Leo6Leo
Copy link
Member

Leo6Leo commented Jan 22, 2024

And tested all the sample script and yaml files in the doc, they all work as expected.

@creydr creydr requested a review from Leo6Leo January 22, 2024 16:17
@Leo6Leo
Copy link
Member

Leo6Leo commented Jan 22, 2024

/lgtm

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jan 22, 2024
@knative-prow knative-prow bot merged commit 4a5962e into knative:main Jan 22, 2024
19 checks passed
prushh pushed a commit to prushh/docs that referenced this pull request Apr 30, 2024
@creydr @prushh
Add basic doc for eventing OIDC feature (knative#5822)
de82afb 
* Add basic doc for eventing OIDC feature

* Add navbar link

* Use correct style for yaml output example

* Fix intend of example output

* Fix path to installation docs

* Add note that transport-encryption should be enabled as well
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pierDipi pierDipi Awaiting requested review from pierDipi

@snneji snneji Awaiting requested review from snneji

@Cali0707 Cali0707 Awaiting requested review from Cali0707

@Leo6Leo Leo6Leo Awaiting requested review from Leo6Leo

Assignees

@Leo6Leo Leo6Leo

@Cali0707 Cali0707

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation for OIDC feature flag
3 participants
@creydr @Leo6Leo @Cali0707