packageapi

Documentation

Overview

Package packageapi provides package-management-related API handlers.

Index

• func Handler(logger *slog.Logger, jobClient client.JobClient, signingKey string, ...) []func(e *echo.Echo)
• type Package
  • func New(logger *slog.Logger, jobClient client.JobClient) *Package
  • func (p *Package) DeleteNodePackage(ctx context.Context, request gen.DeleteNodePackageRequestObject) (gen.DeleteNodePackageResponseObject, error)
  • func (p *Package) GetNodePackage(ctx context.Context, request gen.GetNodePackageRequestObject) (gen.GetNodePackageResponseObject, error)
  • func (p *Package) GetNodePackageByName(ctx context.Context, request gen.GetNodePackageByNameRequestObject) (gen.GetNodePackageByNameResponseObject, error)
  • func (p *Package) GetNodePackageUpdate(ctx context.Context, request gen.GetNodePackageUpdateRequestObject) (gen.GetNodePackageUpdateResponseObject, error)
  • func (p *Package) PostNodePackage(ctx context.Context, request gen.PostNodePackageRequestObject) (gen.PostNodePackageResponseObject, error)
  • func (p *Package) PostNodePackageUpdate(ctx context.Context, request gen.PostNodePackageUpdateRequestObject) (gen.PostNodePackageUpdateResponseObject, error)

Functions

func Handler

func Handler(
	logger *slog.Logger,
	jobClient client.JobClient,
	signingKey string,
	customRoles map[string][]string,
) []func(e *echo.Echo)

Handler returns Package route registration functions.

Types

type Package

type Package struct {
	// JobClient provides job-based operations for package management.
	JobClient client.JobClient
	// contains filtered or unexported fields
}

Package implementation of the Package APIs operations.

func New

func New(
	logger *slog.Logger,
	jobClient client.JobClient,
) *Package

New factory to create a new instance.

func (*Package) DeleteNodePackage

func (p *Package) DeleteNodePackage(
	ctx context.Context,
	request gen.DeleteNodePackageRequestObject,
) (gen.DeleteNodePackageResponseObject, error)

DeleteNodePackage removes a package from a target node.

func (*Package) GetNodePackage

func (p *Package) GetNodePackage(
	ctx context.Context,
	request gen.GetNodePackageRequestObject,
) (gen.GetNodePackageResponseObject, error)

GetNodePackage lists all installed packages on a target node.

func (*Package) GetNodePackageByName

func (p *Package) GetNodePackageByName(
	ctx context.Context,
	request gen.GetNodePackageByNameRequestObject,
) (gen.GetNodePackageByNameResponseObject, error)

GetNodePackageByName gets a single package by name on a target node.

func (*Package) GetNodePackageUpdate

func (p *Package) GetNodePackageUpdate(
	ctx context.Context,
	request gen.GetNodePackageUpdateRequestObject,
) (gen.GetNodePackageUpdateResponseObject, error)

GetNodePackageUpdate lists available package updates on a target node.

func (*Package) PostNodePackage

func (p *Package) PostNodePackage(
	ctx context.Context,
	request gen.PostNodePackageRequestObject,
) (gen.PostNodePackageResponseObject, error)

PostNodePackage installs a package on a target node.

func (*Package) PostNodePackageUpdate

func (p *Package) PostNodePackageUpdate(
	ctx context.Context,
	request gen.PostNodePackageUpdateRequestObject,
) (gen.PostNodePackageUpdateResponseObject, error)

PostNodePackageUpdate refreshes package sources on a target node.