secretparameter

README

Secret Parameter Plugin for Smith

This takes ServiceBindings or explicit Secret dependencies, and converts them into a form acceptable to parametersFrom in Service Catalog.

e.g. a ServiceBinding with a smith resource name of my-binding produces a secret like so:

Secret:
  myVar: x

And with a plugin spec of:

plugin:
  spec:
    mapping:
      my-binding: # <-- name of Smith resource
        myVar: myComputeInputVar

we end up with:

Secret: my-binding: > {"myComputeInputVar": "x"}

This plugin will error out if the mapping is not possible in any way (i.e. there is no my-binding amongst the dependencies, OR there is no myVar in the secret generated by my-binding).

For a slightly more real example, see the examples directory.

Running

This is run by adding it as a Smith plugin. See cmd/smith/main.go, or run:

make run-smith-sc-minikube

Documentation

Index

• func New() (smith_plugin.Plugin, error)
• type Plugin
  • func (p *Plugin) Describe() *smith_plugin.Description
  • func (p *Plugin) Process(rawSpec map[string]interface{}, context *smith_plugin.Context) smith_plugin.ProcessResult
• type Spec

Functions

func New

func New() (smith_plugin.Plugin, error)

Types

type Plugin

type Plugin struct{}

func (*Plugin) Describe

func (p *Plugin) Describe() *smith_plugin.Description

func (*Plugin) Process

func (p *Plugin) Process(rawSpec map[string]interface{}, context *smith_plugin.Context) smith_plugin.ProcessResult

type Spec

type Spec struct {
	// double map should be read as:
	//   map the secret contents of a particular smith resource into the SC parameter format
	//   according to the map[string]string, where LHS original naming -> RHS parameter naming
	//   If a secret key is not in the map, it is ignored.
	// See README.md for an example.
	Mapping map[smith_v1.ResourceName]map[string]string `json:"mapping"`
}