pulumi-docker 4.6.2a1741997713__py3-none-any.whl → 4.7.0__py3-none-any.whl

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.

Potentially problematic release.


This version of pulumi-docker might be problematic. Click here for more details.

pulumi_docker/provider.py CHANGED
@@ -2,6 +2,7 @@
2
2
  # *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
3
3
  # *** Do not edit by hand unless you're certain you know what you are doing! ***
4
4
 
5
+ import builtins
5
6
  import copy
6
7
  import warnings
7
8
  import sys
@@ -20,21 +21,27 @@ __all__ = ['ProviderArgs', 'Provider']
20
21
  @pulumi.input_type
21
22
  class ProviderArgs:
22
23
  def __init__(__self__, *,
23
- ca_material: Optional[pulumi.Input[str]] = None,
24
- cert_material: Optional[pulumi.Input[str]] = None,
25
- cert_path: Optional[pulumi.Input[str]] = None,
26
- host: Optional[pulumi.Input[str]] = None,
27
- key_material: Optional[pulumi.Input[str]] = None,
24
+ ca_material: Optional[pulumi.Input[builtins.str]] = None,
25
+ cert_material: Optional[pulumi.Input[builtins.str]] = None,
26
+ cert_path: Optional[pulumi.Input[builtins.str]] = None,
27
+ context: Optional[pulumi.Input[builtins.str]] = None,
28
+ disable_docker_daemon_check: Optional[pulumi.Input[builtins.bool]] = None,
29
+ host: Optional[pulumi.Input[builtins.str]] = None,
30
+ key_material: Optional[pulumi.Input[builtins.str]] = None,
28
31
  registry_auth: Optional[pulumi.Input[Sequence[pulumi.Input['ProviderRegistryAuthArgs']]]] = None,
29
- ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
32
+ ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None):
30
33
  """
31
34
  The set of arguments for constructing a Provider resource.
32
- :param pulumi.Input[str] ca_material: PEM-encoded content of Docker host CA certificate
33
- :param pulumi.Input[str] cert_material: PEM-encoded content of Docker client certificate
34
- :param pulumi.Input[str] cert_path: Path to directory with Docker TLS config
35
- :param pulumi.Input[str] host: The Docker daemon address
36
- :param pulumi.Input[str] key_material: PEM-encoded content of Docker client private key
37
- :param pulumi.Input[Sequence[pulumi.Input[str]]] ssh_opts: Additional SSH option flags to be appended when using `ssh://` protocol
35
+ :param pulumi.Input[builtins.str] ca_material: PEM-encoded content of Docker host CA certificate
36
+ :param pulumi.Input[builtins.str] cert_material: PEM-encoded content of Docker client certificate
37
+ :param pulumi.Input[builtins.str] cert_path: Path to directory with Docker TLS config
38
+ :param pulumi.Input[builtins.str] context: The name of the Docker context to use. Can also be set via `DOCKER_CONTEXT` environment variable. Overrides the `host`
39
+ if set.
40
+ :param pulumi.Input[builtins.bool] disable_docker_daemon_check: If set to `true`, the provider will not check if the Docker daemon is running. This is useful for
41
+ resources/data_sourcess that do not require a running Docker daemon, such as the data source `RegistryImage`.
42
+ :param pulumi.Input[builtins.str] host: The Docker daemon address
43
+ :param pulumi.Input[builtins.str] key_material: PEM-encoded content of Docker client private key
44
+ :param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] ssh_opts: Additional SSH option flags to be appended when using `ssh://` protocol
38
45
  """
39
46
  if ca_material is not None:
40
47
  pulumi.set(__self__, "ca_material", ca_material)
@@ -42,6 +49,10 @@ class ProviderArgs:
42
49
  pulumi.set(__self__, "cert_material", cert_material)
43
50
  if cert_path is not None:
44
51
  pulumi.set(__self__, "cert_path", cert_path)
52
+ if context is not None:
53
+ pulumi.set(__self__, "context", context)
54
+ if disable_docker_daemon_check is not None:
55
+ pulumi.set(__self__, "disable_docker_daemon_check", disable_docker_daemon_check)
45
56
  if host is None:
46
57
  host = _utilities.get_env('DOCKER_HOST')
47
58
  if host is not None:
@@ -55,62 +66,88 @@ class ProviderArgs:
55
66
 
56
67
  @property
57
68
  @pulumi.getter(name="caMaterial")
58
- def ca_material(self) -> Optional[pulumi.Input[str]]:
69
+ def ca_material(self) -> Optional[pulumi.Input[builtins.str]]:
59
70
  """
60
71
  PEM-encoded content of Docker host CA certificate
61
72
  """
62
73
  return pulumi.get(self, "ca_material")
63
74
 
64
75
  @ca_material.setter
65
- def ca_material(self, value: Optional[pulumi.Input[str]]):
76
+ def ca_material(self, value: Optional[pulumi.Input[builtins.str]]):
66
77
  pulumi.set(self, "ca_material", value)
67
78
 
68
79
  @property
69
80
  @pulumi.getter(name="certMaterial")
70
- def cert_material(self) -> Optional[pulumi.Input[str]]:
81
+ def cert_material(self) -> Optional[pulumi.Input[builtins.str]]:
71
82
  """
72
83
  PEM-encoded content of Docker client certificate
73
84
  """
74
85
  return pulumi.get(self, "cert_material")
75
86
 
76
87
  @cert_material.setter
77
- def cert_material(self, value: Optional[pulumi.Input[str]]):
88
+ def cert_material(self, value: Optional[pulumi.Input[builtins.str]]):
78
89
  pulumi.set(self, "cert_material", value)
79
90
 
80
91
  @property
81
92
  @pulumi.getter(name="certPath")
82
- def cert_path(self) -> Optional[pulumi.Input[str]]:
93
+ def cert_path(self) -> Optional[pulumi.Input[builtins.str]]:
83
94
  """
84
95
  Path to directory with Docker TLS config
85
96
  """
86
97
  return pulumi.get(self, "cert_path")
87
98
 
88
99
  @cert_path.setter
89
- def cert_path(self, value: Optional[pulumi.Input[str]]):
100
+ def cert_path(self, value: Optional[pulumi.Input[builtins.str]]):
90
101
  pulumi.set(self, "cert_path", value)
91
102
 
92
103
  @property
93
104
  @pulumi.getter
94
- def host(self) -> Optional[pulumi.Input[str]]:
105
+ def context(self) -> Optional[pulumi.Input[builtins.str]]:
106
+ """
107
+ The name of the Docker context to use. Can also be set via `DOCKER_CONTEXT` environment variable. Overrides the `host`
108
+ if set.
109
+ """
110
+ return pulumi.get(self, "context")
111
+
112
+ @context.setter
113
+ def context(self, value: Optional[pulumi.Input[builtins.str]]):
114
+ pulumi.set(self, "context", value)
115
+
116
+ @property
117
+ @pulumi.getter(name="disableDockerDaemonCheck")
118
+ def disable_docker_daemon_check(self) -> Optional[pulumi.Input[builtins.bool]]:
119
+ """
120
+ If set to `true`, the provider will not check if the Docker daemon is running. This is useful for
121
+ resources/data_sourcess that do not require a running Docker daemon, such as the data source `RegistryImage`.
122
+ """
123
+ return pulumi.get(self, "disable_docker_daemon_check")
124
+
125
+ @disable_docker_daemon_check.setter
126
+ def disable_docker_daemon_check(self, value: Optional[pulumi.Input[builtins.bool]]):
127
+ pulumi.set(self, "disable_docker_daemon_check", value)
128
+
129
+ @property
130
+ @pulumi.getter
131
+ def host(self) -> Optional[pulumi.Input[builtins.str]]:
95
132
  """
96
133
  The Docker daemon address
97
134
  """
98
135
  return pulumi.get(self, "host")
99
136
 
100
137
  @host.setter
101
- def host(self, value: Optional[pulumi.Input[str]]):
138
+ def host(self, value: Optional[pulumi.Input[builtins.str]]):
102
139
  pulumi.set(self, "host", value)
103
140
 
104
141
  @property
105
142
  @pulumi.getter(name="keyMaterial")
106
- def key_material(self) -> Optional[pulumi.Input[str]]:
143
+ def key_material(self) -> Optional[pulumi.Input[builtins.str]]:
107
144
  """
108
145
  PEM-encoded content of Docker client private key
109
146
  """
110
147
  return pulumi.get(self, "key_material")
111
148
 
112
149
  @key_material.setter
113
- def key_material(self, value: Optional[pulumi.Input[str]]):
150
+ def key_material(self, value: Optional[pulumi.Input[builtins.str]]):
114
151
  pulumi.set(self, "key_material", value)
115
152
 
116
153
  @property
@@ -124,29 +161,32 @@ class ProviderArgs:
124
161
 
125
162
  @property
126
163
  @pulumi.getter(name="sshOpts")
127
- def ssh_opts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
164
+ def ssh_opts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]:
128
165
  """
129
166
  Additional SSH option flags to be appended when using `ssh://` protocol
130
167
  """
131
168
  return pulumi.get(self, "ssh_opts")
132
169
 
133
170
  @ssh_opts.setter
134
- def ssh_opts(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
171
+ def ssh_opts(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]):
135
172
  pulumi.set(self, "ssh_opts", value)
136
173
 
137
174
 
175
+ @pulumi.type_token("pulumi:providers:docker")
138
176
  class Provider(pulumi.ProviderResource):
139
177
  @overload
140
178
  def __init__(__self__,
141
179
  resource_name: str,
142
180
  opts: Optional[pulumi.ResourceOptions] = None,
143
- ca_material: Optional[pulumi.Input[str]] = None,
144
- cert_material: Optional[pulumi.Input[str]] = None,
145
- cert_path: Optional[pulumi.Input[str]] = None,
146
- host: Optional[pulumi.Input[str]] = None,
147
- key_material: Optional[pulumi.Input[str]] = None,
181
+ ca_material: Optional[pulumi.Input[builtins.str]] = None,
182
+ cert_material: Optional[pulumi.Input[builtins.str]] = None,
183
+ cert_path: Optional[pulumi.Input[builtins.str]] = None,
184
+ context: Optional[pulumi.Input[builtins.str]] = None,
185
+ disable_docker_daemon_check: Optional[pulumi.Input[builtins.bool]] = None,
186
+ host: Optional[pulumi.Input[builtins.str]] = None,
187
+ key_material: Optional[pulumi.Input[builtins.str]] = None,
148
188
  registry_auth: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ProviderRegistryAuthArgs', 'ProviderRegistryAuthArgsDict']]]]] = None,
149
- ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
189
+ ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
150
190
  __props__=None):
151
191
  """
152
192
  The provider type for the docker package. By default, resources use package-wide configuration
@@ -156,12 +196,16 @@ class Provider(pulumi.ProviderResource):
156
196
 
157
197
  :param str resource_name: The name of the resource.
158
198
  :param pulumi.ResourceOptions opts: Options for the resource.
159
- :param pulumi.Input[str] ca_material: PEM-encoded content of Docker host CA certificate
160
- :param pulumi.Input[str] cert_material: PEM-encoded content of Docker client certificate
161
- :param pulumi.Input[str] cert_path: Path to directory with Docker TLS config
162
- :param pulumi.Input[str] host: The Docker daemon address
163
- :param pulumi.Input[str] key_material: PEM-encoded content of Docker client private key
164
- :param pulumi.Input[Sequence[pulumi.Input[str]]] ssh_opts: Additional SSH option flags to be appended when using `ssh://` protocol
199
+ :param pulumi.Input[builtins.str] ca_material: PEM-encoded content of Docker host CA certificate
200
+ :param pulumi.Input[builtins.str] cert_material: PEM-encoded content of Docker client certificate
201
+ :param pulumi.Input[builtins.str] cert_path: Path to directory with Docker TLS config
202
+ :param pulumi.Input[builtins.str] context: The name of the Docker context to use. Can also be set via `DOCKER_CONTEXT` environment variable. Overrides the `host`
203
+ if set.
204
+ :param pulumi.Input[builtins.bool] disable_docker_daemon_check: If set to `true`, the provider will not check if the Docker daemon is running. This is useful for
205
+ resources/data_sourcess that do not require a running Docker daemon, such as the data source `RegistryImage`.
206
+ :param pulumi.Input[builtins.str] host: The Docker daemon address
207
+ :param pulumi.Input[builtins.str] key_material: PEM-encoded content of Docker client private key
208
+ :param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] ssh_opts: Additional SSH option flags to be appended when using `ssh://` protocol
165
209
  """
166
210
  ...
167
211
  @overload
@@ -190,13 +234,15 @@ class Provider(pulumi.ProviderResource):
190
234
  def _internal_init(__self__,
191
235
  resource_name: str,
192
236
  opts: Optional[pulumi.ResourceOptions] = None,
193
- ca_material: Optional[pulumi.Input[str]] = None,
194
- cert_material: Optional[pulumi.Input[str]] = None,
195
- cert_path: Optional[pulumi.Input[str]] = None,
196
- host: Optional[pulumi.Input[str]] = None,
197
- key_material: Optional[pulumi.Input[str]] = None,
237
+ ca_material: Optional[pulumi.Input[builtins.str]] = None,
238
+ cert_material: Optional[pulumi.Input[builtins.str]] = None,
239
+ cert_path: Optional[pulumi.Input[builtins.str]] = None,
240
+ context: Optional[pulumi.Input[builtins.str]] = None,
241
+ disable_docker_daemon_check: Optional[pulumi.Input[builtins.bool]] = None,
242
+ host: Optional[pulumi.Input[builtins.str]] = None,
243
+ key_material: Optional[pulumi.Input[builtins.str]] = None,
198
244
  registry_auth: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ProviderRegistryAuthArgs', 'ProviderRegistryAuthArgsDict']]]]] = None,
199
- ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
245
+ ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
200
246
  __props__=None):
201
247
  opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
202
248
  if not isinstance(opts, pulumi.ResourceOptions):
@@ -209,6 +255,8 @@ class Provider(pulumi.ProviderResource):
209
255
  __props__.__dict__["ca_material"] = ca_material
210
256
  __props__.__dict__["cert_material"] = cert_material
211
257
  __props__.__dict__["cert_path"] = cert_path
258
+ __props__.__dict__["context"] = context
259
+ __props__.__dict__["disable_docker_daemon_check"] = pulumi.Output.from_input(disable_docker_daemon_check).apply(pulumi.runtime.to_json) if disable_docker_daemon_check is not None else None
212
260
  if host is None:
213
261
  host = _utilities.get_env('DOCKER_HOST')
214
262
  __props__.__dict__["host"] = host
@@ -223,7 +271,7 @@ class Provider(pulumi.ProviderResource):
223
271
 
224
272
  @property
225
273
  @pulumi.getter(name="caMaterial")
226
- def ca_material(self) -> pulumi.Output[Optional[str]]:
274
+ def ca_material(self) -> pulumi.Output[Optional[builtins.str]]:
227
275
  """
228
276
  PEM-encoded content of Docker host CA certificate
229
277
  """
@@ -231,7 +279,7 @@ class Provider(pulumi.ProviderResource):
231
279
 
232
280
  @property
233
281
  @pulumi.getter(name="certMaterial")
234
- def cert_material(self) -> pulumi.Output[Optional[str]]:
282
+ def cert_material(self) -> pulumi.Output[Optional[builtins.str]]:
235
283
  """
236
284
  PEM-encoded content of Docker client certificate
237
285
  """
@@ -239,7 +287,7 @@ class Provider(pulumi.ProviderResource):
239
287
 
240
288
  @property
241
289
  @pulumi.getter(name="certPath")
242
- def cert_path(self) -> pulumi.Output[Optional[str]]:
290
+ def cert_path(self) -> pulumi.Output[Optional[builtins.str]]:
243
291
  """
244
292
  Path to directory with Docker TLS config
245
293
  """
@@ -247,7 +295,16 @@ class Provider(pulumi.ProviderResource):
247
295
 
248
296
  @property
249
297
  @pulumi.getter
250
- def host(self) -> pulumi.Output[Optional[str]]:
298
+ def context(self) -> pulumi.Output[Optional[builtins.str]]:
299
+ """
300
+ The name of the Docker context to use. Can also be set via `DOCKER_CONTEXT` environment variable. Overrides the `host`
301
+ if set.
302
+ """
303
+ return pulumi.get(self, "context")
304
+
305
+ @property
306
+ @pulumi.getter
307
+ def host(self) -> pulumi.Output[Optional[builtins.str]]:
251
308
  """
252
309
  The Docker daemon address
253
310
  """
@@ -255,9 +312,29 @@ class Provider(pulumi.ProviderResource):
255
312
 
256
313
  @property
257
314
  @pulumi.getter(name="keyMaterial")
258
- def key_material(self) -> pulumi.Output[Optional[str]]:
315
+ def key_material(self) -> pulumi.Output[Optional[builtins.str]]:
259
316
  """
260
317
  PEM-encoded content of Docker client private key
261
318
  """
262
319
  return pulumi.get(self, "key_material")
263
320
 
321
+ @pulumi.output_type
322
+ class TerraformConfigResult:
323
+ def __init__(__self__, result=None):
324
+ if result and not isinstance(result, dict):
325
+ raise TypeError("Expected argument 'result' to be a dict")
326
+ pulumi.set(__self__, "result", result)
327
+
328
+ @property
329
+ @pulumi.getter
330
+ def result(self) -> Mapping[str, Any]:
331
+ return pulumi.get(self, "result")
332
+
333
+ def terraform_config(__self__) -> pulumi.Output['Provider.TerraformConfigResult']:
334
+ """
335
+ This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.
336
+ """
337
+ __args__ = dict()
338
+ __args__['__self__'] = __self__
339
+ return pulumi.runtime.call('pulumi:providers:docker/terraformConfig', __args__, res=__self__, typ=Provider.TerraformConfigResult)
340
+
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "resource": true,
3
3
  "name": "docker",
4
- "version": "4.6.2-alpha.1741997713"
4
+ "version": "4.7.0"
5
5
  }