Skip to content

Commit

Permalink
Merge pull request getporter#2207 from carolynvs/update-v1-links
Browse files Browse the repository at this point in the history
Change release-v1 links to go to main site
  • Loading branch information
carolynvs authored Jun 28, 2022
2 parents 5681403 + 58cf747 commit 33bed82
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -589,8 +589,8 @@ When you realize that you may need to make a breaking change, discuss it with a
Here are some examples of breaking changes:

* The schema of porter.yaml changed.
* The schema of Porter's [file formats](https://release-v1.porter.sh/reference/file-formats) changed.
* The schema of Porter's [config file](https://release-v1.porter.sh/configuration/#config-file) changed.
* The schema of Porter's [file formats](https://getporter.org/reference/file-formats) changed.
* The schema of Porter's [config file](https://getporter.org/configuration/#config-file) changed.
* Flags or behavior of a CLI command changed, such as removing a flag or adding a validation that can result in a hard error, preventing the command from running.

All of Porter's documents have a schemaVersion field and when the schema of the document is changed, the version number should be incremented as well in the default set on new documents, the supported schema version constant in the code, and in the documentation for that document.
Expand Down
12 changes: 6 additions & 6 deletions docs/content/blog/persist-sensitive-data-safely.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Now Porter requires users to configure a secret store to hold any data that has

Let's walk through how to utilize this new feature by updating your Porter configuration file and selecting an appropriate secret plugin.

First, [install the latest Porter v1 prerelease](https://release-v1.porter.sh/install/#prerelease).
First, [install the latest Porter v1 prerelease](/install/#prerelease).

Next, let's install a bundle that handles sensitive data using just the default Porter configuration.

Expand All @@ -36,13 +36,13 @@ The example bundle defines a sensitive parameter named as `password` and a sensi

Porter's default secret plugin does not persist sensitive data. Any bundle that references or produces sensitive data will fail to execute. We do this because there isn't a clear set of safe defaults that are suitable for all users when it comes to storing sensitive data. Instead it is up to the user to select and configure an appropriate secrets plugin.

Now let's configure Porter to persist sensitive data with the [filesystem](https://release-v1.porter.sh/plugins/filesystem/) plugin.
Now let's configure Porter to persist sensitive data with the [filesystem](/plugins/filesystem/) plugin.

```yaml
default-secrets-plugin: "filesystem"
```
The [filesystem plugin](https://release-v1.porter.sh/plugins/filesystem/) resolves and stores sensitive bundle parameters and outpus as plain-text files in your PORTER_HOME directory.
The [filesystem plugin](/plugins/filesystem/) resolves and stores sensitive bundle parameters and outpus as plain-text files in your PORTER_HOME directory.
Note: the filesystem plugin is only intended for testing and local development usage. It's not intended to be used in production. The end of this blog post has recommended plugins that are suitable for production use.
Now you have a secret store set up, we can finally to install the example bundle, this time successfully.
Expand All @@ -67,8 +67,8 @@ Instead, we can find our "password" in our filesystem plugin. In your PORTER_HOM
This is why it's important to choose a secure secret plugin for your production environment so that your sensitive data is protected. As you can see, the filesystem plugin is only acceptable for local development and testing.

Here are some secret plugins that we recommand for production use:
- [Azure Key Vault](https://release-v1.porter.sh/plugins/azure/#secrets)
- [Kubernetes Secrets](https://release-v1.porter.sh/plugins/kubernetes/#secrets)
- [Hashicorp Vault](https://release-v1.porter.sh/plugins/hashicorp/)
- [Azure Key Vault](/plugins/azure/#secrets)
- [Kubernetes Secrets](/plugins/kubernetes/#secrets)
- [Hashicorp Vault](/plugins/hashicorp/)

Give them a try and let us know how it works for you! If there is a secret solution that you would like to use with Porter, let us know, and we can help make that happen more quickly.
2 changes: 1 addition & 1 deletion docs/content/blog/secret-free-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Keeping sensitive data off your machine, and safely in a secret store or vault w
Now Porter's config file is getting the same white glove treatment that bundle credentials always have!
We have [added templating support to Porter's config file][cfg-docs] so that you can use environment variables and secrets without hard-coding sensitive data in the file.

[cfg-docs]: https://release-v1.porter.sh/configuration/#config-file
[cfg-docs]: /configuration/#config-file

Porter has plugins for retrieving secrets from a secret store, and for storing its data in a Mongo database.
Configuring the plugins with credentials to connect to those resources is how sensitive data sneaks into the config file.
Expand Down
4 changes: 2 additions & 2 deletions docs/content/blog/v1-alpha3.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Check out the new features introduced in Porter v1.0.0-alpha.3 such as MongoDB,

This is a big release for our v1 alpha with LOTS of major changes that we hope make Porter easier to use such as [MongoDB](#mongodb-support), [namespaces](#namespaces), [labels](#labels), [bundle state](#bundle-state), and [credential import](#import-credentials-and-parameter-sets). Our [release notes] have a full accounting of all **fifty-eight** pull requests that were included in this release.

A v1 version of our documentation is available at https://release-v1.porter.sh.
A v1 version of our documentation is available at https://getporter.org.

[release notes]: https://github.com/getporter/porter/releases/tag/v1.0.0-alpha.3

Expand Down Expand Up @@ -51,7 +51,7 @@ Resources that are not defined in a namespace are considered global.
When an installation is defined in a namespace, it can reference a credential or parameter set that is also defined in that namespace or at the global scope.
Resources defined globally cannot reference other resources that are defined in a namespace.

You can set the current namespace in the [Porter configuration file](https://release-v1.porter.sh/configuration/#config-file) using the namespace setting.
You can set the current namespace in the [Porter configuration file](/configuration/#config-file) using the namespace setting.

When an installation references a parameter or credential set, Porter first looks for a resource with that name in the current namespace.
If one does not exist, Porter then looks for that resource at the global level.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ bundles.
## NOTES
* Learn how to configure [command completion](#command-completion)
* All the scripts support [customizing the installation through parameters](#install-script-parameters).
* If you are using the [Porter Operator](https://release-v1.porter.sh/operator/), then you must use the most recent v1 prerelease of Porter.
* If you are using the [Porter Operator](/operator/), then you must use the most recent v1 prerelease of Porter.

<a id="prerelease"></a>

Expand Down
2 changes: 1 addition & 1 deletion pkg/schema/check-strategy.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func ValidateSchemaVersion(strategy CheckStrategy, supported string, specified s
if specified == "" {
specified = "(none)"
}
baseMessage := fmt.Errorf("the schema version is %s but the supported schema version is %s. See https://release-v1.porter.sh/reference/file-formats/#supported-versions for more details: %w",
baseMessage := fmt.Errorf("the schema version is %s but the supported schema version is %s. See https://getporter.org/reference/file-formats/#supported-versions for more details: %w",
specified, supported, ErrInvalidSchemaVersion)

switch strategy {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# See the Credential Set file format documentation at https://release-v1.porter.sh/reference/file-formats/#credential-set
# See the Credential Set file format documentation at https://getporter.org/reference/file-formats/#credential-set
schemaType: CredentialSet
schemaVersion: 1.0.1
# Name of the credential set.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# See the Parameter Set file format documentation at https://release-v1.porter.sh/reference/file-formats/#parameter-set
# See the Parameter Set file format documentation at https://getporter.org/reference/file-formats/#parameter-set
schemaType: ParameterSet
schemaVersion: 1.0.1
# Name of the parameter set.
Expand Down

0 comments on commit 33bed82

Please sign in to comment.