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

add dry-run annotation #1933

Merged
merged 1 commit into from
Mar 31, 2021
Merged

add dry-run annotation #1933

merged 1 commit into from
Mar 31, 2021

Conversation

yangminzhu
Copy link
Contributor

@yangminzhu yangminzhu commented Mar 31, 2021

Allows customers to dry-run an authorization policy to test the effect using real traffic without enforcing the policy, reducing the risk of creating or changing the authorization policy.

Only supports AuthorizationPolicy for now, the admission controller will reject other resources with the dry-run annotation.

Design doc: https://docs.google.com/document/d/1xQdZsEgJ3Ld2qebfT3EJkg2COTtCR1TqBVojmnvI78g (approved by Security WG)

@google-cla google-cla bot added the cla: yes Set by the Google CLA bot to indicate the author of a PR has signed the Google CLA. label Mar 31, 2021
@istio-testing istio-testing added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 31, 2021
@@ -392,3 +392,11 @@ annotations:
hidden: false
resources:
- Pod

- name: istio.io/dry-run
featureStatus: Alpha
Copy link
Contributor Author

@yangminzhu yangminzhu Mar 31, 2021

Choose a reason for hiding this comment

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

Note: I wanted to set the featureStatus to experimental but the tool currently only supports alpha, beta and stable. I will look into the tool later to add the support and update the PR when exposing this in the doc (currently this is hidden).

@yangminzhu
Copy link
Contributor Author

@istio/technical-oversight-committee Hi, could anyone from TOC take a quick look at this, the design is already approved by security WG, the implementation is blocked on this and I'm trying to get this into the 1.10 release (code cut in 1 week).

Copy link
Contributor

@smawson smawson left a comment

Choose a reason for hiding this comment

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

I'm comfortable adding this annotation, it seems similar in spirit to some of our other annotations/labels that are meta-controls and don't really make sense as fields (for example istio.io/rev).

@howardjohn howardjohn added the release-notes-none Indicates a PR that does not require release notes. label Mar 31, 2021
@howardjohn
Copy link
Member

/retest

@istio-testing istio-testing merged commit e3f75bd into istio:master Mar 31, 2021
@yangminzhu yangminzhu deleted the dry-run branch March 31, 2021 23:23
@nrjpoddar
Copy link
Member

@yangminzhu since this annotation can be used in other resources in future. Can we describe what the annotation does for AuthZ policy. Where and how do the users see the policy dry-run output?

@yangminzhu
Copy link
Contributor Author

@yangminzhu since this annotation can be used in other resources in future. Can we describe what the annotation does for AuthZ policy. Where and how do the users see the policy dry-run output?

yes, we will add documentation on istio.io for using the annotation. The output can be found in Envoy (log), Prometheus (metric) and Jaeger (tracking).

@nrjpoddar
Copy link
Member

That’s great. Thanks!

zhlsunshine pushed a commit to zhlistio/api that referenced this pull request Jul 8, 2021
zhlsunshine pushed a commit to zhlistio/api that referenced this pull request Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Set by the Google CLA bot to indicate the author of a PR has signed the Google CLA. release-notes-none Indicates a PR that does not require release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants