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 one FAQ - describes ztunnel is not a SPOF. #15306

Merged
merged 13 commits into from
Jun 25, 2024

Conversation

ayushrakesh
Copy link
Contributor

Description

Clears misconception that ztunnel is not a Single Point of Failure.

Fixes #15246

Reviewers

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

ayushrakesh and others added 5 commits June 19, 2024 11:55
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
@ayushrakesh ayushrakesh requested a review from a team as a code owner June 19, 2024 08:05
@istio-testing istio-testing added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test labels Jun 19, 2024
@istio-testing
Copy link
Contributor

Hi @ayushrakesh. Thanks for your PR.

I'm waiting for a istio 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. Regular contributors should join the org to skip this step.

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.

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.

@kfaseela
Copy link
Member

if this PR again fails lint check, please do not close the PR, rather revise it with the fix

@kfaseela
Copy link
Member

/ok-to-test

@istio-testing istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Jun 19, 2024
weight: 25
---

This misunderstanding arises primarily from concerns about the Ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages.
Copy link
Member

Choose a reason for hiding this comment

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

the link to the blog and other details seem to be removed? why?

Copy link
Contributor Author

@ayushrakesh ayushrakesh Jun 19, 2024

Choose a reason for hiding this comment

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

First of all link should be of relative path. That's what confusing me little bit, that should I keep or remove it. I just removed it because the description seems enough to me. Should I revise it.

weight: 25
---

This misunderstanding arises primarily from concerns about the Ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages.
Copy link
Member

@kfaseela kfaseela Jun 19, 2024

Choose a reason for hiding this comment

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

Suggested change
This misunderstanding arises primarily from concerns about the Ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages.
Istio's ztunnel does not introduce a SPOF into a Kubernetes cluster. Ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).

Copy link
Contributor

Choose a reason for hiding this comment

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

check the style guide as to if we have ztunnel or Ztunnel, and if there isn't a style guide, we should write one

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@craigbox @kfaseela PR revised.

@craigbox
Copy link
Contributor

For fast review of a docs PR, please include the link to the changed page in the Netlify deployment preview.

@craigbox
Copy link
Contributor

Please also note that this doesn't address #15246 at all, which is entitled "Add ambient mode section to FAQ"

weight: 25
---

Istio's ztunnel does not introduce a SPOF into a Kubernetes cluster. These ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).
Copy link
Contributor

Choose a reason for hiding this comment

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

These ztunnel failures

Which ztunnel failures?

considered a fallible component in a cluster

[[citation needed]]

ayushrakesh and others added 3 commits June 19, 2024 16:38
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
Copy link
Member

@dhawton dhawton left a comment

Choose a reason for hiding this comment

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

For clarity, try to define acronyms on their first use, especially ones that are not common.

@@ -0,0 +1,6 @@
---
title: Is ztunnel a SPOF?
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
title: Is ztunnel a SPOF?
title: Is ztunnel a single point of failure?

weight: 25
---

Istio's ztunnel does not introduce a SPOF into a Kubernetes cluster. ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).
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
Istio's ztunnel does not introduce a SPOF into a Kubernetes cluster. ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).
Istio's ztunnel does not introduce a single point of failure (SPOF) into a Kubernetes cluster. ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).

Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
weight: 25
---

Istio's ztunnel does not introduce a single point of failure (SPOF) into a Kubernetes cluster. ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure if "ztunnel" at the beginning of a line should be "Ztunnel" or not :) Leaving this to @craigbox for merging

@craigbox
Copy link
Contributor

craigbox commented Jun 20, 2024 via email

@ayushrakesh
Copy link
Contributor Author

Perhaps our new contributor could look at style guides for other projects/companies as an example?

On Fri, 21 Jun 2024 at 08:14, Faseela K @.> wrote: @.* commented on this pull request. ------------------------------ In content/en/about/faq/ambient-mode/is-ztunnel-a-SPOF.md <#15306 (comment)>: > @@ -0,0 +1,6 @@ +--- +title: Is ztunnel a single point of failure? +weight: 25 +--- + +Istio's ztunnel does not introduce a single point of failure (SPOF) into a Kubernetes cluster. ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. Learn more. I am not sure if "ztunnel" at the beginning of a line should be "Ztunnel" or not :) Leaving this to @craigbox https://github.com/craigbox for merging — Reply to this email directly, view it on GitHub <#15306 (review)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABALHQNF3DZVKBINBNXGV3ZIMZ3JAVCNFSM6AAAAABJRQWERCVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDCMZRGI3TENRYGA . You are receiving this because you were mentioned.Message ID: <istio/istio .@.***>

Yeah, will check.

@ayushrakesh
Copy link
Contributor Author

@craigbox
Copy link
Contributor

craigbox commented Jun 21, 2024 via email

@ayushrakesh
Copy link
Contributor Author

@craigbox https://developers.google.com/style/product-names#capitalize shows that if a product's name officially starts from lowercase letter then it must be taken care everywhere in beginning of a line.

I will suggest change phrase slightly like this -
"Failures of ztunnel are confined to..."

weight: 25
---

Istio's ztunnel does not introduce a single point of failure (SPOF) into a Kubernetes cluster. ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).
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
Istio's ztunnel does not introduce a single point of failure (SPOF) into a Kubernetes cluster. ztunnel failures are scoped to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).
Istio's ztunnel does not introduce a single point of failure (SPOF) into a Kubernetes cluster. Failures of ztunnel are confined to a single node, which is considered a fallible component in a cluster. It behaves the same as other node-critical infrastructure running on every cluster such as the Linux kernel, container runtime, etc. In a properly designed system, node outages do not lead to cluster outages. [Learn more](https://blog.howardjohn.info/posts/ambient-spof/).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kfaseela @craigbox PR is revised now.

ayushrakesh and others added 2 commits June 25, 2024 18:17
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
@istio-testing istio-testing merged commit 5224754 into istio:master Jun 25, 2024
6 checks passed
@craigbox
Copy link
Contributor

Please see error introduced by this PR in #15331.

@ayushrakesh
Copy link
Contributor Author

ayushrakesh commented Jun 26, 2024

@craigbox I have made a new PR which fixes this error, please check this #15337. Actually I didn't included index.md file which is responsible for section title.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ambient mode section to FAQ
5 participants