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 AppProtectVersion to Telemetry #5554

Merged
merged 8 commits into from
May 16, 2024
Merged

Conversation

AlexFenlon
Copy link
Contributor

@AlexFenlon AlexFenlon commented May 15, 2024

Proposed changes

This collects the AppProtect Version located in the /opt/app_protect/RELEASE file and adds it to telemetry as shown below.

snippet of the log for when AppProtect is enabled:
IngressAnnotations:[appprotect.f5.com/app-protect-security-log-enable appprotect.f5.com/app-protect-enable appprotect.f5.com/app-protect-policy appprotect.f5.com/app-protect-security-log appprotect.f5.com/app-protect-security-log-destination] AppProtectVersion:4.8.1}}

kubectl describe pods my-release-nginx-ingress-controller-79c4fcbd8f-hnfqh
Name:             my-release-nginx-ingress-controller-79c4fcbd8f-hnfqh
Namespace:        default
Priority:         0
Service Account:  my-release-nginx-ingress
Node:             minikube/192.168.49.2
Start Time:       Wed, 15 May 2024 16:14:02 +0100
Labels:           app.kubernetes.io/instance=my-release
                  app.kubernetes.io/name=nginx-ingress
                  app.kubernetes.io/version=3.6.0-SNAPSHOT
                  app.nginx.org/version=1.25.3-nginx-plus-r31-p1
                  appprotect.f5.com/version=4.8.1
                  pod-template-hash=79c4fcbd8f

snippet of the log for when AppProtect is not enabled:
IngressAnnotations:[] AppProtectVersion:}}

Resolves: #5417

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 main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@AlexFenlon AlexFenlon requested review from a team as code owners May 15, 2024 14:19
@github-actions github-actions bot added enhancement Pull requests for new features/feature enhancements documentation Pull requests/issues for documentation go Pull requests that update Go code labels May 15, 2024
@vepatel
Copy link
Contributor

vepatel commented May 15, 2024

@AlexFenlon Can you please also add the pod labels in the output and the annotation above is from AppProtect DoS not AppProtect WAF, those ones look like appprotect.f5.com/app-protect-enable: "True"
eg:

> k describe pod
Name:             test-release-nginx-ingress-controller-xxxxx
Namespace:        default
Priority:         0
Service Account:  test-release-nginx-ingress
Node:             venktesh-test-default-pool-d644f3ac
Start Time:       Wed, 15 May 2024 14:30:02 +0100
Labels:           app.kubernetes.io/instance=test-release
                  app.kubernetes.io/name=nginx-ingress
                  app.kubernetes.io/version=3.6.0
                  app.nginx.org/version=1.26.0
                  pod-template-hash=8677c6b859

Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

LGTM docs-wise bar one minimal correction.

docs/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
AlexFenlon and others added 2 commits May 16, 2024 13:29
Co-authored-by: Alan Dooley <a.dooley@f5.com>
Signed-off-by: AlexFenlon <a.fenlon@f5.com>
@AlexFenlon AlexFenlon merged commit 95e7c2d into main May 16, 2024
78 checks passed
@AlexFenlon AlexFenlon deleted the feat/telemetry-app-protect-version branch May 16, 2024 13:50
ssrahul96 pushed a commit to ssrahul96/kubernetes-ingress that referenced this pull request Jun 20, 2024
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 enhancement Pull requests for new features/feature enhancements go Pull requests that update Go code
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Collect version of App protect
3 participants