Merge branch 'main' into credsApplyStdout

.github/CODEOWNERS

@@ -4,4 +4,4 @@
 
 /docs/content/  @iennae
 
-*   @schristoff @sgettys @bdegeeter @troy0820
+*   @schristoff @sgettys @bdegeeter @troy0820 @kichristensen

.github/workflows/build_pipelinesrelease_template.yml

@@ -133,6 +133,8 @@ jobs:
     steps:
     - name: checkout
       uses: actions/checkout@v4.1.0
+      with:
+        fetch-depth: 0
     - uses: actions/setup-go@v4
       with:
         go-version: "${{ inputs.GOVERSION }}"

.github/workflows/trivy.yaml

@@ -8,7 +8,7 @@ on:
       # Dependabot pushes to branches in our repo, not in a fork. This causes the push event to trigger for dependabot PRs and the CodeQL check fails.
       - "dependabot/**"
   # Only do a security scan on a PR when there are non-doc changes to save time
-  pull_request_target:
+  pull_request:
     paths-ignore:
       - 'docs/**'
 

CONTRIBUTING.md

@@ -526,7 +526,7 @@ If you are using GoLand, use the **Go Remote** debug configuration and make sure
 
 ### Command Documentation
 
-Our commands are documented at <https://porter.sh/cli> and that documentation is
+Our commands are documented at <https://porter.sh/docs/references/cli/> and that documentation is
 generated by our CLI. You should regenerate that documentation when you change
 any files in **cmd/porter** by running `mage DocsGen` which is run every time
 you run `mage build`.

cmd/porter/bundle.go

@@ -177,6 +177,7 @@ Note: if overrides for registry/tag/reference are provided, this command only re
 		"viper-key": {"force-overwrite"},
 	}
 	f.BoolVar(&opts.AutoBuildDisabled, "autobuild-disabled", false, "Do not automatically build the bundle from source when the last build is out-of-date.")
+	f.BoolVar(&opts.SignBundle, "sign-bundle", false, "Sign the bundle using the configured signing plugin")
 
 	return &cmd
 }
@@ -190,6 +191,7 @@ func buildBundleArchiveCommand(p *porter.Porter) *cobra.Command {
 		Long:  "Archives a bundle by generating a gzipped tar archive containing the bundle, invocation image and any referenced images.",
 		Example: `  porter bundle archive mybun.tgz --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
   porter bundle archive mybun.tgz --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --force
+  porter bundle archive mybun.tgz --compression NoCompression --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
 `,
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return opts.Validate(cmd.Context(), args, p)
@@ -199,7 +201,9 @@ func buildBundleArchiveCommand(p *porter.Porter) *cobra.Command {
 		},
 	}
 
-	addBundlePullFlags(cmd.Flags(), &opts.BundlePullOptions)
-
+	f := cmd.Flags()
+	addBundlePullFlags(f, &opts.BundlePullOptions)
+	f.StringVarP(&opts.CompressionLevel, "compression", "c", opts.GetCompressionLevelDefault(),
+		fmt.Sprintf("Compression level to use when creating the gzipped tar archive. Allowed values are: %s", strings.Join(opts.GetCompressionLevelAllowedValues(), ", ")))
 	return &cmd
 }

cmd/porter/installations.go

@@ -255,6 +255,7 @@ The docker driver runs the bundle container using the local Docker host. To use
 		"Create the installation in the specified namespace. Defaults to the global namespace.")
 	f.StringSliceVarP(&opts.Labels, "label", "l", nil,
 		"Associate the specified labels with the installation. May be specified multiple times.")
+	f.BoolVar(&opts.VerifyBundleBeforeExecution, "verify-bundle", false, "Verify the bundle signature before executing")
 	addBundleActionFlags(f, opts)
 
 	// Allow configuring the --driver flag with runtime-driver, to avoid conflicts with other commands

docs/content/architecture.md

@@ -45,7 +45,7 @@ Learn more about [how Porter works at runtime](/architecture-runtime/).
 
 * [Security Features](/security-features/)
 * [Create a Bundle](/getting-started/create-bundle/)
-* [Distribute Bundles](/development/distribute-bundles/)
-* [Airgapped Deployments](/administrators/airgap/)
+* [Distribute Bundles](/development/authoring-a-bundle/distribute-bundles//)
+* [Airgapped Deployments](/administration/move-bundles-airgapped/)
 
 [mixins]: /mixins/

docs/content/blog/porter-collaboration.md

@@ -64,5 +64,5 @@ overview of CNAB, demos of bundles in action and more.
 [azure-plugin]: /plugins/azure/
 [slack]: /community/#slack
 [install]: /install/
-[tutorial]: /plugins/tutorial/
+[tutorial]: /how-to-guides/work-with-plugins/
 [learning]: /learning/

docs/content/blog/using-docker-in-bundles.md

@@ -96,7 +96,7 @@ install:
 
 This blog post focuses on just the docker mixin, but here is a [full
 working example for how to use Docker Compose in a
-bundle](/examples/src/compose/).
+bundle](/examples/src/dockerapp/).
 
 ### Use Docker
 
@@ -234,6 +234,6 @@ us to take this further, please reach out on the [porter][porter-repo] or [docke
 repositories!
 
 [porter-repo]: https://github.com/getporter/porter/
-[docker-repo]: https://github.com/getporter/mixin-docker/
+[docker-repo]: https://github.com/getporter/docker-mixin
 [compose-spec]: https://www.compose-spec.io/
 [docker mixin]: /mixins/docker/

docs/content/blog/v1-is-here.md

@@ -76,7 +76,7 @@ Read more about Porter's [security features](/security-features/).
 Our v1 release is not a stopping point, but instead a way point where we can now say "Porter is stable and safe to use in production".
 We have big plans going forward, adding new features on top of v1 incrementally:
 
-* **Advanced Dependencies**: Our initial implementation of dependencies was always limited in scope. More complete and powerful dependency support is already underway. Learn more in [PEP003 Advanced Dependencies](https://github.com/getporter/proposals/blob/main/pep/003-dependency-namespaces-and-labels.md).
+* **Advanced Dependencies**: Our initial implementation of dependencies was always limited in scope. More complete and powerful dependency support is already underway. Learn more in [PEP003 Advanced Dependencies](https://github.com/getporter/proposals/blob/main/pep/003-advanced-dependencies.md).
 * **Distribute Mixins as Bundles**: After we have advanced dependency support, we are improving how mixins are distributed and executed so that they are BUNDLES! This will significantly improve performance, layer caching, mixin distribution, and bundle execution security. Learn more in [PEEP005 Mixins are Bundles](https://github.com/getporter/proposals/blob/main/pep/005-mixins-are-bundles.md).
 * **Porter Operator v1**: The [Porter Operator] is far enough along for you to try, and we aim to quickly get it ready for a v1 release.
 * **Support for signing bundles**: Porter will support integration with Notary for signing and verifying bundles.

docs/content/blog/v1-roadmap.md

@@ -39,7 +39,7 @@ We always welcome new contributors, even if you are new to Go, containers, or ev
 If you'd like to help us with v1 or contribute to the larger features in our pipeline, the [new contributor guide] is where to start. 🚀
 
 [v1 milestone]: https://github.com/getporter/porter/milestone/16
-[version strategy]: /project/version-strategy/
+[version strategy]: /references/version-strategy/
 [buildkit]: https://github.com/getporter/porter/pull/1567
 [advanced dependency management]: https://github.com/getporter/proposals/pull/8
 [labels and namespaces]: https://github.com/cnabio/cnab-spec/pull/411

docs/content/docs/bundle/manifest/_index.md

@@ -31,7 +31,7 @@ The manifest is made up of multiple components. See the [Manifest File Format] f
 
 We have full [examples](https://github.com/getporter/examples) of Porter manifests in the Porter repository.
 
-[templates]: /development/using-templates/
+[templates]: /development/authoring-a-bundle/using-templates/
 [Manifest File Format]: /reference/file-formats/#manifest
 
 ## Bundle Metadata
@@ -476,7 +476,7 @@ similar to `help`, but has a different name, you should declare it in the `custo
 ## Dependencies
 
 Dependencies are an extension of the [CNAB Spec](https://github.com/cnabio/cnab-spec/blob/master/500-CNAB-dependencies.md).
-See [dependencies](/dependencies/) for more details on how Porter handles dependencies.
+See [dependencies](/development/authoring-a-bundle/working-with-dependencies/) for more details on how Porter handles dependencies.
 
 ```yaml
 dependencies:
@@ -621,5 +621,5 @@ be copied into the final bundle so that you can access them at runtime. The path
 
 * [Manifest File Format](/reference/file-formats/#manifest)
 * [Using Mixins](/use-mixins/)
-* [Bundle Dependencies](/dependencies/)
+* [Bundle Dependencies](/development/authoring-a-bundle/working-with-dependencies/)
 * [Parameters, Credentials, Outputs, and Images in Porter](/wiring/)

docs/content/docs/bundle/manifest/file-format/_index.md

@@ -233,7 +233,7 @@ status:
 
 ## Next Steps
 
-* [Create a Bundle](/bundle/create/)
+* [Create a Bundle](/development/authoring-a-bundle/create-a-bundle/)
 
 [semver v2]: https://semver.org/spec/v2.0.0.html
 [manifest-schema]: https://raw.githubusercontent.com/getporter/porter/main/pkg/schema/manifest.schema.json

docs/content/docs/contribute/_index.md

@@ -9,6 +9,6 @@ weight: 14
 {{< cards >}}
 {{< card link="guide" title="Contributing Guide" >}}
 {{< card link="tutorial" title="Contributing Tutorial" >}}
-{{< card link="proposal" title="Propose a change to Porter" >}}
+{{< card link="proposals" title="Propose a change to Porter" >}}
 {{< card link="work-with-us" title="Work on Porter with us" >}}
 {{< /cards >}}

docs/content/docs/development/authoring-a-bundle/create-a-bundle.md

@@ -185,7 +185,7 @@ Now that you know how to create a bundle, here are some more detailed topics on
 - [Customize your Porter manifest, porter.yaml][manifest]
 - [Porter Manifest File Format](/bundle/manifest/file-format/)
 - [Best Practices for the exec Mixin](/best-practices/exec-mixin/)
-- [Understand how bundles are distributed](/distribute-bundles/)
+- [Understand how bundles are distributed](/development/authoring-a-bundle/distribute-bundles/)
 
 [install Porter]: /install/
 [Porter Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=getporter.porter-vscode
@@ -198,7 +198,7 @@ Now that you know how to create a bundle, here are some more detailed topics on
 [porter install]: /cli/porter_install/
 [porter mixins search]: /cli/porter_mixins_search/
 [porter explain]: /cli/porter_explain/
-[porter mixin install]: /cli/porter_mixin_install/
+[porter mixin install]: /cli/porter_mixins_install/
 [Mixins]: /mixins/
 [create a custom mixin]: /mixin-dev-guide/
 [terraform mixin]: /mixins/terraform/

docs/content/docs/references/cli/bundles/_index.md

@@ -24,7 +24,7 @@ Commands for working with bundles. These all have shortcuts so that you can call
 
 ### SEE ALSO
 
-- [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.
+- [porter](/references/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.
 
 Most commands require a Docker daemon, either local or remote.
 

docs/content/docs/references/cli/porter.md

@@ -36,22 +36,22 @@ porter [flags]
 
 - [porter archive](/cli/porter_archive/) - Archive a bundle from a reference
 - [porter build](/cli/porter_build/) - Build a bundle
-- [porter bundles](/cli/porter_bundles/) - Bundle commands
+- [porter bundles](/cli/references/cli/bundles/) - Bundle commands
 - [porter completion](/cli/porter_completion/) - Generate completion script
 - [porter copy](/cli/porter_copy/) - Copy a bundle
 - [porter create](/cli/porter_create/) - Create a bundle
-- [porter credentials](/cli/porter_credentials/) - Credentials commands
+- [porter credentials](/references/cli/credentials/) - Credentials commands
 - [porter explain](/cli/porter_explain/) - Explain a bundle
 - [porter inspect](/cli/porter_inspect/) - Inspect a bundle
 - [porter install](/cli/porter_install/) - Create a new installation of a bundle
-- [porter installations](/cli/porter_installations/) - Installation commands
+- [porter installations](/references/cli/installations/) - Installation commands
 - [porter invoke](/cli/porter_invoke/) - Invoke a custom action on an installation
 - [porter lint](/cli/porter_lint/) - Lint a bundle
 - [porter list](/cli/porter_list/) - List installed bundles
 - [porter logs](/cli/porter_logs/) - Show the logs from an installation
-- [porter mixins](/cli/porter_mixins/) - Mixin commands. Mixins assist with authoring bundles.
-- [porter parameters](/cli/porter_parameters/) - Parameter set commands
-- [porter plugins](/cli/porter_plugins/) - Plugin commands. Plugins enable Porter to work on different cloud providers and systems.
+- [porter mixins](/references/cli/mixins/) - Mixin commands. Mixins assist with authoring bundles.
+- [porter parameters](/references/cli/parameters/) - Parameter set commands
+- [porter plugins](/references/cli/plugins/) - Plugin commands. Plugins enable Porter to work on different cloud providers and systems.
 - [porter publish](/cli/porter_publish/) - Publish a bundle
 - [porter schema](/cli/porter_schema/) - Print the JSON schema for the Porter manifest
 - [porter show](/cli/porter_show/) - Show an installation of a bundle

docs/content/security-features.md

@@ -79,5 +79,5 @@ But by default, that foot gun is disabled.
 * [Airgapped Deployments](/references/examples/airgap/)
 * [Blog: Upgrade your plugins to securely store sensitive data](/blog/persist-sensitive-data-safely/)
 
-[credential sets]: /introduction/intro-credentials/#credential-sets
+[credential sets]: /introduction/concepts-and-components/intro-credentials/#credential-sets
 [secrets plugins]: /plugins/types/#secrets

docs/content/wiring.md

@@ -420,7 +420,7 @@ install:
     mariadb.enabled: false
 ```
 
-For more information on how dependencies are handled, refer to the [dependencies](/development/working-with-dependencies/) documentation.
+For more information on how dependencies are handled, refer to the [dependencies](/development/authoring-a-bundle/working-with-dependencies/) documentation.
 
 ## Combining References