utils

Documentation

Index

• func CompilePolicy(path string) (*circuitfactory.Circuit, error)
• func FetchPolicyFromCR(crPath string) (string, error)
• func GenerateDotFile(circuit *circuitfactory.Circuit, dotFilePath string) error
• func GenerateMermaidFile(circuit *circuitfactory.Circuit, mermaidFile string) error
• func GetKubeConfig(kubeConfig string) (*rest.Config, error)
• func ResolveLatestVersion() (string, error)
• func ValidateWithJSONSchema(rootSchema string, schemas []string, documentFile string) error
• type ControllerConn
  • func (c *ControllerConn) Client() (cmdv1.ControllerClient, error)
  • func (c *ControllerConn) InitFlags(flags *flag.FlagSet)
  • func (c *ControllerConn) PostRun(_ *cobra.Command, _ []string)
  • func (c *ControllerConn) PreRunE(_ *cobra.Command, _ []string) error

Functions

func CompilePolicy

func CompilePolicy(path string) (*circuitfactory.Circuit, error)

CompilePolicy compiles the policy and returns the circuit.

func FetchPolicyFromCR

func FetchPolicyFromCR(crPath string) (string, error)

FetchPolicyFromCR extracts the spec key from a CR and saves it to a temp file.

func GenerateDotFile

func GenerateDotFile(circuit *circuitfactory.Circuit, dotFilePath string) error

GenerateDotFile generates a DOT file from the circuit.

func GenerateMermaidFile

func GenerateMermaidFile(circuit *circuitfactory.Circuit, mermaidFile string) error

GenerateMermaidFile generates a mermaid file from the circuit.

func GetKubeConfig

func GetKubeConfig(kubeConfig string) (*rest.Config, error)

GetKubeConfig prepares Kubernetes config to connect with the cluster using provided or default kube config file location.

func ResolveLatestVersion

func ResolveLatestVersion() (string, error)

ResolveLatestVersion returns the latest release version of Aperture.

func ValidateWithJSONSchema

func ValidateWithJSONSchema(rootSchema string, schemas []string, documentFile string) error

ValidateWithJSONSchema validates the given document (YAML) against the given JSON schema.

Types

type ControllerConn

type ControllerConn struct {
	// contains filtered or unexported fields
}

ControllerConn manages flags for connecting to controller – either via address or kubeconfig.

func (*ControllerConn) Client

func (c *ControllerConn) Client() (cmdv1.ControllerClient, error)

Client returns Controller Client, connecting to controller if not yet connected.

func (*ControllerConn) InitFlags

func (c *ControllerConn) InitFlags(flags *flag.FlagSet)

InitFlags sets up flags for kubeRestConfig.

func (*ControllerConn) PostRun

func (c *ControllerConn) PostRun(_ *cobra.Command, _ []string)

PostRun cleans up ControllerConn's resources, and should be run at PostRun stage.

func (*ControllerConn) PreRunE

func (c *ControllerConn) PreRunE(_ *cobra.Command, _ []string) error

PreRunE verifies flags (optionally loading kubeconfig) and should be run at PreRunE stage.