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

cli: re-introduce iam upgrade check #3657

Merged
merged 1 commit into from
Mar 6, 2025

Conversation

3u13r
Copy link
Member

@3u13r 3u13r commented Feb 20, 2025

Context

We still maintain the function in which we manually add the CSP if we did changes that require an constellation iam upgrade, though the function wasn't used for some time. Either we drop this safety check completely (as it also only applies to the cli and not the terraform) and is one less manual step when changing code and releasing, or we use it.

I'm currently of the opinion to drop this, but wanted to show what the full feature looked like.

Proposed change(s)

  • re-introduce iam upgrade check

Checklist

  • Add labels (e.g., for changelog category)

upgrade to this branch: (gcp-snp, 1:1) https://github.com/edgelesssys/constellation/actions/runs/13679706679
nop e2e gcp-snp: https://github.com/edgelesssys/constellation/actions/runs/13679730897

@3u13r 3u13r added the no changelog Change won't be listed in release changelog label Feb 20, 2025
Copy link

netlify bot commented Feb 20, 2025

Deploy Preview for constellation-docs canceled.

Name Link
🔨 Latest commit f08eb35
🔍 Latest deploy log https://app.netlify.com/sites/constellation-docs/deploys/67c86f5fed5f79000830e614

@3u13r 3u13r force-pushed the euler/re-introduce-iam-upgrade-check branch from 248dfa2 to f08eb35 Compare March 5, 2025 15:35
@3u13r 3u13r marked this pull request as ready for review March 5, 2025 15:39
@3u13r 3u13r requested review from elchead and daniel-weisse March 5, 2025 15:39
Copy link
Contributor

github-actions bot commented Mar 5, 2025

Coverage report

Package Old New Trend
cli/internal/cmd 58.10% 57.90% ↘️

@elchead
Copy link
Contributor

elchead commented Mar 5, 2025

Good catch. What is your proposed way of telling users that they need to upgrade the IAM setup for this upgrade?
Is it the release notes? IMO we can drop this warning in the CLI then

@3u13r
Copy link
Member Author

3u13r commented Mar 5, 2025

What is your proposed way of telling users that they need to upgrade the IAM setup for this upgrade?

To be honest I'm a bit on the fence about it. I think that both the migration page (https://docs.edgeless.systems/constellation/reference/migration) and the UpgradeRequiresIAMMigration change require the dev to "just know" on an IAM change to add a disclaimer. Since the code is a bit awkward to pass the yes flag though those layers, I'm a bit more inclined to just document it in the docs. On the other hand, the warning in the cli is a bit more present for the user than reading patchnotes and migration guides. But again, if a user is using our Terraform module and has downloaded the module, then we should inform them too.
Open to opinions here.

Copy link
Member

@daniel-weisse daniel-weisse left a comment

Choose a reason for hiding this comment

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

IMO we should make this as obvious as possible for the user.
While documenting it in just one place is simpler for the devs, I see no harm in additionally keeping the check in the CLI.
Since these IAM upgrades are somewhat of a "breaking" change we should document they should ideally be mentioned in the release notes, have a small entry in the migration page, and have this additional check during upgrades with the CLI

We can't easily supply something similar for Terraform, but here people should pay a bit more attention to the release notes anyways.

Copy link
Contributor

@elchead elchead left a comment

Choose a reason for hiding this comment

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

I don't have a strong opinion either, but I agree that the dev effort for maintaining the warning is also limited. Let's merge then

@3u13r 3u13r merged commit fab1c8e into main Mar 6, 2025
19 checks passed
@3u13r 3u13r deleted the euler/re-introduce-iam-upgrade-check branch March 6, 2025 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog Change won't be listed in release changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants