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

docs/WAF: failure zones refresh #21545

Merged
merged 12 commits into from
Jul 22, 2024
Merged

docs/WAF: failure zones refresh #21545

merged 12 commits into from
Jul 22, 2024

Conversation

krastin
Copy link
Contributor

@krastin krastin commented Jul 15, 2024

Description

Incorporating some WAF content into the related Consul doc.

Testing & Reproduction steps

N/A

Links

N/A

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@krastin krastin requested a review from a team as a code owner July 15, 2024 14:35
@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Jul 15, 2024
@krastin krastin added pr/no-changelog PR does not need a corresponding .changelog entry backport/all Apply backports for all active releases per .release/versions.hcl labels Jul 15, 2024
Copy link
Contributor

@aimeeu aimeeu left a comment

Choose a reason for hiding this comment

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

nits, and some structure suggestions

Copy link
Contributor

@danielehc danielehc left a comment

Choose a reason for hiding this comment

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

Thank for revamping this.

Left a few comments.

The only thing I would add for some of these sections would be an architectural diagram that explains the desired architecture.

i.e.

This would make it easier to follow the failure cases listed as examples

Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>
@krastin krastin changed the title failure zones initial commit docs/WAF: failure zones refresh Jul 17, 2024
Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

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

Style changes and simplifications.

Before merging, we still need:

  1. Dark mode images
  2. Links to tutorials like the redundancy zones tutorial, because they demonstrate these concepts with a practical example.


Cluster peering lets you connect two or more independent Consul clusters using mesh gateways, so that services can communicate between non-identical partitions in different datacenters.

![Reference architecture diagram for Consul cluster peering](/img/architecture/cluster-peering-diagram.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Dark mode required

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.16,1.18] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

16 similar comments
@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

boruszak added a commit that referenced this pull request Aug 23, 2024
* failure zones initial commit

* Apply suggestions from code review

Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>

* Update improving-consul-resilience.mdx

Co-authored-by: Aimee Ukasick <[email protected]>

* typo

* adding diagrams

* fixing inline bulletpoint image

* adding light and dark diagrams

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <[email protected]>

* fix links in article

* fix inline alert render

---------

Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>
Co-authored-by: Jeff Boruszak <[email protected]>
boruszak added a commit that referenced this pull request Aug 23, 2024
* failure zones initial commit

* Apply suggestions from code review

Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>

* Update improving-consul-resilience.mdx

Co-authored-by: Aimee Ukasick <[email protected]>

* typo

* adding diagrams

* fixing inline bulletpoint image

* adding light and dark diagrams

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <[email protected]>

* fix links in article

* fix inline alert render

---------

Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>
Co-authored-by: Jeff Boruszak <[email protected]>
boruszak added a commit that referenced this pull request Aug 23, 2024
* failure zones initial commit

* Apply suggestions from code review

Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>

* Update improving-consul-resilience.mdx

Co-authored-by: Aimee Ukasick <[email protected]>

* typo

* adding diagrams

* fixing inline bulletpoint image

* adding light and dark diagrams

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <[email protected]>

* fix links in article

* fix inline alert render

---------

Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>
Co-authored-by: Jeff Boruszak <[email protected]>
@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

2 similar comments
@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

boruszak added a commit that referenced this pull request Aug 26, 2024
docs/WAF: failure zones refresh (#21545)

* failure zones initial commit

* Apply suggestions from code review




* Update improving-consul-resilience.mdx



* typo

* adding diagrams

* fixing inline bulletpoint image

* adding light and dark diagrams

* Apply suggestions from code review



* fix links in article

* fix inline alert render

---------

Co-authored-by: Krastin Krastev <[email protected]>
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>
boruszak added a commit that referenced this pull request Aug 26, 2024
* failure zones initial commit

* Apply suggestions from code review




* Update improving-consul-resilience.mdx



* typo

* adding diagrams

* fixing inline bulletpoint image

* adding light and dark diagrams

* Apply suggestions from code review



* fix links in article

* fix inline alert render

---------

Co-authored-by: Krastin Krastev <[email protected]>
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>
boruszak added a commit that referenced this pull request Aug 26, 2024
docs/WAF: failure zones refresh (#21545)

* failure zones initial commit

* Apply suggestions from code review




* Update improving-consul-resilience.mdx



* typo

* adding diagrams

* fixing inline bulletpoint image

* adding light and dark diagrams

* Apply suggestions from code review



* fix links in article

* fix inline alert render

---------

Co-authored-by: Krastin Krastev <[email protected]>
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: danielehc <[email protected]>
@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

1 similar comment
@hc-github-team-consul-core
Copy link
Collaborator

@krastin, a backport is missing for this PR [21545] for versions [1.15,1.17,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/all Apply backports for all active releases per .release/versions.hcl backport/ent/1.15 Changes are backported to 1.15 ent backport/ent/1.17 Changes are backported to 1.17 ent backport/ent/1.18 Changes are backported to 1.18 ent backport/1.19 Changes are backported to 1.19 pr/no-changelog PR does not need a corresponding .changelog entry pr/no-metrics-test type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants