cmd

Documentation

Overview

Package cmd implements the command line commands qed and server.

Index

• Variables
• func Commands() [][]string
• func Open(url string) bool
• type BackupConfig
• type BugConfig
• type GenerateConfig
  • func GenerateDefaultConfig() *GenerateConfig
• type RestoreConfig

Variables

var (
	QedAuditorInstancesCount = prometheus.NewGauge(
		prometheus.GaugeOpts{
			Name: "qed_auditor_instances_count",
			Help: "Number of auditor agents running.",
		},
	)

	QedAuditorBatchesProcessSeconds = prometheus.NewSummary(
		prometheus.SummaryOpts{
			Name: "qed_auditor_batches_process_seconds",
			Help: "Duration of Auditor batch processing",
		},
	)

	QedAuditorBatchesReceivedTotal = prometheus.NewCounter(
		prometheus.CounterOpts{
			Name: "qed_auditor_batches_received_total",
			Help: "Number of batches received by auditors.",
		},
	)

	QedAuditorGetMembershipProofErrTotal = prometheus.NewCounter(
		prometheus.CounterOpts{
			Name: "qed_auditor_get_membership_proof_err_total",
			Help: "Number of errors trying to get membership proofs by auditors.",
		},
	)
)

var (
	QedMonitorInstancesCount = prometheus.NewGauge(
		prometheus.GaugeOpts{
			Name: "qed_monitor_instances_count",
			Help: "Number of monitor agents running.",
		},
	)

	QedMonitorBatchesReceivedTotal = prometheus.NewCounter(
		prometheus.CounterOpts{
			Name: "qed_monitor_batches_received_total",
			Help: "Number of batches received by monitors.",
		},
	)

	QedMonitorBatchesProcessSeconds = prometheus.NewSummary(
		prometheus.SummaryOpts{
			Name: "qed_monitor_batches_process_seconds",
			Help: "Duration of Monitor batch processing",
		},
	)

	QedMonitorGetIncrementalProofErrTotal = prometheus.NewCounter(
		prometheus.CounterOpts{
			Name: "qed_monitor_get_incremental_proof_err_total",
			Help: "Number of errors trying to get incremental proofs by monitors.",
		},
	)
)

var (
	QedPublisherInstancesCount = prometheus.NewGauge(
		prometheus.GaugeOpts{
			Name: "qed_publisher_instances_count",
			Help: "Number of publisher agents running.",
		},
	)

	QedPublisherBatchesReceivedTotal = prometheus.NewCounter(
		prometheus.CounterOpts{
			Name: "qed_publisher_batches_received_total",
			Help: "Number of batches received by publishers.",
		},
	)

	QedPublisherBatchesProcessSeconds = prometheus.NewSummary(
		prometheus.SummaryOpts{
			Name: "qed_publisher_batches_process_seconds",
			Help: "Duration of Publisher batch processing",
		},
	)
)

var Ctx context.Context = context.Background()

var Root *cobra.Command = &cobra.Command{
	Use:   "qed",
	Short: "QED system",
	Long:  "QED implements an authenticated data structure as an append-only log. This command exposes the QED components. Please refer to QED manual to learn about QED architecture and its components",

	SilenceUsage: true,
}

Functions

func Commands

func Commands() [][]string

Commands returns a list of commands to use to open a url.

func Open

func Open(url string) bool

Open tries to open url in a browser and reports its status.

Types

type BackupConfig

type BackupConfig struct {
	// Endpoint [host:port] to ask for QED management APIs.
	Endpoint string `desc:"QED Log service management endpoint http://ip:port"`

	// Log level
	Log string `desc:"Set log level to info, error or debug"`

	// ApiKey to query the server endpoint.
	APIKey string `desc:"Set API Key to talk to QED Log service"`
}

type BugConfig

type BugConfig struct {
	// Set non default issue description.
	Desc string `desc:"Write custom issue description"`
}

type GenerateConfig

type GenerateConfig struct {
	// Path to the private key file used to sign snapshots.
	Path string `desc:"Set custom output directory"`

	// DNSName or IPAddr for which the certificates will be generated.
	Host string `desc:"Set custom DNS name or IP address for new certificates"`
}

func GenerateDefaultConfig

func GenerateDefaultConfig() *GenerateConfig

type RestoreConfig

type RestoreConfig struct {
	// Path where backups are placed.
	BackupDir string `desc:"Path where backups are placed"`

	// Backup to restore.
	BackupID uint32 `desc:"Backup to restore."`

	// Path to restore a backup.
	RestorePath string `desc:"Path to restore a backup"`

	// Log level
	Log string `desc:"Set log level to info, error or debug"`
}