2024-03-04 10:44:38 +00:00
<!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/PodCreateOptions" data-has-hydrated = "false" >
< head >
< meta charset = "UTF-8" >
2024-11-20 14:22:05 +00:00
< meta name = "generator" content = "Docusaurus v3.6.2" >
2024-03-04 10:44:38 +00:00
< title data-rh = "true" > Interface: PodCreateOptions | 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/PodCreateOptions" > < 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: PodCreateOptions | 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/PodCreateOptions" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/api/interfaces/PodCreateOptions" hreflang = "en" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/api/interfaces/PodCreateOptions" 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" >
2024-11-21 13:29:22 +00:00
< 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.117dce5f.css" >
2024-11-26 15:07:52 +00:00
< script src = "/assets/js/runtime~main.ea5382b4.js" defer = "defer" > < / script >
< script src = "/assets/js/main.29118669.js" defer = "defer" > < / script >
2024-03-04 10:44:38 +00:00
< / head >
< body class = "navigation-with-keyboard" >
2024-11-20 14:22:05 +00:00
< 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 window . 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 = "/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 > < a class = "navbar__item navbar__link" href = "/tutorial" > Tutorials< / 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" aria-pressed = "true" > < 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
2024-08-14 11:49:56 +00:00
< 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 = "exit_policy" > exit_policy?< a href = "#exit_policy" class = "hash-link" aria-label = "Direct link to exit_policy?" title = "Direct link to exit_policy?" > < / a > < / h3 >
2024-03-04 10:44:38 +00:00
< blockquote >
2024-06-13 13:39:41 +00:00
< p > < code > optional< / code > < strong > exit_policy< / strong > : < code > string< / code > < / p >
2024-03-04 10:44:38 +00:00
< / blockquote >
2024-06-13 13:39:41 +00:00
< p > ExitPolicy determines the pod' s exit and stop behaviour.< / p >
2024-08-14 11:49:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "examples" > Examples< a href = "#examples" class = "hash-link" aria-label = "Direct link to Examples" title = "Direct link to Examples" > < / a > < / h4 >
2024-06-13 13:39:41 +00:00
< div class = "language-ts codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_D5yF" > < pre tabindex = "0" class = "prism-code language-ts codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token string-property property" > " continue" < / span > < span class = "token operator" > :< / span > < span class = "token plain" > the pod continues running< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > .< / span > < span class = "token plain" > This < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > is< / span > < span class = "token plain" > the < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > default< / span > < span class = "token plain" > policy< / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > when creating a pod< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > .< / span > < br > < / span > < / code > < / pre > < div class = "buttonGroup_aaMX" > < button type = "button" aria-label = "Copy code to clipboard" title = "Copy" class = "clean-btn" > < span class = "copyButtonIcons_z5j7" aria-hidden = "true" > < svg viewBox = "0 0 24 24" class = "copyButtonIcon_FoOz" > < path fill = "currentColor" d = "M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" > < / path > < / svg > < svg viewBox = "0 0 24 24" class = "copyButtonSuccessIcon_L0B6" > < path fill = "currentColor" d = "M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" > < / path > < / svg > < / span > < / button > < / div > < / div > < / div >
< div class = "language-ts codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_D5yF" > < pre tabindex = "0" class = "prism-code language-ts codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token string-property property" > " stop" < / span > < span class = "token operator" > :< / span > < span class = "token plain" > stop the pod when the last container exits< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > .< / span > < span class = "token plain" > This < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > is< / span > < span class = "token plain" > the< / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > default< / span > < span class = "token plain" > behaviour < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > for< / span > < span class = "token plain" > play kube< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > .< / span > < br > < / span > < / code > < / pre > < div class = "buttonGroup_aaMX" > < button type = "button" aria-label = "Copy code to clipboard" title = "Copy" class = "clean-btn" > < span class = "copyButtonIcons_z5j7" aria-hidden = "true" > < svg viewBox = "0 0 24 24" class = "copyButtonIcon_FoOz" > < path fill = "currentColor" d = "M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" > < / path > < / svg > < svg viewBox = "0 0 24 24" class = "copyButtonSuccessIcon_L0B6" > < path fill = "currentColor" d = "M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" > < / path > < / svg > < / span > < / button > < / div > < / div > < / div >
2024-09-09 10:44:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "defined-in" > Defined in< a href = "#defined-in" class = "hash-link" aria-label = "Direct link to Defined in" title = "Direct link to Defined in" > < / a > < / h4 >
2024-11-26 15:07:52 +00:00
< p > < a href = "https://github.com/podman-desktop/podman-desktop/blob/92b49603d373e4ad7c8f44aae3979e2adc95b127/packages/extension-api/src/extension-api.d.ts#L467" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:467< / a > < / p >
2024-06-13 13:39:41 +00:00
< hr >
2024-08-14 11:49:56 +00:00
< 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 >
2024-06-13 13:39:41 +00:00
< blockquote >
< p > < code > optional< / code > < strong > labels< / strong > : < code > object< / code > < / p >
< / blockquote >
< p > Labels are key-value pairs that are used to add metadata to pods. Optional.< / p >
2024-09-09 10:44:56 +00:00
< 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 >
2024-06-13 13:39:41 +00:00
< p > [< code > key< / code > : < code > string< / code > ]: < code > string< / code > < / p >
2024-09-09 10:44:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "defined-in-1" > Defined in< a href = "#defined-in-1" class = "hash-link" aria-label = "Direct link to Defined in" title = "Direct link to Defined in" > < / a > < / h4 >
2024-11-26 15:07:52 +00:00
< p > < a href = "https://github.com/podman-desktop/podman-desktop/blob/92b49603d373e4ad7c8f44aae3979e2adc95b127/packages/extension-api/src/extension-api.d.ts#L428" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:428< / a > < / p >
2024-06-13 13:39:41 +00:00
< hr >
2024-08-14 11:49:56 +00:00
< h3 class = "anchor anchorWithStickyNavbar_JmGV" id = "name" > name?< a href = "#name" class = "hash-link" aria-label = "Direct link to name?" title = "Direct link to name?" > < / a > < / h3 >
2024-06-13 13:39:41 +00:00
< blockquote >
< p > < code > optional< / code > < strong > name< / strong > : < code > string< / code > < / p >
< / blockquote >
< p > Name is the name of the pod. If not provided, a name will be generated when the pod is created. Optional.< / p >
2024-09-09 10:44:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "defined-in-2" > Defined in< a href = "#defined-in-2" class = "hash-link" aria-label = "Direct link to Defined in" title = "Direct link to Defined in" > < / a > < / h4 >
2024-11-26 15:07:52 +00:00
< p > < a href = "https://github.com/podman-desktop/podman-desktop/blob/92b49603d373e4ad7c8f44aae3979e2adc95b127/packages/extension-api/src/extension-api.d.ts#L418" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:418< / a > < / p >
2024-07-02 10:55:41 +00:00
< hr >
2024-08-14 11:49:56 +00:00
< h3 class = "anchor anchorWithStickyNavbar_JmGV" id = "netns" > netns?< a href = "#netns" class = "hash-link" aria-label = "Direct link to netns?" title = "Direct link to netns?" > < / a > < / h3 >
2024-07-02 10:55:41 +00:00
< blockquote >
< p > < code > optional< / code > < strong > netns< / strong > : < code > object< / code > < / p >
< / blockquote >
< p > Network namespace< / p >
2024-08-14 11:49:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "nsmode" > nsmode< a href = "#nsmode" class = "hash-link" aria-label = "Direct link to nsmode" title = "Direct link to nsmode" > < / a > < / h4 >
2024-07-02 10:55:41 +00:00
< blockquote >
< p > < strong > nsmode< / strong > : < code > string< / code > < / p >
< / blockquote >
< p > NamespaceMode< / p >
2024-08-14 11:49:56 +00:00
< h5 class = "anchor anchorWithStickyNavbar_JmGV" id = "examples-1" > Examples< a href = "#examples-1" class = "hash-link" aria-label = "Direct link to Examples" title = "Direct link to Examples" > < / a > < / h5 >
2024-07-02 10:55:41 +00:00
< div class = "language-ts codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_D5yF" > < pre tabindex = "0" class = "prism-code language-ts codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token template-string template-punctuation string" style = "color:rgb(255, 121, 198)" > `< / span > < span class = "token template-string string" style = "color:rgb(255, 121, 198)" > bridge< / span > < span class = "token template-string template-punctuation string" style = "color:rgb(255, 121, 198)" > `< / span > < span class = "token plain" > indicates that the network < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > backend< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > (< / span > < span class = "token constant" style = "color:rgb(189, 147, 249)" > CNI< / span > < span class = "token operator" > /< / span > < span class = "token plain" > netavark< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > )< / span > < span class = "token plain" > should be used< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > .< / span > < br > < / span > < / code > < / pre > < div class = "buttonGroup_aaMX" > < button type = "button" aria-label = "Copy code to clipboard" title = "Copy" class = "clean-btn" > < span class = "copyButtonIcons_z5j7" aria-hidden = "true" > < svg viewBox = "0 0 24 24" class = "copyButtonIcon_FoOz" > < path fill = "currentColor" d = "M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" > < / path > < / svg > < svg viewBox = "0 0 24 24" class = "copyButtonSuccessIcon_L0B6" > < path fill = "currentColor" d = "M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" > < / path > < / svg > < / span > < / button > < / div > < / div > < / div >
< div class = "language-ts codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_D5yF" > < pre tabindex = "0" class = "prism-code language-ts codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token template-string template-punctuation string" style = "color:rgb(255, 121, 198)" > `< / span > < span class = "token template-string string" style = "color:rgb(255, 121, 198)" > pasta< / span > < span class = "token template-string template-punctuation string" style = "color:rgb(255, 121, 198)" > `< / span > < span class = "token plain" > indicates that a pasta network stack should be used< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > .< / span > < br > < / span > < / code > < / pre > < div class = "buttonGroup_aaMX" > < button type = "button" aria-label = "Copy code to clipboard" title = "Copy" class = "clean-btn" > < span class = "copyButtonIcons_z5j7" aria-hidden = "true" > < svg viewBox = "0 0 24 24" class = "copyButtonIcon_FoOz" > < path fill = "currentColor" d = "M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" > < / path > < / svg > < svg viewBox = "0 0 24 24" class = "copyButtonSuccessIcon_L0B6" > < path fill = "currentColor" d = "M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" > < / path > < / svg > < / span > < / button > < / div > < / div > < / div >
2024-09-09 10:44:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "defined-in-3" > Defined in< a href = "#defined-in-3" class = "hash-link" aria-label = "Direct link to Defined in" title = "Direct link to Defined in" > < / a > < / h4 >
2024-11-26 15:07:52 +00:00
< p > < a href = "https://github.com/podman-desktop/podman-desktop/blob/92b49603d373e4ad7c8f44aae3979e2adc95b127/packages/extension-api/src/extension-api.d.ts#L447" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:447< / a > < / p >
2024-09-09 10:44:56 +00:00
< hr >
< h3 class = "anchor anchorWithStickyNavbar_JmGV" id = "networks" > Networks?< a href = "#networks" class = "hash-link" aria-label = "Direct link to Networks?" title = "Direct link to Networks?" > < / a > < / h3 >
< blockquote >
< p > < code > optional< / code > < strong > Networks< / strong > : < code > object< / code > < / p >
< / blockquote >
< p > Map of networks names to ids the container should join to.
You can request additional settings for each network, you can set network aliases,< / 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 > object< / code > < / p >
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "remarks" > Remarks< a href = "#remarks" class = "hash-link" aria-label = "Direct link to Remarks" title = "Direct link to Remarks" > < / a > < / h4 >
< p > PodCreateOptions.netns.nsmode need to be set to < code > bridge< / code > to join a network< / p >
2024-08-14 11:49:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "defined-in-4" > Defined in< a href = "#defined-in-4" class = "hash-link" aria-label = "Direct link to Defined in" title = "Direct link to Defined in" > < / a > < / h4 >
2024-11-26 15:07:52 +00:00
< p > < a href = "https://github.com/podman-desktop/podman-desktop/blob/92b49603d373e4ad7c8f44aae3979e2adc95b127/packages/extension-api/src/extension-api.d.ts#L438" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:438< / a > < / p >
2024-03-04 10:44:38 +00:00
< hr >
2024-08-14 11:49:56 +00:00
< h3 class = "anchor anchorWithStickyNavbar_JmGV" id = "portmappings" > portmappings?< a href = "#portmappings" class = "hash-link" aria-label = "Direct link to portmappings?" title = "Direct link to portmappings?" > < / a > < / h3 >
2024-03-04 10:44:38 +00:00
< blockquote >
2024-04-23 13:30:46 +00:00
< p > < code > optional< / code > < strong > portmappings< / strong > : < a href = "/api/interfaces/PodCreatePortOptions" > < code > PodCreatePortOptions< / code > < / a > []< / p >
2024-03-04 10:44:38 +00:00
< / blockquote >
2024-06-13 13:39:41 +00:00
< p > PortMappings is a set of ports to map into the infra container.
As, by default, containers share their network with the infra container, this will forward the ports to the entire pod.
Only available if NetNS is set to Bridge, Slirp, or Pasta.< / p >
2024-08-14 11:49:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "defined-in-5" > Defined in< a href = "#defined-in-5" class = "hash-link" aria-label = "Direct link to Defined in" title = "Direct link to Defined in" > < / a > < / h4 >
2024-11-26 15:07:52 +00:00
< p > < a href = "https://github.com/podman-desktop/podman-desktop/blob/92b49603d373e4ad7c8f44aae3979e2adc95b127/packages/extension-api/src/extension-api.d.ts#L424" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:424< / a > < / p >
2024-03-04 10:44:38 +00:00
< hr >
2024-08-14 11:49:56 +00:00
< 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 >
2024-03-04 10:44:38 +00:00
< blockquote >
2024-04-23 13:30:46 +00:00
< p > < code > optional< / code > < strong > provider< / strong > : < a href = "/api/interfaces/ContainerProviderConnection" > < code > ContainerProviderConnection< / code > < / a > < / p >
2024-03-04 10:44:38 +00:00
< / blockquote >
2024-08-14 11:49:56 +00:00
< h4 class = "anchor anchorWithStickyNavbar_JmGV" id = "defined-in-6" > Defined in< a href = "#defined-in-6" class = "hash-link" aria-label = "Direct link to Defined in" title = "Direct link to Defined in" > < / a > < / h4 >
2024-11-26 15:07:52 +00:00
< p > < a href = "https://github.com/podman-desktop/podman-desktop/blob/92b49603d373e4ad7c8f44aae3979e2adc95b127/packages/extension-api/src/extension-api.d.ts#L430" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:430< / 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/PodContainerInfo" > < div class = "pagination-nav__sublabel" > Previous< / div > < div class = "pagination-nav__label" > PodContainerInfo< / div > < / a > < a class = "pagination-nav__link pagination-nav__link--next" href = "/api/interfaces/PodCreatePortOptions" > < div class = "pagination-nav__sublabel" > Next< / div > < div class = "pagination-nav__label" > PodCreatePortOptions< / 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 = "#exit_policy" class = "table-of-contents__link toc-highlight" > exit_policy?< / a > < / li > < li > < a href = "#labels" class = "table-of-contents__link toc-highlight" > labels?< / a > < / li > < li > < a href = "#name" class = "table-of-contents__link toc-highlight" > name?< / a > < / li > < li > < a href = "#netns" class = "table-of-contents__link toc-highlight" > netns?< / a > < / li > < li > < a href = "#networks" class = "table-of-contents__link toc-highlight" > Networks?< / a > < / li > < li > < a href = "#portmappings" class = "table-of-contents__link toc-highlight" > portmappings?< / a > < / li > < li > < a href = "#provider" class = "table-of-contents__link toc-highlight" > provider?< / 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" > Links< / div > < ul class = "footer__items clean-list" > < li class = "footer__item" > < a href = "https://github.com/containers/podman-desktop" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > GitHub< svg width = "13.5" height = "13.5" aria-hidden = "true" viewBox = "0 0 24 24" class = "iconExternalLink_nPrP" > < path fill = "currentColor" d = "M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z" > < / path > < / svg > < / a > < / li > < li class = "footer__item" > < a href = "https://discord.com/invite/x5GzFF6QH4" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Chat (bridged): #podman-desktop on Discord< svg width = "13.5" height = "13.5" aria-hidden = "true" viewBox = "0 0 24 24" class = "iconExternalLink_nPrP" > < path fill = "currentColor" d = "M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z" > < / path > < / svg > < / a > < / li > < li class = "footer__item" > < a href = "https://github.com/containers/podman-desktop#communication" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Other ways to Communicate< svg width = "13.5" height = "13.5" aria-hidden = "true" viewBox = "0 0 24 24" class = "iconExternalLink_nPrP" > < path fill = "currentColor" d = "M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z" > < / path > < / svg > < / a > < / li > < li class = "footer__item" > < a href = "https://github.com/orgs/containers/projects/4/views/8" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Current Sprint< svg width = "13.5" height = "13.5" aria-hidden = "true" viewBox = "0 0 24 24" class = "iconExternalLink_nPrP" > < path fill = "currentColor"
2024-03-04 10:44:38 +00:00
< / body >
< / html >
