utils

package
v2.17.0-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 25, 2023 License: Apache-2.0 Imports: 48 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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 added in v2.1.1 

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 GetPolicies added in v2.16.0 

func GetPolicies(policyDir string) ([]string, error)

GetPolicies returns path of valid files having a valid Aperture Policy .

func GetPolicy added in v2.16.0 

func GetPolicy(policyFile string) (*languagev1.Policy, string, error)

func GetPolicyCR added in v2.16.0 

func GetPolicyCR(policyFile string) (*policyv1alpha1.Policy, error)

func GetPolicyTUIModel added in v2.16.0 

func GetPolicyTUIModel(policyDir string, selectAll bool) ([]string, *tui.CheckBoxModel, error)

GetPolicyTUIModel prepares the TUI model for selecting policies to apply from the given directory path.

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 RestoreFile 

func RestoreFile(file string)

RestoreFile restores a file from its backup.

func ValidateWithJSONSchema 

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

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

Types

type Config added in v2.10.0 

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 added in v2.10.0 

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) GetKubeRestConfig added in v2.1.1 

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) IntrospectionClient added in v2.16.0 

func (c *ControllerConn) IntrospectionClient() (IntrospectionClient, error)

client returns Controller IntrospectionClient, connecting to controller if not yet connected.

func (*ControllerConn) IsKube added in v2.1.1 

func (c *ControllerConn) IsKube() bool

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

func (*ControllerConn) PolicyClient added in v2.16.0 

func (c *ControllerConn) PolicyClient() (PolicyClient, error)

client returns Controller PolicyClient, connecting to controller if not yet connected.

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.

func (*ControllerConn) StatusClient added in v2.16.0 

func (c *ControllerConn) StatusClient() (StatusClient, error)

client returns Controller StatusClient, connecting to controller if not yet connected.

type IntrospectionClient added in v2.16.0 

type IntrospectionClient interface {
	ListAgents(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*cmdv1.ListAgentsResponse, error)
	// Seems to be unimplemented on the controller at all?!
	ListServices(ctx context.Context, in *cmdv1.ListServicesRequest, opts ...grpc.CallOption) (*cmdv1.ListServicesControllerResponse, error)
	ListFlowControlPoints(ctx context.Context, in *cmdv1.ListFlowControlPointsRequest, opts ...grpc.CallOption) (*cmdv1.ListFlowControlPointsControllerResponse, error)
	ListAutoScaleControlPoints(ctx context.Context, in *cmdv1.ListAutoScaleControlPointsRequest, opts ...grpc.CallOption) (*cmdv1.ListAutoScaleControlPointsControllerResponse, error)
	ListDiscoveryEntities(ctx context.Context, in *cmdv1.ListDiscoveryEntitiesRequest, opts ...grpc.CallOption) (*cmdv1.ListDiscoveryEntitiesControllerResponse, error)
	ListDiscoveryEntity(ctx context.Context, in *cmdv1.ListDiscoveryEntityRequest, opts ...grpc.CallOption) (*cmdv1.ListDiscoveryEntityAgentResponse, error)
	PreviewFlowLabels(ctx context.Context, in *cmdv1.PreviewFlowLabelsRequest, opts ...grpc.CallOption) (*cmdv1.PreviewFlowLabelsControllerResponse, error)
	PreviewHTTPRequests(ctx context.Context, in *cmdv1.PreviewHTTPRequestsRequest, opts ...grpc.CallOption) (*cmdv1.PreviewHTTPRequestsControllerResponse, error)
}

IntrospectionClient is a subset of cmdv1.ControllerClient that covers APIs that need controller to grab information from agents via reverse rpc.

These are currently not supported for the cloud controller.

FIXME: Perhaps it'd be better to split the service on proto level (keep backcompat in mind).

type PolicyClient added in v2.16.0 

type PolicyClient interface {
	ListPolicies(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*v1.GetPoliciesResponse, error)
	UpsertPolicy(ctx context.Context, in *v1.UpsertPolicyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	PostDynamicConfig(ctx context.Context, in *v1.PostDynamicConfigRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	DeletePolicy(ctx context.Context, in *v1.DeletePolicyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	GetDecisions(ctx context.Context, in *v1.GetDecisionsRequest, opts ...grpc.CallOption) (*v1.GetDecisionsResponse, error)
}

PolicyClient is a subset of cmdv1.ControllerClient that covers APIs related to policies.

FIXME: Perhaps it'd be better to split the service on proto level (keep backcompat in mind).

type StatusClient added in v2.16.0 

type StatusClient interface {
	GetStatus(ctx context.Context, in *v11.GroupStatusRequest, opts ...grpc.CallOption) (*v11.GroupStatus, error)
}

StatusClient is a subset of cmdv1.ControllerClient that covers APIs related to status.

FIXME: Perhaps it'd be better to split the service on proto level (keep backcompat in mind).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.