spire

Documentation

Overview

Package spire provides two simple functions:

• Start to start a SpireServer/SpireAgent for local testing
• AddEntry to add entries into the spire server

Index

• func AddEntry(ctx context.Context, parentID, spiffeID, selector, federatesWith string) error
• func PeerSpiffeIDFromContext(ctx context.Context) (spiffeid.ID, error)
• func Start(options ...Option) <-chan error
• type Option
  • func WithAgentConfig(conf string) Option
  • func WithAgentID(agentID string) Option
  • func WithContext(ctx context.Context) Option
  • func WithEntry(spiffeID, selector string) Option
  • func WithFederatedEntry(spiffeID, selector, federatesWith string) Option
  • func WithRoot(root string) Option
  • func WithServerConfig(conf string) Option

Functions

func AddEntry

func AddEntry(ctx context.Context, parentID, spiffeID, selector, federatesWith string) error

AddEntry - adds an entry to the spire server for parentID, spiffeID, and selector

parentID is usually the same as the agentID provided to Start()

func PeerSpiffeIDFromContext

func PeerSpiffeIDFromContext(ctx context.Context) (spiffeid.ID, error)

PeerSpiffeIDFromContext - returns spiffe ID of the service from the peer context

func Start

func Start(options ...Option) <-chan error

Start - start a spire-server and spire-agent with the given agentId

Types

type Option

type Option func(*option)

Option for spire

func WithAgentConfig

func WithAgentConfig(conf string) Option

WithAgentConfig - adds agent config

func WithAgentID

func WithAgentID(agentID string) Option

WithAgentID - agentID for starting spire

func WithContext

func WithContext(ctx context.Context) Option

WithContext - use ctx as context for starting spire

func WithEntry

func WithEntry(spiffeID, selector string) Option

WithEntry - Option to add Entry to spire-server. May be used multiple times.

func WithFederatedEntry

func WithFederatedEntry(spiffeID, selector, federatesWith string) Option

WithFederatedEntry - Option to add federated Entry to spire-server. May be used multiple times.

func WithRoot

func WithRoot(root string) Option

WithRoot - sets root folder

func WithServerConfig

func WithServerConfig(conf string) Option

WithServerConfig - adds server config