Documentation
¶
Index ¶
- Constants
- Variables
- func SetContext(c context.Context)
- func SetLogger(l Logger)
- func SetVersion(v string)
- func ValidStyles() []string
- type ActTLSCmd
- type Logger
- type Options
- type SchemaValidator
- type SrvCheckCmd
- type SrvClusterCmd
- type SrvConfigCmd
- type SrvInfoCmd
- type SrvLsCmd
- type SrvMappingCmd
- type SrvPasswdCmd
- type SrvPingCmd
- type SrvReportCmd
- type SrvRequestCmd
- type SrvRunCmd
- type SrvRunConfig
- type SrvWatchAccountCmd
- type SrvWatchJSCmd
- type SrvWatchServerCmd
Constants ¶
View Source
const ( Skipped auditCheckOutcome = iota Pass Fail SomeIssues )
View Source
const ( DefaultDurableConsumerName string = "natscli-bench" DefaultStreamName string = "benchstream" DefaultBucketName string = "benchbucket" )
Variables ¶
View Source
var SkipContexts bool
SkipContexts used during tests
View Source
var (
Version = "development"
)
Functions ¶
func SetVersion ¶
func SetVersion(v string)
func ValidStyles ¶
func ValidStyles() []string
ValidStyles are valid color styles this package supports
Types ¶
type Logger ¶
type Logger interface {
Printf(format string, a ...any)
Fatalf(format string, a ...any)
Print(a ...any)
Fatal(a ...any)
Println(a ...any)
}
Logger provides a pluggable logger implementation
type Options ¶
type Options struct {
// Config is a nats configuration context
Config *natscontext.Context
// Servers is the list of servers to connect to
Servers string
// Creds is nats credentials to authenticate with
Creds string
// TlsCert is the TLS Public Certificate
TlsCert string
// TlsKey is the TLS Private Key
TlsKey string
// TlsCA is the certificate authority to verify the connection with
TlsCA string
// Timeout is how long to wait for operations
Timeout time.Duration
// ConnectionName is the name to use for the underlying NATS connection
ConnectionName string
// Username is the username or token to connect with
Username string
// Password is the password to connect with
Password string
// Nkey is the file holding a nkey to connect with
Nkey string
// JsApiPrefix is the JetStream API prefix
JsApiPrefix string
// JsEventPrefix is the JetStream events prefix
JsEventPrefix string
// JsDomain is the domain to connect to
JsDomain string
// CfgCtx is the context name to use
CfgCtx string
// Trace enables verbose debug logging
Trace bool
// Customer inbox Prefix
InboxPrefix string
// Conn sets a prepared connect to connect with
Conn *nats.Conn
// Mgr sets a prepared jsm Manager to use for JetStream access
Mgr *jsm.Manager
// JSc is a prepared NATS JetStream context to use for KV and Object access
JSc nats.JetStreamContext
// Disables registering of CLI cheats
NoCheats bool
// PrometheusNamespace is the namespace to use for prometheus format output in server check
PrometheusNamespace string
// SocksProxy is a SOCKS5 proxy to use for NATS connections
SocksProxy string
// ColorScheme influence table colors and more based on ValidStyles()
ColorScheme string
// TlsFirst configures the TLSHandshakeFirst behavior in nats.go
TlsFirst bool
// WinCertStoreType enables windows cert store - user or machine
WinCertStoreType string
// WinCertStoreMatchBy configures how to search for certs when using match - subject or issuer
WinCertStoreMatchBy string
// WinCertStoreMatch is the query to match with
WinCertStoreMatch string
// WinCertCaStoreMatch is the queries for CAs to use
WinCertCaStoreMatch []string
}
Options configure the CLI
func ConfigureInApp ¶
func ConfigureInApp(app *fisk.Application, cliOpts *Options, prepare bool, disable ...string) (*Options, error)
ConfigureInApp attaches the cli commands to app, prepare will load the context on demand and should be true unless override nats, manager and js context is given in a custom PreAction in the caller. Disable is a list of command names to skip.
func ConfigureInCommand ¶
func ConfigureInCommand(cmd *fisk.CmdClause, cliOpts *Options, prepare bool, disable ...string) (*Options, error)
ConfigureInCommand attaches the cli commands to cmd, prepare will load the context on demand and should be true unless override nats, manager and js context is given in a custom PreAction in the caller. Disable is a list of command names to skip.
type SchemaValidator ¶
type SchemaValidator struct{}
func (SchemaValidator) ValidateStruct ¶
func (v SchemaValidator) ValidateStruct(data any, schemaType string) (ok bool, errs []string)
type SrvCheckCmd ¶
type SrvCheckCmd struct {
// contains filtered or unexported fields
}
type SrvClusterCmd ¶
type SrvClusterCmd struct {
// contains filtered or unexported fields
}
type SrvConfigCmd ¶
type SrvConfigCmd struct {
// contains filtered or unexported fields
}
type SrvInfoCmd ¶
type SrvInfoCmd struct {
// contains filtered or unexported fields
}
type SrvMappingCmd ¶
type SrvMappingCmd struct {
// contains filtered or unexported fields
}
type SrvPasswdCmd ¶
type SrvPasswdCmd struct {
// contains filtered or unexported fields
}
type SrvPingCmd ¶
type SrvPingCmd struct {
// contains filtered or unexported fields
}
type SrvReportCmd ¶
type SrvReportCmd struct {
// contains filtered or unexported fields
}
type SrvRequestCmd ¶
type SrvRequestCmd struct {
// contains filtered or unexported fields
}
type SrvRunConfig ¶
type SrvRunConfig struct {
Name string
Port string
UserPassword string
UserPasswordCrypt string
ServicePassword string
ServicePasswordCrypt string
SystemPassword string
SystemPasswordCrypt string
ExtendDemoNetwork bool
ExtendWithContext bool
JetStream bool
JSDomain string
Verbose bool
Debug bool
StoreDir string
Clean bool
MonitorPort int
Context *natscontext.Context
}
type SrvWatchAccountCmd ¶
type SrvWatchAccountCmd struct {
// contains filtered or unexported fields
}
type SrvWatchJSCmd ¶
type SrvWatchJSCmd struct {
// contains filtered or unexported fields
}
type SrvWatchServerCmd ¶
type SrvWatchServerCmd struct {
// contains filtered or unexported fields
}
Source Files
¶
- account_command.go
- account_tls_command.go
- audit_analyze_command.go
- audit_command.go
- audit_gather_command.go
- auth_account_command.go
- auth_account_exports.go
- auth_account_imports.go
- auth_command.go
- auth_nkey_command.go
- auth_operator_command.go
- auth_user_command.go
- bench_command.go
- cli.go
- columns.go
- config.go
- consumer_command.go
- context_command.go
- errors_command.go
- events_command.go
- jsonschema.go
- kv_command.go
- latency_command.go
- object_command.go
- plugins_command.go
- pub_command.go
- reply_command.go
- rtt_command.go
- schema_command.go
- schema_info_command.go
- schema_req_command.go
- schema_search_command.go
- schema_validate_command.go
- server_account_command.go
- server_check_command.go
- server_cluster_command.go
- server_command.go
- server_config_command.go
- server_info_command.go
- server_list_command.go
- server_mapping_command.go
- server_mkpasswd_command.go
- server_ping_command.go
- server_report_command.go
- server_request_command.go
- server_run_command.go
- server_watch_acct_command.go
- server_watch_command.go
- server_watch_js_command.go
- server_watch_srv_command.go
- service_command.go
- stream_command.go
- sub_command.go
- tables.go
- top_command.go
- trace_command.go
- traffic_command.go
- util.go
- yaml.go
Click to show internal directories.
Click to hide internal directories.