README
¶
Porter
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. Based on the Cloud Native Application Bundle Specification, CNAB, Porter provides a declarative authoring experience that lets you focus on what you know best: your application.
Learn all about Porter at porter.sh
Contact
- Mailing List - Great for following the project at a high level because it is low traffic, mostly release notes and blog posts on new features.
- Slack - Discuss #porter or #cnab with other users and the maintainers.
- Open an Issue - If you have a bug, feature request or question about Porter, ask on GitHub so that we can prioritize it and make sure you get an answer. If you ask on Slack, we will probably turn around and make an issue anyway. 😉
Looking for Contributors
Want to work on Porter with us? 💖 We are actively seeking out new contributors with the hopes of building up both casual contributors and enticing some of you into becoming reviewers and maintainers.
Start with our New Contributors Guide
Porter wouldn't be possible without our contributors, carrying the load and making it better every day! 🙇♀️
Roadmap
Porter is an open-source project and things get done as quickly as we have motivated contributors working on features that interest them. 😉
We use a single project board across all of our repositories to track open issues and pull requests.
The roadmap represents what the core maintainers have said that they are currently working on and plan to work on over the next few months. We use the "on-hold" bucket to communicate items of interest that doesn't have a core maintainer who will be working on it.
Check out our roadmap
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
credentials
Package credentials provides primitives for working with Porter credential sets, usually refered to as "credentials" as a shorthand.
|
Package credentials provides primitives for working with Porter credential sets, usually refered to as "credentials" as a shorthand. |
|
pkgmgmt
Package pkgmgmt implements the backing package management used by mixins and plugins.
|
Package pkgmgmt implements the backing package management used by mixins and plugins. |
|
pkgmgmt/client
Package client provides a package management client for Porter's mixins and plugins.
|
Package client provides a package management client for Porter's mixins and plugins. |
|
pkgmgmt/feed
Package feed helps work with a Porter package feed (mixin or plugin).
|
Package feed helps work with a Porter package feed (mixin or plugin). |
|
secrets
Package secrets provides primitives for resolving secrets from external sources, such as Hashicorp Vault or Azure Key Vault, into Credential Sets and injecting them into bundle runtimes.
|
Package secrets provides primitives for resolving secrets from external sources, such as Hashicorp Vault or Azure Key Vault, into Credential Sets and injecting them into bundle runtimes. |
|
secrets/host
Package host provides a plugin implementing the original behavior of resolving secrets from the local host: environment variables, paths, commands and static values.
|
Package host provides a plugin implementing the original behavior of resolving secrets from the local host: environment variables, paths, commands and static values. |
|
secrets/in-memory
Package inmemory provides an in-memory implementation of a secret store suitable for unit testing.
|
Package inmemory provides an in-memory implementation of a secret store suitable for unit testing. |
|
secrets/pluginstore
Package pluginstore is an internal Porter package that implements the secret.Store interface via plugins.
|
Package pluginstore is an internal Porter package that implements the secret.Store interface via plugins. |
|
storage
Package storage is an internal Porter package that implements the crud store via plugins.
|
Package storage is an internal Porter package that implements the crud store via plugins. |
|
storage/crudstore
Package crudstore defines the crudstore plugin interface shared between Porter and its plugin.
|
Package crudstore defines the crudstore plugin interface shared between Porter and its plugin. |
|
storage/filesystem
Package filesystem implements the crudstore plugin interface, storing data on the local filesystem.
|
Package filesystem implements the crudstore plugin interface, storing data on the local filesystem. |
|
storage/pluginstore
Package pluginstore is an internal Porter package that implements the crud.Store interface via plugins.
|
Package pluginstore is an internal Porter package that implements the crud.Store interface via plugins. |
|
test
Test contains common test helpers used across packages in porter.
|
Test contains common test helpers used across packages in porter. |
|
workshop
|
|