Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve container instance metatype descriptions #5540

Merged
merged 5 commits into from
Nov 12, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,14 @@

<AD id="container.image"
name="Image name"
description="The image the container will be created with. The value will need to be expressed in the form registryURL/imagename in case of a custom registry.
Please fill the following registry credentials in case of pulling from a custom or authenticated Docker hub registry."
description="Specifies the image reference that will be used to create this container instance.
The value has to be expressed in the form registryURL/imagename in case of a custom registry. In case the image will be pulled from the official Docker Hub registry, the registryURL can be ignored and
only the imagename can be provided. Default: nginx (the image will be pulled from the Docker Hub registry)"
mattdibi marked this conversation as resolved.
Show resolved Hide resolved
type="String" cardinality="1" required="true" default="nginx" />

<AD id="container.image.tag" name="Image tag"
description="Describes which image version that should be pulled from the container registry." type="String"
description="Describes which image version that should be pulled from the container registry. Default: latest" type="String"
MMaiero marked this conversation as resolved.
Show resolved Hide resolved
cardinality="1" required="true" default="latest" />

<AD id="container.signature.trust.anchor" name="Trust anchor"
description="Trust anchor used to verify the container image signature.|TextArea" type="String"
cardinality="1" required="false" default="" />

<AD id="container.signature.verify.transparency.log" name="Verify in transparency log"
description="Sets the transparency log verification, to be used when a container image signature has been uploaded to the transparency log." type="Boolean"
cardinality="1" required="false" default="true" />

<AD
id="container.signature.enforcement.digest"
name="Container Image Enforcement Digest"
description="Digest of the container image allowed to run on the device if the Container Enforcement Monitor is enabled. If not given, it will be computed by the Container Signature Verification service."
type="String" cardinality="1" required="false"
default="" />

<AD id="registry.hostname" name="Authentication Registry URL"
description="Url for docker registry. Required only for authenticated registries"
Expand All @@ -60,10 +46,24 @@
description="Password for container registry. Required only for authenticated registries"
type="Password"
cardinality="0" required="false" default="" />

<AD id="container.signature.trust.anchor" name="Trust anchor"
description="Trust anchor used to verify the container image signature.|TextArea" type="String"
cardinality="1" required="false" default="" />

<AD id="container.signature.verify.transparency.log" name="Verify in transparency log"
description="Sets the transparency log verification, to be used when a container image signature has been uploaded to the transparency log." type="Boolean"
cardinality="1" required="false" default="true" />

<AD id="container.signature.enforcement.digest"
name="Container Image Enforcement Digest"
description="Digest of the container image allowed to run on the device, if the Container Enforcement Monitor is enabled. If not provided, it will be computed by the Container Signature Verification service."
type="String" cardinality="1" required="false"
default="" />

<AD id="container.image.download.retries"
name="Image Download Retries"
description="The number of retries to pull the container image. Set to 0 for unlimited retries"
description="Specifies the number tentatives to pull the container image that the framework performes. Set to 0 for unlimited retries. Default: 5"
MMaiero marked this conversation as resolved.
Show resolved Hide resolved
type="Integer"
cardinality="1"
min="0"
Expand All @@ -72,7 +72,7 @@

<AD id="container.image.download.interval"
name="Image Download Retry Interval"
description="The interval (in milliseconds) between retries to pull the container image"
description="The interval (in milliseconds) between retries to pull the container image. Default: 30000"
type="Integer"
cardinality="1"
min="0"
Expand All @@ -81,7 +81,7 @@

<AD id="container.image.download.timeout"
name="Image Download Timeout"
description="Image download timeout. Value specified in seconds"
description="Image download timeout. Value specified in seconds. Default: 500"
type="Integer"
cardinality="0"
required="true"
Expand Down Expand Up @@ -176,11 +176,11 @@
</AD>

<AD id="container.loggerParameters" name="Logger Parameters"
description="Used to pass logger parameters to a container's logging driver. Example: max-size=10m, max-file=2." type="String" cardinality="1"
description="Used to pass logger parameters to a container's logging driver. Example: max-size=10m, max-file=2. Default: max-size=10m" type="String" cardinality="1"
required="false" default="max-size=10m" />

<AD id="container.restart.onfailure" name="Restart Container On Failure" type="Boolean" cardinality="1" required="true" default="false"
description="Automatically restart the container when it has failed.">
description="Automatically restart the container when it has failed. Default: false">
</AD>

</OCD>
Expand Down