Skip to content

update crd descriptions #8038

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Conversation

mohamadaldawamnah
Copy link

@mohamadaldawamnah mohamadaldawamnah commented Jul 17, 2025

Proposed changes

Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to
that issue here in this description (not in the title of the PR).

  • modified types.go with descriptions
  • update crds with description

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

@mohamadaldawamnah mohamadaldawamnah requested a review from a team as a code owner July 17, 2025 09:25
@github-actions github-actions bot added go Pull requests that update Go code chore Pull requests for routine tasks labels Jul 17, 2025
Copy link
Contributor

github-actions bot commented Jul 17, 2025

Package Report

gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx, 1.27.5-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-module-njs, 1.27.5+0.8.10-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-module-otel, 1.27.5+0.1.2-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-agent, 3.0.3~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx, 1.27.5-1~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-module-njs, 1.27.5+0.8.10-1~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-module-otel, 1.27.5+0.1.2-1~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-agent, 3.0.3~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus, 34-2~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-njs, 34+0.8.9-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-otel, 34+0.1.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-fips-check, 34+0.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-agent, 3.0.3~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus, 34-2~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-njs, 34+0.8.9-1~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-otel, 34+0.1.1-1~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-fips-check, 34+0.1-1~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-agent, 3.0.3~bookworm, arm64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus, 34-2~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-njs, 34+0.8.9-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-otel, 34+0.1.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-fips-check, 34+0.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-appprotect, 34+5.442.0-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect, 34+5.442.0-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-attack-signatures, 2025.07.10-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-threat-campaigns, 2025.07.16-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-agent, 2.42.0~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus, 34-2~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-njs, 34+0.8.9-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-otel, 34+0.1.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-fips-check, 34+0.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-appprotect, 34+5.442.0-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-module-plus, 34+5.442.0-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-plugin, 6.16.0-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-agent, 2.42.0~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus, 34-2~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-njs, 34+0.8.9-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-otel, 34+0.1.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-fips-check, 34+0.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-appprotectdos, 34+4.6.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-dos, 34+4.6.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus, 34-2~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-njs, 34+0.8.9-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-otel, 34+0.1.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-fips-check, 34+0.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-appprotect, 34+5.442.0-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect, 34+5.442.0-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-attack-signatures, 2025.07.10-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-threat-campaigns, 2025.07.16-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-plus-module-appprotectdos, 34+4.6.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, app-protect-dos, 34+4.6.1-1~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d, nginx-agent, 2.42.0~bookworm, amd64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx, 1.27.5-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-module-njs, 1.27.5.0.8.10-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-module-otel, 1.27.5.0.1.2-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-agent, 3.0.3, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx, 1.27.5-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-module-njs, 1.27.5.0.8.10-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-module-otel, 1.27.5.0.1.2-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-agent, 3.0.3, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus, 34-r2, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus-module-njs, 34.0.8.9-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus-module-otel, 34.0.1.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus-module-fips-check, 34.0.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-agent, 3.0.3, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus, 34-r2, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus-module-njs, 34.0.8.9-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus-module-otel, 34.0.1.1-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-plus-module-fips-check, 34.0.1-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine, nginx-agent, 3.0.3, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus, 34-r2, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-njs, 34.0.8.9-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-otel, 34.0.1.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-fips-check, 34.0.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-agent, 3.0.3, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus, 34-r2, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-njs, 34.0.8.9-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-otel, 34.0.1.1-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-fips-check, 34.0.1-r1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-agent, 3.0.3, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus, 34-r2, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-njs, 34.0.8.9-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-otel, 34.0.1.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-fips-check, 34.0.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-agent, 2.42.0, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-appprotect, 34.5.442.0-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, app-protect, 34.5.442.0-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, app-protect-attack-signatures, 2025.07.10-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, app-protect-threat-campaigns, 2025.07.16-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus, 34-r2, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-njs, 34.0.8.9-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-otel, 34.0.1.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-fips-check, 34.0.1-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-agent, 2.42.0, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, nginx-plus-module-appprotect, 34.5.442.0-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, app-protect-module-plus, 34.5.442.0-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-alpine-fips, app-protect-plugin, 6.16.0-r1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx, 1.27.5-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-module-njs, 1.27.5+0.9.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-module-otel, 1.27.5+0.1.2-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-agent, 3.0.3-1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx, 1.27.5-1.el9.ngx, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-module-njs, 1.27.5+0.9.0-1.el9.ngx, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-module-otel, 1.27.5+0.1.2-1.el9.ngx, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-agent, 3.0.3-1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus, 34-2.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-njs, 34+0.8.9-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-otel, 34+0.1.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-fips-check, 34+0.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-agent, 3.0.3-1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus, 34-2.el9.ngx, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-njs, 34+0.8.9-1.el9.ngx, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-otel, 34+0.1.1-1.el9.ngx, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-fips-check, 34+0.1-1.el9.ngx, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-agent, 3.0.3-1, aarch64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus, 34-2.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-njs, 34+0.8.9-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-otel, 34+0.1.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-fips-check, 34+0.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-agent, 2.42.0-1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-appprotect, 34+5.442.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect, 34+5.442.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-attack-signatures, 2025.07.10-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-threat-campaigns, 2025.07.16-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus, 34-2.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-njs, 34+0.8.9-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-otel, 34+0.1.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-fips-check, 34+0.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-agent, 2.42.0-1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-appprotect, 34+5.442.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-module-plus, 34+5.442.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-plugin, 6.16.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus, 34-2.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-njs, 34+0.8.9-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-otel, 34+0.1.1-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-fips-check, 34+0.1-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-agent, 2.42.0-1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-appprotect, 34+5.442.0-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, app-protect, 34+5.442.0-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, app-protect-attack-signatures, 2025.07.10-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, app-protect-threat-campaigns, 2025.07.16-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus, 34-2.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-njs, 34+0.8.9-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-otel, 34+0.1.1-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-fips-check, 34+0.1-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-agent, 2.42.0-1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, nginx-plus-module-appprotect, 34+5.442.0-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, app-protect-module-plus, 34+5.442.0-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-nap-v5/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi8, app-protect-plugin, 6.16.0-1.el8.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus, 34-2.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-njs, 34+0.8.9-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-otel, 34+0.1.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-fips-check, 34+0.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-appprotectdos, 34+4.6.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-dos, 34+4.6.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus, 34-2.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-njs, 34+0.8.9-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-otel, 34+0.1.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-fips-check, 34+0.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-appprotect, 34+5.442.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-plus-module-appprotectdos, 34+4.6.1-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, nginx-agent, 2.42.0-1, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect, 34+5.442.0-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-attack-signatures, 2025.07.10-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-threat-campaigns, 2025.07.16-1.el9.ngx, x86_64
gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/dev/nginx-ic-dos-nap/nginx-plus-ingress:t-1add5a2eddc9c4ad9faa16752329028d-ubi, app-protect-dos, 34+4.6.1-1.el9.ngx, x86_64

@mohamadaldawamnah
Copy link
Author

I have hereby read the F5 CLA and agree to its terms

Copy link

codecov bot commented Jul 17, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 52.93%. Comparing base (74fb6af) to head (8fa48a4).

Files with missing lines Patch % Lines
cmd/nginx-ingress/main.go 50.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8038      +/-   ##
==========================================
- Coverage   52.96%   52.93%   -0.03%     
==========================================
  Files          90       90              
  Lines       21729    21729              
==========================================
- Hits        11508    11502       -6     
- Misses       9744     9748       +4     
- Partials      477      479       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mohamadaldawamnah
Copy link
Author

I have hereby read the F5 CLA and agree to its terms

@vepatel vepatel linked an issue Jul 17, 2025 that may be closed by this pull request
5 tasks
@vepatel vepatel changed the title Chore/update crd description update crd descriptions Jul 18, 2025
Copy link
Collaborator

Choose a reason for hiding this comment

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

It's unclear how these changes are related to the intent of the PR

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's unclear how these changes are related to the intent of the PR

ExternalDNS ExternalDNS `json:"externalDNS"`
// Specifies which Ingress Controller must handle the VirtualServerRoute resource. Must be the same as the ingressClassName of the VirtualServer that references this resource.
IngressClass string `json:"ingressClassName"`
// The host (domain name) of the server. Must be a valid subdomain as defined in RFC 1123, such as my-app or hello.example.com. When using a wildcard domain like *.example.com the domain must be contained in double quotes. The host value needs to be unique among all Ingress and VirtualServer resources. See also Handling Host and Listener Collisions.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What does See also Handling Host and Listener Collisions. refer to?

// InternalRoute allows for the configuration of internal routing.
InternalRoute bool `json:"internalRoute"`
}

// VirtualServerListener references a custom http and/or https listener defined in GlobalConfiguration.
type VirtualServerListener struct {
HTTP string `json:"http"`
// The name of am HTTP listener defined in a GlobalConfiguration resource.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
// The name of am HTTP listener defined in a GlobalConfiguration resource.
// The name of an HTTP listener defined in a GlobalConfiguration resource.

RecordTTL int64 `json:"recordTTL,omitempty"`
// Labels stores labels defined for the Endpoint
// +optional
Copy link
Collaborator

Choose a reason for hiding this comment

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

removing the optional flag changes the behaviour of the field

ResponseHeaders *ProxyResponseHeaders `json:"responseHeaders"`
}

// ProxyRequestHeaders defines the request headers manipulation in an ActionProxy.
type ProxyRequestHeaders struct {
Pass *bool `json:"pass"`
Set []Header `json:"set"`
// Passes the original request headers to the proxied upstream server. See the proxy_pass_request_header directive for more information. Default is true.
Copy link
Collaborator

Choose a reason for hiding this comment

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

See the proxy_pass_request_header directive for more information

This appears to be referring to an NGINX directive.

// The port on which the listener will accept connections.
Port int `json:"port"`
// Custom SNI processing for listener. Allows listener to be used as a passthrough for SNI processing
PassSNI bool `json:"passSNI"`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this a new field?

Port int `json:"port"`
// Custom SNI processing for listener. Allows listener to be used as a passthrough for SNI processing
PassSNI bool `json:"passSNI"`
// ipv4 and ipv6 addresses that NGINX will listen on. Defaults to listening on all available IPv4 and IPv6 addresses.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does the IPv4 field also handle IPv6 addresses?

Rate string `json:"rate"`
// The key to which the rate limit is applied. Can contain text, variables, or a combination of them.
// Variables must be surrounded by ${}. For example: ${binary_remote_addr}. Accepted variables are
// $binary_remote_addr,$request_uri,$request_method,$url,$http_, $args,$arg_,$cookie_,$jwt_claim_.
Copy link
Collaborator

Choose a reason for hiding this comment

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

spaces after comma's

Secret string `json:"secret"`
}

// IngressMTLS defines an Ingress MTLS policy.
// The IngressMTLS policy configures client certificate verification.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Putting The in-front of the Type comment will affect linting?

@@ -135,24 +135,37 @@ spec:
metadata:
type: object
spec:
description: GlobalConfigurationSpec is the spec of the GlobalConfiguration
resource.
description: spec field of the GlobalConfiguration resource
Copy link
Contributor

Choose a reason for hiding this comment

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

In my opinion, the description of this should be more similar to what we have in docs instead X field of Y.

These descriptions are to tell the reader what exactly this does, rather than what it is.

properties:
listeners:
description: Listeners field of the GlobalConfigurationSpec resource
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above but docs here

PolicySpec is the spec of the Policy resource.
The spec includes multiple fields, where each field represents a different policy.
Only one policy (field) is allowed.
description: spec field of the Policy resource
Copy link
Contributor

Choose a reason for hiding this comment

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

Older description was better, this is too generic

Suggested change
description: spec field of the Policy resource
description: |-
PolicySpec is the spec of the Policy resource.
The spec includes multiple fields, where each field represents a different policy.
Only one policy (field) is allowed.

properties:
accessControl:
description: AccessControl defines an access policy based on the source
IP of a request.
description: The access control policy based on the client IP address.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here

Suggested change
description: The access control policy based on the client IP address.
description: AccessControl defines an access policy based on the source
IP of a request.

type: string
token:
description: 'The token specifies a variable that contains the
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a reason ths has ' ' around the description?

Spec GlobalConfigurationSpec `json:"spec"`
}

// GlobalConfigurationSpec is the spec of the GlobalConfiguration resource.
type GlobalConfigurationSpec struct {
// Listeners field of the GlobalConfigurationSpec resource
Copy link
Contributor

Choose a reason for hiding this comment

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

not needed

@@ -423,6 +579,7 @@ type Listener struct {
type GlobalConfigurationList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
// Items field of the GlobalConfigurationList resource
Copy link
Contributor

Choose a reason for hiding this comment

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

??

@@ -441,23 +598,34 @@ type GlobalConfigurationList struct {
type TransportServer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec TransportServerSpec `json:"spec"`
// spec field of the TransportServer resource
Copy link
Contributor

Choose a reason for hiding this comment

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

not needed

@@ -537,7 +737,7 @@ type TransportServerStatus struct {
type TransportServerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`

// Items field of the TransportServerList resource
Copy link
Contributor

Choose a reason for hiding this comment

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

not needed

@@ -554,32 +754,46 @@ type TransportServerList struct {
type Policy struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec PolicySpec `json:"spec"`
// spec field of the Policy resource
Copy link
Contributor

Choose a reason for hiding this comment

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

not needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks go Pull requests that update Go code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update custom resource definition yaml descriptions
4 participants