Document GPRC Connection's TLS option #1290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 tasks
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1290/merge It will be deleted automatically in 30 days. |
heitortsergent
approved these changes
Aug 10, 2023
...ascript api/07 k6-experimental/02 grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
...ascript api/07 k6-experimental/02 grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
...ascript api/07 k6-experimental/02 grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
.../docs/02 javascript api/11 k6-net-grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
.../docs/02 javascript api/11 k6-net-grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
...ascript api/07 k6-experimental/02 grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
olegbespalov
commented
Aug 11, 2023
...ascript api/07 k6-experimental/02 grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
olegbespalov
commented
Aug 11, 2023
.../docs/02 javascript api/11 k6-net-grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
codebien
approved these changes
Aug 11, 2023
mstoykov
reviewed
Aug 14, 2023
Comment on lines
72
to
93
| // note: the services in this example don't exist. If you would like | ||
| // to run this example, make sure to replace the URLs, and | ||
| // the cacerts, cert, key, and password variables. | ||
| const params = { | ||
| 'foo1.grpcbin.test.k6.io:9001': { | ||
| plaintext: false, | ||
| tls: { | ||
| cacerts: [open('cacerts0.pem')], | ||
| cert: open('cert0.pem'), | ||
| key: open('key0.pem'), | ||
| }, | ||
| }, | ||
| 'foo2.grpcbin.test.k6.io:9002': { | ||
| plaintext: false, | ||
| tls: { | ||
| cacerts: open('cacerts1.pem'), | ||
| cert: open('cert1.pem'), | ||
| key: open('key1.pem'), | ||
| password: 'cert1-passphrase', | ||
| }, | ||
| }, | ||
| }; |
There was a problem hiding this comment.
This was briefly discussed in the original PR - the certificates and keys are likely going to be big enough that loading each and everyone for each VU will be wasteful.
As such I would recommend using SharedArray to anyone who will use this to have different certificates per connection/VU.
I would also prefer if any examples we provide follow this advice as users commonly copy paste examples as-is.
mstoykov
approved these changes
Aug 14, 2023
mstoykov
reviewed
Aug 14, 2023
...ascript api/07 k6-experimental/02 grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
mstoykov
reviewed
Aug 14, 2023
.../docs/02 javascript api/11 k6-net-grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
mstoykov
requested changes
Aug 14, 2023
… grpc/20 Client/20-Client-connect-connect-address-params.md Co-authored-by: Mihail Stoykov <312246+mstoykov@users.noreply.github.com>
…ent/20-Client-connect-connect-address-params.md Co-authored-by: Mihail Stoykov <312246+mstoykov@users.noreply.github.com>
oleiade
approved these changes
Aug 14, 2023
mstoykov
approved these changes
Aug 14, 2023
codebien
reviewed
Aug 14, 2023
...ascript api/07 k6-experimental/02 grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
… grpc/20 Client/20-Client-connect-connect-address-params.md Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com>
mstoykov
reviewed
Aug 14, 2023
.../docs/02 javascript api/11 k6-net-grpc/20 Client/20-Client-connect-connect-address-params.md
Outdated
Show resolved
Hide resolved
…ent/20-Client-connect-connect-address-params.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Document Connection TLS param from the grafana/k6#3159
Why?
It needs to be documented.