Porter CredentialSet File Format 1.0.1

Porter CredentialSet File Format 1.0.1

Credential Sets can be defined in either json or yaml. You can use this json schema to validate a credential set file.

Supported Versions

Below are schema versions for credential sets, and the corresponding Porter version that supports it.

Schema Type Schema Version Porter Version
CredentialSet (none) v0.38.*
CredentialSet 1.0.1 v1.0.0-alpha.1+

Sometimes you may want to work with a different version of a resource than what is supported by Porter, especially when migrating from one version of Porter to another. The schema-check configuration setting allows you to change how Porter behaves when the schemaVersion of a resource doesn’t match Porter’s supported version.


schemaType: CredentialSet
schemaVersion: 1.0.1
name: mycreds
namespace: staging
  team: redteam
  owner: xianglu
  - name: token
      env: GITHUB_TOKEN
  - name: kubeconfig
      path: $HOME/.kube/config
  - name: connStr
      secret: my-connection-string
Field Required Description
schemaType false The type of document.
schemaVersion true The version of the Credential Set schema used in this file.
name true The name of the credential set.
namespace false The namespace in which the credential set is defined. Defaults to the empty (global) namespace.
labels false A set of key-value pairs associated with the credential set.
credentials true A list of credentials and instructions for Porter to resolve the credential value.
credentials.name true The name of the credential as defined in the bundle.
credentials.source true Specifies how the credential should be resolved. Must have only one child property:
secret, value, env, path, or command