spire

Documentation

Index

• func GetBundle(ctx context.Context, client *kubeutil.Client) (*types.Bundle, error)
• func GetRegistrationEntries(ctx context.Context, client *kubeutil.Client) (map[string]*RegisteredEntry, error)
• func GetServerCABundleAndFederatedBundles(ctx context.Context, client *kubeutil.Client) (string, map[string]string, error)
• func WaitForServerIP(ctx context.Context, client *kubeutil.Client) (string, error)
• type Agent
• type AgentStatus
  • func GetAgentStatus(ctx context.Context, client *kubeutil.Client) (*AgentStatus, error)
• type RegisteredEntry
• type SCMContainer
• type ServerContainer
• type ServerStatus
  • func GetServerStatus(ctx context.Context, client *kubeutil.Client) (*ServerStatus, error)

Functions

func GetBundle

func GetBundle(ctx context.Context, client *kubeutil.Client) (*types.Bundle, error)

GetBundle retrieves a SPIFFE bundle for the local trust zone by exec'ing into a SPIRE Server.

func GetRegistrationEntries

func GetRegistrationEntries(ctx context.Context, client *kubeutil.Client) (map[string]*RegisteredEntry, error)

func GetServerCABundleAndFederatedBundles

func GetServerCABundleAndFederatedBundles(ctx context.Context, client *kubeutil.Client) (string, map[string]string, error)

GetServerCABundleAndFederatedBundles retrieves the server CA bundle (i.e. bundle of the host) and any available federated bundles from the SPIRE server, in order to do a federation health check

func WaitForServerIP

func WaitForServerIP(ctx context.Context, client *kubeutil.Client) (string, error)

WaitForServerIP waits for a SPIRE server pod and service to become ready, then returns the external IP of the service.

Types

type Agent

type Agent struct {
	Name            string
	Status          string
	Id              string
	AttestationType string
	ExpirationTime  time.Time
	Serial          string
	CanReattest     bool
}

Agent contains status information about a running SPIRE agent.

type AgentStatus

type AgentStatus struct {
	Expected int
	Ready    int
	Agents   []Agent
}

AgentStatus contains status information about a running cluster of SPIRE agents.

func GetAgentStatus

func GetAgentStatus(ctx context.Context, client *kubeutil.Client) (*AgentStatus, error)

GetAgentStatus queries a SPIRE server for the status of agents attested to it and returns an `*AgentStatus`.

type RegisteredEntry

type RegisteredEntry struct {
	Id string
}

RegisteredEntry contains details of a workload registered with SPIRE

type SCMContainer

type SCMContainer struct {
	Name  string
	Ready bool
}

SCMContainer contains status information about a running SPIRE controller manager container.

type ServerContainer

type ServerContainer struct {
	Name  string
	Ready bool
}

ServerContainer contains status information about a running SPIRE server container.

type ServerStatus

type ServerStatus struct {
	Replicas      int
	ReadyReplicas int
	Containers    []ServerContainer
	SCMs          []SCMContainer
}

ServerStatus contains status information about a running SPIRE server cluster.

func GetServerStatus

func GetServerStatus(ctx context.Context, client *kubeutil.Client) (*ServerStatus, error)

GetServerStatus queries the status of a SPIRE server and returns a `*ServerStatus`.