docs: update for Docker image restructuring and deprecations#4158
docs: update for Docker image restructuring and deprecations#4158
Conversation
Document breaking changes for upcoming Temporal Server 1.30+ release including auto-setup image deprecation, server/admin-tools image streamlining, dockerize to sprig migration, and Helm chart compatibility requirements to prepare users for the security and maintenance improvements.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Tasha Alfano seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
📖 Docs PR preview links
|
| You must register this Namespace before using it. | ||
|
|
||
| When deploying with Docker Compose or the [auto-setup image](https://github.com/temporalio/docker-builds/blob/main/docker/auto-setup.sh), the `default` Namespace is created automatically. | ||
| :::warning Deprecated: auto-setup Image |
There was a problem hiding this comment.
I would prefer something more like:
### The default Namespace
If no Namespace is specified, SDKs and CLI use the `default` Namespace.
You must register this Namespace before using it. For local development, the [`temporal server start-dev`](/cli/server#start-dev) command automatically creates the `default` Namespace.
For all other deployment methods, create the `default` Namespace manually using the Temporal CLI:
```bash
temporal operator namespace create --namespace default
:::warning Deprecated: auto-setup Image
The temporalio/auto-setup image is deprecated and no longer receives updates.
:::
For setup examples, refer to the samples-server repository and helm-charts repository.
There was a problem hiding this comment.
https://github.com/temporalio/samples-server/tree/main/compose
There was a problem hiding this comment.
I actually don't think we need this admonition at all. Since we removed the original text there is now no connection between the default namespace and a deprecated deployment artifact and no need to mention it
| The following example shows how the [auto-setup.sh](https://github.com/temporalio/docker-builds/blob/main/docker/auto-setup.sh) script sets up your Visibility store. | ||
| :::warning Deprecated: auto-setup.sh Script | ||
|
|
||
| The `auto-setup.sh` script and `temporalio/auto-setup` image are deprecated and no longer receive updates. For setup examples, refer to the [samples-server repository](https://github.com/temporalio/samples-server). |
There was a problem hiding this comment.
| The `auto-setup.sh` script and `temporalio/auto-setup` image are deprecated and no longer receive updates. For setup examples, refer to the [samples-server repository](https://github.com/temporalio/samples-server). | |
| The `auto-setup.sh` script and `temporalio/auto-setup` image are deprecated and no longer receive updates. For setup examples, refer to the [samples-server repository](https://github.com/temporalio/samples-server/tree/main/compose). |
There was a problem hiding this comment.
same for similar references
this is not completely true. there are other constants such as those for nexus. |
we should be able to instruct users to run a tdbg or server command to dump all the dynamic configs |
missed a reference |
| The `temporalio/server` image has been streamlined to include only production-essential components. The following tools have been removed: | ||
|
|
||
| - `temporal` CLI | ||
| - `dockerize` (replaced with embedded `sprig` templating) | ||
| - `curl` | ||
| - `bash` | ||
|
|
||
| Configuration templating now uses embedded `sprig` instead of `dockerize`. See [Configuration Templating](#configuration-templating) for details. | ||
|
|
||
| ::: | ||
|
|
||
| The environment variables supported by the Temporal Docker images are documented [on Docker Hub](https://hub.docker.com/r/temporalio/server). |
There was a problem hiding this comment.
I can't seem to find this section. Does Configuration Templating actually exist?
There was a problem hiding this comment.
Ah, search redirects me to that main website
no changes required just calling it out |
| For Elasticsearch setup, use the `temporal-elasticsearch-tool` available in the `temporalio/admin-tools` image (version 1.30+). For examples, refer to the [samples-server repository](https://github.com/temporalio/samples-server). | ||
|
|
||
| ::: | ||
|
|
||
| The following example shows how to set up an Elasticsearch Visibility store using `temporal-elasticsearch-tool`: |
There was a problem hiding this comment.
should we just replace the existing examples or have them in a collapsible section?
|
|
||
| :::warning Docker Image Changes | ||
|
|
||
| The `temporalio/auto-setup` image is **deprecated** and no longer receives updates. |
There was a problem hiding this comment.
reference to docker compose above should go to samples server.
Summary
Updates documentation for upcoming Docker image changes in Temporal Server 1.30+. These changes reflect the restructuring of Temporal's Docker images to reduce security vulnerabilities, minimize image size, and clarify intended use.
Key Changes
Deprecated Images
temporalio/auto-setup- Deprecated and no longer receiving updatesServer Image Changes (
temporalio/server)Documented removal of the following tools:
temporalCLIdockerize(replaced with embeddedsprig)curlbashAdmin Tools Image Changes (
temporalio/admin-tools)temporal-elasticsearch-toolConfiguration Changes
.Envanddefaultfunction)temporal-server render-configusageHelm Chart Compatibility
Files Changed
docs/production-deployment/self-hosted-guide/deployment.mdxdocs/production-deployment/self-hosted-guide/visibility.mdx(5 locations updated)docs/production-deployment/self-hosted-guide/namespaces.mdxNotes