CE-657 - Move Application leader election tutorial to docs #21366

danielehc · 2024-06-25T09:26:06Z

Description

Preview: https://consul-git-ce-657-hashicorp.vercel.app/consul/docs/dynamic-app-config/sessions

Testing & Reproduction steps

Links

PR Checklist

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

aimeeu

style guide nits

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx

aimeeu · 2024-07-08T21:06:57Z

website/content/docs/dynamic-app-config/sessions/index.mdx

 The primitives provided by sessions and the locking mechanisms of the KV
 store can be used to build client-side leader election algorithms.


Suggested change

The primitives provided by sessions and the locking mechanisms of the KV

store can be used to build client-side leader election algorithms.

You can use the primitives provided by sessions and the locking mechanisms of the KV

store to build client-side leader election algorithms.

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

boruszak

Excellent work! This doc is looking good.

I left an initial round of suggestions. After you implement them, ask Aimee to give her review.

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx

boruszak · 2024-08-06T23:12:38Z

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx

+<Note>
+
+This locking system is purely advisory. There is no enforcement that clients must acquire a lock to perform any operation. Any client can read, write, and delete a key without owning the corresponding lock. It is not the goal of Consul to protect against misbehaving clients.
+
+</Note>


Odd placement for this note

I thought that, after learning how to perform the lock it was useful to get a remark that the process is different from an actual lock that would prevent other operations to be performed. Do you have suggestions over which position would fit better?

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx

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

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx

boruszak

Final suggestions and style issues that I noticed.

Looks excellent. Merge when ready!

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx

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

* First commit * Fix navigation * Add some commands * Structure draft * Complete usage doc structure * Fix link * Apply suggestions from code review Co-authored-by: Aimee Ukasick <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Apply suggestions from code review * Replace tutorial path * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> --------- Co-authored-by: Aimee Ukasick <[email protected]> Co-authored-by: Jeff Boruszak <[email protected]> Co-authored-by: boruszak <[email protected]>

…21673) * CE-655 - Moving DNS forwading tutorial to docs (#21348) * First commit * Add page to navigation * test new doc page * Update website/content/docs/services/discovery/dns-forwarding.mdx * Update website/content/docs/services/discovery/dns-forwarding.mdx * fix push build atttempt * Draft * Draft * empty line * Draft * empty lines * Draft * First draft * Create documentation for Argo Rollouts Plugin. (#20680) * Create documentation for Argo Rollouts Plugin. * Create documentation for Argo Rollouts Plugin. * Apply suggestions from code review Co-authored-by: David Yu <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Update docs based on feedback * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx --------- Co-authored-by: David Yu <[email protected]> Co-authored-by: Jeff Boruszak <[email protected]> Co-authored-by: Michael Wilkerson <[email protected]> * Split content and add images * Fix navigation * Add links and context * Restructure changes * Fix enable documentation * Fix enable documentation * Fix index documentation * Add troubleshooting and fix codeblocks * Add troubleshooting and fix codeblocks * Typos and last checks * Apply suggestions from code review Co-authored-by: Aimee Ukasick <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Update website/content/docs/services/discovery/dns-forwarding/enable.mdx * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Add dark mode images * Add dark mode images * Apply suggestions from code review --------- Co-authored-by: boruszak <[email protected]> Co-authored-by: Ashwin Venkatesh <[email protected]> Co-authored-by: David Yu <[email protected]> Co-authored-by: Jeff Boruszak <[email protected]> Co-authored-by: Michael Wilkerson <[email protected]> Co-authored-by: Aimee Ukasick <[email protected]> * CE-657 - Move Application leader election tutorial to docs (#21366) * First commit * Fix navigation * Add some commands * Structure draft * Complete usage doc structure * Fix link * Apply suggestions from code review Co-authored-by: Aimee Ukasick <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Apply suggestions from code review * Replace tutorial path * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> --------- Co-authored-by: Aimee Ukasick <[email protected]> Co-authored-by: Jeff Boruszak <[email protected]> Co-authored-by: boruszak <[email protected]> --------- Co-authored-by: danielehc <[email protected]> Co-authored-by: Ashwin Venkatesh <[email protected]> Co-authored-by: David Yu <[email protected]> Co-authored-by: Michael Wilkerson <[email protected]> Co-authored-by: Aimee Ukasick <[email protected]>

* First commit * Fix navigation * Add some commands * Structure draft * Complete usage doc structure * Fix link * Apply suggestions from code review Co-authored-by: Aimee Ukasick <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> * Apply suggestions from code review * Replace tutorial path * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> --------- Co-authored-by: Aimee Ukasick <[email protected]> Co-authored-by: Jeff Boruszak <[email protected]> Co-authored-by: boruszak <[email protected]>

First commit

7b300c6

danielehc added type/docs Documentation needs to be created/updated/clarified pr/no-changelog PR does not need a corresponding .changelog entry pr/no-backport labels Jun 25, 2024

danielehc self-assigned this Jun 25, 2024

danielehc requested a review from a team as a code owner June 25, 2024 09:26

vercel bot had a problem deploying to Preview – consul June 25, 2024 09:28 Failure

Fix navigation

6452d47

vercel bot deployed to Preview – consul June 25, 2024 09:46 View deployment

Add some commands

aaec64e

vercel bot deployed to Preview – consul June 25, 2024 11:49 View deployment

danielehc changed the title ~~Move Application leader election tutorial to docs~~ CE-657 - Move Application leader election tutorial to docs Jun 25, 2024

Merge branch 'main' into CE-657

4252715

vercel bot deployed to Preview – consul June 27, 2024 10:07 View deployment

Structure draft

88fc210

vercel bot deployed to Preview – consul June 27, 2024 13:01 View deployment

Complete usage doc structure

3aa27d6

vercel bot deployed to Preview – consul June 27, 2024 18:03 View deployment

Fix link

69709e8

vercel bot deployed to Preview – consul July 3, 2024 11:07 View deployment

aimeeu approved these changes Jul 8, 2024

View reviewed changes

Merge branch 'main' into CE-657

20b0c60

vercel bot deployed to Preview – consul July 16, 2024 13:36 View deployment

Apply suggestions from code review

dee12ca

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

vercel bot deployed to Preview – consul July 16, 2024 13:44 View deployment

Merge branch 'main' into CE-657

fda9d55

vercel bot deployed to Preview – consul August 6, 2024 12:57 View deployment

boruszak reviewed Aug 6, 2024

View reviewed changes

danielehc and others added 2 commits August 13, 2024 11:31

Apply suggestions from code review

2065aec

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

Merge branch 'main' into CE-657

0cbd48b

Apply suggestions from code review

0d43fc9

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

vercel bot deployed to Preview – consul August 14, 2024 15:00 View deployment

danielehc commented Aug 14, 2024

View reviewed changes

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx Outdated Show resolved Hide resolved

danielehc commented Aug 14, 2024

View reviewed changes

website/content/docs/dynamic-app-config/sessions/application-leader-election.mdx Outdated Show resolved Hide resolved

danielehc added 2 commits August 14, 2024 18:36

Apply suggestions from code review

eedd96f

Merge branch 'main' into CE-657

cd1f584

vercel bot deployed to Preview – consul August 14, 2024 16:48 View deployment

Replace tutorial path

03161f9

boruszak approved these changes Aug 14, 2024

View reviewed changes

vercel bot deployed to Preview – consul August 14, 2024 22:29 View deployment

danielehc and others added 2 commits August 15, 2024 08:57

Apply suggestions from code review

6bff61c

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

Merge branch 'main' into CE-657

4883f46

danielehc merged commit e2bb1b7 into main Aug 15, 2024
58 of 59 checks passed

danielehc deleted the CE-657 branch August 15, 2024 07:07

vercel bot deployed to Preview – consul August 15, 2024 07:10 View deployment

boruszak mentioned this pull request Aug 27, 2024

docs: Backport for DNS Forwarding/Application leader election docs #21673

Merged

4 tasks

dhiaayachi mentioned this pull request Sep 25, 2024

docs: Backport for DNS Forwarding/Application leader election docs dhiaayachi/consul#132

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CE-657 - Move Application leader election tutorial to docs #21366

CE-657 - Move Application leader election tutorial to docs #21366

danielehc commented Jun 25, 2024 •

edited

Loading

aimeeu left a comment

aimeeu Jul 8, 2024

boruszak left a comment

boruszak Aug 6, 2024

danielehc Aug 14, 2024

boruszak left a comment

		The primitives provided by sessions and the locking mechanisms of the KV
		store can be used to build client-side leader election algorithms.

CE-657 - Move Application leader election tutorial to docs #21366

CE-657 - Move Application leader election tutorial to docs #21366

Conversation

danielehc commented Jun 25, 2024 • edited Loading

Description

Testing & Reproduction steps

Links

PR Checklist

aimeeu left a comment

Choose a reason for hiding this comment

aimeeu Jul 8, 2024

Choose a reason for hiding this comment

boruszak left a comment

Choose a reason for hiding this comment

boruszak Aug 6, 2024

Choose a reason for hiding this comment

danielehc Aug 14, 2024

Choose a reason for hiding this comment

boruszak left a comment

Choose a reason for hiding this comment

danielehc commented Jun 25, 2024 •

edited

Loading