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 example bundle with sensitive data #10

Merged
merged 5 commits into from
Jun 1, 2022
Merged

Conversation

VinozzZ
Copy link
Contributor

@VinozzZ VinozzZ commented May 31, 2022

This PR adds an example bundle that contains sensitive data so that we can demonstrate how to work with such bundles in Porter

Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
# Bundle with sensitive data

This bundle demonstrates how porter works with bundle that contains sensitive
data. It requires users to set up a secret store in their porter configuration
Copy link
Member

Choose a reason for hiding this comment

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

Can you provide steps for what they should configure (it's okay to link to the quickstart or existing doc) and then include a section that has them try out the bundle?

You can look at https://github.com/getporter/examples/tree/main/otel-jaeger for the amount of detail that we want to include in the example readmes. Essentially someone should be able to figure out how to configure porter and then run the example bundle.

@carolynvs
Copy link
Member

Also I have started to keep an index of all the examples on the README, so make sure to add yours to the learn section.

VinozzZ added 2 commits May 31, 2022 16:13
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
to setup [filesystem](https://release-v1.porter.sh/plugins/filesystem/) plugin.
After setting up the secret plugin, run to install the bundle:
```
porter install --reference ghcr.io/getporter/examples/porter-sensitive-data:v0.1.0
Copy link
Member

Choose a reason for hiding this comment

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

I think the reference below doesn't match where the bundle will end up being published?

Suggested change
porter install --reference ghcr.io/getporter/examples/porter-sensitive-data:v0.1.0
porter install --reference ghcr.io/getporter/examples/sensitive-data:v0.1.0

Copy link
Member

Choose a reason for hiding this comment

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

When I tried to run the install command without any additional flags the installation failed because one of the parameters is required and does not have a default. Can you update the instructions to include the full command including all required arguments?

$ porter install
Building bundle ===>
Defaulting the type of output name to file
Copying porter runtime ===>
Copying mixins ===>
Copying mixin exec ===>

Generating Dockerfile =======>

Writing Dockerfile =======>
Building invocation image
Checking database schema
Selected configured plugin	{"plugin-key": "mongodb"}
Connecting to plugin	{"plugin-command": "/Users/carolynvs/.porter/porter plugin run storage.porter.mongodb"}
starting plugin
plugin started
waiting for RPC address
using plugin
plugin address
Initializing installation collection indices
Initializing parameter collection indices
Initializing credentials collection indices
parameter "password" is required
received EOF, stopping recv loop
plugin process exited
plugin exited

VinozzZ added 2 commits June 1, 2022 09:03
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
Copy link
Member

@carolynvs carolynvs left a comment

Choose a reason for hiding this comment

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

Perfect, thanks for adding this example!

@carolynvs carolynvs merged commit 7f6ce49 into getporter:main Jun 1, 2022
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.

2 participants