• Documentation
  • Tutorials
  • Blogs
  • Product

What's on this Page

  • Overview
  • What’s Changing
    • New Naming Convention
  • Why This Change?
  • Migration Timeline
    • Parallel Availability Period
    • Deprecation and Removal
  • How to Migrate
    • For Kubernetes/Helm Deployments
  • Frequently Asked Questions
    • Do I need to migrate immediately?
    • Will this affect my existing deployments?
    • Can I test the new images before migrating production?
    • What if I have multiple Step environments?
    • Are there any functional differences between old and new images?
  • Related Resources
  • Step
  • Admin guide
  • Maintenance
  • Agent Runtime Image Naming Convention Migration
Categories: ADMIN GUIDE MAINTENANCE
This article references one of our previous releases, click here to go to our latest version instead.

Agent Runtime Image Naming Convention Migration

Overview

Starting with Step 29, we are introducing a new naming convention for all agent runtime Docker images. This change improves consistency, clarity, and maintainability across the Agent runtime images.

Important: This change affects ALL Step agent runtime images, not just specific ones. Plan your migration accordingly.

What’s Changing

New Naming Convention

All agent runtime images will follow a new, more structured naming pattern:

Base Runtime Image (Java + Chromium)

Old Image Name New Image Name
docker.exense.ch/step-enterprise/base:21-debian-12-slim docker.exense.ch/step-enterprise/agent/runtime:1.0.0

Key changes:

  • Added agent/ path segment for better organization
  • Restructured tag format: <image-version> (instead of <java-version>-<os>-<os-version>)
  • Changed from base to runtime for more descriptive naming

Extended Runtime Image (Full Browsers)

Old Image Name New Image Name
docker.exense.ch/step-enterprise/browsers:1.0.4-java-21 docker.exense.ch/step-enterprise/agent/runtime-extended:1.0.0

Key changes:

  • Added agent/ path segment for better organization
  • Changed from browsers to runtime-extended for consistency
  • Restructured tag format: <image-version> (instead of <image-version>-java-<version>)

Why This Change?

The new naming convention provides several benefits:

  1. Consistency: All agent runtime images follow the same structural pattern
  2. Clarity: The agent/runtime path clearly identifies these as agent runtime images
  3. Maintainability: Easier to manage and organize images in repositories
  4. Extensibility: Better foundation for future image variants and versions
  5. Discoverability: Logical grouping makes it easier to find related images

Migration Timeline

Parallel Availability Period

Duration: Step 29

During Step 29:

  • Both old and new image names will be available
  • Old images will continue to receive updates
  • You can migrate at your convenience during this window
  • No immediate action is required, but planning your migration is recommended

Deprecation and Removal

Effective: Step 30

Starting with Step 30:

  • Old image names will be deprecated and no longer updated
  • Only new image names will receive updates
  • Action required: You must migrate to new image names before upgrading to Step 30

How to Migrate

For Kubernetes/Helm Deployments

Update Helm Values

Update your values.yaml file with the new image names:

Chart default behavior:

  • Chart versions before 1.3.0: Use old image names by default
  • Chart version 1.3.0: Still uses old image names by default for backward compatibility
  • Chart version 1.4.0+ (not yet released): Will use new image names by default
  • If you explicitly define images: You maintain full control and must update them manually if needed

Recommendation: We recommend explicitly defining your agent runtime images in your Helm values for better control and visibility, regardless of chart defaults.

Before:

agent:
  pools:
  - name: "my-agent-pool"
    image: docker.exense.ch/step-enterprise/base:21-debian-12-slim

After:

agent:
  pools:
  - name: "my-agent-pool"
    image: docker.exense.ch/step-enterprise/agent/runtime:1.0.0

For extended runtime images:

Before:

agent:
  pools:
  - name: "my-agent-pool"
    image: docker.exense.ch/step-enterprise/browsers:1.0.4-java-21

After:

agent:
  pools:
  - name: "my-agent-pool"
    image: docker.exense.ch/step-enterprise/agent/runtime-extended:1.0.0

Frequently Asked Questions

Do I need to migrate immediately?

No. Both old and new image names will be available during Step 29. However, you must migrate before upgrading to Step 30.

Will this affect my existing deployments?

Existing deployments using old image names will continue to work even after Step 30. The old images will remain accessible but will no longer receive updates (including security patches and browser updates) after deprecation. We strongly recommend migrating to ensure you continue receiving updates.

Can I test the new images before migrating production?

Yes. We recommend testing in a non-production environment first. Both image versions are functionally identical during the transition period.

What if I have multiple Step environments?

Migrate each environment independently during the transition period. Start with development/test environments to validate the migration process.

Are there any functional differences between old and new images?

No. The images are functionally identical. Only the repository path and tag format have changed.

Related Resources

  • Agent Runtime Docker Image Release Strategy
  • Creating Custom Agent Images
  • Helm Chart Migration Guide
  • Docker Private Repository Access

See Also

  • Agent configuration for Step SaaS
  • Agent installation
  • Agent Runtime Docker Image Release Strategy
  • Agent Provisioning configuration
  • Agent configuration
  • Home
  • Whats new?
  • Release Strategy
  • Set up
  • Administration
    • Maintenance
      • Backup & Restore
      • Housekeeping
      • Upgrade / Migration
      • Upgrade / Migration of the Helm chart
      • Agent Runtime Image Naming Convention Migration
      • Troubleshooting
    • Project management
    • Role management
  • SaaS guide
  • User guide
  • Developer guide
  • DevOps
  • Plugins
  • Libraries
Step Logo
    • Documentation
    • Tutorials
    • Blogs
    • Product
    • Home
    • Whats new?
    • Release Strategy
    • Set up
    • Administration
      • Maintenance
        • Backup & Restore
        • Housekeeping
        • Upgrade / Migration
        • Upgrade / Migration of the Helm chart
        • Agent Runtime Image Naming Convention Migration
        • Troubleshooting
      • Project management
      • Role management
    • SaaS guide
    • User guide
    • Developer guide
    • DevOps
    • Plugins
    • Libraries