heimdall

package

v1.9.5 Latest Latest Go to latest Published: Oct 16, 2026 License: Apache-2.0 Imports: 42 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/patterninc/heimdall

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Heimdall
- func (h *Heimdall) Init() error
- func (h *Heimdall) Start() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCommandClusterPairNotFound = fmt.Errorf(`command-cluster pair is not found`)
	ErrJobCancelFailed            = fmt.Errorf(`async job unrecognized or already in final state`)
	ErrCallerNotAllowed           = fmt.Errorf(`caller is not allowed to run this command`)
	ErrResultNotReady             = fmt.Errorf(`result is not available until the job has succeeded`)
)

View Source

var (
	ErrUnknownJobID  = fmt.Errorf(`unknown job_id`)
	ErrInvalidCursor = fmt.Errorf(`invalid pagination cursor`)
)

View Source

var (
	ErrNoCaller = fmt.Errorf(`cannot identify caller -- access denied`)
)

View Source

var (
	ErrUnknownClusterID = fmt.Errorf(`unknown cluster_id`)
)

View Source

var (
	ErrUnknownCommandID = fmt.Errorf(`unknown command_id`)
)

Functions ¶

This section is empty.

Types ¶

type Heimdall ¶

type Heimdall struct {
	Server               *server.Server       `yaml:"server,omitempty" json:"server,omitempty"`
	Commands             command.Commands     `yaml:"commands,omitempty" json:"commands,omitempty"`
	Clusters             cluster.Clusters     `yaml:"clusters,omitempty" json:"clusters,omitempty"`
	RBACs                rbac.RBACs           `yaml:"rbacs,omitempty" json:"rbacs,omitempty"`
	JobsDirectory        string               `yaml:"jobs_directory,omitempty" json:"jobs_directory,omitempty"`
	ArchiveDirectory     string               `yaml:"archive_directory,omitempty" json:"archive_directory,omitempty"`
	ResultDirectory      string               `yaml:"result_directory,omitempty" json:"result_directory,omitempty"`
	PluginsDirectory     string               `yaml:"plugin_directory,omitempty" json:"plugin_directory,omitempty"`
	Database             *database.Database   `yaml:"database,omitempty" json:"database,omitempty"`
	Pool                 *pool.Pool[*job.Job] `yaml:"pool,omitempty" json:"pool,omitempty"`
	Auth                 *auth.Auth           `yaml:"auth,omitempty" json:"auth,omitempty"`
	Janitor              *janitor.Janitor     `yaml:"janitor,omitempty" json:"janitor,omitempty"`
	HealthCheck          *healthCheckConfig   `yaml:"health_check,omitempty" json:"health_check,omitempty"`
	SensitiveContextKeys []string             `yaml:"sensitive_context_keys,omitempty" json:"sensitive_context_keys,omitempty"`
	Version              string               `yaml:"-" json:"-"`
	// contains filtered or unexported fields
}

func (*Heimdall) Init ¶

func (h *Heimdall) Init() error

func (*Heimdall) Start ¶

func (h *Heimdall) Start() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL