Skip to content

Revise website tutorial how-to-transactional-write #1025

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

wendy-ha18
Copy link

@wendy-ha18 wendy-ha18 commented Jun 10, 2025

This PR uses to address this issue: #801 for updating the Guide to making transactional writes.

  • Add prerequisites (etcdctl and a currently running etcd cluster are required)
  • Define all variables and flags used in the examples in a bulleted list
  • Explain txn and why you might want to transactionally write things (might need a maintainer to help with this!) (completed partially, need to ask for advice).

@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

The full list of commands accepted by this bot can be found 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
Copy link

Hi @wendy-ha18. Thanks for your PR.

I'm waiting for a etcd-io 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.

@wendy-ha18 wendy-ha18 force-pushed the wendyha-update-tutorial-how-to-transactional-write branch from 41f20f7 to b316d0b Compare June 10, 2025 20:20
@wendy-ha18
Copy link
Author

One requirement of issue: #801 mentioned about why you might want to transactionally write things (might need a maintainer to help with this!).

After consideration, IMHO, the main reason we want to transactionally write things are to maintain data consistency and ensure expected state fefore writing, which are similar with this part. Just want to ask maintainer @jmhbnz do you have any opinions on it?.

Do we still need to including this explaination to make the tutorial clearer?

@wendy-ha18
Copy link
Author

cc @ronaldngounou @jberkus @nate-double-u for reviewing.

@jberkus
Copy link
Contributor

jberkus commented Jun 11, 2025

/ok-to-test

@jberkus
Copy link
Contributor

jberkus commented Jun 11, 2025

@wendy-ha18 see linting errors per the test.

@wendy-ha18 wendy-ha18 force-pushed the wendyha-update-tutorial-how-to-transactional-write branch from 6f2ec2a to 2457d7a Compare June 13, 2025 15:55
@wendy-ha18 wendy-ha18 force-pushed the wendyha-update-tutorial-how-to-transactional-write branch from 2457d7a to 0a8fb97 Compare June 13, 2025 16:08
@wendy-ha18
Copy link
Author

wendy-ha18 commented Jun 13, 2025

Hi @jberkus I have fixed all of lint test fails and backport v3.6 to v3.5 as well.
Could you plz help me review it again? Thanks a lot Josh!

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

Successfully merging this pull request may close these issues.

3 participants