From 275039b5dceaf147625239969141c01e2f34adc8 Mon Sep 17 00:00:00 2001
From: MMaiero <matteo.maiero@eurotech.com>
Date: Tue, 12 Nov 2024 09:11:32 +0100
Subject: [PATCH 1/5] docs: Improve container instance metatype descriptions

Signed-off-by: MMaiero <matteo.maiero@eurotech.com>
---
 ...a.container.provider.ContainerInstance.xml | 46 +++++++++----------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
index 78f903e43b3..7ad0b694d15 100644
--- a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
+++ b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
@@ -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)"
             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"
             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" 
@@ -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"
             type="Integer" 
             cardinality="1" 
             min="0"
@@ -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"
@@ -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" 
@@ -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>

From 52836bdc61372c2add0ff9a2996909dc7c326f5b Mon Sep 17 00:00:00 2001
From: Matteo Maiero <matteo.maiero@eurotech.com>
Date: Tue, 12 Nov 2024 10:12:02 +0100
Subject: [PATCH 2/5] Update
 kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml

Co-authored-by: Mattia Dal Ben <mattdibi@users.noreply.github.com>
---
 .../org.eclipse.kura.container.provider.ContainerInstance.xml   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
index 7ad0b694d15..42e1eac0f02 100644
--- a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
+++ b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
@@ -63,7 +63,7 @@
         
         <AD id="container.image.download.retries" 
             name="Image Download Retries" 
-            description="Specifies the number tentatives to pull the container image that the framework performes. Set to 0 for unlimited retries. Default: 5"
+            description="Specifies the number of retries the framework performs when attempting to pull the container image. Set to 0 for unlimited retries. Default: 5"
             type="Integer" 
             cardinality="1" 
             min="0"

From a45a3e3bd2c0e7898939a92a3cfaf8619cfe5a50 Mon Sep 17 00:00:00 2001
From: Matteo Maiero <matteo.maiero@eurotech.com>
Date: Tue, 12 Nov 2024 10:12:17 +0100
Subject: [PATCH 3/5] Update
 kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml

Co-authored-by: Mattia Dal Ben <mattdibi@users.noreply.github.com>
---
 .../org.eclipse.kura.container.provider.ContainerInstance.xml   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
index 42e1eac0f02..e99a5700490 100644
--- a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
+++ b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
@@ -27,7 +27,7 @@
             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. Default: latest" type="String"
+            description="Describes which image version should be pulled from the container registry. Default: latest" type="String"
             cardinality="1" required="true" default="latest" />
         
         <AD id="registry.hostname" name="Authentication Registry URL"

From c8e41e59529080186c3c701317ae98ded6f5cff0 Mon Sep 17 00:00:00 2001
From: MMaiero <matteo.maiero@eurotech.com>
Date: Tue, 12 Nov 2024 10:17:23 +0100
Subject: [PATCH 4/5] Improved image description

Signed-off-by: MMaiero <matteo.maiero@eurotech.com>
---
 ...rg.eclipse.kura.container.provider.ContainerInstance.xml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
index e99a5700490..e08c4968b2c 100644
--- a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
+++ b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
@@ -22,8 +22,10 @@
         <AD id="container.image" 
             name="Image name" 
             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)"
+            The value has to be expressed in the form registryURL/imagename. If no registryURL is provided, the official Docker Hub registry will be used as default. 
+            In the use case of pulling the testing/test-image image from a local registry listening on port 5000 (myregistry.local:5000), the registryURL has
+            to be specified as follows: myregistry.local:5000/testing/test-image
+            Default: nginx (the image will be pulled from the Docker Hub registry)"
             type="String" cardinality="1" required="true" default="nginx" />
 
         <AD id="container.image.tag" name="Image tag"

From 5231c7c694c3935183974ae5d88b0e21886dea1a Mon Sep 17 00:00:00 2001
From: Matteo Maiero <matteo.maiero@eurotech.com>
Date: Tue, 12 Nov 2024 11:43:35 +0100
Subject: [PATCH 5/5] Update
 kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml

Co-authored-by: Mattia Dal Ben <mattdibi@users.noreply.github.com>
---
 .../org.eclipse.kura.container.provider.ContainerInstance.xml   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
index e08c4968b2c..d14ea3b2f65 100644
--- a/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
+++ b/kura/org.eclipse.kura.container.provider/OSGI-INF/metatype/org.eclipse.kura.container.provider.ContainerInstance.xml
@@ -23,7 +23,7 @@
             name="Image name" 
             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. If no registryURL is provided, the official Docker Hub registry will be used as default. 
-            In the use case of pulling the testing/test-image image from a local registry listening on port 5000 (myregistry.local:5000), the registryURL has
+            When pulling the testing/test-image image from a local registry listening on port 5000 (e.g. myregistry.local:5000), the registryURL/imagename field has
             to be specified as follows: myregistry.local:5000/testing/test-image
             Default: nginx (the image will be pulled from the Docker Hub registry)"
             type="String" cardinality="1" required="true" default="nginx" />