Update docs (#1426) (#1689)

[PR #1426/a67cb9ed backport][stable-5] Update docs

This is a backport of PR #1426 as merged into main (a67cb9e).
SUMMARY

Update ecs_taskdefinition documentation with firelensConfiguration option (see also #1425)

ISSUE TYPE


Docs Pull Request

COMPONENT NAME

ecs_taskdefinition
ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell <None>

changelogs/fragments/1426-docs_update_ecs_taskdefinition.yml

@@ -0,0 +1,2 @@
+trivial:
+- ecs_task_definition - Add firelens docs

plugins/modules/ecs_taskdefinition.py

@@ -536,6 +536,32 @@
                         description: The type of resource to assign to a container.
                         type: str
                         choices: ['GPU', 'InferenceAccelerator']
+            firelensConfiguration:
+                description:
+                    - The FireLens configuration for the container.
+                    - This is used to specify and configure a log router for container logs.
+                required: False
+                type: dict
+                suboptions:
+                    type:
+                        description:
+                            - The log router to use. The valid values are C(fluentd) or C(fluentbit).
+                        required: False
+                        type: str
+                        choices:
+                            - fluentd
+                            - fluentbit
+                    options:
+                        description:
+                            - The options to use when configuring the log router.
+                            - This field is optional and can be used to specify a custom configuration
+                              file or to add additional metadata, such as the task, task definition, cluster,
+                              and container instance details to the log event.
+                            - If specified, the syntax to use is
+                              C({"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}).
+                            - For more information, see U(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef).
+                        required: False
+                        type: dict
     network_mode:
         description:
             - The Docker networking mode to use for the containers in the task.

plugins/modules/ecs_taskdefinition_info.py

@@ -219,7 +219,59 @@
             description: The configuration options to send to the log driver.
             returned: when present
             type: str
-
+        healthCheck:
+            description: The container health check command and associated configuration parameters for the container.
+            returned: when present
+            type: dict
+            contains:
+                command:
+                    description: A string array representing the command that the container runs to determine if it is healthy.
+                    type: list
+                interval:
+                    description: The time period in seconds between each health check execution.
+                    type: int
+                timeout:
+                    description: The time period in seconds to wait for a health check to succeed before it is considered a failure.
+                    type: int
+                retries:
+                    description: The number of times to retry a failed health check before the container is considered unhealthy.
+                    type: int
+                startPeriod:
+                    description: The optional grace period to provide containers time to bootstrap before failed.
+                    type: int
+        resourceRequirements:
+            description: The type and amount of a resource to assign to a container.
+            returned: when present
+            type: dict
+            contains:
+                value:
+                    description: The value for the specified resource type.
+                    type: str
+                type:
+                    description: The type of resource to assign to a container.
+                    type: str
+        systemControls:
+            description: A list of namespaced kernel parameters to set in the container.
+            returned: when present
+            type: dict
+            contains:
+                namespace:
+                    description: TThe namespaced kernel.
+                    type: str
+                value:
+                    description: The value for the namespaced kernel.
+                    type: str
+        firelensConfiguration:
+            description: The FireLens configuration for the container.
+            returned: when present
+            type: dict
+            contains:
+                type:
+                    description: The log router.
+                    type: str
+                options:
+                    description: The options to use when configuring the log router.
+                    type: dict
 family:
     description: The family of your task definition, used as the definition name
     returned: always