podman-desktop/api/interfaces/BuildImageOptions.html

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-interfaces/BuildImageOptions" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.0.0">
<title data-rh="true">Interface: BuildImageOptions | Podman Desktop</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" name="twitter:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" property="og:url" content="https://podman-desktop.io/api/interfaces/BuildImageOptions"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-api-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-api-current"><meta data-rh="true" property="og:title" content="Interface: BuildImageOptions | Podman Desktop"><meta data-rh="true" name="description" content="Properties"><meta data-rh="true" property="og:description" content="Properties"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/interfaces/BuildImageOptions"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/BuildImageOptions" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/BuildImageOptions" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Podman Desktop Atom Feed">
<link rel="alternate" type="application/json" href="/blog/feed.json" title="Podman Desktop JSON Feed">


<link rel="search" type="application/opensearchdescription+xml" title="Podman Desktop" href="/opensearch.xml">

<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<script async src="//gc.zgo.at/count.js" data-goatcounter="https://podman-desktop-website.goatcounter.com/count"></script><link rel="stylesheet" href="/assets/css/styles.fded9501.css">
<script src="/assets/js/runtime~main.ee442abe.js" defer="defer"></script>
<script src="/assets/js/main.25e6558f.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):window.matchMedia("(prefers-color-scheme: light)").matches?t("light"):t("dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_oPtH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--light_hHel" height="56"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--dark_yETr" height="56"></div><b class="navbar__title text--truncate">podman desktop</b></a><a class="navbar__item navbar__link" href="/docs/intro">Documentation</a><a class="navbar__item navbar__link" href="/core-values">Core Values</a><a class="navbar__item navbar__link" href="/features">Features</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/extend">Extend</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_ki11 colorModeToggle_Hewu"><button class="clean-btn toggleButton_MMFG toggleButtonDisabled_Uw7m" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_lgto"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_U96C"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.9
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties"></a></h2>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="abortcontroller">abortController?<a href="#abortcontroller" class="hash-link" aria-label="Direct link to abortController?" title="Direct link to abortController?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>abortController</strong>: <code>AbortController</code></p>
</blockquote>
<p>The abort controller for running the build image operation</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source">Source<a href="#source" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2385" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2385</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="buildargs">buildargs?<a href="#buildargs" class="hash-link" aria-label="Direct link to buildargs?" title="Direct link to buildargs?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>buildargs</strong>: <code>Object</code></p>
</blockquote>
<p>JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the
buildargs as the environment context for commands run via the <code>Dockerfile</code> RUN instruction, or for variable
expansion in other <code>Dockerfilev</code> instructions. This is not meant for passing secret values.
For example, the build arg <code>FOO=bar</code> would become <code>{&quot;FOO&quot;:&quot;bar&quot;}</code> in JSON. This would result in the query
parameter <code>buildargs={&quot;FOO&quot;:&quot;bar&quot;}</code>. Note that <code>{&quot;FOO&quot;:&quot;bar&quot;}</code> should be URI component encoded.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="index-signature">Index signature<a href="#index-signature" class="hash-link" aria-label="Direct link to Index signature" title="Direct link to Index signature"></a></h4>
<p>[<code>key</code>: <code>string</code>]: <code>string</code></p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-1">Source<a href="#source-1" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2469" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2469</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="cachefrom">cachefrom?<a href="#cachefrom" class="hash-link" aria-label="Direct link to cachefrom?" title="Direct link to cachefrom?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>cachefrom</strong>: <code>string</code></p>
</blockquote>
<p>JSON array of images used for build cache resolution.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-2">Source<a href="#source-2" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2411" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2411</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="containerfile">containerFile?<a href="#containerfile" class="hash-link" aria-label="Direct link to containerFile?" title="Direct link to containerFile?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>containerFile</strong>: <code>string</code></p>
</blockquote>
<p>Specifies a Containerfile which contains instructions for building the image</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-3">Source<a href="#source-3" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2365" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2365</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="cpuperiod">cpuperiod?<a href="#cpuperiod" class="hash-link" aria-label="Direct link to cpuperiod?" title="Direct link to cpuperiod?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>cpuperiod</strong>: <code>number</code></p>
</blockquote>
<p>The length of a CPU period in microseconds.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-4">Source<a href="#source-4" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2455" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2455</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="cpuquota">cpuquota?<a href="#cpuquota" class="hash-link" aria-label="Direct link to cpuquota?" title="Direct link to cpuquota?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>cpuquota</strong>: <code>number</code></p>
</blockquote>
<p>Microseconds of CPU time that the container can get in a CPU period.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-5">Source<a href="#source-5" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2460" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2460</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="cpusetcpus">cpusetcpus?<a href="#cpusetcpus" class="hash-link" aria-label="Direct link to cpusetcpus?" title="Direct link to cpusetcpus?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>cpusetcpus</strong>: <code>number</code></p>
</blockquote>
<p>CPUs in which to allow execution (e.g., 0-3, 0,1).</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-6">Source<a href="#source-6" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2450" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2450</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="cpushares">cpushares?<a href="#cpushares" class="hash-link" aria-label="Direct link to cpushares?" title="Direct link to cpushares?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>cpushares</strong>: <code>number</code></p>
</blockquote>
<p>CPU shares (relative weight).</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-7">Source<a href="#source-7" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2445" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2445</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="extrahosts">extrahosts?<a href="#extrahosts" class="hash-link" aria-label="Direct link to extrahosts?" title="Direct link to extrahosts?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>extrahosts</strong>: <code>string</code></p>
</blockquote>
<p>Extra hosts to add to /etc/hosts</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-8">Source<a href="#source-8" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2390" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2390</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="forcerm">forcerm?<a href="#forcerm" class="hash-link" aria-label="Direct link to forcerm?" title="Direct link to forcerm?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>forcerm</strong>: <code>boolean</code></p>
</blockquote>
<p>Default: false</p>
<p>Always remove intermediate containers, even upon failure.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-9">Source<a href="#source-9" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2430" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2430</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="labels">labels?<a href="#labels" class="hash-link" aria-label="Direct link to labels?" title="Direct link to labels?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>labels</strong>: <code>Object</code></p>
</blockquote>
<p>Arbitrary key/value labels to set on the image, as a JSON map of string pairs.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="index-signature-1">Index signature<a href="#index-signature-1" class="hash-link" aria-label="Direct link to Index signature" title="Direct link to Index signature"></a></h4>
<p>[<code>key</code>: <code>string</code>]: <code>string</code></p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-10">Source<a href="#source-10" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2484" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2484</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="memory">memory?<a href="#memory" class="hash-link" aria-label="Direct link to memory?" title="Direct link to memory?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>memory</strong>: <code>number</code></p>
</blockquote>
<p>Set memory limit for build.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-11">Source<a href="#source-11" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2435" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2435</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="memswap">memswap?<a href="#memswap" class="hash-link" aria-label="Direct link to memswap?" title="Direct link to memswap?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>memswap</strong>: <code>number</code></p>
</blockquote>
<p>Total memory (memory + swap). Set as -1 to disable swap.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-12">Source<a href="#source-12" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2440" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2440</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="networkmode">networkmode?<a href="#networkmode" class="hash-link" aria-label="Direct link to networkmode?" title="Direct link to networkmode?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>networkmode</strong>: <code>string</code></p>
</blockquote>
<p>Sets the networking mode for the run commands during build. Supported standard values are: <code>bridge</code>,
<code>host</code>, <code>none</code>, and <code>container:&lt;name|id&gt;</code>. Any other value is taken as a custom network&#x27;s name or ID
to which this container should connect to.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-13">Source<a href="#source-13" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2491" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2491</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="nocache">nocache?<a href="#nocache" class="hash-link" aria-label="Direct link to nocache?" title="Direct link to nocache?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>nocache</strong>: <code>boolean</code></p>
</blockquote>
<p>Default: false</p>
<p>Do not use the cache when building the image.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-14">Source<a href="#source-14" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2512" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2512</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="outputs">outputs?<a href="#outputs" class="hash-link" aria-label="Direct link to outputs?" title="Direct link to outputs?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>outputs</strong>: <code>string</code></p>
</blockquote>
<p>Default: &quot;&quot;</p>
<p>BuildKit output configuration</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-15">Source<a href="#source-15" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2505" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2505</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="platform">platform?<a href="#platform" class="hash-link" aria-label="Direct link to platform?" title="Direct link to platform?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>platform</strong>: <code>string</code></p>
</blockquote>
<p>Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-16">Source<a href="#source-16" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2375" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2375</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="provider">provider?<a href="#provider" class="hash-link" aria-label="Direct link to provider?" title="Direct link to provider?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>provider</strong>: <code>any</code></p>
</blockquote>
<p>Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-17">Source<a href="#source-17" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2380" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2380</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="pull">pull?<a href="#pull" class="hash-link" aria-label="Direct link to pull?" title="Direct link to pull?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>pull</strong>: <code>string</code></p>
</blockquote>
<p>Attempt to pull the image even if an older image exists locally.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-18">Source<a href="#source-18" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2416" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2416</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="q">q?<a href="#q" class="hash-link" aria-label="Direct link to q?" title="Direct link to q?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>q</strong>: <code>boolean</code></p>
</blockquote>
<p>Default: false</p>
<p>Suppress verbose build output.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-19">Source<a href="#source-19" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2406" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2406</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="remote">remote?<a href="#remote" class="hash-link" aria-label="Direct link to remote?" title="Direct link to remote?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>remote</strong>: <code>string</code></p>
</blockquote>
<p>A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are
placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the
file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points
to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path
inside the tarball.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-20">Source<a href="#source-20" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2399" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2399</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="rm">rm?<a href="#rm" class="hash-link" aria-label="Direct link to rm?" title="Direct link to rm?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>rm</strong>: <code>boolean</code></p>
</blockquote>
<p>Default: true</p>
<p>Remove intermediate containers after a successful build.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-21">Source<a href="#source-21" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2423" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2423</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="shmsize">shmsize?<a href="#shmsize" class="hash-link" aria-label="Direct link to shmsize?" title="Direct link to shmsize?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>shmsize</strong>: <code>number</code></p>
</blockquote>
<p>Size of <code>/dev/shm</code> in bytes. The size must be greater than 0. If omitted the system uses 64MB.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-22">Source<a href="#source-22" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2474" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2474</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="squash">squash?<a href="#squash" class="hash-link" aria-label="Direct link to squash?" title="Direct link to squash?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>squash</strong>: <code>boolean</code></p>
</blockquote>
<p>Squash the resulting images layers into a single layer.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-23">Source<a href="#source-23" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2479" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2479</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="tag">tag?<a href="#tag" class="hash-link" aria-label="Direct link to tag?" title="Direct link to tag?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>tag</strong>: <code>string</code></p>
</blockquote>
<p>Specifies the name which is assigned to the resulting image if the build process completes successfully</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-24">Source<a href="#source-24" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2370" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2370</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="target">target?<a href="#target" class="hash-link" aria-label="Direct link to target?" title="Direct link to target?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>target</strong>: <code>string</code></p>
</blockquote>
<p>Default: &quot;&quot;</p>
<p>Target build stage</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-25">Source<a href="#source-25" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/fa84efb/packages/extension-api/src/extension-api.d.ts#L2498" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2498</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/interfaces/AuthenticationSessionsChangeEvent"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interface: AuthenticationSessionsChangeEvent</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/interfaces/CancellationToken"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interface: CancellationToken</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#abortcontroller" class="table-of-contents__link toc-highlight">abortController?</a></li><li><a href="#buildargs" class="table-of-contents__link toc-highlight">buildargs?</a></li><li><a href="#cachefrom" class="table-of-contents__link toc-highlight">cachefrom?</a></li><li><a href="#containerfile" class="table-of-contents__link toc-highlight">containerFile?</a></li><li><a href="#cpuperiod" class="table-of-contents__link toc-highlight">cpuperiod?</a></li><li><a href="#cpuquota" class="table-of-contents__link toc-highlight">cpuquota?</a></li><li><a href="#cpusetcpus" class="table-of-contents__link toc-highlight">cpusetcpus?</a></li><li><a href="#cpushares" class="table-of-contents__link toc-highlight">cpushares?</a></li><li><a href="#extrahosts" class="table-of-contents__link toc-highlight">extrahosts?</a></li><li><a href="#forcerm" class="table-of-contents__link toc-highlight">forcerm?</a></li><li><a href="#labels" class="table-of-contents__link toc-highlight">labels?</a></li><li><a href="#memory" class="table-of-contents__link toc-highlight">memory?</a></li><li><a href="#memswap" class="table-of-contents__link toc-highlight">memswap?</a></li><li><a href="#networkmode" class="table-of-contents__link toc-highlight">networkmode?</a></li><li><a href="#nocache" class="table-of-contents__link toc-highlight">nocache?</a></li><li><a href="#outputs" class="table-of-contents__link toc-highlight">outputs?</a></li><li><a href="#platform" class="table-of-contents__link toc-highlight">platform?</a></li><li><a href="#provider" class="table-of-contents__link toc-highlight">provider?</a></li><li><a href="#pull" class="table-of-contents__link toc-highlight">pull?</a></li><li><a href="#q" class="table-of-contents__link toc-highlight">q?</a></li><li><a href="#remote" class="table-of-contents__link toc-highlight">remote?</a></li><li><a href="#rm" class="table-of-contents__link toc-highlight">rm?</a></li><li><a href="#shmsize" class="table-of-contents__link toc-highlight">shmsize?</a></li><li><a href="#squash" class="table-of-contents__link toc-highlight">squash?</a></li><li><a href="#tag" class="table-of-contents__link toc-highlight">tag?</a></li><li><a href="#target" class="table-of-contents__link toc-highlight">target?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installing Podman Desktop</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/migrating-from-docker">Migrating from Docker</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/kubernetes">Working with Kubernetes</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title"
</body>
</html>