Image Cache

Defined insandbox.hcl

The image_cache resource creates a container registry cache for Docker images. It allows you to configure custom registries and network connections for caching Docker images locally.

Basic Syntax

resource "image_cache" "main" {
  network {
    id = resource.network.main.meta.id
  }
}

Full Syntax

resource "image_cache" "main" {
  registry {
    hostname = "private.registry.com"

    auth {
      username = "myuser"
      password = "mypassword"
    }
  }

  network {
    id         = resource.network.main.meta.id
    ip_address = "10.0.1.100"
    aliases    = ["cache.local"]
  }
}

Fields

Field	Type	Required	Description
registry	block	—	Additional registries to cache images fromrepeatable
network	block	—	Connect this resource to a specific network so it can communicate with other containers or servicesrepeatable

Registry

image_cache→Registry

Additional registries to cache images from

Field	Type	Required	Description
hostname	string	✓	Hostname of the container registry
auth	block	—	Authentication credentials for the registry

Auth

image_cache→Registry→Auth

Authentication credentials for the registry

Field	Type	Required	Description
hostname	string	—	Hostname for authentication
username	string	✓	Username for authentication
password	string	✓	Password for authentication

Network

image_cache→Network

Network attachments for the image cache

Field	Type	Required	Description
id	string	—	ID of the network to attach the container
target	referencenetwork	—	The network to attach the container to
ip_address	string	—	Static IP address to assign container for the network, the ip address must be within range defined by the network subnet. If this parameter is omitted an IP address will be automatically assigned. ConstraintsMust be a valid IPv4 address (e.g., 192.168.1.10)
aliases	list(string)	—	Aliases allow alternate names to specified for the container

Computed Attributes

These attributes are set by the system and are read-only.

Attribute	Type	Description
network[].name	string	Name will equal the name of the network as created by jumppad
network[].assigned_address	string	AssignedAddress will equal if IPAddress is set, else it will be the value automatically assigned from the network

Computed Fields

Field	Type	Description
meta.id	string	Full resource identifier

Nested Blocks

registry

Configure additional registries for the image cache.

Field	Type	Required	Description
hostname	string	✓	Hostname of the registry
auth	block		Authentication configuration for the registry

auth

Authentication configuration for a registry.

Field	Type	Required	Description
hostname	string		Hostname for authentication (can differ from registry hostname)
username	string	✓	Username for authentication
password	string	✓	Password for authentication

network

Network attachment configuration for the cache container.

Field	Type	Required	Description
id	string	✓	Network resource ID to attach to
ip_address	string		Static IP address to assign
aliases	[]string		Network aliases for the container

Examples

Simple Cache with Network

resource "image_cache" "main" {
  network {
    id = resource.network.lab.meta.id
  }
}

Cache with Private Registry

resource "image_cache" "private" {
  registry {
    hostname = "my-registry.company.com"

    auth {
      username = "service-account"
      password = var.registry_password
    }
  }

  network {
    id         = resource.network.main.meta.id
    ip_address = "192.168.1.50"
    aliases    = ["registry-cache.local"]
  }
}