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

TLS Passthrough how-to guide missing instructions on enabling experimental features #2481

Closed
kate-osborn opened this issue Aug 29, 2024 · 0 comments · Fixed by #2546
Closed

TLS Passthrough how-to guide missing instructions on enabling experimental features #2481

kate-osborn opened this issue Aug 29, 2024 · 0 comments · Fixed by #2546
Assignees
@bjee19
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/small Estimated to be completed within ~2 days
Milestone
v1.5.0

Comments

@kate-osborn
Copy link
Contributor

kate-osborn commented Aug 29, 2024 •
edited by mpstefan
Loading

As a user of NGF
I want a guide to show me how to enable experimental features for NGF
So that I can use features that have not come out of the experimental channel of the Gateway API
And so that I know that any features I use that are experimental are subject to change.

Acceptance

  • An include description is created that describes how to:
    • What is the risk of using experimental features or why do experimental features need to be enabled
    • Install the Gateway API experimental features
    • How to enable experimental features on NGF either by:
      • --gateway-api-experimental-features command-line flag must be set on the deployment manifest
      • The nginxGateway.gwAPIExperimentalFeatures.enable helm option needs to be set to true.
  • A reference to this guide is provided where experimental features are mentioned including but not limited to:
@mpstefan mpstefan added the documentation Improvements or additions to documentation label Sep 3, 2024
@mpstefan mpstefan added this to the v1.5.0 milestone Sep 3, 2024
@salonichf5 salonichf5 assigned salonichf5 and unassigned salonichf5 Sep 5, 2024
@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. size/small Estimated to be completed within ~2 days labels Sep 9, 2024
@bjee19 bjee19 self-assigned this Sep 9, 2024
@bjee19 bjee19 mentioned this issue Sep 12, 2024
Merged
6 tasks
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in NGINX Gateway Fabric Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bjee19 bjee19

Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/small Estimated to be completed within ~2 days
Projects
NGINX Gateway Fabric
Status: ✅ Done
Milestone
v1.5.0
Development

Successfully merging a pull request may close this issue.

Add description for enabling experimental features bjee19/nginx-gateway-fabric
4 participants
@mpstefan @kate-osborn @bjee19 @salonichf5