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

Rename NotifyKiller to Enforcer in docs #2518

Merged
merged 1 commit into from
Jun 7, 2024
Merged

Rename NotifyKiller to Enforcer in docs #2518

merged 1 commit into from
Jun 7, 2024

Conversation

shidoxo
Copy link
Contributor

@shidoxo shidoxo commented Jun 5, 2024

Changed all occurrences of "killer" to enforcer in selectors.md

Fixes: #2517

Signed-off-by: michalzarsm <michalzarsm@gmail.com>
@shidoxo shidoxo requested review from mtardy and a team as code owners June 5, 2024 17:58
Copy link

netlify bot commented Jun 5, 2024

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit fcbffee
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/6660a73e90d262000806283c
😎 Deploy Preview https://deploy-preview-2518--tetragon.netlify.app
📱 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.

@mtardy mtardy added area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation. labels Jun 5, 2024
Copy link
Contributor

@kkourt kkourt left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

Thanks for this page of the doc I think it's good!

I'll note there are still some references globally in docs that could be changed and could be added in the issue: it's mostly docs in the tracing_policy_types.go and .proto that gets propagated through generation.

rg -g '!.git' -g '!vendor' -i killer

You get an output similar to this:

pkg/api/tracingapi/client_kprobe.go
27:     ActionNotifyKiller = 12

install/kubernetes/tetragon/crds-yaml/cilium.io_tracingpolicies.yaml
95:                description: A killer spec.

install/kubernetes/tetragon/crds-yaml/cilium.io_tracingpoliciesnamespaced.yaml
95:                description: A killer spec.

patch
40:+        # for killer tests on 32 bits syscall values

docs/content/en/docs/reference/grpc-api.md
677:| KPROBE_ACTION_NOTIFYENFORCER | 13 | NotifyEnforcer action notifies killer sensor. |

pkg/k8s/apis/cilium.io/client/crds/v1alpha1/cilium.io_tracingpolicies.yaml
95:                description: A killer spec.

pkg/k8s/apis/cilium.io/client/crds/v1alpha1/cilium.io_tracingpoliciesnamespaced.yaml
95:                description: A killer spec.

contrib/upgrade-notes/v1.1.0.md
15:* Killer is renamed to enforcer. If using policies with killers, you need to replace `killers` with `enforcers` and `action: NotifyKiller` with `action: NotifyEnforcer`.

pkg/k8s/apis/cilium.io/v1alpha1/tracing_policy_types.go
105:    // A killer spec.

bpf/process/types/basic.h
110:    ACTION_NOTIFY_KILLER = 12,
2217:   case ACTION_NOTIFY_KILLER:

pkg/grpc/tracing/tracing.go
63:     case tracingapi.ActionNotifyKiller:

api/v1/tetragon/tetragon.pb.go
58:     // NotifyEnforcer action notifies killer sensor.

api/v1/tetragon/tetragon.proto
464:    // NotifyEnforcer action notifies killer sensor.

api/v1/README.md
1114:| KPROBE_ACTION_NOTIFYENFORCER | 13 | NotifyEnforcer action notifies killer sensor. |

@mtardy mtardy merged commit 70ed792 into cilium:main Jun 7, 2024
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update docs to use NotifyEnforcer
4 participants