diff --git a/avm/res/container-instance/container-group/README.md b/avm/res/container-instance/container-group/README.md index 1545fb232b..53c1daf65d 100644 --- a/avm/res/container-instance/container-group/README.md +++ b/avm/res/container-instance/container-group/README.md @@ -28,9 +28,10 @@ The following section provides usage examples for the module, which were used to - [Using only defaults](#example-1-using-only-defaults) - [Using CMK ](#example-2-using-cmk) -- [Using large parameter set](#example-3-using-large-parameter-set) -- [Using private network](#example-4-using-private-network) -- [WAF-aligned](#example-5-waf-aligned) +- [Using only defaults and low memory containers](#example-3-using-only-defaults-and-low-memory-containers) +- [Using large parameter set](#example-4-using-large-parameter-set) +- [Using private network](#example-5-using-private-network) +- [WAF-aligned](#example-6-waf-aligned) ### Example 1: _Using only defaults_ @@ -60,7 +61,7 @@ module containerGroup 'br/public:avm/res/container-instance/container-group:

-### Example 3: _Using large parameter set_ +### Example 3: _Using only defaults and low memory containers_ + +This instance deploys the module with the minimum set of required parameters and with low memory. + + +

+ +via Bicep module + +```bicep +module containerGroup 'br/public:avm/res/container-instance/container-group:' = { + name: 'containerGroupDeployment' + params: { + // Required parameters + containers: [ + { + name: 'az-aci-x-001' + properties: { + image: 'mcr.microsoft.com/azuredocs/aci-helloworld' + ports: [ + { + port: 443 + protocol: 'Tcp' + } + ] + resources: { + requests: { + cpu: 2 + memoryInGB: '0.5' + } + } + } + } + ] + name: 'ciclow001' + // Non-required parameters + ipAddressPorts: [ + { + port: 443 + protocol: 'Tcp' + } + ] + location: '' + } +} +``` + +
+

+ +

+ +via JSON parameters file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "containers": { + "value": [ + { + "name": "az-aci-x-001", + "properties": { + "image": "mcr.microsoft.com/azuredocs/aci-helloworld", + "ports": [ + { + "port": 443, + "protocol": "Tcp" + } + ], + "resources": { + "requests": { + "cpu": 2, + "memoryInGB": "0.5" + } + } + } + } + ] + }, + "name": { + "value": "ciclow001" + }, + // Non-required parameters + "ipAddressPorts": { + "value": [ + { + "port": 443, + "protocol": "Tcp" + } + ] + }, + "location": { + "value": "" + } + } +} +``` + +
+

+ +

+ +via Bicep parameters file + +```bicep-params +using 'br/public:avm/res/container-instance/container-group:' + +// Required parameters +param containers = [ + { + name: 'az-aci-x-001' + properties: { + image: 'mcr.microsoft.com/azuredocs/aci-helloworld' + ports: [ + { + port: 443 + protocol: 'Tcp' + } + ] + resources: { + requests: { + cpu: 2 + memoryInGB: '0.5' + } + } + } + } +] +param name = 'ciclow001' +// Non-required parameters +param ipAddressPorts = [ + { + port: 443 + protocol: 'Tcp' + } +] +param location = '' +``` + +
+

+ +### Example 4: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -506,9 +653,13 @@ module containerGroup 'br/public:avm/res/container-instance/container-group:

-### Example 4: _Using private network_ +### Example 5: _Using private network_ This instance deploys the module within a virtual network. @@ -813,7 +972,7 @@ module containerGroup 'br/public:avm/res/container-instance/container-group:

-### Example 5: _WAF-aligned_ +### Example 6: _WAF-aligned_ This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework. @@ -1085,7 +1244,7 @@ module containerGroup 'br/public:avm/res/container-instance/container-group: