Skip to content
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

update README from tctl to Temporal CLI #367

Merged
merged 7 commits into from
Oct 14, 2024
Merged

update README from tctl to Temporal CLI #367

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
67a7910
update README from tctl to Temporal CLI
kevinawoo Oct 12, 2024
4368134
fixed typos
kevinawoo Oct 12, 2024
dbeffca
Update codec-server/README.md
kevinawoo Oct 14, 2024
cb898c6
Update codec-server/README.md
kevinawoo Oct 14, 2024
a738250
Update codec-server/README.md
kevinawoo Oct 14, 2024
16a9404
Update codec-server/README.md
kevinawoo Oct 14, 2024
dbe80fb
Temporal Web -> Temporal UI
kevinawoo Oct 14, 2024
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
71 changes: 36 additions & 35 deletions codec-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
### Steps to run this sample:

This sample shows how to decode payloads that have been encoded by a codec so they can be displayed by tctl and Temporal Web.
This sample shows how to decode payloads that have been encoded by a codec so they can be displayed by the Temporal CLI and Temporal Web.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: none of this is your responsibility but if you don't mind I'm thinking "Temporal UI" is the proper name (e.g. https://docs.temporal.io/evaluate/major-components) -- could be worth changing throughout.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome! I was looking for a proper name guide. I updated it in dbe80fb. Please take a look 🙏

The sample codec server supports OIDC authentication (via JWT in the Authorization header).
Temporal Web can be configured to pass the user's OIDC access token to the codec server, see: https://github.com/temporalio/web#configuration
Configuring OIDC is outside of the scope of this sample, but please see the [serverjwtauth repo](../serverjwtauth/) for more details about authentication.

1) Run a [Temporal service](https://github.com/temporalio/samples-go/tree/main/#how-to-use).
2) Run the following command to start the worker
```
go run worker/main.go
```
```
go run worker/main.go
```
3) Run the following command to start the example
```
go run starter/main.go
```
4) Run the following command and see that tctl cannot display the payloads as they are encoded (compressed)
```
tctl workflow show --wid codecserver_workflowID
```
5) Run the following command to start the remote codec server
```
go run ./codec-server
```
6) Run the following command to see that tctl can now decode (uncompress) the payloads via the remote codec server
```
tctl --codec_endpoint 'http://localhost:8081/{namespace}' workflow show --wid codecserver_workflowID
```
```
go run starter/main.go
```
4) Run the following command and see that CLI cannot display the payloads as they are encoded (compressed)
kevinawoo marked this conversation as resolved.
Show resolved Hide resolved
```
temporal workflow show --w codecserver_workflowID
kevinawoo marked this conversation as resolved.
Show resolved Hide resolved
```
5) Run the following command to start the remote codec server.
The `-web` flag is needed for Temporal Web UI for CORS.
```
go run ./codec-server -web=http://localhost:8080
```
6) Run the following command to see that CLI can now decode (uncompress) the payloads via the remote codec server
kevinawoo marked this conversation as resolved.
Show resolved Hide resolved
```
temporal --codec-endpoint 'http://localhost:8081/{namespace}' workflow show --w codecserver_workflowID
```

# Codec Server Protocol

Expand All @@ -47,26 +48,26 @@ This makes deployment more flexible by allowing the endpoints to be mounted at a
Implementations MAY:

1. Support codec for different namespaces under different URLs.
2. Read the `X-Namespace` header sent to the /encode or /decode endpoints as an alternative to differentiating namespaces based on URL. The current `tctl` and Temporal Web UI codec client code will set `X-Namespace` appropriately for each request.
2. Read the `X-Namespace` header sent to the /encode or /decode endpoints as an alternative to differentiating namespaces based on URL. The current CLI and Temporal Web UI codec client code will set `X-Namespace` appropriately for each request.

In the endpoint sequence diagrams below we are using `tctl` as an example of the client side, but Temporal Web and all other consumers will follow the same protocol.
In the endpoint sequence diagrams below we are using CLI as an example of the client side, but Temporal Web and all other consumers will follow the same protocol.
kevinawoo marked this conversation as resolved.
Show resolved Hide resolved

### Encode

```mermaid
sequenceDiagram;
participant tctl
participant CLI
participant Server as Codec Server

tctl->>Server: HTTP POST /encode
Note right of tctl: Content-Type: application/json
Note right of tctl: Body: Payloads protobuf as JSON
CLI->>Server: HTTP POST /encode
Note right of CLI: Content-Type: application/json
Note right of CLI: Body: Payloads protobuf as JSON
alt invalid JSON
Server-->>tctl: HTTP 400 BadRequest
Server-->>CLI: HTTP 400 BadRequest
else encoder error
Server-->>tctl: HTTP 400 BadRequest
Server-->>CLI: HTTP 400 BadRequest
else
Server-->>tctl: HTTP 200 OK
Server-->>CLI: HTTP 200 OK
Note left of Server: Content-Type: application/json
Note left of Server: Body: Encoded Payloads protobuf as JSON
end
Expand All @@ -76,18 +77,18 @@ sequenceDiagram;

```mermaid
sequenceDiagram;
participant tctl
participant CLI
participant Server as Codec Server

tctl->>Server: HTTP POST /decode
Note right of tctl: Content-Type: application/json
Note right of tctl: Body: Payloads protobuf as JSON
CLI->>Server: HTTP POST /decode
Note right of CLI: Content-Type: application/json
Note right of CLI: Body: Payloads protobuf as JSON
alt invalid JSON
Server-->>tctl: HTTP 400 BadRequest
Server-->>CLI: HTTP 400 BadRequest
else decoder error
Server-->>tctl: HTTP 400 BadRequest
Server-->>CLI: HTTP 400 BadRequest
else
Server-->>tctl: HTTP 200 OK
Server-->>CLI: HTTP 200 OK
Note left of Server: Content-Type: application/json
Note left of Server: Body: Decoded Payloads protobuf as JSON
end
Expand Down