Skip to content

docs: add comprehensive firewall rules documentation#1660

Open
barbacbd wants to merge 1 commit into
kubernetes-sigs:mainfrom
barbacbd:firewall-docs
Open

docs: add comprehensive firewall rules documentation#1660
barbacbd wants to merge 1 commit into
kubernetes-sigs:mainfrom
barbacbd:firewall-docs

Conversation

@barbacbd

@barbacbd barbacbd commented May 7, 2026

Copy link
Copy Markdown
Contributor

Add detailed documentation for the firewall API feature that allows users to configure GCP VPC firewall rules through the GCPCluster resource.

The documentation covers:

  • Default firewall rule management (Managed/Unmanaged policies)
  • Custom firewall rule configuration with complete field reference
  • Support for ALLOW/DENY rules, Ingress/Egress directions
  • Five practical examples including SSH, web traffic, and multi-protocol rules
  • Best practices, limitations, and troubleshooting guidance

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Add docs for the Firewall API changes.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

TODOs:

  • squashed commits
  • includes documentation
  • adds unit tests

Release note:

Add detailed documentation for the firewall API feature that allows users to configure GCP VPC firewall rules through the GCPCluster resource.

Add detailed documentation for the firewall API feature that allows users
to configure GCP VPC firewall rules through the GCPCluster resource.

The documentation covers:
- Default firewall rule management (Managed/Unmanaged policies)
- Custom firewall rule configuration with complete field reference
- Support for ALLOW/DENY rules, Ingress/Egress directions
- Five practical examples including SSH, web traffic, and multi-protocol rules
- Best practices, limitations, and troubleshooting guidance

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. labels May 7, 2026
@netlify

netlify Bot commented May 7, 2026

Copy link
Copy Markdown

Deploy Preview for kubernetes-sigs-cluster-api-gcp ready!

Name Link
🔨 Latest commit 321d6aa
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sigs-cluster-api-gcp/deploys/69fceece0a0b170008e61c83
😎 Deploy Preview https://deploy-preview-1660--kubernetes-sigs-cluster-api-gcp.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 project configuration.

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: barbacbd
Once this PR has been reviewed and has the lgtm label, please assign salasberryfin for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested review from cpanato and dims May 7, 2026 19:58
@linux-foundation-easycla

Copy link
Copy Markdown

CLA Missing ID CLA Not Signed

  • ✅ login: barbacbd / name: barbacbd (321d6aa)
  • ❌ The email address for the commit (321d6aa) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please visit our EasyCLA portal and chat with our support bot.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

  1. Anything <id+login@users.noreply.github.com> - it will locate your GitHub user by id part.
  2. Anything <login@users.noreply.github.com> - it will locate your GitHub user by login part.
  3. Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
  4. Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
  5. login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Alternatively, if the co-author should not be included, remove the Co-authored-by: line from the commit message.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 7, 2026
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

Hi @barbacbd. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 7, 2026
@barbacbd

barbacbd commented May 7, 2026

Copy link
Copy Markdown
Contributor Author

/cc @salasberryfin

@k8s-ci-robot k8s-ci-robot requested a review from salasberryfin May 7, 2026 19:58
@barbacbd

barbacbd commented May 7, 2026

Copy link
Copy Markdown
Contributor Author

/retest-required

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@barbacbd: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest-required

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants