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.

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

docs: add config alpha state and exempt-namespace docs #2890

Merged

Conversation

salaxander
Copy link
Contributor

What this PR does / why we need it:
Documentation updates to add the API state for the Config resource, and the --exempt-namespace-prefix and --exempt-namespace-suffix flags.

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #1865
Fixes #1764

@@ -65,6 +67,10 @@ If it becomes necessary to exempt a namespace from Gatekeeper webhook entirely (
3. Add the `admission.gatekeeper.sh/ignore` label to the namespace. The value attached
to the label is ignored, so it can be used to annotate the reason for the exemption.

Similarly, you can also exempt entire groups of namespaces using the `--exempt-namespace-prefix` and `--exempt-namespace-suffix` flags.
Copy link
Contributor

Choose a reason for hiding this comment

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

was there a need to update the helm chart readme too? as per

https://github.com/open-policy-agent/gatekeeper/pull/2655/files

Copy link
Member

@ritazh ritazh Jul 28, 2023

Choose a reason for hiding this comment

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

@salaxander Can you please address this as well? and once the helm doc is updated, might be good to also mention those helm values to update. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So it looks like the exemptNamespaceSuffixes Helm value doesn't exist (I would consider adding a new value to be out of scope for this PR). exemptNamespacePrefixes is documented on line 176 of the README

| controllerManager.exemptNamespacePrefixes     | The namespace prefixes to exempt by the admission webhook  

Copy link
Member

Choose a reason for hiding this comment

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

Helm chart values changes shouldn't be that big. You can take a look at https://github.com/open-policy-agent/gatekeeper/pull/2655/files but address the review comment. Or you can do it as a follow up.

Copy link
Member

Choose a reason for hiding this comment

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

i am okay if we want to follow up with that if we can create an issue

salaxander and others added 4 commits July 21, 2023 14:07
Signed-off-by: Xander Grzywinski <xandergrzyw@gmail.com>
Signed-off-by: Eshaan Mathur <37758843+eshaanm25@users.noreply.github.com>
Co-authored-by: Rita Zhang <rita.z.zhang@gmail.com>
Signed-off-by: Xander Grzywinski <xandergrzyw@gmail.com>
Signed-off-by: Nilekh Chaudhari <1626598+nilekhc@users.noreply.github.com>
Signed-off-by: Xander Grzywinski <xandergrzyw@gmail.com>
…uffix flags

Signed-off-by: Xander Grzywinski <xandergrzyw@gmail.com>
@codecov-commenter
Copy link

Codecov Report

Patch coverage has no change and project coverage change: +0.01 🎉

Comparison is base (1076798) 53.60% compared to head (3857fe3) 53.62%.

❗ Current head 3857fe3 differs from pull request most recent head 164c509. Consider uploading reports for the commit 164c509 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2890      +/-   ##
==========================================
+ Coverage   53.60%   53.62%   +0.01%     
==========================================
  Files         133      133              
  Lines       11545    11545              
==========================================
+ Hits         6189     6191       +2     
+ Misses       4880     4879       -1     
+ Partials      476      475       -1     
Flag Coverage Δ
unittests 53.62% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@sozercan sozercan left a comment

Choose a reason for hiding this comment

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

LGTM

@salaxander salaxander merged commit f3eba67 into open-policy-agent:master Aug 1, 2023
3 checks passed
@salaxander salaxander deleted the config_exempt_namespace branch August 1, 2023 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document config resource as alpha document exempt-namespace-prefix
8 participants