Skip to content

docs: mTLS adding commnets to code blocks + README updates #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 31, 2025
+15 −3
Merged

docs: mTLS adding commnets to code blocks + README updates #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc523f5
mTLS adding commnets to code blocks + README updates
vishwa-uber Oct 31, 2025
e952144
Merge branch 'master' into mTLS-docs
vishwa-uber Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions new_samples/client_samples/helloworld_tls/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@ https://github.com/cadence-workflow/cadence/blob/e1267de12f8bc670fc84fab456d3495
```

4. **Start cadence server with TLS**
```bash
./cadence-server --env development --zone tls start
```
To enable mTLS in Cadence server, you need to configure TLS settings and start the server with the appropriate environment configuration.
Starting the Server with TLS
Use the --zone flag to specify the TLS configuration when starting the Cadence server:

./cadence-server --env development --zone tls start

This will load [config/development.yaml](https://github.com/cadence-workflow/cadence/blob/e1267de12f8bc670fc84fab456d3495c8fc2f8a8/config/development.yaml) + [config/development_tls.yaml](https://github.com/cadence-workflow/cadence/blob/e1267de12f8bc670fc84fab456d3495c8fc2f8a8/config/development_tls.yaml).
See [CONTRIBUTING.md](https://github.com/cadence-workflow/cadence/blob/e1267de12f8bc670fc84fab456d3495c8fc2f8a8/CONTRIBUTING.md#4-run) for more details.

## Running the Sample

Expand Down
3 changes: 3 additions & 0 deletions new_samples/client_samples/helloworld_tls/hello_world_tls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,10 @@ func withTLSDialOption() (grpc.DialOption, error) {
RootCAs: caCertPool,
Certificates: []tls.Certificate{clientCert},
}
// Create TLS credentials from the TLS configuration
creds := credentials.NewTLS(&tlsConfig)
// Create a gRPC dial option with TLS credentials for secure connection
grpc.DialerCredentials(creds)
// Return the gRPC dial option configured with TLS credentials
return grpc.DialerCredentials(creds), nil
}
4 changes: 4 additions & 0 deletions new_samples/worker/worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ func StartWorker() {

func BuildCadenceClient(dialOptions ...grpc.DialOption) workflowserviceclient.Interface {
grpcTransport := grpc.NewTransport()
// Create a single peer chooser that identifies the host/port and configures
// a gRPC dialer with TLS credentials
myChooser := peer.NewSingle(
yarpchostport.Identify(HostPort),
grpcTransport.NewDialer(dialOptions...),
Expand All @@ -91,6 +93,8 @@ func BuildCadenceClient(dialOptions ...grpc.DialOption) workflowserviceclient.In

clientConfig := dispatcher.ClientConfig(CadenceService)

// Create a compatibility adapter that wraps proto-based YARPC clients
// to provide a unified interface for domain, workflow, worker, and visibility APIs
return compatibility.NewThrift2ProtoAdapter(
apiv1.NewDomainAPIYARPCClient(clientConfig),
apiv1.NewWorkflowAPIYARPCClient(clientConfig),
Expand Down
Loading