com.google.cloud.tools.jib.image.json

Class ContainerConfigurationTemplate

java.lang.Object

com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

All Implemented Interfaces:

JsonTemplate

public class ContainerConfigurationTemplate
extends Object
implements JsonTemplate

JSON Template for Docker Container Configuration referenced in Docker Manifest Schema V2.2

Example container config JSON:

 {
   "created": "1970-01-01T00:00:00Z",
   "architecture": "amd64",
   "os": "linux",
   "config": {
     "Env": ["/usr/bin/java"],
     "Entrypoint": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"],
     "Cmd": ["arg1", "arg2"],
     "Healthcheck": {
       "Test": ["CMD-SHELL", "/usr/bin/check-health localhost"],
       "Interval": 30000000000,
       "Timeout": 10000000000,
       "StartPeriod": 0,
       "Retries": 3
     }
     "ExposedPorts": { "6000/tcp":{}, "8000/tcp":{}, "9000/tcp":{} },
     "Volumes":{"/var/job-result-data":{},"/var/log/my-app-logs":{}}},
     "Labels": { "com.example.label": "value" },
     "WorkingDir": "/home/user/workspace",
     "User": "me"
   },
   "history": [
     {
       "author": "Jib",
       "created": "1970-01-01T00:00:00Z",
       "created_by": "jib"
     },
     {
       "author": "Jib",
       "created": "1970-01-01T00:00:00Z",
       "created_by": "jib"
     }
   ]
   "rootfs": {
     "diff_ids": [
       "sha256:2aebd096e0e237b447781353379722157e6c2d434b9ec5a0d63f2a6f07cf90c2",
       "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef",
     ],
     "type": "layers"
   }
 
 }

See Also:

Image Manifest Version 2, Schema 2

Constructor Summary

Constructors

Constructor and Description
ContainerConfigurationTemplate()

Method Summary

Modifier and Type	Method and Description
void	addHistoryEntry(HistoryEntry historyEntry)
void	addLayerDiffId(DescriptorDigest diffId)
String	getArchitecture() Returns the architecture for which this container was built.
int	getLayerCount()
DescriptorDigest	getLayerDiffId(int index)
String	getOs() Returns the operating system for which this container was built.
void	setArchitecture(String architecture) Sets the architecture for which this container was built.
void	setContainerCmd(List<String> cmd)
void	setContainerEntrypoint(List<String> command)
void	setContainerEnvironment(List<String> environment)
void	setContainerExposedPorts(Map<String,Map<?,?>> exposedPorts)
void	setContainerHealthCheckInterval(Long interval)
void	setContainerHealthCheckRetries(Integer retries)
void	setContainerHealthCheckStartPeriod(Long startPeriod)
void	setContainerHealthCheckTest(List<String> test)
void	setContainerHealthCheckTimeout(Long timeout)
void	setContainerLabels(Map<String,String> labels)
void	setContainerUser(String user)
void	setContainerVolumes(Map<String,Map<?,?>> volumes)
void	setContainerWorkingDir(String workingDirectory)
void	setCreated(String created)
void	setOs(String os) Sets the operating system for which this container was built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContainerConfigurationTemplate

public ContainerConfigurationTemplate()

Method Detail

setCreated

public void setCreated(@Nullable
                       String created)

setArchitecture

public void setArchitecture(String architecture)

Sets the architecture for which this container was built. See the OCI Image Configuration specification for acceptable values.

Parameters:

architecture - value for the architecture field

setOs

public void setOs(String os)

Sets the operating system for which this container was built. See the OCI Image Configuration specification for acceptable values.

Parameters:

os - value for the os field

setContainerEnvironment

public void setContainerEnvironment(@Nullable
                                    List<String> environment)

setContainerEntrypoint

public void setContainerEntrypoint(@Nullable
                                   List<String> command)

setContainerCmd

public void setContainerCmd(@Nullable
                            List<String> cmd)

setContainerHealthCheckTest

public void setContainerHealthCheckTest(List<String> test)

setContainerHealthCheckInterval

public void setContainerHealthCheckInterval(@Nullable
                                            Long interval)

setContainerHealthCheckTimeout

public void setContainerHealthCheckTimeout(@Nullable
                                           Long timeout)

setContainerHealthCheckStartPeriod

public void setContainerHealthCheckStartPeriod(@Nullable
                                               Long startPeriod)

setContainerHealthCheckRetries

public void setContainerHealthCheckRetries(@Nullable
                                           Integer retries)

setContainerExposedPorts

public void setContainerExposedPorts(@Nullable
                                     Map<String,Map<?,?>> exposedPorts)

setContainerLabels

public void setContainerLabels(@Nullable
                               Map<String,String> labels)

setContainerWorkingDir

public void setContainerWorkingDir(@Nullable
                                   String workingDirectory)

setContainerUser

public void setContainerUser(@Nullable
                             String user)

setContainerVolumes

public void setContainerVolumes(@Nullable
                                Map<String,Map<?,?>> volumes)

addLayerDiffId

public void addLayerDiffId(DescriptorDigest diffId)

addHistoryEntry

public void addHistoryEntry(HistoryEntry historyEntry)

getArchitecture

public String getArchitecture()

Returns the architecture for which this container was built. See the OCI Image Configuration specification for acceptable values.

Returns:

the architecture field

getOs

public String getOs()

Returns the operating system for which this container was built. See the OCI Image Configuration specification for acceptable values.

Returns:

the os field

getLayerDiffId

public DescriptorDigest getLayerDiffId(int index)

getLayerCount

public int getLayerCount()