I updated the README to describe how to disable client authentication and to provide examples of how to subsequently connect to the cluster using the command line as well as the Go SDK.
Why?
The Temporal documentation explains how to connect to a cluster that does not use TLS at all. It also explains how to connect to a cluster that uses mTLS. However, it does not explain how to connect to a cluster that uses TLS (i.e., without client certificates), which I believe represents a common configuration for self-hosted clusters. By following this README, it is now possible for someone to quickly set up and run such a cluster for testing purposes and also be able to access it from the command line or code (Go SDK).
While it would be a nice future enhancement to add code examples for other SDKs, they are likely similar enough in concept to the Go example that a developer could create one of their own in the meantime.
Checklist
Closes: N/A
How was this tested:
Chad Retz from the Temporal SDK team helped me come up with working examples for tctl and Go. I simplified those a bit and then adapted the tctl example for the new temporal command. I tested all of these locally.
Any docs updates needed?
I will file this separately, but the Foundations section of the Developer guide should be updated to include this example (in addition to the no TLS and mTLS examples already present).
The documentation for tctl and temporal (CLI) are focused primarily on individual options, rather than scenarios involving combinations of those options that lead to a specific outcome, so no update is feasbile to those in their current form.
tomwheeler
commented
1 year ago
What was changed
I updated the README to describe how to disable client authentication and to provide examples of how to subsequently connect to the cluster using the command line as well as the Go SDK.
Why?
The Temporal documentation explains how to connect to a cluster that does not use TLS at all. It also explains how to connect to a cluster that uses mTLS. However, it does not explain how to connect to a cluster that uses TLS (i.e., without client certificates), which I believe represents a common configuration for self-hosted clusters. By following this README, it is now possible for someone to quickly set up and run such a cluster for testing purposes and also be able to access it from the command line or code (Go SDK).
While it would be a nice future enhancement to add code examples for other SDKs, they are likely similar enough in concept to the Go example that a developer could create one of their own in the meantime.
Checklist
Closes: N/A
How was this tested: Chad Retz from the Temporal SDK team helped me come up with working examples for
tctland Go. I simplified those a bit and then adapted thetctlexample for the newtemporalcommand. I tested all of these locally.Any docs updates needed? I will file this separately, but the Foundations section of the Developer guide should be updated to include this example (in addition to the no TLS and mTLS examples already present).
The documentation for
tctlandtemporal(CLI) are focused primarily on individual options, rather than scenarios involving combinations of those options that lead to a specific outcome, so no update is feasbile to those in their current form.