Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
buildah-add(1)		     General Commands Manual		  buildah-add(1)

NAME
     buildah-add  -  Add  the  contents of a file, URL, or a directory to a con-
     tainer.

SYNOPSIS
     buildah add [options] container src [[src ...] dest]

DESCRIPTION
     Adds the contents of a file, URL, or a directory to a  container's  working
     directory or a specified location in the container.  If a local source file
     appears  to  be an archive, its contents are extracted and added instead of
     the archive file itself.  If a local directory is specified  as  a  source,
     its contents are copied to the destination.

OPTIONS
     --add-history

     Add  an  entry  to the history which will note the digest of the added con-
     tent.  Defaults to false.

     Note: You can also override the default value of --add-history  by  setting
     the BUILDAH_HISTORY environment variable. export BUILDAH_HISTORY=true

     --cert-dir path

     Use  certificates	at  path  (*.crt, *.cert, *.key) when connecting to reg-
     istries for pulling images named with the --from flag, and when  connecting
     to  HTTPS servers when fetching sources from locations specified with HTTPS
     URLs.  The default certificates directory is /etc/containers/certs.d.

     --checksum checksum

     Checksum the source content. The value of checksum must be a standard  con-
     tainer digest string. Only supported for HTTP sources.

     --chmod permissions

     Sets the access permissions of the destination content. Accepts the numeri-
     cal format.

     --chown owner:group

     Sets the user and group ownership of the destination content.

     --contextdir directory

     Build  context  directory. Specifying a context directory causes Buildah to
     chroot into that context directory. This means copying files pointed at  by
     symbolic links outside of the chroot will fail.

     --exclude pattern

     Exclude  copying files matching the specified pattern. Option can be speci-
     fied multiple times. See containerignore(5) for supported formats.

     --from containerOrImage

     Use the root directory of the specified working container or image  as  the
     root  directory  when  resolving  absolute source paths and the path of the
     context directory.  If an image needs to be pulled, options  recognized  by
     buildah pull can be used.

     --ignorefile file

     Path  to  an  alternative	.containerignore  (.dockerignore) file. Requires
     --contextdir be specified.

     --link

     Create an independent image layer for the added files instead of  modifying
     the working container's filesystem. If buildah run creates a file and buil-
     dah  add  --link  adds  a	file to the same path, the file from buildah add
     --link will be present in the committed image.  The --link layer is applied
     after all container filesystem changes at commit time.

     --quiet, -q

     Refrain from printing a digest of the added content.

     --retry attempts

     Number of times to retry in case of failure when pulling images  from  reg-
     istries or retrieving content from HTTPS URLs.

     Defaults to 3.

     --retry-delay duration

     Duration  of  delay  between retry attempts in case of failure when pulling
     images from registries or retrieving content from HTTPS URLs.

     Defaults to 2s.

     --timestamp seconds

     Set the timestamp ("mtime") for added content to  exactly	this  number  of
     seconds since the epoch (Unix time 0, i.e., 00:00:00 UTC on 1 January 1970)
     to help allow for deterministic builds.

     The  destination directory into which the content is being copied will most
     likely reflect the time at which the content was added to it.

     --tls-verify bool-value

     Require verification of certificates when retrieving sources from HTTPS lo-
     cations, or when pulling images referred to with the --from* flag (defaults
     to true).	TLS verification cannot be used when talking to an insecure reg-
     istry.

EXAMPLE
     buildah add containerID '/myapp/app.conf' '/myapp/app.conf'

     buildah   add   --chown   myuser:mygroup	containerID    '/myapp/app.conf'
     '/myapp/app.conf'

     buildah add --chmod 660 containerID '/myapp/app.conf' '/myapp/app.conf'

     buildah add containerID '/home/myuser/myproject.go'

     buildah add containerID '/home/myuser/myfiles.tar' '/tmp'

     buildah add containerID '/tmp/workingdir' '/tmp/workingdir'

     buildah	  add	   containerID	    'https://github.com/containers/buil-
     dah/blob/main/README.md' '/tmp'

     buildah add containerID 'passwd' 'certs.d' /etc

FILES
   .containerignore or .dockerignore
     If a .containerignore or .dockerignore file exists in  the  context  direc-
     tory,  buildah add reads its contents. If both exist, then .containerignore
     is used.

     When the --ignorefile option is specified Buildah reads it and uses  it  to
     decide  which content to exclude when copying content into the working con-
     tainer.

     Users can specify a series of Unix shell glob patterns in an ignore file to
     identify files/directories to exclude.

     Buildah supports a special wildcard string ** which matches any  number  of
     directories  (including  zero).  For  example, */.go will exclude all files
     that end with .go that are found in all directories.

     Example .containerignore/.dockerignore file:

     # here are files we want to exclude
     */*.c
     **/output*
     src

     */*.c Excludes files and directories whose names end with	.c  in	any  top
     level subdirectory. For example, the source file include/rootless.c.

     **/output* Excludes files and directories starting with output from any di-
     rectory.

     src  Excludes  files named src and the directory src as well as any content
     in it.

     Lines starting with ! (exclamation mark) can be used to make exceptions  to
     exclusions.  The  following  is  an example .containerignore file that uses
     this mechanism:

     *.doc
     !Help.doc

     Exclude all doc files except Help.doc when copying content  into  the  con-
     tainer.

     This  functionality  is  compatible  with	the handling of .containerignore
     files described here:

     https://github.com/containers/common/blob/main/docs/containerignore.5.md

SEE ALSO
     buildah(1), containerignore(5)

buildah 			   April 2021			  buildah-add(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=buildah-add&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help