docs: Add low level API access (#1300)

Author: HofmeisterAn

.github/workflows/cicd.yml

@@ -3,8 +3,10 @@ name: Continuous Integration & Delivery
 on:
   push:
     branches: [ develop, main, bugfix/*, feature/* ]
+    paths-ignore: [ 'docs/**', 'examples/**' ]
   pull_request:
     branches: [ develop, main ]
+    paths-ignore: [ 'docs/**', 'examples/**' ]
   workflow_dispatch:
     inputs:
       publish_nuget_package:

.github/workflows/codeql-analysis.yml

@@ -3,8 +3,10 @@ name: CodeQL
 on:
   push:
     branches: [ develop, main ]
+    paths-ignore: [ 'docs/**', 'examples/**' ]
   pull_request:
     branches: [ develop, main ]
+    paths-ignore: [ 'docs/**', 'examples/**' ]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.sha }}

docs/api/low_level_api_access.md

@@ -0,0 +1,9 @@
+# Low level API access
+
+Testcontainers does not expose all available [Docker Engine APIs](https://docs.docker.com/reference/api/engine/latest/) through its container, image, network, and volume builders. In some cases, you may need to access the underlying Docker Engine API to configure specific properties that are not available via Testcontainers' API. To access all available Docker Engine API properties for creating a resource, use the builder method: `WithCreateParameterModifier(Action<TCreateResourceEntity>)`. This method allows you to use a callback to configure the final payload that is sent to the Docker Engine.
+
+```csharp title="Setting the memory limit to 2GB"
+const long TwoGB = 2L * 1024 * 1024 * 1024;
+_ = new ContainerBuilder()
+  .WithCreateParameterModifier(parameterModifier => parameterModifier.HostConfig.Memory = TwoGB);
+```

mkdocs.yml

@@ -36,6 +36,7 @@ nav:
   - api/create_docker_image.md
   - api/create_docker_container.md
   - api/create_docker_network.md
+  - api/low_level_api_access.md
   - api/resource_reaper.md
   - api/resource_reuse.md
   - api/wait_strategies.md