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

Upgrade carbonplan version and update aws upgrade docs #3420

Merged
merged 15 commits into from
Nov 15, 2023

Conversation

GeorgianaElena
Copy link
Member

For #3224

@GeorgianaElena GeorgianaElena requested a review from a team as a code owner November 14, 2023 15:47
@GeorgianaElena GeorgianaElena changed the title Upgrade carbonplan version and update aws uprade docs Upgrade carbonplan version and update aws upgrade docs Nov 14, 2023
Copy link
Member

@sgibson91 sgibson91 left a comment

Choose a reason for hiding this comment

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

LGTM! I've left some comments trying to clean up the language a bit, but I think this is a complex topic so if I've misunderstood anything feel free to ignore it.

docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
docs/howto/upgrade-cluster/aws.md Outdated Show resolved Hide resolved
@GeorgianaElena
Copy link
Member Author

@sgibson91 and @consideRatio, many thanks for your feedback. I have added a bunch of commits this morning that I hope made the info a bit more clear.

Check it out at https://2i2c-pilot-hubs--3420.org.readthedocs.build/howto/upgrade-cluster/aws/ and let me know what you think

@consideRatio
Copy link
Contributor

image

I think the commit part is complicated because we don't version control it, and I don't think we should either. I think it simply doesn't get easier than the somewhat tricky procedure that requires attention to make sure to keep track of what is being applied - it will always be the yaml file as written to disk. If you introduce work on committing, it adds additional steps and complexity, especially since its not a version controlled file.

Due to this, I'd favor the removal of this optional step and nesting the important admonition under the third step.


Here "the config file" is mentioned to be the .jsonnet file specifically. I think this should be left not explicit, letting the reader either update the .yaml file, or the jsonnet file + generate like done in the step below. Compare:

image

image


With three minor version upgradable at the time, I think we should lean on the reduced complexity we can arrive at and assume we never need to upgrade more then three versions at the time.

This doesn't belong any more i think, after we upgraded the control plan version 1-3 times, we should simply have stayed at there going onwards. This change was also the only change to commit btw.

image

Copy link
Contributor

@consideRatio consideRatio left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @GeorgianaElena!! I figure we can merge, and if needed we can do another iteration at some later time. Its really tricky to document this procedure I think!

@GeorgianaElena
Copy link
Member Author

Thanks @consideRatio. I've added one more commit and going for a merge now.

@GeorgianaElena GeorgianaElena merged commit 87ff189 into 2i2c-org:master Nov 15, 2023
@GeorgianaElena GeorgianaElena deleted the upgrade-carbonplan branch November 15, 2023 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done 🎉
Development

Successfully merging this pull request may close these issues.

3 participants