pulumi-docker 4.6.0a1714109818__tar.gz → 4.6.0a1714492220__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/PKG-INFO +1 -1
  2. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/container.py +28 -32
  3. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/get_network.py +0 -4
  4. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/get_registry_image.py +0 -4
  5. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/get_remote_image.py +0 -4
  6. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/network.py +0 -4
  7. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/plugin.py +7 -7
  8. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/remote_image.py +21 -33
  9. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/volume.py +0 -4
  10. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker.egg-info/PKG-INFO +1 -1
  11. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pyproject.toml +1 -1
  12. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/README.md +0 -0
  13. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/__init__.py +0 -0
  14. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/_enums.py +0 -0
  15. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/_inputs.py +0 -0
  16. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/_utilities.py +0 -0
  17. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/config/__init__.py +0 -0
  18. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/config/__init__.pyi +0 -0
  19. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/config/outputs.py +0 -0
  20. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/config/vars.py +0 -0
  21. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/get_logs.py +0 -0
  22. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/get_plugin.py +0 -0
  23. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/image.py +0 -0
  24. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/outputs.py +0 -0
  25. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/provider.py +0 -0
  26. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/pulumi-plugin.json +0 -0
  27. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/py.typed +0 -0
  28. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/registry_image.py +0 -0
  29. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/secret.py +0 -0
  30. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/service.py +0 -0
  31. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/service_config.py +0 -0
  32. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker/tag.py +0 -0
  33. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker.egg-info/SOURCES.txt +0 -0
  34. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker.egg-info/dependency_links.txt +0 -0
  35. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker.egg-info/requires.txt +0 -0
  36. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/pulumi_docker.egg-info/top_level.txt +0 -0
  37. {pulumi_docker-4.6.0a1714109818 → pulumi_docker-4.6.0a1714492220}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: pulumi_docker
3
- Version: 4.6.0a1714109818
3
+ Version: 4.6.0a1714492220
4
4
  Summary: A Pulumi package for interacting with Docker in Pulumi programs
5
5
  License: Apache-2.0
6
6
  Project-URL: Homepage, https://pulumi.io
@@ -100,10 +100,10 @@ class ContainerArgs:
100
100
  :param pulumi.Input[Sequence[pulumi.Input[str]]] group_adds: Additional groups for the container user
101
101
  :param pulumi.Input['ContainerHealthcheckArgs'] healthcheck: A test to perform to check that the container is healthy
102
102
  :param pulumi.Input[str] hostname: Hostname of the container.
103
- :param pulumi.Input[Sequence[pulumi.Input['ContainerHostArgs']]] hosts: Hostname to add
103
+ :param pulumi.Input[Sequence[pulumi.Input['ContainerHostArgs']]] hosts: Additional hosts to add to the container.
104
104
  :param pulumi.Input[bool] init: Configured whether an init process should be injected for this container. If unset this will default to the `dockerd` defaults.
105
105
  :param pulumi.Input[str] ipc_mode: IPC sharing mode for the container. Possible values are: `none`, `private`, `shareable`, `container:<name|id>` or `host`.
106
- :param pulumi.Input[Sequence[pulumi.Input['ContainerLabelArgs']]] labels: User-defined key/value metadata.
106
+ :param pulumi.Input[Sequence[pulumi.Input['ContainerLabelArgs']]] labels: User-defined key/value metadata
107
107
  :param pulumi.Input[str] log_driver: The logging driver to use for the container.
108
108
  :param pulumi.Input[Mapping[str, Any]] log_opts: Key/value pairs to use as options for the logging driver.
109
109
  :param pulumi.Input[bool] logs: Save the container logs (`attach` must be enabled). Defaults to `false`.
@@ -113,14 +113,14 @@ class ContainerArgs:
113
113
  :param pulumi.Input[Sequence[pulumi.Input['ContainerMountArgs']]] mounts: Specification for mounts to be added to containers created as part of the service.
114
114
  :param pulumi.Input[bool] must_run: If `true`, then the Docker container will be kept running. If `false`, then as long as the container exists, Terraform
115
115
  assumes it is successful. Defaults to `true`.
116
- :param pulumi.Input[str] name: The name or id of the network to use. You can use `name` or `id` attribute from a `Network` resource.
116
+ :param pulumi.Input[str] name: The name of the container.
117
117
  :param pulumi.Input[str] network_mode: Network mode of the container.
118
118
  :param pulumi.Input[Sequence[pulumi.Input['ContainerNetworksAdvancedArgs']]] networks_advanced: The networks the container is attached to
119
119
  :param pulumi.Input[str] pid_mode: he PID (Process) Namespace mode for the container. Either `container:<name|id>` or `host`.
120
120
  :param pulumi.Input[Sequence[pulumi.Input['ContainerPortArgs']]] ports: Publish a container's port(s) to the host.
121
121
  :param pulumi.Input[bool] privileged: If `true`, the container runs in privileged mode.
122
122
  :param pulumi.Input[bool] publish_all_ports: Publish all ports of the container.
123
- :param pulumi.Input[bool] read_only: Whether the mount should be read-only.
123
+ :param pulumi.Input[bool] read_only: If `true`, the container will be started as readonly. Defaults to `false`.
124
124
  :param pulumi.Input[bool] remove_volumes: If `true`, it will remove anonymous volumes associated with the container. Defaults to `true`.
125
125
  :param pulumi.Input[str] restart: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to `no`.
126
126
  :param pulumi.Input[bool] rm: If `true`, then the container will be automatically removed when it exits. Defaults to `false`.
@@ -512,7 +512,7 @@ class ContainerArgs:
512
512
  @pulumi.getter
513
513
  def hosts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ContainerHostArgs']]]]:
514
514
  """
515
- Hostname to add
515
+ Additional hosts to add to the container.
516
516
  """
517
517
  return pulumi.get(self, "hosts")
518
518
 
@@ -548,7 +548,7 @@ class ContainerArgs:
548
548
  @pulumi.getter
549
549
  def labels(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ContainerLabelArgs']]]]:
550
550
  """
551
- User-defined key/value metadata.
551
+ User-defined key/value metadata
552
552
  """
553
553
  return pulumi.get(self, "labels")
554
554
 
@@ -657,7 +657,7 @@ class ContainerArgs:
657
657
  @pulumi.getter
658
658
  def name(self) -> Optional[pulumi.Input[str]]:
659
659
  """
660
- The name or id of the network to use. You can use `name` or `id` attribute from a `Network` resource.
660
+ The name of the container.
661
661
  """
662
662
  return pulumi.get(self, "name")
663
663
 
@@ -741,7 +741,7 @@ class ContainerArgs:
741
741
  @pulumi.getter(name="readOnly")
742
742
  def read_only(self) -> Optional[pulumi.Input[bool]]:
743
743
  """
744
- Whether the mount should be read-only.
744
+ If `true`, the container will be started as readonly. Defaults to `false`.
745
745
  """
746
746
  return pulumi.get(self, "read_only")
747
747
 
@@ -1107,11 +1107,11 @@ class _ContainerState:
1107
1107
  :param pulumi.Input[Sequence[pulumi.Input[str]]] group_adds: Additional groups for the container user
1108
1108
  :param pulumi.Input['ContainerHealthcheckArgs'] healthcheck: A test to perform to check that the container is healthy
1109
1109
  :param pulumi.Input[str] hostname: Hostname of the container.
1110
- :param pulumi.Input[Sequence[pulumi.Input['ContainerHostArgs']]] hosts: Hostname to add
1110
+ :param pulumi.Input[Sequence[pulumi.Input['ContainerHostArgs']]] hosts: Additional hosts to add to the container.
1111
1111
  :param pulumi.Input[str] image: The ID of the image to back this container. The easiest way to get this value is to use the `RemoteImage` resource as is shown in the example.
1112
1112
  :param pulumi.Input[bool] init: Configured whether an init process should be injected for this container. If unset this will default to the `dockerd` defaults.
1113
1113
  :param pulumi.Input[str] ipc_mode: IPC sharing mode for the container. Possible values are: `none`, `private`, `shareable`, `container:<name|id>` or `host`.
1114
- :param pulumi.Input[Sequence[pulumi.Input['ContainerLabelArgs']]] labels: User-defined key/value metadata.
1114
+ :param pulumi.Input[Sequence[pulumi.Input['ContainerLabelArgs']]] labels: User-defined key/value metadata
1115
1115
  :param pulumi.Input[str] log_driver: The logging driver to use for the container.
1116
1116
  :param pulumi.Input[Mapping[str, Any]] log_opts: Key/value pairs to use as options for the logging driver.
1117
1117
  :param pulumi.Input[bool] logs: Save the container logs (`attach` must be enabled). Defaults to `false`.
@@ -1121,7 +1121,7 @@ class _ContainerState:
1121
1121
  :param pulumi.Input[Sequence[pulumi.Input['ContainerMountArgs']]] mounts: Specification for mounts to be added to containers created as part of the service.
1122
1122
  :param pulumi.Input[bool] must_run: If `true`, then the Docker container will be kept running. If `false`, then as long as the container exists, Terraform
1123
1123
  assumes it is successful. Defaults to `true`.
1124
- :param pulumi.Input[str] name: The name or id of the network to use. You can use `name` or `id` attribute from a `Network` resource.
1124
+ :param pulumi.Input[str] name: The name of the container.
1125
1125
  :param pulumi.Input[Sequence[pulumi.Input['ContainerNetworkDataArgs']]] network_datas: The data of the networks the container is connected to.
1126
1126
  :param pulumi.Input[str] network_mode: Network mode of the container.
1127
1127
  :param pulumi.Input[Sequence[pulumi.Input['ContainerNetworksAdvancedArgs']]] networks_advanced: The networks the container is attached to
@@ -1129,7 +1129,7 @@ class _ContainerState:
1129
1129
  :param pulumi.Input[Sequence[pulumi.Input['ContainerPortArgs']]] ports: Publish a container's port(s) to the host.
1130
1130
  :param pulumi.Input[bool] privileged: If `true`, the container runs in privileged mode.
1131
1131
  :param pulumi.Input[bool] publish_all_ports: Publish all ports of the container.
1132
- :param pulumi.Input[bool] read_only: Whether the mount should be read-only.
1132
+ :param pulumi.Input[bool] read_only: If `true`, the container will be started as readonly. Defaults to `false`.
1133
1133
  :param pulumi.Input[bool] remove_volumes: If `true`, it will remove anonymous volumes associated with the container. Defaults to `true`.
1134
1134
  :param pulumi.Input[str] restart: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to `no`.
1135
1135
  :param pulumi.Input[bool] rm: If `true`, then the container will be automatically removed when it exits. Defaults to `false`.
@@ -1554,7 +1554,7 @@ class _ContainerState:
1554
1554
  @pulumi.getter
1555
1555
  def hosts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ContainerHostArgs']]]]:
1556
1556
  """
1557
- Hostname to add
1557
+ Additional hosts to add to the container.
1558
1558
  """
1559
1559
  return pulumi.get(self, "hosts")
1560
1560
 
@@ -1602,7 +1602,7 @@ class _ContainerState:
1602
1602
  @pulumi.getter
1603
1603
  def labels(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ContainerLabelArgs']]]]:
1604
1604
  """
1605
- User-defined key/value metadata.
1605
+ User-defined key/value metadata
1606
1606
  """
1607
1607
  return pulumi.get(self, "labels")
1608
1608
 
@@ -1711,7 +1711,7 @@ class _ContainerState:
1711
1711
  @pulumi.getter
1712
1712
  def name(self) -> Optional[pulumi.Input[str]]:
1713
1713
  """
1714
- The name or id of the network to use. You can use `name` or `id` attribute from a `Network` resource.
1714
+ The name of the container.
1715
1715
  """
1716
1716
  return pulumi.get(self, "name")
1717
1717
 
@@ -1807,7 +1807,7 @@ class _ContainerState:
1807
1807
  @pulumi.getter(name="readOnly")
1808
1808
  def read_only(self) -> Optional[pulumi.Input[bool]]:
1809
1809
  """
1810
- Whether the mount should be read-only.
1810
+ If `true`, the container will be started as readonly. Defaults to `false`.
1811
1811
  """
1812
1812
  return pulumi.get(self, "read_only")
1813
1813
 
@@ -2154,7 +2154,6 @@ class Container(pulumi.CustomResource):
2154
2154
 
2155
2155
  ## Example Usage
2156
2156
 
2157
- <!--Start PulumiCodeChooser -->
2158
2157
  ```python
2159
2158
  import pulumi
2160
2159
  import pulumi_docker as docker
@@ -2166,7 +2165,6 @@ class Container(pulumi.CustomResource):
2166
2165
  name="foo",
2167
2166
  image=ubuntu_remote_image.image_id)
2168
2167
  ```
2169
- <!--End PulumiCodeChooser -->
2170
2168
 
2171
2169
  ## Import
2172
2170
 
@@ -2231,11 +2229,11 @@ class Container(pulumi.CustomResource):
2231
2229
  :param pulumi.Input[Sequence[pulumi.Input[str]]] group_adds: Additional groups for the container user
2232
2230
  :param pulumi.Input[pulumi.InputType['ContainerHealthcheckArgs']] healthcheck: A test to perform to check that the container is healthy
2233
2231
  :param pulumi.Input[str] hostname: Hostname of the container.
2234
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerHostArgs']]]] hosts: Hostname to add
2232
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerHostArgs']]]] hosts: Additional hosts to add to the container.
2235
2233
  :param pulumi.Input[str] image: The ID of the image to back this container. The easiest way to get this value is to use the `RemoteImage` resource as is shown in the example.
2236
2234
  :param pulumi.Input[bool] init: Configured whether an init process should be injected for this container. If unset this will default to the `dockerd` defaults.
2237
2235
  :param pulumi.Input[str] ipc_mode: IPC sharing mode for the container. Possible values are: `none`, `private`, `shareable`, `container:<name|id>` or `host`.
2238
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerLabelArgs']]]] labels: User-defined key/value metadata.
2236
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerLabelArgs']]]] labels: User-defined key/value metadata
2239
2237
  :param pulumi.Input[str] log_driver: The logging driver to use for the container.
2240
2238
  :param pulumi.Input[Mapping[str, Any]] log_opts: Key/value pairs to use as options for the logging driver.
2241
2239
  :param pulumi.Input[bool] logs: Save the container logs (`attach` must be enabled). Defaults to `false`.
@@ -2245,14 +2243,14 @@ class Container(pulumi.CustomResource):
2245
2243
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerMountArgs']]]] mounts: Specification for mounts to be added to containers created as part of the service.
2246
2244
  :param pulumi.Input[bool] must_run: If `true`, then the Docker container will be kept running. If `false`, then as long as the container exists, Terraform
2247
2245
  assumes it is successful. Defaults to `true`.
2248
- :param pulumi.Input[str] name: The name or id of the network to use. You can use `name` or `id` attribute from a `Network` resource.
2246
+ :param pulumi.Input[str] name: The name of the container.
2249
2247
  :param pulumi.Input[str] network_mode: Network mode of the container.
2250
2248
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerNetworksAdvancedArgs']]]] networks_advanced: The networks the container is attached to
2251
2249
  :param pulumi.Input[str] pid_mode: he PID (Process) Namespace mode for the container. Either `container:<name|id>` or `host`.
2252
2250
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerPortArgs']]]] ports: Publish a container's port(s) to the host.
2253
2251
  :param pulumi.Input[bool] privileged: If `true`, the container runs in privileged mode.
2254
2252
  :param pulumi.Input[bool] publish_all_ports: Publish all ports of the container.
2255
- :param pulumi.Input[bool] read_only: Whether the mount should be read-only.
2253
+ :param pulumi.Input[bool] read_only: If `true`, the container will be started as readonly. Defaults to `false`.
2256
2254
  :param pulumi.Input[bool] remove_volumes: If `true`, it will remove anonymous volumes associated with the container. Defaults to `true`.
2257
2255
  :param pulumi.Input[str] restart: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to `no`.
2258
2256
  :param pulumi.Input[bool] rm: If `true`, then the container will be automatically removed when it exits. Defaults to `false`.
@@ -2288,7 +2286,6 @@ class Container(pulumi.CustomResource):
2288
2286
 
2289
2287
  ## Example Usage
2290
2288
 
2291
- <!--Start PulumiCodeChooser -->
2292
2289
  ```python
2293
2290
  import pulumi
2294
2291
  import pulumi_docker as docker
@@ -2300,7 +2297,6 @@ class Container(pulumi.CustomResource):
2300
2297
  name="foo",
2301
2298
  image=ubuntu_remote_image.image_id)
2302
2299
  ```
2303
- <!--End PulumiCodeChooser -->
2304
2300
 
2305
2301
  ## Import
2306
2302
 
@@ -2603,11 +2599,11 @@ class Container(pulumi.CustomResource):
2603
2599
  :param pulumi.Input[Sequence[pulumi.Input[str]]] group_adds: Additional groups for the container user
2604
2600
  :param pulumi.Input[pulumi.InputType['ContainerHealthcheckArgs']] healthcheck: A test to perform to check that the container is healthy
2605
2601
  :param pulumi.Input[str] hostname: Hostname of the container.
2606
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerHostArgs']]]] hosts: Hostname to add
2602
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerHostArgs']]]] hosts: Additional hosts to add to the container.
2607
2603
  :param pulumi.Input[str] image: The ID of the image to back this container. The easiest way to get this value is to use the `RemoteImage` resource as is shown in the example.
2608
2604
  :param pulumi.Input[bool] init: Configured whether an init process should be injected for this container. If unset this will default to the `dockerd` defaults.
2609
2605
  :param pulumi.Input[str] ipc_mode: IPC sharing mode for the container. Possible values are: `none`, `private`, `shareable`, `container:<name|id>` or `host`.
2610
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerLabelArgs']]]] labels: User-defined key/value metadata.
2606
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerLabelArgs']]]] labels: User-defined key/value metadata
2611
2607
  :param pulumi.Input[str] log_driver: The logging driver to use for the container.
2612
2608
  :param pulumi.Input[Mapping[str, Any]] log_opts: Key/value pairs to use as options for the logging driver.
2613
2609
  :param pulumi.Input[bool] logs: Save the container logs (`attach` must be enabled). Defaults to `false`.
@@ -2617,7 +2613,7 @@ class Container(pulumi.CustomResource):
2617
2613
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerMountArgs']]]] mounts: Specification for mounts to be added to containers created as part of the service.
2618
2614
  :param pulumi.Input[bool] must_run: If `true`, then the Docker container will be kept running. If `false`, then as long as the container exists, Terraform
2619
2615
  assumes it is successful. Defaults to `true`.
2620
- :param pulumi.Input[str] name: The name or id of the network to use. You can use `name` or `id` attribute from a `Network` resource.
2616
+ :param pulumi.Input[str] name: The name of the container.
2621
2617
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerNetworkDataArgs']]]] network_datas: The data of the networks the container is connected to.
2622
2618
  :param pulumi.Input[str] network_mode: Network mode of the container.
2623
2619
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerNetworksAdvancedArgs']]]] networks_advanced: The networks the container is attached to
@@ -2625,7 +2621,7 @@ class Container(pulumi.CustomResource):
2625
2621
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ContainerPortArgs']]]] ports: Publish a container's port(s) to the host.
2626
2622
  :param pulumi.Input[bool] privileged: If `true`, the container runs in privileged mode.
2627
2623
  :param pulumi.Input[bool] publish_all_ports: Publish all ports of the container.
2628
- :param pulumi.Input[bool] read_only: Whether the mount should be read-only.
2624
+ :param pulumi.Input[bool] read_only: If `true`, the container will be started as readonly. Defaults to `false`.
2629
2625
  :param pulumi.Input[bool] remove_volumes: If `true`, it will remove anonymous volumes associated with the container. Defaults to `true`.
2630
2626
  :param pulumi.Input[str] restart: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to `no`.
2631
2627
  :param pulumi.Input[bool] rm: If `true`, then the container will be automatically removed when it exits. Defaults to `false`.
@@ -2901,7 +2897,7 @@ class Container(pulumi.CustomResource):
2901
2897
  @pulumi.getter
2902
2898
  def hosts(self) -> pulumi.Output[Optional[Sequence['outputs.ContainerHost']]]:
2903
2899
  """
2904
- Hostname to add
2900
+ Additional hosts to add to the container.
2905
2901
  """
2906
2902
  return pulumi.get(self, "hosts")
2907
2903
 
@@ -2933,7 +2929,7 @@ class Container(pulumi.CustomResource):
2933
2929
  @pulumi.getter
2934
2930
  def labels(self) -> pulumi.Output[Sequence['outputs.ContainerLabel']]:
2935
2931
  """
2936
- User-defined key/value metadata.
2932
+ User-defined key/value metadata
2937
2933
  """
2938
2934
  return pulumi.get(self, "labels")
2939
2935
 
@@ -3006,7 +3002,7 @@ class Container(pulumi.CustomResource):
3006
3002
  @pulumi.getter
3007
3003
  def name(self) -> pulumi.Output[str]:
3008
3004
  """
3009
- The name or id of the network to use. You can use `name` or `id` attribute from a `Network` resource.
3005
+ The name of the container.
3010
3006
  """
3011
3007
  return pulumi.get(self, "name")
3012
3008
 
@@ -3070,7 +3066,7 @@ class Container(pulumi.CustomResource):
3070
3066
  @pulumi.getter(name="readOnly")
3071
3067
  def read_only(self) -> pulumi.Output[Optional[bool]]:
3072
3068
  """
3073
- Whether the mount should be read-only.
3069
+ If `true`, the container will be started as readonly. Defaults to `false`.
3074
3070
  """
3075
3071
  return pulumi.get(self, "read_only")
3076
3072
 
@@ -124,14 +124,12 @@ def get_network(name: Optional[str] = None,
124
124
 
125
125
  ## Example Usage
126
126
 
127
- <!--Start PulumiCodeChooser -->
128
127
  ```python
129
128
  import pulumi
130
129
  import pulumi_docker as docker
131
130
 
132
131
  main = docker.get_network(name="main")
133
132
  ```
134
- <!--End PulumiCodeChooser -->
135
133
 
136
134
 
137
135
  :param str name: The name of the Docker network.
@@ -159,14 +157,12 @@ def get_network_output(name: Optional[pulumi.Input[str]] = None,
159
157
 
160
158
  ## Example Usage
161
159
 
162
- <!--Start PulumiCodeChooser -->
163
160
  ```python
164
161
  import pulumi
165
162
  import pulumi_docker as docker
166
163
 
167
164
  main = docker.get_network(name="main")
168
165
  ```
169
- <!--End PulumiCodeChooser -->
170
166
 
171
167
 
172
168
  :param str name: The name of the Docker network.
@@ -88,7 +88,6 @@ def get_registry_image(insecure_skip_verify: Optional[bool] = None,
88
88
 
89
89
  ## Example Usage
90
90
 
91
- <!--Start PulumiCodeChooser -->
92
91
  ```python
93
92
  import pulumi
94
93
  import pulumi_docker as docker
@@ -98,7 +97,6 @@ def get_registry_image(insecure_skip_verify: Optional[bool] = None,
98
97
  name=ubuntu.name,
99
98
  pull_triggers=[ubuntu.sha256_digest])
100
99
  ```
101
- <!--End PulumiCodeChooser -->
102
100
 
103
101
 
104
102
  :param bool insecure_skip_verify: If `true`, the verification of TLS certificates of the server/registry is disabled. Defaults to `false`
@@ -126,7 +124,6 @@ def get_registry_image_output(insecure_skip_verify: Optional[pulumi.Input[Option
126
124
 
127
125
  ## Example Usage
128
126
 
129
- <!--Start PulumiCodeChooser -->
130
127
  ```python
131
128
  import pulumi
132
129
  import pulumi_docker as docker
@@ -136,7 +133,6 @@ def get_registry_image_output(insecure_skip_verify: Optional[pulumi.Input[Option
136
133
  name=ubuntu.name,
137
134
  pull_triggers=[ubuntu.sha256_digest])
138
135
  ```
139
- <!--End PulumiCodeChooser -->
140
136
 
141
137
 
142
138
  :param bool insecure_skip_verify: If `true`, the verification of TLS certificates of the server/registry is disabled. Defaults to `false`
@@ -75,7 +75,6 @@ def get_remote_image(name: Optional[str] = None,
75
75
 
76
76
  ## Example Usage
77
77
 
78
- <!--Start PulumiCodeChooser -->
79
78
  ```python
80
79
  import pulumi
81
80
  import pulumi_docker as docker
@@ -89,7 +88,6 @@ def get_remote_image(name: Optional[str] = None,
89
88
  # uses the tag and the image digest
90
89
  tag_and_digest = docker.get_remote_image(name="nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2")
91
90
  ```
92
- <!--End PulumiCodeChooser -->
93
91
 
94
92
 
95
93
  :param str name: The name of the Docker image, including any tags or SHA256 repo digests.
@@ -113,7 +111,6 @@ def get_remote_image_output(name: Optional[pulumi.Input[str]] = None,
113
111
 
114
112
  ## Example Usage
115
113
 
116
- <!--Start PulumiCodeChooser -->
117
114
  ```python
118
115
  import pulumi
119
116
  import pulumi_docker as docker
@@ -127,7 +124,6 @@ def get_remote_image_output(name: Optional[pulumi.Input[str]] = None,
127
124
  # uses the tag and the image digest
128
125
  tag_and_digest = docker.get_remote_image(name="nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2")
129
126
  ```
130
- <!--End PulumiCodeChooser -->
131
127
 
132
128
 
133
129
  :param str name: The name of the Docker image, including any tags or SHA256 repo digests.
@@ -453,14 +453,12 @@ class Network(pulumi.CustomResource):
453
453
 
454
454
  ## Example Usage
455
455
 
456
- <!--Start PulumiCodeChooser -->
457
456
  ```python
458
457
  import pulumi
459
458
  import pulumi_docker as docker
460
459
 
461
460
  private_network = docker.Network("private_network", name="my_network")
462
461
  ```
463
- <!--End PulumiCodeChooser -->
464
462
 
465
463
  ## Import
466
464
 
@@ -521,14 +519,12 @@ class Network(pulumi.CustomResource):
521
519
 
522
520
  ## Example Usage
523
521
 
524
- <!--Start PulumiCodeChooser -->
525
522
  ```python
526
523
  import pulumi
527
524
  import pulumi_docker as docker
528
525
 
529
526
  private_network = docker.Network("private_network", name="my_network")
530
527
  ```
531
- <!--End PulumiCodeChooser -->
532
528
 
533
529
  ## Import
534
530
 
@@ -35,7 +35,7 @@ class PluginArgs:
35
35
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
36
36
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
37
37
  :param pulumi.Input[Sequence[pulumi.Input['PluginGrantPermissionArgs']]] grant_permissions: Grant specific permissions only
38
- :param pulumi.Input[str] name: The name of the permission
38
+ :param pulumi.Input[str] name: Docker Plugin name
39
39
  """
40
40
  if alias is not None:
41
41
  pulumi.set(__self__, "alias", alias)
@@ -156,7 +156,7 @@ class PluginArgs:
156
156
  @pulumi.getter
157
157
  def name(self) -> Optional[pulumi.Input[str]]:
158
158
  """
159
- The name of the permission
159
+ Docker Plugin name
160
160
  """
161
161
  return pulumi.get(self, "name")
162
162
 
@@ -188,7 +188,7 @@ class _PluginState:
188
188
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
189
189
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
190
190
  :param pulumi.Input[Sequence[pulumi.Input['PluginGrantPermissionArgs']]] grant_permissions: Grant specific permissions only
191
- :param pulumi.Input[str] name: The name of the permission
191
+ :param pulumi.Input[str] name: Docker Plugin name
192
192
  :param pulumi.Input[str] plugin_reference: Docker Plugin Reference
193
193
  """
194
194
  if alias is not None:
@@ -312,7 +312,7 @@ class _PluginState:
312
312
  @pulumi.getter
313
313
  def name(self) -> Optional[pulumi.Input[str]]:
314
314
  """
315
- The name of the permission
315
+ Docker Plugin name
316
316
  """
317
317
  return pulumi.get(self, "name")
318
318
 
@@ -370,7 +370,7 @@ class Plugin(pulumi.CustomResource):
370
370
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
371
371
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
372
372
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PluginGrantPermissionArgs']]]] grant_permissions: Grant specific permissions only
373
- :param pulumi.Input[str] name: The name of the permission
373
+ :param pulumi.Input[str] name: Docker Plugin name
374
374
  """
375
375
  ...
376
376
  @overload
@@ -468,7 +468,7 @@ class Plugin(pulumi.CustomResource):
468
468
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
469
469
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
470
470
  :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PluginGrantPermissionArgs']]]] grant_permissions: Grant specific permissions only
471
- :param pulumi.Input[str] name: The name of the permission
471
+ :param pulumi.Input[str] name: Docker Plugin name
472
472
  :param pulumi.Input[str] plugin_reference: Docker Plugin Reference
473
473
  """
474
474
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
@@ -555,7 +555,7 @@ class Plugin(pulumi.CustomResource):
555
555
  @pulumi.getter
556
556
  def name(self) -> pulumi.Output[str]:
557
557
  """
558
- The name of the permission
558
+ Docker Plugin name
559
559
  """
560
560
  return pulumi.get(self, "name")
561
561
 
@@ -25,11 +25,11 @@ class RemoteImageArgs:
25
25
  triggers: Optional[pulumi.Input[Mapping[str, Any]]] = None):
26
26
  """
27
27
  The set of arguments for constructing a RemoteImage resource.
28
- :param pulumi.Input[str] name: type of ulimit, e.g. `nofile`
28
+ :param pulumi.Input[str] name: The name of the Docker image, including any tags or SHA256 repo digests.
29
29
  :param pulumi.Input['RemoteImageBuildArgs'] build: Configuration to build an image. Please see [docker build command reference](https://docs.docker.com/engine/reference/commandline/build/#options) too.
30
- :param pulumi.Input[bool] force_remove: Always remove intermediate containers
30
+ :param pulumi.Input[bool] force_remove: If true, then the image is removed forcibly when the resource is destroyed.
31
31
  :param pulumi.Input[bool] keep_locally: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
32
- :param pulumi.Input[str] platform: Set platform if server is multi-platform capable
32
+ :param pulumi.Input[str] platform: The platform to use when pulling the image. Defaults to the platform of the current machine.
33
33
  :param pulumi.Input[Sequence[pulumi.Input[str]]] pull_triggers: List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the docker*registry*image.
34
34
  :param pulumi.Input[Mapping[str, Any]] triggers: A map of arbitrary strings that, when changed, will force the `RemoteImage` resource to be replaced. This can be used to rebuild an image when contents of source code folders change
35
35
  """
@@ -51,7 +51,7 @@ class RemoteImageArgs:
51
51
  @pulumi.getter
52
52
  def name(self) -> pulumi.Input[str]:
53
53
  """
54
- type of ulimit, e.g. `nofile`
54
+ The name of the Docker image, including any tags or SHA256 repo digests.
55
55
  """
56
56
  return pulumi.get(self, "name")
57
57
 
@@ -75,7 +75,7 @@ class RemoteImageArgs:
75
75
  @pulumi.getter(name="forceRemove")
76
76
  def force_remove(self) -> Optional[pulumi.Input[bool]]:
77
77
  """
78
- Always remove intermediate containers
78
+ If true, then the image is removed forcibly when the resource is destroyed.
79
79
  """
80
80
  return pulumi.get(self, "force_remove")
81
81
 
@@ -99,7 +99,7 @@ class RemoteImageArgs:
99
99
  @pulumi.getter
100
100
  def platform(self) -> Optional[pulumi.Input[str]]:
101
101
  """
102
- Set platform if server is multi-platform capable
102
+ The platform to use when pulling the image. Defaults to the platform of the current machine.
103
103
  """
104
104
  return pulumi.get(self, "platform")
105
105
 
@@ -147,11 +147,11 @@ class _RemoteImageState:
147
147
  """
148
148
  Input properties used for looking up and filtering RemoteImage resources.
149
149
  :param pulumi.Input['RemoteImageBuildArgs'] build: Configuration to build an image. Please see [docker build command reference](https://docs.docker.com/engine/reference/commandline/build/#options) too.
150
- :param pulumi.Input[bool] force_remove: Always remove intermediate containers
150
+ :param pulumi.Input[bool] force_remove: If true, then the image is removed forcibly when the resource is destroyed.
151
151
  :param pulumi.Input[str] image_id: The ID of the image (as seen when executing `docker inspect` on the image). Can be used to reference the image via its ID in other resources.
152
152
  :param pulumi.Input[bool] keep_locally: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
153
- :param pulumi.Input[str] name: type of ulimit, e.g. `nofile`
154
- :param pulumi.Input[str] platform: Set platform if server is multi-platform capable
153
+ :param pulumi.Input[str] name: The name of the Docker image, including any tags or SHA256 repo digests.
154
+ :param pulumi.Input[str] platform: The platform to use when pulling the image. Defaults to the platform of the current machine.
155
155
  :param pulumi.Input[Sequence[pulumi.Input[str]]] pull_triggers: List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the docker*registry*image.
156
156
  :param pulumi.Input[str] repo_digest: The image sha256 digest in the form of `repo[:tag]@sha256:<hash>`.
157
157
  :param pulumi.Input[Mapping[str, Any]] triggers: A map of arbitrary strings that, when changed, will force the `RemoteImage` resource to be replaced. This can be used to rebuild an image when contents of source code folders change
@@ -191,7 +191,7 @@ class _RemoteImageState:
191
191
  @pulumi.getter(name="forceRemove")
192
192
  def force_remove(self) -> Optional[pulumi.Input[bool]]:
193
193
  """
194
- Always remove intermediate containers
194
+ If true, then the image is removed forcibly when the resource is destroyed.
195
195
  """
196
196
  return pulumi.get(self, "force_remove")
197
197
 
@@ -227,7 +227,7 @@ class _RemoteImageState:
227
227
  @pulumi.getter
228
228
  def name(self) -> Optional[pulumi.Input[str]]:
229
229
  """
230
- type of ulimit, e.g. `nofile`
230
+ The name of the Docker image, including any tags or SHA256 repo digests.
231
231
  """
232
232
  return pulumi.get(self, "name")
233
233
 
@@ -239,7 +239,7 @@ class _RemoteImageState:
239
239
  @pulumi.getter
240
240
  def platform(self) -> Optional[pulumi.Input[str]]:
241
241
  """
242
- Set platform if server is multi-platform capable
242
+ The platform to use when pulling the image. Defaults to the platform of the current machine.
243
243
  """
244
244
  return pulumi.get(self, "platform")
245
245
 
@@ -309,21 +309,18 @@ class RemoteImage(pulumi.CustomResource):
309
309
  Finds and downloads the latest `ubuntu:precise` image but does not check
310
310
  for further updates of the image
311
311
 
312
- <!--Start PulumiCodeChooser -->
313
312
  ```python
314
313
  import pulumi
315
314
  import pulumi_docker as docker
316
315
 
317
316
  ubuntu = docker.RemoteImage("ubuntu", name="ubuntu:precise")
318
317
  ```
319
- <!--End PulumiCodeChooser -->
320
318
 
321
319
  ### Dynamic updates
322
320
 
323
321
  To be able to update an image dynamically when the `sha256` sum changes,
324
322
  you need to use it in combination with `RegistryImage` as follows:
325
323
 
326
- <!--Start PulumiCodeChooser -->
327
324
  ```python
328
325
  import pulumi
329
326
  import pulumi_docker as docker
@@ -333,14 +330,12 @@ class RemoteImage(pulumi.CustomResource):
333
330
  name=ubuntu.name,
334
331
  pull_triggers=[ubuntu.sha256_digest])
335
332
  ```
336
- <!--End PulumiCodeChooser -->
337
333
 
338
334
  ### Build
339
335
 
340
336
  You can also use the resource to build an image.
341
337
  In this case the image "zoo" and "zoo:develop" are built.
342
338
 
343
- <!--Start PulumiCodeChooser -->
344
339
  ```python
345
340
  import pulumi
346
341
  import pulumi_docker as docker
@@ -358,17 +353,16 @@ class RemoteImage(pulumi.CustomResource):
358
353
  },
359
354
  ))
360
355
  ```
361
- <!--End PulumiCodeChooser -->
362
356
 
363
357
  You can use the `triggers` argument to specify when the image should be rebuild. This is for example helpful when you want to rebuild the docker image whenever the source code changes.
364
358
 
365
359
  :param str resource_name: The name of the resource.
366
360
  :param pulumi.ResourceOptions opts: Options for the resource.
367
361
  :param pulumi.Input[pulumi.InputType['RemoteImageBuildArgs']] build: Configuration to build an image. Please see [docker build command reference](https://docs.docker.com/engine/reference/commandline/build/#options) too.
368
- :param pulumi.Input[bool] force_remove: Always remove intermediate containers
362
+ :param pulumi.Input[bool] force_remove: If true, then the image is removed forcibly when the resource is destroyed.
369
363
  :param pulumi.Input[bool] keep_locally: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
370
- :param pulumi.Input[str] name: type of ulimit, e.g. `nofile`
371
- :param pulumi.Input[str] platform: Set platform if server is multi-platform capable
364
+ :param pulumi.Input[str] name: The name of the Docker image, including any tags or SHA256 repo digests.
365
+ :param pulumi.Input[str] platform: The platform to use when pulling the image. Defaults to the platform of the current machine.
372
366
  :param pulumi.Input[Sequence[pulumi.Input[str]]] pull_triggers: List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the docker*registry*image.
373
367
  :param pulumi.Input[Mapping[str, Any]] triggers: A map of arbitrary strings that, when changed, will force the `RemoteImage` resource to be replaced. This can be used to rebuild an image when contents of source code folders change
374
368
  """
@@ -390,21 +384,18 @@ class RemoteImage(pulumi.CustomResource):
390
384
  Finds and downloads the latest `ubuntu:precise` image but does not check
391
385
  for further updates of the image
392
386
 
393
- <!--Start PulumiCodeChooser -->
394
387
  ```python
395
388
  import pulumi
396
389
  import pulumi_docker as docker
397
390
 
398
391
  ubuntu = docker.RemoteImage("ubuntu", name="ubuntu:precise")
399
392
  ```
400
- <!--End PulumiCodeChooser -->
401
393
 
402
394
  ### Dynamic updates
403
395
 
404
396
  To be able to update an image dynamically when the `sha256` sum changes,
405
397
  you need to use it in combination with `RegistryImage` as follows:
406
398
 
407
- <!--Start PulumiCodeChooser -->
408
399
  ```python
409
400
  import pulumi
410
401
  import pulumi_docker as docker
@@ -414,14 +405,12 @@ class RemoteImage(pulumi.CustomResource):
414
405
  name=ubuntu.name,
415
406
  pull_triggers=[ubuntu.sha256_digest])
416
407
  ```
417
- <!--End PulumiCodeChooser -->
418
408
 
419
409
  ### Build
420
410
 
421
411
  You can also use the resource to build an image.
422
412
  In this case the image "zoo" and "zoo:develop" are built.
423
413
 
424
- <!--Start PulumiCodeChooser -->
425
414
  ```python
426
415
  import pulumi
427
416
  import pulumi_docker as docker
@@ -439,7 +428,6 @@ class RemoteImage(pulumi.CustomResource):
439
428
  },
440
429
  ))
441
430
  ```
442
- <!--End PulumiCodeChooser -->
443
431
 
444
432
  You can use the `triggers` argument to specify when the image should be rebuild. This is for example helpful when you want to rebuild the docker image whenever the source code changes.
445
433
 
@@ -512,11 +500,11 @@ class RemoteImage(pulumi.CustomResource):
512
500
  :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
513
501
  :param pulumi.ResourceOptions opts: Options for the resource.
514
502
  :param pulumi.Input[pulumi.InputType['RemoteImageBuildArgs']] build: Configuration to build an image. Please see [docker build command reference](https://docs.docker.com/engine/reference/commandline/build/#options) too.
515
- :param pulumi.Input[bool] force_remove: Always remove intermediate containers
503
+ :param pulumi.Input[bool] force_remove: If true, then the image is removed forcibly when the resource is destroyed.
516
504
  :param pulumi.Input[str] image_id: The ID of the image (as seen when executing `docker inspect` on the image). Can be used to reference the image via its ID in other resources.
517
505
  :param pulumi.Input[bool] keep_locally: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
518
- :param pulumi.Input[str] name: type of ulimit, e.g. `nofile`
519
- :param pulumi.Input[str] platform: Set platform if server is multi-platform capable
506
+ :param pulumi.Input[str] name: The name of the Docker image, including any tags or SHA256 repo digests.
507
+ :param pulumi.Input[str] platform: The platform to use when pulling the image. Defaults to the platform of the current machine.
520
508
  :param pulumi.Input[Sequence[pulumi.Input[str]]] pull_triggers: List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the docker*registry*image.
521
509
  :param pulumi.Input[str] repo_digest: The image sha256 digest in the form of `repo[:tag]@sha256:<hash>`.
522
510
  :param pulumi.Input[Mapping[str, Any]] triggers: A map of arbitrary strings that, when changed, will force the `RemoteImage` resource to be replaced. This can be used to rebuild an image when contents of source code folders change
@@ -548,7 +536,7 @@ class RemoteImage(pulumi.CustomResource):
548
536
  @pulumi.getter(name="forceRemove")
549
537
  def force_remove(self) -> pulumi.Output[Optional[bool]]:
550
538
  """
551
- Always remove intermediate containers
539
+ If true, then the image is removed forcibly when the resource is destroyed.
552
540
  """
553
541
  return pulumi.get(self, "force_remove")
554
542
 
@@ -572,7 +560,7 @@ class RemoteImage(pulumi.CustomResource):
572
560
  @pulumi.getter
573
561
  def name(self) -> pulumi.Output[str]:
574
562
  """
575
- type of ulimit, e.g. `nofile`
563
+ The name of the Docker image, including any tags or SHA256 repo digests.
576
564
  """
577
565
  return pulumi.get(self, "name")
578
566
 
@@ -580,7 +568,7 @@ class RemoteImage(pulumi.CustomResource):
580
568
  @pulumi.getter
581
569
  def platform(self) -> pulumi.Output[Optional[str]]:
582
570
  """
583
- Set platform if server is multi-platform capable
571
+ The platform to use when pulling the image. Defaults to the platform of the current machine.
584
572
  """
585
573
  return pulumi.get(self, "platform")
586
574
 
@@ -189,14 +189,12 @@ class Volume(pulumi.CustomResource):
189
189
 
190
190
  ## Example Usage
191
191
 
192
- <!--Start PulumiCodeChooser -->
193
192
  ```python
194
193
  import pulumi
195
194
  import pulumi_docker as docker
196
195
 
197
196
  shared_volume = docker.Volume("shared_volume", name="shared_volume")
198
197
  ```
199
- <!--End PulumiCodeChooser -->
200
198
 
201
199
  ## Import
202
200
 
@@ -249,14 +247,12 @@ class Volume(pulumi.CustomResource):
249
247
 
250
248
  ## Example Usage
251
249
 
252
- <!--Start PulumiCodeChooser -->
253
250
  ```python
254
251
  import pulumi
255
252
  import pulumi_docker as docker
256
253
 
257
254
  shared_volume = docker.Volume("shared_volume", name="shared_volume")
258
255
  ```
259
- <!--End PulumiCodeChooser -->
260
256
 
261
257
  ## Import
262
258
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: pulumi_docker
3
- Version: 4.6.0a1714109818
3
+ Version: 4.6.0a1714492220
4
4
  Summary: A Pulumi package for interacting with Docker in Pulumi programs
5
5
  License: Apache-2.0
6
6
  Project-URL: Homepage, https://pulumi.io
@@ -5,7 +5,7 @@
5
5
  keywords = ["pulumi", "docker"]
6
6
  readme = "README.md"
7
7
  requires-python = ">=3.8"
8
- version = "4.6.0a1714109818"
8
+ version = "4.6.0a1714492220"
9
9
  [project.license]
10
10
  text = "Apache-2.0"
11
11
  [project.urls]