Documentation
¶
Overview ¶
Package cmd provides CLI commands for OSAPI.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ServerManager ¶
type ServerManager interface {
cli.Lifecycle
// GetAgentHandler returns agent handler for registration.
GetAgentHandler(jobClient jobclient.JobClient) []func(e *echo.Echo)
// GetNodeHandler returns node handler for registration.
GetNodeHandler(jobClient jobclient.JobClient) []func(e *echo.Echo)
// GetJobHandler returns job handler for registration.
GetJobHandler(jobClient jobclient.JobClient) []func(e *echo.Echo)
// GetHealthHandler returns health handler for registration.
GetHealthHandler(
checker health.Checker,
startTime time.Time,
version string,
metrics health.MetricsProvider,
) []func(e *echo.Echo)
// GetMetricsHandler returns Prometheus metrics handler for registration.
GetMetricsHandler(metricsHandler http.Handler, path string) []func(e *echo.Echo)
// GetAuditHandler returns audit handler for registration.
GetAuditHandler(store audit.Store) []func(e *echo.Echo)
// RegisterHandlers registers a list of handlers with the Echo instance.
RegisterHandlers(handlers []func(e *echo.Echo))
}
ServerManager responsible for Server operations.
type TokenGenerator ¶
type TokenGenerator interface {
Generate(
signingKey string,
roles []string,
subject string,
permissions []string,
) (string, error)
}
TokenGenerator generates signed JWT tokens.
type TokenValidator ¶
type TokenValidator interface {
Validate(
tokenString string,
signingKey string,
) (*authtoken.CustomClaims, error)
}
TokenValidator parses and validates JWT tokens.
Source Files
¶
- agent.go
- agent_helpers.go
- agent_start.go
- api.go
- api_helpers.go
- api_server.go
- api_server_start.go
- client.go
- client_agent.go
- client_agent_get.go
- client_agent_list.go
- client_audit.go
- client_audit_export.go
- client_audit_get.go
- client_audit_list.go
- client_health.go
- client_health_ready.go
- client_health_status.go
- client_job.go
- client_job_add.go
- client_job_delete.go
- client_job_get.go
- client_job_list.go
- client_job_retry.go
- client_job_run.go
- client_job_status.go
- client_metrics.go
- client_node.go
- client_node_command.go
- client_node_command_exec.go
- client_node_command_shell.go
- client_node_hostname_get.go
- client_node_network.go
- client_node_network_dns.go
- client_node_network_dns_get.go
- client_node_network_dns_update.go
- client_node_network_ping.go
- client_node_status_get.go
- job.go
- nats.go
- nats_helpers.go
- nats_server.go
- nats_server_start.go
- root.go
- start.go
- token.go
- token_generate.go
- token_validate.go
Click to show internal directories.
Click to hide internal directories.