Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Launch Docker Image Screens

  10 minute read.

Last Modified 2022-10-26 16:58 EDT

Launch Docker Image on the Applications screen opens a configuration wizard that steps through the application creation process using Docker image when selected while on the Available Applications tab.

AppsScreenHeaderSCALE

The docker image wizard includes 12 configuration screens and a Confirm Options screen that displays a summary of some of the setting options configured. The Launch Docker Image wizard allows you to configure third-party applications using settings based on Kubernetes. You can use the wizard to configure applications not included in the Official catalog or to do a more advanced installation of official catalog applications.

Application Name Screen

The Application Name screen is the first step in the Launch Docker Image configuration wizard.

LaunchDockerImageApplicationName

SettingDescription
Application NameEnter a name for the application you are adding. The name must have lowercase alphanumeric characters, must begin with an alphabet character and can end with an alphanumeric character. The name can contain a hyphen (-) but not as the first or last character in the name. For example, using chia-1 but not -chia1 or 1chia- as a valid name.

Container Images Screen

The Container Images settings specify the Docker image details. Always refer to the dockerhub page for information on what the docker container requires.

Define the image tag, when the image is pulled from the remote repository, how the container is updated, and when a container automatically restarts with these settings.

LaunchDockerImageContainerImages

SettingDescription
Image RepositoryRequired. Enter the Docker image repository name. For example, for Plex enter plexinc/pms-docker.
Image TagEnter the tag for the specified image. For example, for Plex enter 1.20.2.3402-0fec14d92.
Image Pull PolicySelect the Docker image pull policy from the dropdown list. Options are Only pull image if not present on host, Always pull image even if present on host, or Never pull image even if it’s not present on host.

Container Entrypoint

The Container Entrypoint settings specify both commands and arguement options the application requires.

Define any commands and arguments to use for the image. These can override any existing commands stored in the image. Check the documentation for the application you want to install using a Docker Image for entrypoint commands or arguments you need to enter.

LaunchDockerImageContainerEntrypoints

SettingDescription
Configure Container CMDClick Add to display a Command field.
CommandEnter container command. For example, if adding MinIO, enter SERVER.
Configure Container ArgsClick Add to display an argument entry Arg field. Click again to add more arguments.
ArgumentEnter an argument. For example, if adding MinIO, enter the IP and port string such as http://0.0.0.0/9000/data.

Container Environment Variables

The Container Environment Variables settings specify container environment variables the container/image needs.

You can also define additional environment variables for the container. Be sure to check the documentation for the image you are trying to deploy and add any required variables here.

LaunchDockerImageContainerEnvironmentVariables

SettingDescription
Configure Container Environment VariablesClick Add to display a block of Container Environment Variables. Click again to add more blocks for environment variables.
Container Environment VariablesContainer environmental variable name and value fields.
Environment Variable NameEnter the environment variable name. For example, if installing Pi-Hole enter *TZ for timezone.
Environment Variable ValueEnter the value for the variable specified in Environment Variable Name. For example, for Pi-Hole timezone variable, enter AmericaNewYork.

Networking

The Networking settings specify network policy, addresses, and DNS services if the container needs special networking configuration.

See the Docker documentation for more details on host networking. Users can create additional network interfaces for the container if needed or give static IP addresses and routes to new interface. By default, containers use the DNS settings from the host system. You can change the DNS policy and define separate nameservers and search domains. See the Docker DNS services documentation for more details.

LaunchDockerImageNetworkingInterfaceDNSSettings

SettingDescription
Configure Add External InterfacesClick Add to displays a block of interface settings.
Interface ConfigurationRequired. Select an interface from the Host Interface dropdown list.
Host InterfaceRequired. Select a host interface on your system from the dropdown list.
IP Address ManagementSelect an option for how to manage the IP address from the IPAM Type dropdown list.
IPAM TypeRequired. Select an option from the dropdown list to specify the type for IPAM. Options are Use DHCP or Use Static IP. To add a default route, select Add route allow you to enter route destination IP /subnet 0.0.0.0/0. Enter the gateway (for example, 192.168.1.1). After submitting the docker image, navigate to Installed Applications, locate the docker image you added, select Edit and change the route destination/subnet to equal 0.0.0.0 /0.
DNS PolicySelect the option from the dropdown list that specifies the policy. Default behavior is where Pod inherits the name resolution configuration from the node that the pods run on. If None is specified, it allows a pod to ignore DNS settings from the Kubernetes environment. Options are:
Use Default DNS Policy where Pod inherits the name resolution configuration from the node.
Kubernetes internal DNS is prioritized and resolved first. If the domain does not resolve with internal kubernetes DNS, the DNS query forwards to the upstream nameserver inherited from the node. This useful if the workload to access other services, workflows, using kubernetes internal DNS.
For Pods running with hostNetwork and wanting to prioritize internal kubernetes DNS should make use of this policy.
Ignore DNS settings from the Kubernetes cluster.
DNS ConfigurationSpecify custom DNS configuration to apply to the pod. Click Add to dsiplay a Nameserver entry field. Click again to add another name server.
NameserverEnter the IP address of the name server.

LaunchDockerImageNetworkingInterfaceDNSSettings

SettingDescription
Configure SearchesClick Add to display a Search Entry field.
Search EntryEnter the search value you want to configure.
Configure DSN OptionsClick Add to display a block of Option Entry Configuration settings. Click again to display another block of settings if needed.
Option NameRequired. Enter the option name.
Option ValueRequired. Enter the value for the option name.
Provide access to node network namespace for the workloadSelect to enable.

Port Forwarding

The Port Forwarding settings specify the container and node ports and the transfer protocol to use.

Choose the protocol and enter port numbers for both the container and node. You can define multiple port forwards.

LaunchDockerImagePortForwarding

SettingDescription
Configure Specify Node ports to forward to workloadClick Add to display a block of Port Forwarding Configuration settings.
Container PortRequired. Do not enter the same port number used by another system service or container.
Node PortRequired. Enter a node port number over 9000.
ProtocolSelect the protocol to use from the dropdown list. Options are TCP Protocol or UDP Protocol.

Storage

The Storage settings specify the host path configuration, memory backed volumes, and storage volumes.

Create the pool, dataset, zvol or directory for the container to use before you begin configuring the container as leaving the wizard closes it without saving.

Set the Host Path volume to a dataset and directory path. Somme apps like Pi-Hole use volumes store data between container upgrades. For host path volumes, you can mount SCALE storage locations inside the container. Define the path to the system storage and the container internal path for the system storage location to appear. For more details, see the Kubernetes hostPath documentation. Users can create additional Persistent Volumes (PVs) for storage within the container. PVs consume space from the pool chosen for application management. To do this, name each new dataset and define a path where that dataset appears inside the container.

LaunchDockerImageStorageHostPath

SettingDescription
Configure Host Path VolumesClick Add to display a block of Host Path Configuration settings. Click again to add another block of settings.
Host PathRequire. Enter or click arrow_right to the left of folder /mnt to browse to the location of the host path. Click on the dataset to select and display it in the Host Path field.
Mount PathRequired. Enter the /data directory where host path mounts inside the pod.
Read OnlySelect to make the mount path inside the pod read only and prevent using the container to store data.

LaunchDockerImageStorageVolumeSettings

SettingDescription
Configure Memory Backed VolumesClick Add to display a block of memory Backed Volume settings. Click again to display another block of settings.
Mount PathRequired. Enter the path where temporary path mounts inside the pod.
Configure VolumesClick Add to display a block of Volume settings. Click again to add another block of settings.
Mount PathRequired. Enter the path where the volume mounts inside the pod.
Dataset NameRequired. Enter the name of the dataset.

Workload Details

The Workload Details settings specify if containers in a pod run with TTY or STDIN enabled, allow it to enable any device on the host or configure host capabilities, and if you run the container as a user or group.

LaunchDockerImageWorkloadDetails

SettingDescription
Enable TTYSelect to set containers in a pod to run with TTY enabled. Disabled by default.
enable STDINSelect to set containers in a pod to run with STDIN enabled. Disabled by default.
Privileged ModeSelect to allow any container in a pod to enable any device on the host, but a privileged container is given access to all devices on the host. This allows the container nearly all the same access as processes running on the host.
Configure CapabilitiesClick Add to display a Add Capability field**. Click again to add another field.
Add CapabilityEnter a capability.
Configure Container User and Group IDSelect to display the Run Container as User and Run Container as Group settings to add security context (runAsUser and runAsGroup variables).
Run Container As UserEnter a user ID (numeric value) for container.
Run Container as GroupEnter a group ID (numeric value) for container.

Scaling/Upgrade Policy

Use Kill existing pods before creating new ones to recreate the container or Create new pods and then kill old ones if you want rolling upgrades.

LaunchDockerImageScalingUpgradePolicy

Select Create new pods and then kill the old ones to retain your existing configuration and container until the upgrade completes before removing it. Select Kill existing pods before creating new ones to remove the exiting pod and start with a new updated pod. This is useful if your old pod was not functioning properly. For fewer issues, select Kill existing pods before creating new ones.

Resource Reservation

The Resource Reservation screen specifies the GPU configuration.

Resource Limits

The Resource Limits setting specifies whether to Enable Pod resource limits.

Portal Configuration

The Portal Configuration setting specifies whether to Enable WebUI Portal (only supported in TrueNAS SCALE Bluefin).

Confirm Options

The Confirm Options screen displays a summary of the image/container configuration. Click Back to return to previous screens to make changes and Next to advance back to Confirm Options. Click Save to create the image and add the application to the Installed Applications screen.

Related Content

Related Apps Articles