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

Fix website typos #1776

Merged
merged 1 commit into from
Sep 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ To install a bundle, you use the `porter install` command.
porter install porter-hello --reference getporter/porter-hello:v0.1.0
```

In this example, you are installing the v0.1.0 version of the getporter/porter-hello bundle from its location in the default registry (Docker Hub) and setting the installation name to hello.
In this example, you are installing the v0.1.0 version of the getporter/porter-hello bundle from its location in the default registry (Docker Hub) and setting the installation name to porter-hello.

## List Bundle Installations

Expand Down
8 changes: 4 additions & 4 deletions docs/content/quickstart/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Examples of a credential would be: a GitHub Personal Access Token, your cloud pr
We classify those values as credentials so that when different people execute that bundle, they provide their own personal credentials and execute the bundle with their user permissions.
In contrast, a database connection string used by your application is considered only to be a sensitive parameter because regardless of who is installing the bundle, the same connection string should be used.

**If you want to use different values depending on the person executing the bundle, use credentials. Otherwise use sensitive parameters.**
**If you want to use different values depending on the person executing the bundle, use credentials. Otherwise, use sensitive parameters.**

This is a convention recommended by Porter to avoid a situation where Sally installs a bundle with her personal credentials, and then every time another user subsequently upgrades the bundle, her credentials are re-used, making it look like Sally ran the upgrades.
Ultimately the difference between the parameters and credentisl is that credentials are never stored or reused by a bundle.
Ultimately the difference between the parameters and credentials is that credentials are never stored or reused by a bundle.

Credentials are injected into a bundle as either an environment variable or a file.
Depending on the bundle, a credential can apply to all actions (install/upgrade/uninstall) or may only apply to a particular action.
Expand Down Expand Up @@ -58,7 +58,7 @@ Generating new credential github from bundle credentials-tutorial
```

This creates a credential set named github.
View the parameter set with the `porter parameters show` command:
View the credential set with the `porter credentials show` command:

```console
$ porter credentials show github
Expand All @@ -74,7 +74,7 @@ Modified: 21 minutes ago

The output shows that the credential set has one credential defined: github-token. The credential's value is not stored in the credential set, instead it only stores a mapping from the credential name to a location where the credential can be resolved, in this case an environment variable named GITHUB_TOKEN.

In production it is a best practice to source sensitive values, either parameters or credentials, from a secret store, such as Hashicorp Vault or Azure Key Vault.
In production, it is a best practice to source sensitive values, either parameters or credentials, from a secret store, such as Hashicorp Vault or Azure Key Vault.
Avoid storing sensitive values in files or environment variables on developer and CI machines which could be compromised.
See the list of available [plugins](/plugins/) for which secret providers are supported.

Expand Down
2 changes: 1 addition & 1 deletion docs/themes/porter/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h2>When would I use Porter?</h2>
<li><span class="emoji">🕑</span> Save time because the bundle contains the exact version of your deployment tools. Users don’t need to find and install tools or switch between versions.</li>
<li><span class="emoji">🗂</span> View rich metadata about a deployment. Run porter explain to quickly see how to customize an installation with parameters, what credentials are needed by the bundle. There is no need for detailed installation documentation.</li>
<li><span class="emoji">🧠</span> Reduce the operational knowledge required to manage an application. Often deployments involve multiple tools, such as terraform, AND helm, AND kubectl; all glued together with bash scripts. Bundles abstract away the details of a deployment, and provide a consistent set of commands to deploy any application.</li>
<li><span class="emoji">💁‍♀️</span> Manage deployments securely as a team. Porter uses secure just-in-time credential injection and remembers the parameters last used to deploy. Teammates don’t need to hunt down the proper values themselves, or copy sensitive credentials into local environment variables or files. Secrets remain secure in a secret store such as Hashcorp Vault or Azure Key Vault.</li>
<li><span class="emoji">💁‍♀️</span> Manage deployments securely as a team. Porter uses secure just-in-time credential injection and remembers the parameters last used to deploy. Teammates don’t need to hunt down the proper values themselves, or copy sensitive credentials into local environment variables or files. Secrets remain secure in a secret store such as Hashicorp Vault or Azure Key Vault.</li>
</ul>
<p>These are just some of the reasons why working with bundles with the tools embedded inside is helpful vs. using the same tools standalone.</p>
</div>
Expand Down