Skip to content

Commit

Permalink
update vtgate refernece for v16.0+, remove changes to lower versions
Browse files Browse the repository at this point in the history 
Signed-off-by: Phani Raj <[email protected]>
  • Loading branch information
Phani Raj committed Apr 26, 2023
1 parent 20e3c6b commit c23e0cf
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 5 deletions.
1 change: 0 additions & 1 deletion content/en/docs/14.0/reference/programs/vtgate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ The following global options apply to `vtgate`:
| --grpc_server_keepalive_enforcement_policy_min_time | duration | grpc server minimum keepalive time (default 5m0s) |
| --grpc_server_keepalive_enforcement_policy_permit_without_stream | boolean | grpc server permit client keepalive pings even when there are no active streams (RPCs) |
| --grpc_use_effective_callerid | boolean | If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. |
| --grpc-use-static-authentication-callerid | boolean | If set, will set the immediate caller id to the username authenticated by the static auth plugin. |
| --healthcheck_retry_delay | duration | health check retry delay (default 2ms) |
| --healthcheck_timeout | duration | the health check timeout period (default 1m0s) |
| --jaeger-agent-host | string | host and port to send spans to. if empty, no tracing will be done |
Expand Down
2 changes: 0 additions & 2 deletions content/en/docs/15.0/reference/features/transport-security-model.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,6 @@ In a private network, where TLS security is not required, it might still be desi

**Important**: This is not secure. Any user code can provide any value for the Effective Caller ID's principal, and therefore access any data. This is intended as a safety feature to make sure some applications do not misbehave. Therefore, this flag is not enabled by default.

Another way to customize the immediateCallerID is to set the `grpc-use-static-authentication-callerid` flag on vtgate, which is only effective if you're using the static authentication plugin with vtgate. In this case, the username from the current authenticated session to vtgate is copied over as the Immediate Caller ID, and used throughout the Vitess stack.

### Example

For a concrete example, see [encrypted_transport_test.go](https://github.com/vitessio/vitess/blob/main/go/test/endtoend/encryption/encryptedtransport/encrypted_transport_test.go) in the source tree.
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/16.0/reference/programs/vtgate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ The following global options apply to `vtgate`:
| --grpc_server_initial_window_size | Int | gRPC server initial window size |
| --grpc_server_keepalive_enforcement_policy_min_time | Duration | gRPC server minimum keepalive time (default 10s) |
| --grpc_server_keepalive_enforcement_policy_permit_without_stream | Boolean | gRPC server permit client keepalive pings even when there are no active streams (RPCs) |
| --grpc_use_effective_callerid | Boolean | If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. |
| --grpc_use_effective_callerid | Boolean | If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. |
| --grpc-use-static-authentication-callerid | boolean | If set, will set the immediate caller id to the username authenticated by the static auth plugin. |
| --healthcheck_retry_delay | Duration | health check retry delay (default 2ms) |
| --healthcheck_timeout | Duration | the health check timeout period (default 1m0s) |
| -h, --help | Boolean | display usage and exit |
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/17.0/reference/programs/vtgate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ The following global options apply to `vtgate`:
| --grpc_server_initial_window_size | Int | gRPC server initial window size |
| --grpc_server_keepalive_enforcement_policy_min_time | Duration | gRPC server minimum keepalive time (default 10s) |
| --grpc_server_keepalive_enforcement_policy_permit_without_stream | Boolean | gRPC server permit client keepalive pings even when there are no active streams (RPCs) |
| --grpc_use_effective_callerid | Boolean | If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. |
| --grpc_use_effective_callerid | Boolean | If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. |
| --grpc-use-static-authentication-callerid | boolean | If set, will set the immediate caller id to the username authenticated by the static auth plugin. |
| --healthcheck_retry_delay | Duration | health check retry delay (default 2ms) |
| --healthcheck_timeout | Duration | the health check timeout period (default 1m0s) |
| -h, --help | Boolean | display usage and exit |
Expand Down

0 comments on commit c23e0cf

Please sign in to comment.