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

[esc] add at scale doc #13465

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

[esc] add at scale doc #13465

wants to merge 2 commits into from

Conversation

dschaller
Copy link
Member

Proposed changes

add doc on using ESC at scale, breaking down the steps based on user role, and providing examples of RBAC team access, JIT access of secrets/configuration, revision tags, providers, etc.

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@dschaller dschaller marked this pull request as ready for review December 2, 2024 06:01
@dschaller dschaller requested a review from a team as a code owner December 2, 2024 06:01
@dschaller dschaller requested a review from seanyeh December 2, 2024 06:01
return fmt.Errorf("failed to open environment: %v", err)
}

awsProvider, err := getAwsProviderFromEnv(ctx, values)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this example can be simplified because the default aws provider will pick up these env vars automatically if the environment is imported by the stack config.

I think using the ESC SDK within a stack makes the example appear more complicated, and we might be better served having a different non-stack example of using the SDK instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

👍 yeah I did have the thought this is a somewhat exaggerated example meant to show using JIT secrets in a practical application.

I ended up sticking with it because while the provider will use the environment variables by default you have to set those which when performing updates locally means you have to open the environment as an explicit step. With this you don't have to do any of that. Just as long as your PAT is set correctly.

Copy link
Contributor

Choose a reason for hiding this comment

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

is an explicit open really required? just having the environment in the config seems to work for me 😕

environment:
  - dev-sandbox
import * as aws from "@pulumi/aws";
const bucket = new aws.s3.BucketV2("my-bucket");
export const bucketName = bucket.id;

@pulumi-bot
Copy link
Collaborator

@interurban
Copy link
Collaborator

Hey @dschaller Are you ready for a docs team review on this or still working on it?

@dschaller
Copy link
Member Author

Hey @interurban let me convert this to a draft based on some convo I had async with @nyobe

@dschaller dschaller marked this pull request as draft December 24, 2024 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants