55835583 </ span >
55845584 </ a >
55855585
5586+ < nav class ="md-nav " aria-label ="resource_type schema ">
5587+ < ul class ="md-nav__list ">
5588+
5589+ < li class ="md-nav__item ">
5590+ < a href ="#name " class ="md-nav__link ">
5591+ < span class ="md-ellipsis ">
5592+
5593+ name
5594+
5595+ </ span >
5596+ </ a >
5597+
5598+ </ li >
5599+
5600+ < li class ="md-nav__item ">
5601+ < a href ="#type " class ="md-nav__link ">
5602+ < span class ="md-ellipsis ">
5603+
5604+ type
5605+
5606+ </ span >
5607+ </ a >
5608+
5609+ </ li >
5610+
5611+ < li class ="md-nav__item ">
5612+ < a href ="#source " class ="md-nav__link ">
5613+ < span class ="md-ellipsis ">
5614+
5615+ source
5616+
5617+ </ span >
5618+ </ a >
5619+
5620+ </ li >
5621+
5622+ < li class ="md-nav__item ">
5623+ < a href ="#privileged " class ="md-nav__link ">
5624+ < span class ="md-ellipsis ">
5625+
5626+ privileged
5627+
5628+ </ span >
5629+ </ a >
5630+
5631+ </ li >
5632+
5633+ < li class ="md-nav__item ">
5634+ < a href ="#params " class ="md-nav__link ">
5635+ < span class ="md-ellipsis ">
5636+
5637+ params
5638+
5639+ </ span >
5640+ </ a >
5641+
5642+ </ li >
5643+
5644+ < li class ="md-nav__item ">
5645+ < a href ="#check_every " class ="md-nav__link ">
5646+ < span class ="md-ellipsis ">
5647+
5648+ check_every
5649+
5650+ </ span >
5651+ </ a >
5652+
5653+ </ li >
5654+
5655+ < li class ="md-nav__item ">
5656+ < a href ="#tags " class ="md-nav__link ">
5657+ < span class ="md-ellipsis ">
5658+
5659+ tags
5660+
5661+ </ span >
5662+ </ a >
5663+
5664+ </ li >
5665+
5666+ < li class ="md-nav__item ">
5667+ < a href ="#defaults " class ="md-nav__link ">
5668+ < span class ="md-ellipsis ">
5669+
5670+ defaults
5671+
5672+ </ span >
5673+ </ a >
5674+
5675+ </ li >
5676+
5677+ </ ul >
5678+ </ nav >
5679+
55865680</ li >
55875681
55885682 </ ul >
@@ -5631,13 +5725,15 @@ <h1>Resource Types</h1>
56315725< h2 id ="resource_type-schema "> < code > resource_type</ code > schema</ h2 >
56325726< details class ="warning ">
56335727< summary > < strong > < code > name</ code > </ strong > : < a href ="../config-basics/#identifier-schema "> < code > identifier</ code > </ a > (required)</ summary >
5728+ < h3 id ="name "> < code > name</ code > </ h3 >
56345729< p > The name of the resource type. This should be short and simple. This name will be referenced by
56355730< a href ="../pipelines/#pipeline-schema "> < code > pipeline.resources</ code > </ a > defined within the same pipeline, and
56365731< a href ="../tasks/#task-config-schema "> < code > task-config.image_resource</ code > </ a > s used by tasks running in the pipeline.</ p >
56375732< p > Pipeline-provided resource types can override the core resource types by specifying the same name.</ p >
56385733</ details >
56395734< details class ="warning ">
56405735< summary > < strong > < code > type</ code > </ strong > : < a href ="./#resource_type-schema "> < code > resource_type.name</ code > </ a > | < a href ="../config-basics/#identifier-schema "> < code > identifier</ code > </ a > (required)</ summary >
5736+ < h3 id ="type "> < code > type</ code > </ h3 >
56415737< p > The type of the resource used to provide the resource type's container image.</ p >
56425738< p > This is a bit meta. Usually this value will be < code > registry-image</ code > as the resource type must result in a container
56435739image.</ p >
@@ -5646,6 +5742,7 @@ <h2 id="resource_type-schema"><code>resource_type</code> schema</h2>
56465742</ details >
56475743< details class ="warning ">
56485744< summary > < strong > < code > source</ code > </ strong > : < a href ="../config-basics/#config-schema "> < code > config</ code > </ a > (required)</ summary >
5745+ < h3 id ="source "> < code > source</ code > </ h3 >
56495746< p > The configuration for the resource type's resource. This varies by resource type, and is a black box to Concourse;
56505747it is blindly passed to the resource at runtime.</ p >
56515748< p > To use < code > registry-image</ code > as an example, the source would contain something like < code > repository: username/reponame</ code > . See
@@ -5654,6 +5751,7 @@ <h2 id="resource_type-schema"><code>resource_type</code> schema</h2>
56545751</ details >
56555752< details class ="info ">
56565753< summary > < code > privileged</ code > : < a href ="../config-basics/#boolean-schema "> < code > boolean</ code > </ a > </ summary >
5754+ < h3 id ="privileged "> < code > privileged</ code > </ h3 >
56575755< p > < em > Default < code > false</ code > </ em > . If set to < code > true</ code > , the resource's containers will be run with full capabilities, as determined by
56585756the worker backend the task runs on.</ p >
56595757< p > For Linux-based backends it typically determines whether or not the container will run in a separate user namespace,
@@ -5665,22 +5763,26 @@ <h2 id="resource_type-schema"><code>resource_type</code> schema</h2>
56655763</ details >
56665764< details class ="info ">
56675765< summary > < code > params</ code > : < a href ="../config-basics/#config-schema "> < code > config</ code > </ a > </ summary >
5766+ < h3 id ="params "> < code > params</ code > </ h3 >
56685767< p > Arbitrary config to pass when running the < a href ="../steps/get/ "> < code > get</ code > step</ a > to fetch the resource type's image. This is
56695768equivalent to < a href ="../steps/get/#get-step "> < code > get</ code > step < code > params</ code > </ a > .</ p >
56705769</ details >
56715770< details class ="info ">
56725771< summary > < code > check_every</ code > : < a href ="../config-basics/#duration-schema "> < code > duration</ code > </ a > </ summary >
5772+ < h3 id ="check_every "> < code > check_every</ code > </ h3 >
56735773< p > < em > Default < code > 1m</ code > </ em > . The interval on which to check for new versions of the resource. Acceptable interval options are
56745774defined by the < a href ="https://golang.org/pkg/time/#ParseDuration "> time.ParseDuration function</ a > .</ p >
56755775</ details >
56765776< details class ="info ">
56775777< summary > < code > tags</ code > : < a href ="../config-basics/#string-schema "> < code > [string]</ code > </ a > </ summary >
5778+ < h3 id ="tags "> < code > tags</ code > </ h3 >
56785779< p > < em > Default < code > []</ code > </ em > . A list of tags to determine which workers the checks will be performed on. You'll want to specify
56795780this if the source is internal to a worker's network, for example. See also
56805781< a href ="../steps/modifier-and-hooks/tags/ "> < code > tags</ code > </ a > </ p >
56815782</ details >
56825783< details class ="info ">
56835784< summary > < code > defaults</ code > : < a href ="../config-basics/#config-schema "> < code > config</ code > </ a > </ summary >
5785+ < h3 id ="defaults "> < code > defaults</ code > </ h3 >
56845786< p > The default configuration for the resource type. This varies by resource type, and is a black box to Concourse; it
56855787is merged with (duplicate fields are overwritten by) < a href ="../resources/#resource-schema "> < code > resource.source</ code > </ a > and
56865788passed to the resource at runtime.</ p >
@@ -5733,7 +5835,7 @@ <h2 id="resource_type-schema"><code>resource_type</code> schema</h2>
57335835</ span > </ code > </ pre > </ div >
57345836</ details >
57355837< p > Alternatively, the web node can be configured to use
5736- < a href ="../install/running-web/#configuring-defaults-for-resource-types "> defaults for base resource types</ a > </ p >
5838+ < a href ="../install/running-web/#configuring-defaults-for-resource-types "> defaults for base resource types</ a > . </ p >
57375839</ details >
57385840< hr >
57395841< details class ="example ">
0 commit comments