Skip to content

docs: update for Docker image restructuring and deprecations#4158

Open
tlalfano wants to merge 16 commits intomainfrom
docker-changes-tasha
Open

docs: update for Docker image restructuring and deprecations#4158
tlalfano wants to merge 16 commits intomainfrom
docker-changes-tasha

Conversation

@tlalfano
Copy link
Contributor

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 updates
  • All references now point to samples-server repository for examples

Server Image Changes (temporalio/server)

Documented removal of the following tools:

  • temporal CLI
  • dockerize (replaced with embedded sprig)
  • curl
  • bash

Admin Tools Image Changes (temporalio/admin-tools)

  • Added documentation for new temporal-elasticsearch-tool

Configuration Changes

  • Added new "Configuration Templating" section explaining dockerize → sprig migration
  • Documented template syntax changes (.Env and default function)
  • Added temporal-server render-config usage

Helm Chart Compatibility

  • Documented breaking changes in Helm chart version 0.73.1+
  • Server/admin-tools images 1.30+ require Helm chart 0.73.1 or later
  • Cannot override existing chart versions with newer images

Files Changed

  • docs/production-deployment/self-hosted-guide/deployment.mdx
  • docs/production-deployment/self-hosted-guide/visibility.mdx (5 locations updated)
  • docs/production-deployment/self-hosted-guide/namespaces.mdx

Notes

  • Temporal Cloud deployments are not impacted by these changes
  • All deprecation warnings consistently direct users to samples-server repository for examples

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.
@tlalfano tlalfano requested a review from a team as a code owner January 28, 2026 21:28
@vercel
Copy link

vercel bot commented Jan 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview, Comment Feb 11, 2026 6:24pm

Request Review

@CLAassistant
Copy link

CLAassistant commented Jan 28, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ tlalfano
✅ lennessyy
❌ Tasha Alfano


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.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 28, 2026

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

https://github.com/temporalio/samples-server/tree/main/compose

Copy link
Contributor

@lennessyy lennessyy Jan 30, 2026

Choose a reason for hiding this comment

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

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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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).

Copy link
Contributor

Choose a reason for hiding this comment

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

same for similar references

@chaptersix
Copy link
Contributor

For the complete list of dynamic configuration keys, see https://github.com/temporalio/temporal/blob/main/common/dynamicconfig/constants.go. Ensure that you check server release notes for any changes to these keys and values.

this is not completely true. there are other constants such as those for nexus.

@chaptersix
Copy link
Contributor

For the complete list of dynamic configuration keys, see https://github.com/temporalio/temporal/blob/main/common/dynamicconfig/constants.go. Ensure that you check server release notes for any changes to these keys and values.

this is not completely true. there are other constants such as those for nexus.

temporalio/temporal#8676

we should be able to instruct users to run a tdbg or server command to dump all the dynamic configs

@chaptersix
Copy link
Contributor

For more examples on how dynamic configuration is set, see:

[docker-compose](https://github.com/temporalio/docker-compose/tree/main/dynamicconfig)

missed a reference

Comment on lines 102 to 113
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).
Copy link
Contributor

Choose a reason for hiding this comment

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

I can't seem to find this section. Does Configuration Templating actually exist?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, search redirects me to that main website

@chaptersix
Copy link
Contributor

For the complete list of dynamic configuration keys, see https://github.com/temporalio/temporal/blob/main/common/dynamicconfig/constants.go. Ensure that you check server release notes for any changes to these keys and values.

this is not completely true. there are other constants such as those for nexus.

temporalio/temporal#8676

we should be able to instruct users to run a tdbg or server command to dump all the dynamic configs

no changes required just calling it out

Comment on lines 424 to 428
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`:
Copy link
Contributor

Choose a reason for hiding this comment

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

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

reference to docker compose above should go to samples server.

@lennessyy lennessyy self-assigned this Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants