cli

Documentation

Overview

Package cli contains functionality for the command-line interface of the service. It provides commands for starting both the server and scheduler services.

Index

• type Arguments
  • func AddArguments(options ...Option) *Arguments
• type BlockUserCmd
  • func (c *BlockUserCmd) Run() error
• type ClearSchedulerCmd
  • func (c *ClearSchedulerCmd) Run(opts *Arguments) error
• type CreateIndexCmd
  • func (r *CreateIndexCmd) Run(opts *CreateIndexCmd) error
• type DataCmd
• type DeleteCmd
  • func (c *DeleteCmd) Run(opts *DeleteCmd) error
• type DeleteJobSchedulerCmd
  • func (c *DeleteJobSchedulerCmd) Run(opts *Arguments) error
• type DeleteUserCmd
  • func (c *DeleteUserCmd) Run() error
• type ElasticCmd
• type FeedCmd
• type FetchFeedCmd
  • func (c *FetchFeedCmd) Run() error
• type ILMCmd
• type IndicesCmd
• type InitSchedulerCmd
  • func (c *InitSchedulerCmd) Run(opts *Arguments) error
• type ListJobsSchedulerCmd
  • func (c *ListJobsSchedulerCmd) Run(opts *Arguments) error
• type MigrateIndexCmd
  • func (r *MigrateIndexCmd) Run(opts *MigrateIndexCmd) error
• type Option
  • func WithEnvironment(env string) Option
  • func WithLogger(logger *slog.Logger) Option
• type ResetFeedUpdatesCmd
  • func (c *ResetFeedUpdatesCmd) Run() error
• type RunSchedulerCmd
  • func (c *RunSchedulerCmd) Run(opts *Arguments) error
• type SchedulerCmd
• type ServeCmd
  • func (r *ServeCmd) Run(opts *Arguments) error
• type UpdateILMPoliciesCmd
  • func (r *UpdateILMPoliciesCmd) Run(opts *UpdateILMPoliciesCmd) error
• type UpdateIndexSchemaCmd
  • func (r *UpdateIndexSchemaCmd) Run(opts *UpdateIndexSchemaCmd) error
• type UserArgs
• type UserCmd

Types

type Arguments

type Arguments struct {
	// Logger is a logger that the command can use.
	Logger *slog.Logger
	// StaticContent is an embedded filesystem containing static files.
	StaticContent embed.FS
	// Environment is the running environment for the application.
	Environment string
}

Arguments are the common options for commands.

func AddArguments

func AddArguments(options ...Option) *Arguments

AddArguments generates command-line arguments from the given options.

type BlockUserCmd

type BlockUserCmd struct {
	UserArgs

	Value bool `help:"Block status."`
}

func (*BlockUserCmd) Run

func (c *BlockUserCmd) Run() error

type ClearSchedulerCmd

type ClearSchedulerCmd struct{}

ClearSchedulerCmd is a cli command for clearing the scheduled jobs queue.

func (*ClearSchedulerCmd) Run

func (c *ClearSchedulerCmd) Run(opts *Arguments) error

Run runs the clear command that will remove all scheduled jobs.

type CreateIndexCmd

type CreateIndexCmd struct {
	schema.IndicesOptions
}

func (*CreateIndexCmd) Run

func (r *CreateIndexCmd) Run(opts *CreateIndexCmd) error

type DataCmd

type DataCmd struct {
	Delete DeleteCmd `cmd:"delete" help:"Delete objects"`
}

DataCmd defines the `data` command, which contains commands for manipulating data.

type DeleteCmd

type DeleteCmd struct {
	ObjectID string `arg:"" help:"ID of object to delete"`
}

func (*DeleteCmd) Run

func (c *DeleteCmd) Run(opts *DeleteCmd) error

type DeleteJobSchedulerCmd

type DeleteJobSchedulerCmd struct {
	ID    string `arg:"" help:"The job ID."`
	Group string `arg:"" help:"The job group (optional)." optional:""`
}

DeleteJobSchedulerCmd is a cli command for deleting a scheduled job.

func (*DeleteJobSchedulerCmd) Run

func (c *DeleteJobSchedulerCmd) Run(opts *Arguments) error

Run runs the delete-job scheduler command.

type DeleteUserCmd

type DeleteUserCmd struct {
	UserArgs
}

func (*DeleteUserCmd) Run

func (c *DeleteUserCmd) Run() error

type ElasticCmd

type ElasticCmd struct {
	Indices IndicesCmd `cmd:"indices" help:"Perform operations on indices."`
	ILM     ILMCmd     `cmd:"ilm"     help:"Perform ILM operations."`
}

ElasticCmd contains commands for manipulating Elasticsearch.

type FeedCmd

type FeedCmd struct {
	Fetch        FetchFeedCmd        `cmd:"fetch"         help:"fetch a feed (by either URL or ID)"`
	ResetUpdates ResetFeedUpdatesCmd `cmd:"reset-updates" help:"reset the feed updates job"`
}

FeedCmd contains sub commands for interacting with feeds.

type FetchFeedCmd

type FetchFeedCmd struct {
	FeedID   models.FeedID `help:"ID of feed"`
	FeedURL  string        `help:"URL of feed"`
	Validate bool          `help:"validate the feed" default:"false"`
}

FetchFeedCmd is a command that will fetch a feed, by either URL or its Feed ID.

func (*FetchFeedCmd) Run

func (c *FetchFeedCmd) Run() error

Run performs the operations for fetching feed details.

type ILMCmd

type ILMCmd struct {
	Update UpdateILMPoliciesCmd `cmd:"update" help:"Update ILM policies."`
}

type IndicesCmd

type IndicesCmd struct {
	Update  UpdateIndexSchemaCmd `cmd:"update"  help:"Update schema(s)"`
	Migrate MigrateIndexCmd      `cmd:"migrate" help:"Migrate data"`
	Create  CreateIndexCmd       `cmd:"create"  help:"Create indices"`
}

IndicesCmd contains commands for manipulating Elasticsearch indices.

type InitSchedulerCmd

type InitSchedulerCmd struct{}

InitSchedulerCmd is a cli command to init the scheduler backend (for a new installation), without starting the scheduler.

func (*InitSchedulerCmd) Run

func (c *InitSchedulerCmd) Run(opts *Arguments) error

Run runs the clear command that will remove all scheduled jobs.

type ListJobsSchedulerCmd

type ListJobsSchedulerCmd struct{}

ListJobsSchedulerCmd is a cli command for listing all scheduled jobs.

func (*ListJobsSchedulerCmd) Run

func (c *ListJobsSchedulerCmd) Run(opts *Arguments) error

Run runs the clear command that will remove all scheduled jobs.

type MigrateIndexCmd

type MigrateIndexCmd struct {
	schema.IndicesOptions
}

func (*MigrateIndexCmd) Run

func (r *MigrateIndexCmd) Run(opts *MigrateIndexCmd) error

type Option

type Option func(*Arguments) *Arguments

Option is a functional option for the command-line.

func WithEnvironment

func WithEnvironment(env string) Option

WithEnvironment option sets the environment for the command.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger defines a logger for a command.

type ResetFeedUpdatesCmd

type ResetFeedUpdatesCmd struct {
	FeedID models.FeedID `help:"ID of feed"`
}

ResetFeedUpdatesCmd is a cli command to reset the updates for a feed. It will reset the last_fetched timestamp on the feed and delete any scheduled job for feed updates.

func (*ResetFeedUpdatesCmd) Run

func (c *ResetFeedUpdatesCmd) Run() error

Run performs the operations for resetting feed updates.

type RunSchedulerCmd

type RunSchedulerCmd struct{}

RunSchedulerCmd is a cli command for running the scheduler component.

func (*RunSchedulerCmd) Run

func (c *RunSchedulerCmd) Run(opts *Arguments) error

Run contains logic for setup and execution of the scheduler.

type SchedulerCmd

type SchedulerCmd struct {
	Run       RunSchedulerCmd       `cmd:"run"        help:"Run scheduler."`
	Clear     ClearSchedulerCmd     `cmd:"clear"      help:"Clear all jobs."`
	Init      InitSchedulerCmd      `cmd:"init"       help:"Initialise the scheduler/queue."`
	ListJobs  ListJobsSchedulerCmd  `cmd:"list-jobs"  help:"List all jobs."`
	DeleteJob DeleteJobSchedulerCmd `cmd:"delete-job" help:"Job related commands."`
}

SchedulerCmd defines the `scheduler` command, for performing job scheduler related actions.

type ServeCmd

type ServeCmd struct{}

ServeCmd defines the `server` command for running the server.

func (*ServeCmd) Run

func (r *ServeCmd) Run(opts *Arguments) error

Run performs setup and execution for the server command.

type UpdateILMPoliciesCmd

type UpdateILMPoliciesCmd struct {
	schema.ILMOptions
}

func (*UpdateILMPoliciesCmd) Run

func (r *UpdateILMPoliciesCmd) Run(opts *UpdateILMPoliciesCmd) error

type UpdateIndexSchemaCmd

type UpdateIndexSchemaCmd struct {
	schema.IndicesOptions
}

func (*UpdateIndexSchemaCmd) Run

func (r *UpdateIndexSchemaCmd) Run(opts *UpdateIndexSchemaCmd) error

type UserArgs

type UserArgs struct {
	UserID models.UserID `arg:"" help:"ID of object to delete"`
}

type UserCmd

type UserCmd struct {
	Delete DeleteUserCmd `cmd:"delete" help:"Delete user"`
	Block  BlockUserCmd  `cmd:"delete" help:"Block user"`
}

UserCmd contains sub commands for managing users.