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

AP: Deprecate external refs #2249

Merged
merged 4 commits into from Mar 9, 2022
Merged

AP: Deprecate external refs #2249

merged 4 commits into from Mar 9, 2022

Conversation

rafwegv
Copy link
Contributor

@rafwegv rafwegv commented Dec 7, 2021

Proposed changes

Add a warning when an external refs field is detected in the policy.
This is the first stage of deprecation. In next release the policy will become invalid , and further down the line the fields will be removed from the crd.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto master
  • I will ensure my PR is targeting the master branch and pulling from my branch from my own fork

@rafwegv rafwegv self-assigned this Dec 7, 2021
@rafwegv
Copy link
Contributor Author

rafwegv commented Dec 7, 2021

Hi @soneillf5 @pleshakov I would appreciate input on where would be a good place to document this change, to make any customers aware of the deprecation.

@brianehlert
Copy link
Collaborator

brianehlert commented Dec 7, 2021

@rafwegv
Bare minimum is release notes.
I would add a deprecation note into the docs where the configuration option is presented to make it very clear.

@codecov-commenter
Copy link

codecov-commenter commented Dec 7, 2021

Codecov Report

Merging #2249 (bb50645) into master (56a7bfb) will decrease coverage by 0.00%.
The diff coverage is 77.77%.

❗ Current head bb50645 differs from pull request most recent head ba60891. Consider uploading reports for the commit ba60891 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2249      +/-   ##
==========================================
- Coverage   53.66%   53.65%   -0.01%     
==========================================
  Files          48       48              
  Lines       14200    14218      +18     
==========================================
+ Hits         7620     7629       +9     
- Misses       6342     6348       +6     
- Partials      238      241       +3     
Impacted Files Coverage Δ
pkg/apis/configuration/validation/appprotect.go 76.19% <58.33%> (-23.81%) ⬇️
internal/configs/configurator.go 37.54% <100.00%> (+0.03%) ⬆️
internal/configs/ingress.go 76.59% <100.00%> (-0.05%) ⬇️
internal/configs/virtualserver.go 95.32% <100.00%> (ø)
internal/k8s/configuration.go 95.86% <100.00%> (ø)
...apis/configuration/validation/appprotect_common.go 98.00% <100.00%> (ø)
pkg/apis/configuration/validation/virtualserver.go 96.24% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56a7bfb...ba60891. Read the comment docs.

@nginx-bot nginx-bot force-pushed the ap-depracate-external-refs branch 3 times, most recently from d695fa9 to 24b5853 Compare December 9, 2021 06:09
@nginx-bot nginx-bot force-pushed the ap-depracate-external-refs branch 13 times, most recently from a59f268 to 77a94a2 Compare December 16, 2021 14:25
@AmitShnek
Copy link

@rafwegv ?

@rafwegv
Copy link
Contributor Author

rafwegv commented Dec 22, 2021

Hi @brianehlert i have added a note in the config docs. As I understand that will be then referenced in the release notes.

@soneillf5
Copy link
Contributor

@rafwegv Are there any tests associated with this change? How do we know this works and doesn't break in the future?

@rafwegv
Copy link
Contributor Author

rafwegv commented Jan 5, 2022

@soneillf5 This feature does not touch the kic code, it goes straight to the file on storage without any checks. This PR is only meant to warn the admin that this feature is going to go away in the future.

@brianehlert brianehlert added the nap label Jan 7, 2022
@nginx-bot nginx-bot removed the nap label Jan 7, 2022
@ciarams87 ciarams87 removed the request for review from soneillf5 January 24, 2022 10:18
Copy link
Member

@lucacome lucacome left a comment

Choose a reason for hiding this comment

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

Is this PR still relevant? I couldn't find any reference to the deprecation of external reference in NAP WAF docs. If so I left a comment.

internal/k8s/appprotect/app_protect_resources.go Outdated Show resolved Hide resolved
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Feb 24, 2022
@rafwegv rafwegv force-pushed the ap-depracate-external-refs branch 3 times, most recently from b0f3434 to 2f55ff0 Compare February 25, 2022 14:51
@lucacome lucacome requested a review from ciarams87 March 1, 2022 03:06
@lucacome
Copy link
Member

lucacome commented Mar 1, 2022

@rafwegv I noticed that the are a lot of changes to unrelated files, but it looks like it's about formatting and spaces so I approved it anyway

@lucacome lucacome changed the title AP: Deprecate exteral refs AP: Deprecate external refs Mar 9, 2022
@lucacome lucacome merged commit 3b6b4a9 into master Mar 9, 2022
@lucacome lucacome deleted the ap-depracate-external-refs branch March 9, 2022 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants