crusade-tracker/system/caches/pluginsDslCache/doc/jetbrains.build-server.configs.kotlin.v10.build-features/-docker-support-feature/index.html

110 lines
6.0 KiB
HTML
Raw Normal View History

2021-01-18 20:27:50 +00:00
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DockerSupportFeature - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10.buildFeatures</a>&nbsp;/&nbsp;<a href="./index.html">DockerSupportFeature</a><br/>
<br/>
<h1>DockerSupportFeature</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">DockerSupportFeature</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/index.html"><span class="identifier">BuildFeature</span></a></code>
<p><a href="https://www.jetbrains.com/help/teamcity/?Docker+Support">Docker Support feature</a>
tracks pushed images and adds a dedicated tab with information about them.</p>
<p><strong>See Also</strong><br/>
<p><a href="../docker-support.html">dockerSupport</a></p>
</p>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-login-to-registry/index.html">LoginToRegistry</a></p>
</td>
<td>
<code><span class="keyword">sealed</span> <span class="keyword">class </span><span class="identifier">LoginToRegistry</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-compound-param/index.html"><span class="identifier">CompoundParam</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">DockerSupportFeature</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature)/init">init</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">DockerSupportFeature</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature)/base">base</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">DockerSupportFeature</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="cleanup-pushed-images.html">cleanupPushedImages</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">cleanupPushedImages</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">?</span></code>
<p>On server clean-up, delete pushed docker images from registry.</p>
</td>
</tr>
<tr>
<td>
<p><a href="login-to-registry.html">loginToRegistry</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">loginToRegistry</span><span class="symbol">: </span><a href="-login-to-registry/index.html"><span class="identifier">LoginToRegistry</span></a><span class="symbol">?</span></code>
<p>Log in to the Docker registry with the given ID before the build.</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/enabled.html">enabled</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">enabled</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
<p>Specifies whether the feature is enabled</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/id.html">id</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">id</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Build feature id, if not specified will be generated</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/type.html">type</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
<p>Build feature type</p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="on.html">on</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">on</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature$on(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildFeatures.DockerSupportFeature.LoginToRegistry.On, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="-login-to-registry/-on/index.html"><span class="identifier">On</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="-login-to-registry/-on/index.html"><span class="identifier">On</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>