-
Notifications
You must be signed in to change notification settings - Fork 224
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.
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
Temporal Nexus: Go SDK Feature Guide #3057
base: main
Are you sure you want to change the base?
Conversation
docs/develop/go/temporal-nexus.mdx
Outdated
``` | ||
temporal server start-dev --http-port 7243 --dynamic-config-value system.enableNexus=true | ||
``` | ||
|
||
This command automatically starts the Web UI, creates the default Namespace, and uses an in-memory database. | ||
|
||
The Temporal Server should be available on `localhost:7233` and the Temporal Web UI should be accessible at [http://localhost:8233](http://localhost:8233). | ||
|
||
## Create caller and handler Namespaces {#create-caller-handler-namespaces} | ||
|
||
Before setting up Nexus endpoints, create separate namespaces for the caller and handler. | ||
|
||
``` | ||
temporal operator namespace create --namespace my-target-namespace | ||
temporal operator namespace create --namespace my-caller-namespace | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: you can condense this into a single step with start-dev --namespace my-target-namespace --namespace my-caller-namespace ...
if you want, it'll save you having to mention the default namespace that gets created.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just hopping in here to mention that to align with existing temporal
CLI docs, we use:
docs% temporal operator namespace
Manage Temporal Cluster (Service) Namespaces:
temporal operator namespace [command] [command options]
For example:
temporal operator namespace create \
--namespace YourNewNamespaceName
Usage:
temporal operator namespace [command]
TMI: tcld
uses a different convention (specifically <namespace_id>.<account_id>
, but it is not yet all aligned)
d6d9071
to
5c5018d
Compare
@jsundai I will do another pass tomorrow, I am off today. |
Nexus events are included in the caller’s Workflow history: | ||
|
||
``` | ||
temporal workflow show -w <ID> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
temporal workflow show -w <ID> | |
temporal workflow show \ | |
-workflow-id YourWorkflowID |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order to not delay getting these Nexus docs live and published, this seems like something that would require further discussion. I will make a separate PR outside of this one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think there's much of a rush to merge this. Up to you if you want to postpone and handle in a separate PR.
// ... | ||
// See alternatives at https://pkg.go.dev/go.temporal.io/sdk/temporalnexus. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This snippet should start either at the start of this comment or strip it out.
What does this PR do?
adds temporal nexus into the go sdk feature guide
Preview
Notes to reviewers