Skip to content

Commit

Permalink
FMWK-631-fix-documentation
Browse files Browse the repository at this point in the history
- fixed auth and tls-key-password documentation
  • Loading branch information
filkeith committed Jan 9, 2025
1 parent e9dbc61 commit 8909848
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions flags/aerospikeFlags.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func NewDefaultAerospikeFlags() *AerospikeFlags {
}
}

// NewAerospikeFlagSet returns a new pflag.FlagSet with Aerospike flags defined.
// NewFlagSet returns a new pflag.FlagSet with Aerospike flags defined.
// Values set in the returned FlagSet will be stored in the AerospikeFlags argument.
func (af *AerospikeFlags) NewFlagSet(fmtUsage UsageFormatter) *pflag.FlagSet {
f := &pflag.FlagSet{}
Expand All @@ -43,9 +43,9 @@ func (af *AerospikeFlags) NewFlagSet(fmtUsage UsageFormatter) *pflag.FlagSet {
f.Var(&af.AuthMode, "auth", fmtUsage("The authentication mode used by the Aerospike server."+
" INTERNAL uses standard user/pass. EXTERNAL uses external methods (like LDAP)"+
" which are configured on the server. EXTERNAL requires TLS. PKI allows TLS"+
" authentication and authorization based on a certificate. No user name needs to be configured."))
" authentication and authorization based on a certificate. No username needs to be configured."))
f.BoolVar(&af.TLSEnable, "tls-enable", false, fmtUsage("Enable TLS authentication with Aerospike."+
" If false, other tls options are ignored.",
" If false, other TLS options are ignored.",
))
f.StringVar(&af.TLSName, "tls-name", "", fmtUsage("The server TLS context to use to"+
" authenticate the connection to Aerospike.",
Expand All @@ -54,7 +54,7 @@ func (af *AerospikeFlags) NewFlagSet(fmtUsage UsageFormatter) *pflag.FlagSet {
f.Var(&af.TLSRootCAPath, "tls-capath", fmtUsage("A path containing CAs for connecting to Aerospike."))
f.Var(&af.TLSCertFile, "tls-certfile", fmtUsage("The certificate file for mutual TLS authentication with Aerospike."))
f.Var(&af.TLSKeyFile, "tls-keyfile", fmtUsage("The key file used for mutual TLS authentication with Aerospike."))
f.Var(&af.TLSKeyFilePass, "tls-keyfile-password", fmtUsage("The password used to decrypt the key-file if encrypted."))
f.Var(&af.TLSKeyFilePass, "tls-keyfile-password", fmtUsage("The password used to decrypt the key file if encrypted."))
f.Var(&af.TLSProtocols, "tls-protocols", fmtUsage(
"Set the TLS protocol selection criteria. This format is the same as"+
" Apache's SSLProtocol documented at https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssl protocol.",
Expand Down

0 comments on commit 8909848

Please sign in to comment.