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.

Sign up for GitHub

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

Jump to bottom

Docs: Add note about --watch-namespace. #11947

Merged
merged 1 commit into from
Sep 8, 2024
Merged

Docs: Add note about --watch-namespace. #11947

merged 1 commit into from
Sep 8, 2024

Conversation

longwuyuan
Copy link
Contributor

What this PR does / why we need it:

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

fixes #9196

How Has This Been Tested?

  • Its a docs PR so no test needed
  • The behavior is already documented

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

/area docs
/kind documentation
/triage accepted

cc @Gacko @strongjz

@k8s-ci-robot k8s-ci-robot added area/docs kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 8, 2024
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. needs-priority size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 8, 2024
@netlify Netlify
Copy link

netlify bot commented Sep 8, 2024 •
edited
Loading

✅ Deploy Preview for kubernetes-ingress-nginx ready!

Name Link
🔨 Latest commit c090fa1
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/66dd324ecd621200088355dd
😎 Deploy Preview https://deploy-preview-11947--kubernetes-ingress-nginx.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.

Gacko
Gacko reviewed Sep 8, 2024
View reviewed changes
Copy link
Member

@Gacko Gacko left a comment

Choose a reason for hiding this comment

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

/retitle Docs: Add note about --watch-namespace.
/triage accepted
/kind documentation
/priority backlog
/lgtm

docs/deploy/index.md Outdated
@@ -428,7 +427,7 @@ kubectl exec $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --version

By default, the controller watches Ingress objects from all namespaces. If you want to change this behavior,
use the flag `--watch-namespace` or check the Helm chart value `controller.scope` to limit the controller to a single
namespace.
namespace. Although the use of this flag is not popular and also not encouraged so much, one important fact to note is that the secret containing the default-ssl-certificate needs to also be present in the watched namespace(s).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
namespace. Although the use of this flag is not popular and also not encouraged so much, one important fact to note is that the secret containing the default-ssl-certificate needs to also be present in the watched namespace(s).
namespace. Although the use of this flag is not popular, one important fact to note is that the secret containing the default-ssl-certificate needs to also be present in the watched namespace(s).

I'd not tell that. In the end this flag might make your deployment more secure.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed as sugested

@k8s-ci-robot k8s-ci-robot changed the title added watched-ns flag related note Docs: Add note about --watch-namespace. Sep 8, 2024
@k8s-ci-robot k8s-ci-robot added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-priority labels Sep 8, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 8, 2024
@Gacko
Copy link
Member

Gacko commented Sep 8, 2024

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 8, 2024
@Gacko
Copy link
Member

Gacko commented Sep 8, 2024

/cherry-pick release-1.10

@Gacko
Copy link
Member

Gacko commented Sep 8, 2024

/cherry-pick release-1.11

@k8s-infra-cherrypick-robot
Copy link
Contributor

@Gacko: once the present PR merges, I will cherry-pick it on top of release-1.10 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.10

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-infra-cherrypick-robot
Copy link
Contributor

@Gacko: once the present PR merges, I will cherry-pick it on top of release-1.11 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.11

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 removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 8, 2024
@Gacko
Copy link
Member

Gacko commented Sep 8, 2024

/unhold
/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Sep 8, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Gacko, longwuyuan

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

The pull request process is described here

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 merged commit 0b98b17 into kubernetes:main Sep 8, 2024
7 checks passed
@k8s-infra-cherrypick-robot
Copy link
Contributor

@Gacko: new pull request created: #11948

In response to this:

/cherry-pick release-1.10

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-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Sep 8, 2024
Merged
@k8s-infra-cherrypick-robot
Copy link
Contributor

@Gacko: new pull request created: #11949

In response to this:

/cherry-pick release-1.11

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-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Sep 8, 2024
Merged
@longwuyuan longwuyuan deleted the docs-fix-9196 branch September 9, 2024 06:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Gacko Gacko Gacko left review comments

@tao12345666333 tao12345666333 Awaiting requested review from tao12345666333

Assignees

@Gacko Gacko

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/backlog Higher priority than priority/awaiting-more-evidence. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Using default-tls-certificate & watch-namespace does not work if secret is not in watched namespace
4 participants
@longwuyuan @Gacko @k8s-infra-cherrypick-robot @k8s-ci-robot