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

Add Managing Configuration and Secrets Tutorial #12530

Merged
merged 12 commits into from
Sep 24, 2024

Conversation

toriancrane
Copy link
Contributor

@toriancrane toriancrane commented Aug 16, 2024

Proposed changes

This PR adds the content for the Managing Configuration and Secrets tutorial.

  • Add meta image

@pulumi-bot
Copy link
Collaborator

@toriancrane toriancrane marked this pull request as ready for review August 26, 2024 14:07
@toriancrane toriancrane requested a review from a team as a code owner August 26, 2024 14:07
@pulumi-bot
Copy link
Collaborator

@toriancrane toriancrane requested a review from cnunciato August 26, 2024 14:15
@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

content/tutorials/managing-config-and-secrets/index.md Outdated Show resolved Hide resolved
content/tutorials/managing-config-and-secrets/index.md Outdated Show resolved Hide resolved
content/tutorials/managing-config-and-secrets/index.md Outdated Show resolved Hide resolved
# - some-non-existent-collection
---

## Create a new project
Copy link
Contributor

Choose a reason for hiding this comment

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

In the "Inspecting Infrastructure" tutorial, we refer to this step as optional (e.g. either use an existing project or create a new one). That said, tagging this as optional in that tutorial, especially as the first step, felt a little awkward. I think we should be consistent across the tutorials and introduce this step as "Next, either create a new project or navigate to the code for an existing one. To create a project...".

Copy link
Contributor Author

@toriancrane toriancrane Sep 10, 2024

Choose a reason for hiding this comment

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

I almost wonder if we should just keep it simple rather than adding the indication that it can be run against existing code. I do agree that the [Optional] part in the other tutorial is a bit awkward so I will remove that on another branch.


## Create configuration values

In a Pulumi project, you can locally [store and retrieve configuration values](/docs/concepts/config/) using the `pulumi config set <key> [value]` command. To demonstrate, run the following command to create a configuration value with a key of `myEnvironment` and a value of `development`:
Copy link
Contributor

Choose a reason for hiding this comment

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

See previous comment. I think we should use a different example configuration value other than the overloaded term "environment".

Copy link
Contributor Author

@toriancrane toriancrane Sep 10, 2024

Choose a reason for hiding this comment

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

On this one I will keep as is. The example program code being leveraged is also being used in another tutorial and I would basically have to duplicate this code just to change myEnvironment to something else. I have however updated the intro paragraph to make this less confusing. Also I would argue that the use of environment is not specific to Pulumi ESC if we are thinking in terms of dev/test/prod, so in this case I think it's pretty reasonable to have as part of the example.

content/tutorials/managing-config-and-secrets/index.md Outdated Show resolved Hide resolved
content/tutorials/managing-config-and-secrets/index.md Outdated Show resolved Hide resolved
content/tutorials/managing-config-and-secrets/meta.png Outdated Show resolved Hide resolved
@pulumi-bot
Copy link
Collaborator

@thoward
Copy link
Contributor

thoward commented Sep 23, 2024

LGTM!

@toriancrane toriancrane merged commit 90748db into master Sep 24, 2024
8 checks passed
@toriancrane toriancrane deleted the torian/config-secrets2 branch September 24, 2024 07:53
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.

3 participants