mirror of
https://github.com/mcuadros/ascode
synced 2025-11-16 05:17:13 +01:00
5 lines
5.8 KiB
HTML
5 lines
5.8 KiB
HTML
<!doctype html><html lang=en><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><title>docker - AsCode - Terraform Alternative Syntax</title><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=https://ascode.run/images/favicon.png><link rel=stylesheet href=/css/style.min.df49831c6872564dff31a5f0978a9571f2c8110b513d4b3b1fc8ead41dcdc9f0.css></head><body class="page page-default-single"><div id=main-menu-mobile class=main-menu-mobile><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><div class=wrapper><div class=header><div class=container><div class=logo><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div class=logo-mobile><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div id=main-menu class=main-menu><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><button id=toggle-main-menu-mobile class="hamburger hamburger--slider" type=button>
|
|
<span class=hamburger-box><span class=hamburger-inner></span></span></button></div></div><div class="main container pt-2 pt-md-6 pb-3 pb-md-6"><div class=row><div class="col-12 col-md-3 mb-3"><div class=sidebar><div class=docs-menu><h4><a href=/docs/reference/>API Reference</a></h4><ul><li><a href=/docs/reference/types/>built-in</a></li><li><a class=active href=/docs/reference/docker/>docker</a></li><li><a href=/docs/reference/base64/>encoding/base64</a></li><li><a href=/docs/reference/csv/>encoding/csv</a></li><li><a href=/docs/reference/json/>encoding/json</a></li><li><a href=/docs/reference/yaml/>encoding/yaml</a></li><li><a href=/docs/reference/http/>http</a></li><li><a href=/docs/reference/math/>math</a></li><li><a href=/docs/reference/os/>os</a></li><li><a href=/docs/reference/filepath/>path/filepath</a></li><li><a href=/docs/reference/re/>re</a></li><li><a href=/docs/reference/time/>time</a></li><li><a href=/docs/reference/url/>url</a></li></ul></div><div style=font-size:90%;margin-top:40px><a href=/docs/>« Documentation</a></div></div></div><div class="col-12 col-md-9"><h1 class=title>docker</h1><div class=content><h2 id=index>Index</h2><div class=toc><nav id=TableOfContents><ul><li><a href=#overview>Overview</a></li><li><a href=#functions>Functions</a><ul><li><a href=#def-bimageb>def <b>image</b></a></li></ul></li><li><a href=#types>Types</a><ul><li><a href=#type-bimageb>type <b>Image</b></a></li></ul></li></ul></nav></div><h2 id=overview>Overview</h2><p>The docker modules allow you to manipulate docker image names.</p><h2 id=functions>Functions</h2><h3 id=def-bimageb>def <b>image</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>image</span><span class=p>(</span><span class=nx>image</span><span class=p>,</span> <span class=nx>constraint</span><span class=p>)</span> <span class=nx>Image</span>
|
|
</code></pre></div><p>Returns a new <code>Image</code> based on a given image and constraint.</p><h6 id=arguments>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>image</code></td><td><code>string</code></td><td>Container image name. Eg.: <code>ubuntu</code> or <code>quay.io/prometheus/prometheus</code>.</td></tr><tr><td><code>constraint</code></td><td><code>string</code></td><td><a href=https://github.com/Masterminds/semver/#checking-version-constraints>Semver</a> contraint. Eg.: <code>1.2.*</code></td></tr></tbody></table><h2 id=types>Types</h2><h3 id=type-bimageb>type <b>Image</b></h3><p>Represents a docker container image.</p><h6 id=properties>Properties</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>string</code></td><td>Image name. Eg.: <code>docker.io/library/fedora</code></td></tr><tr><td><code>domain</code></td><td><code>string</code></td><td>Registry domain. Eg.: <code>docker.io</code>.</td></tr><tr><td><code>path</code></td><td><code>string</code></td><td>Repository path. Eg.: <code>library/fedora</code></td></tr></tbody></table><h6 id=methods>Methods</h6><h4 id=def-iimageibtagsb>def <i>Image</i>.<b>tags</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>Image</span><span class=p>.</span><span class=nf>tags</span><span class=p>()</span> <span class=nx>list</span>
|
|
</code></pre></div><p>List of all the tags for this container image.</p><h4 id=def-iimageibversionb>def <i>Image</i>.<b>version</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>Image</span><span class=p>.</span><span class=nf>version</span><span class=p>()</span> <span class=kt>string</span>
|
|
</code></pre></div><p>Return the highest tag matching the image constraint.</p><h6 id=arguments-1>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>full</code></td><td><code>bool</code></td><td>If <code>true</code> returns the image name plus the tag. Eg.: <code>docker.io/library/fedora:29</code></td></tr></tbody></table></div></div></div></div></div></div><div class=sub-footer><div class=container><div class=row><div class=col-12><div class=sub-footer-inner><ul><li><a href=https://github.com/mcuadros/ascod>Documentation version v1.3.0</a></li><li>Template by <a href=https://www.zerostatic.io>Robert Austin</a></li></ul></div></div></div></div><script type=text/javascript src=/js/scripts.min.be6fe1294698d6acd837c5182149cd1a24daae9fa1903ce810c264539d254d62.js></script></body></html> |