Documentation
¶
Index ¶
Constants ¶
View Source
const ( // FileModeDirectory is the FileMode that should be used when creating a // directory. It ensures that both the user and the group have the same // permissions. FileModeDirectory os.FileMode = 0770 // FileModeWritable is the FileMode that should be used when creating a file // that should have read/write permissions. It ensures that both the user and // the group have the same permissions. FileModeWritable os.FileMode = 0660 // FileModeExecutable is the FileMode that should be used when creating an // executable file, such as a script or binary. It ensures that both the user // and the group have the same permissions. FileModeExecutable os.FileMode = 0770 // PORTER_USER_AGENT is the value used in user-agent header for porter PORTER_USER_AGENT = "getporter/porter" )
Variables ¶
View Source
var ( Commit string Version string )
These are build-time values, set during an official release
Functions ¶
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
config-adapter
Package configadapter converts a Porter manifest (porter.yaml) to a CNAB bundle.json
|
Package configadapter converts a Porter manifest (porter.yaml) to a CNAB bundle.json |
|
extensions/dependencies/v2
Package v2 defines the v2 Porter Dependency specification, org.getporter.dependencies@v2.
|
Package v2 defines the v2 Porter Dependency specification, org.getporter.dependencies@v2. |
|
encoding package handles marshal and unmarshaling documents into various formats, such as json, bson, yaml, etc.
|
encoding package handles marshal and unmarshaling documents into various formats, such as json, bson, yaml, etc. |
|
Package experimental defines flags that control experimental features
|
Package experimental defines flags that control experimental features |
|
Package pkgmgmt implements the backing package management used by mixins and plugins.
|
Package pkgmgmt implements the backing package management used by mixins and plugins. |
|
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. |
|
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). |
|
pluggable
Package pluggable manages configuring and connecting to Porter's plugins.
|
Package pluggable manages configuring and connecting to Porter's plugins. |
|
Package portercontext contains our common application Context structure that we should use to interact with stdin/stdout/stederr, running commands, and interacting with the file system.
|
Package portercontext contains our common application Context structure that we should use to interact with stdin/stdout/stederr, running commands, and interacting with the file system. |
|
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. |
|
plugins/filesystem
Package filesystem provides a plugin implementing the secret plugin protocol for creating/resolving secrets from the local filesystem.
|
Package filesystem provides a plugin implementing the secret plugin protocol for creating/resolving secrets from the local filesystem. |
|
plugins/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. |
|
plugins/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. |
|
plugins/proto
Package proto is the protobuf definition for the SecretsProtocol
|
Package proto is the protobuf definition for the SecretsProtocol |
|
pluginstore
Package pluginstore is an internal Porter package that implements the plugins.SecretsPlugin interface.
|
Package pluginstore is an internal Porter package that implements the plugins.SecretsPlugin interface. |
|
See an example of implementation: pkg/storage/plugins/mongodb package
|
See an example of implementation: pkg/storage/plugins/mongodb package |
|
migrations
migrations package handles migrating Porter's stored documents when necessary.
|
migrations package handles migrating Porter's stored documents when necessary. |
|
migrations/crudstore
Package crudstore supports reading data out of a legacy porter storage plugin
|
Package crudstore supports reading data out of a legacy porter storage plugin |
|
migrations/testhelpers
Package testhelpers contains helper functions for testing the pkg/storage/migrations package.
|
Package testhelpers contains helper functions for testing the pkg/storage/migrations package. |
|
plugins
plugin package contains interfaces for storage plugins.
|
plugin package contains interfaces for storage plugins. |
|
plugins/mongodb_docker
Package mongodb_docker implements the plugins.StorageProtocol interface, storing data using an instance of mongodb running in a container, with the data stored in a docker volume.
|
Package mongodb_docker implements the plugins.StorageProtocol interface, storing data using an instance of mongodb running in a container, with the data stored in a docker volume. |
|
plugins/proto
Package proto is the protobuf definition for the StorageProtocol
|
Package proto is the protobuf definition for the StorageProtocol |
|
pluginstore
Package pluginstore is an internal Porter package that implements the plugins.StorageProtocol interface via the hashicorp/go-plugins library.
|
Package pluginstore is an internal Porter package that implements the plugins.StorageProtocol interface via the hashicorp/go-plugins library. |
|
Test contains common test helpers used across packages in porter.
|
Test contains common test helpers used across packages in porter. |
Click to show internal directories.
Click to hide internal directories.