utils

Documentation

Index

• Variables
• func BackupFile(file string) error
• func CompilePolicy(name string, policyBytes []byte) (*circuitfactory.Circuit, *languagev1.Policy, error)
• func FetchPolicyFromCR(crPath string) (string, error)
• func GenerateDotFile(circuit *circuitfactory.Circuit, dotFilePath string, depth int) error
• func GenerateMermaidFile(circuit *circuitfactory.Circuit, mermaidFile string, depth int) error
• func GetControllerDeployment(kubeRestConfig *rest.Config, namespace string) (*appsv1.Deployment, error)
• func GetControllerNs() string
• func GetKubeConfig(kubeConfig string) (*rest.Config, error)
• func GetRelPath(dir string) string
• func GetSource(dir string) string
• func GetVersion(dir string) string
• func IsBlueprintDeprecated(policyDir string) (bool, string)
• func PullSource(dir, uri string) error
• func ReaderLock(dir string) error
• func ResolveLatestVersion() (string, error)
• func RestoreFile(file string)
• func Unlock(dir string)
• func ValidateWithJSONSchema(rootSchema string, schemas []string, documentFile string) error
• func WriterLock(dir string) error
• type Config
• type ControllerConfig
• type ControllerConn
  • func (c *ControllerConn) Client() (cmdv1.ControllerClient, error)
  • func (c *ControllerConn) GetKubeRestConfig() *rest.Config
  • func (c *ControllerConn) InitFlags(flags *flag.FlagSet)
  • func (c *ControllerConn) IsKube() bool
  • func (c *ControllerConn) PostRun(_ *cobra.Command, _ []string)
  • func (c *ControllerConn) PreRunE(_ *cobra.Command, _ []string) error

Variables

var AllowDeprecated = false

Functions

func BackupFile

func BackupFile(file string) error

BackupFile backs up a file. If backup exists, it will be restored first.

func CompilePolicy

func CompilePolicy(name string, policyBytes []byte) (*circuitfactory.Circuit, *languagev1.Policy, 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, depth int) error

GenerateDotFile generates a DOT file from the given circuit with the specified depth. The depth determines how many levels of components in the tree should be expanded in the graph. If maxDepth is set to -1, the function will expand components up to the maximum possible depth.

Parameters:

• circuit: A pointer to the circuitfactory.Circuit object to be used for generating the DOT file.
• dotFilePath: The file path where the generated DOT file should be saved.
• maxDepth: The maximum depth the graph should be expanded to. If set to -1, the function will expand components up to the maximum possible depth.

Returns:

• An error if any issues occur during the file creation or writing process, otherwise nil.

Example usage:

err := GenerateDotFile(circuit, "output.dot", 3)
// This will generate a DOT file with components expanded up to a depth of 3.

err := GenerateDotFile(circuit, "output.dot", -1)
// This will generate a DOT file with components expanded up to the maximum possible depth.

func GenerateMermaidFile

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

GenerateMermaidFile generates a Mermaid file from the given circuit with the specified depth. The depth determines how many levels of components in the tree should be expanded in the graph. If maxDepth is set to -1, the function will expand components up to the maximum possible depth.

Parameters:

• circuit: A pointer to the circuitfactory.Circuit object to be used for generating the Mermaid file.
• mermaidFile: The file path where the generated Mermaid file should be saved.
• maxDepth: The maximum depth the graph should be expanded to. If set to -1, the function will expand components up to the maximum possible depth.

Returns:

• An error if any issues occur during the file creation or writing process, otherwise nil.

Example usage:

err := GenerateMermaidFile(circuit, "output.mmd", 3)
// This will generate a Mermaid file with components expanded up to a depth of 3.

err := GenerateMermaidFile(circuit, "output.mmd", -1)
// This will generate a Mermaid file with components expanded up to the maximum possible depth.

func GetControllerDeployment

func GetControllerDeployment(kubeRestConfig *rest.Config, namespace string) (*appsv1.Deployment, error)

GetControllerDeployment returns the deployment of the Aperture Controller.

func GetControllerNs

func GetControllerNs() string

GetControllerNs returns namespace in which the Aperture Controller is running.

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 GetRelPath

func GetRelPath(dir string) string

GetRelPath returns the relative path to the dependency.

func GetSource

func GetSource(dir string) string

GetSource returns the source of the dependency.

func GetVersion

func GetVersion(dir string) string

GetVersion returns the version of the dependency.

func IsBlueprintDeprecated

func IsBlueprintDeprecated(policyDir string) (bool, string)

IsBlueprintDeprecated whether the policyDir is deprecated it reads metadata.yaml and checks for deprecated key the value of that key is the deprecation message.

func PullSource

func PullSource(dir, uri string) error

func ReaderLock

func ReaderLock(dir string) error

ReaderLock acquires a reader lock on the directory.

func ResolveLatestVersion

func ResolveLatestVersion() (string, error)

ResolveLatestVersion returns the latest release version of Aperture.

func RestoreFile

func RestoreFile(file string)

RestoreFile restores a file from its backup.

func Unlock

func Unlock(dir string)

Unlock releases the lock on the directory.

func ValidateWithJSONSchema

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

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

func WriterLock

func WriterLock(dir string) error

WriterLock acquires a writer lock on the directory.

Types

type Config

type Config struct {
	// When changing fields, remember to update docs/content/reference/configuration/aperturectl.md.
	Controller *ControllerConfig `toml:"controller"`
}

Config is the config file structure for Aperture.

type ControllerConfig

type ControllerConfig struct {
	// When changing fields, remember to update docs/content/reference/configuration/aperturectl.md.
	URL    string `toml:"url"`
	APIKey string `toml:"api_key"`
}

ControllerConfig is the config file structure for Aperture Cloud Controller.

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) GetKubeRestConfig

func (c *ControllerConn) GetKubeRestConfig() *rest.Config

GetKubeRestConfig returns kubeRestConfig.

func (*ControllerConn) InitFlags

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

InitFlags sets up flags for kubeRestConfig.

func (*ControllerConn) IsKube

func (c *ControllerConn) IsKube() bool

IsKube returns true if controller should be found in Kubernetes cluster.

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.