From ffcbf2550a965f54815319e30d633c398c228780 Mon Sep 17 00:00:00 2001 From: Will Lahti Date: Thu, 17 Sep 2020 16:01:03 -0400 Subject: [PATCH] Clarify tlsHandshakeTimeShift CLI help text (#1894) It only applies to handshakes with the orderer endpoint. FAB-18205 Signed-off-by: Will Lahti --- docs/source/commands/peerchaincode.md | 16 ++++++++-------- docs/source/commands/peerchannel.md | 16 ++++++++-------- docs/source/commands/peerlifecycle.md | 20 ++++++++++---------- internal/peer/common/ordererenv.go | 2 +- 4 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/source/commands/peerchaincode.md b/docs/source/commands/peerchaincode.md index cf24df7bf94..9e554bfc4c3 100644 --- a/docs/source/commands/peerchaincode.md +++ b/docs/source/commands/peerchaincode.md @@ -94,7 +94,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` @@ -130,7 +130,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` @@ -163,7 +163,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` @@ -193,7 +193,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` @@ -225,7 +225,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` @@ -257,7 +257,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` @@ -281,7 +281,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` @@ -318,7 +318,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint --transient string Transient map of arguments in JSON encoding ``` diff --git a/docs/source/commands/peerchannel.md b/docs/source/commands/peerchannel.md index 4949ee067d3..497a37a5e92 100644 --- a/docs/source/commands/peerchannel.md +++ b/docs/source/commands/peerchannel.md @@ -42,7 +42,7 @@ Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint Use "peer channel [command] --help" for more information about a command. ``` @@ -71,7 +71,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -96,7 +96,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -120,7 +120,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -144,7 +144,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -167,7 +167,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -191,7 +191,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -216,7 +216,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` ## Example Usage diff --git a/docs/source/commands/peerlifecycle.md b/docs/source/commands/peerlifecycle.md index f31d5c44cb4..7bb768af034 100644 --- a/docs/source/commands/peerlifecycle.md +++ b/docs/source/commands/peerlifecycle.md @@ -74,7 +74,7 @@ Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint Use "peer lifecycle chaincode [command] --help" for more information about a command. ``` @@ -105,7 +105,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -131,7 +131,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -158,7 +158,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -186,7 +186,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -225,7 +225,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -255,7 +255,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -292,7 +292,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -330,7 +330,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` @@ -359,7 +359,7 @@ Global Flags: -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer --tls Use TLS when communicating with the orderer endpoint - --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes + --tlsHandshakeTimeShift duration The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint ``` diff --git a/internal/peer/common/ordererenv.go b/internal/peer/common/ordererenv.go index 280a060ced9..47994154140 100644 --- a/internal/peer/common/ordererenv.go +++ b/internal/peer/common/ordererenv.go @@ -70,5 +70,5 @@ func AddOrdererFlags(cmd *cobra.Command) { flags.DurationVarP(&connTimeout, "connTimeout", "", 3*time.Second, "Timeout for client to connect") flags.DurationVarP(&tlsHandshakeTimeShift, "tlsHandshakeTimeShift", "", 0, - "The amount of time to shift backwards for certificate expiration checks during TLS handshakes") + "The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint") }