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

Unclear wording in pulumi cloud aws oidc document #1632

Open
d3287t328 opened this issue Apr 17, 2024 · 1 comment
Open

Unclear wording in pulumi cloud aws oidc document #1632

d3287t328 opened this issue Apr 17, 2024 · 1 comment
Labels
kind/bug Some behavior is incorrect or out of spec

Comments

@d3287t328
Copy link

d3287t328 commented Apr 17, 2024

What happened?

At the end of this document here https://github.com/pulumi/examples/tree/master/aws-py-oidc-provider-pulumi-cloud it suggests you can delete the stack used to create the pulumi cloud oidc resource "Once you are done, you can destroy all of the resources as well as the stack:"

But it is not clear to me if doing this deletes the oidc provider for ESC as well. I see it says "all of the resources are destroyed" but does the oidc provider live on after the stack is destroyed? I am asking here because the doc does not make it clear if the stack is essential to create the oidc resource or if the stack needs to remain to keep the oidc provider active in aws.

Example

It could be that the deletion comment is just part of the lifecycle of the oidc provider that when you are done with using it you can delete it but if you intend on using it the intention should not be delete it right afterwards. There should be some additional wording "now that the oidc provider is ready you are ready to continue using ESC."

The wording does not explain if it lives on in AWS after the stack is deleted or not. This ambiguity is difficult for users to understand what is meant without manually testing it.

Also shouldn't the stack name used in the example be more purposeful then the name 'dev' when it could instead be 'oidc' to make it clear that is what the stack is for?

Output of pulumi about

NA

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

@d3287t328 d3287t328 added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Apr 17, 2024
@cnunciato
Copy link
Contributor

Thanks for submitting this @d3287t328! We'll try to make these docs clearer.

@cnunciato cnunciato removed the needs-triage Needs attention from the triage team label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Some behavior is incorrect or out of spec
Projects
None yet
Development

No branches or pull requests

2 participants