max-voitcov
73386ba0ff
Six new resources from terraform-provider-dokploy v0.2.0 -- Network, DnsProvider, VaultProvider, Schedule, VolumeBackup and Libsql -- plus the new properties on Domain (`enabled`), Compose (`serviceNetworks`, `createEnvFile`, `icon`) and Application. Verified with `pulumi up` against a live v0.30.2 instance: create, preview-clean, and destroy. The upstream provider also now refuses a volume Mount with no `volumeName`, which Dokploy would otherwise turn into an anonymous Docker volume recreated on every deploy. That surfaces here at preview time, before anything exists. Two things made that fix nearly invisible to Pulumi users, so this commit fixes the second one: the bridge resolves the upstream `docs/` through the Go module cache, where a locally `replace`d dependency never lands, so tfgen was emitting every resource with no description at all. UpstreamRepoPath now points at the checkout and all 445 inputs carry documentation -- with names rendered per language, so Python readers see `volume_name` where TypeScript readers see `volumeName`.
596 lines
26 KiB
Python
Generated
596 lines
26 KiB
Python
Generated
# coding=utf-8
|
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
|
|
import builtins as _builtins
|
|
import warnings
|
|
import sys
|
|
import pulumi
|
|
import pulumi.runtime
|
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
if sys.version_info >= (3, 11):
|
|
from typing import NotRequired, TypedDict, TypeAlias
|
|
else:
|
|
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
from . import _utilities
|
|
|
|
__all__ = ['NetworkArgs', 'Network']
|
|
|
|
@pulumi.input_type
|
|
class NetworkArgs:
|
|
def __init__(__self__, *,
|
|
attachable: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
driver: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enable_ipv4: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
enable_ipv6: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
internal: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
ipam: pulumi.Input[Optional[_builtins.str]] = None,
|
|
mtu: pulumi.Input[Optional[_builtins.int]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None):
|
|
"""
|
|
The set of arguments for constructing a Network resource.
|
|
|
|
:param pulumi.Input[_builtins.bool] attachable: Allow standalone containers to attach to an overlay network.
|
|
:param pulumi.Input[_builtins.str] driver: Network driver. Use `overlay` for multi-node Swarm clusters and `bridge` for a single host. Valid values: `bridge`, `overlay`.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv4: Enable IPv4 address allocation.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv6: Enable IPv6 address allocation.
|
|
:param pulumi.Input[_builtins.bool] internal: Isolate the network from external access.
|
|
:param pulumi.Input[_builtins.str] ipam: Custom IP address management, as a JSON object with `subnet`, `gateway` and `ipRange` keys. Leave unset to let Docker choose a subnet.
|
|
:param pulumi.Input[_builtins.int] mtu: Maximum transmission unit for the network. Leave unset to use Docker's default.
|
|
:param pulumi.Input[_builtins.str] name: Name of the Docker network.
|
|
:param pulumi.Input[_builtins.str] server_id: Remote server to create the network on. Omit to use the Dokploy host itself.
|
|
"""
|
|
if attachable is not None:
|
|
pulumi.set(__self__, "attachable", attachable)
|
|
if driver is not None:
|
|
pulumi.set(__self__, "driver", driver)
|
|
if enable_ipv4 is not None:
|
|
pulumi.set(__self__, "enable_ipv4", enable_ipv4)
|
|
if enable_ipv6 is not None:
|
|
pulumi.set(__self__, "enable_ipv6", enable_ipv6)
|
|
if internal is not None:
|
|
pulumi.set(__self__, "internal", internal)
|
|
if ipam is not None:
|
|
pulumi.set(__self__, "ipam", ipam)
|
|
if mtu is not None:
|
|
pulumi.set(__self__, "mtu", mtu)
|
|
if name is not None:
|
|
pulumi.set(__self__, "name", name)
|
|
if server_id is not None:
|
|
pulumi.set(__self__, "server_id", server_id)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def attachable(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Allow standalone containers to attach to an overlay network.
|
|
"""
|
|
return pulumi.get(self, "attachable")
|
|
|
|
@attachable.setter
|
|
def attachable(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "attachable", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def driver(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Network driver. Use `overlay` for multi-node Swarm clusters and `bridge` for a single host. Valid values: `bridge`, `overlay`.
|
|
"""
|
|
return pulumi.get(self, "driver")
|
|
|
|
@driver.setter
|
|
def driver(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "driver", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="enableIpv4")
|
|
def enable_ipv4(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Enable IPv4 address allocation.
|
|
"""
|
|
return pulumi.get(self, "enable_ipv4")
|
|
|
|
@enable_ipv4.setter
|
|
def enable_ipv4(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "enable_ipv4", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="enableIpv6")
|
|
def enable_ipv6(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Enable IPv6 address allocation.
|
|
"""
|
|
return pulumi.get(self, "enable_ipv6")
|
|
|
|
@enable_ipv6.setter
|
|
def enable_ipv6(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "enable_ipv6", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def internal(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Isolate the network from external access.
|
|
"""
|
|
return pulumi.get(self, "internal")
|
|
|
|
@internal.setter
|
|
def internal(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "internal", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def ipam(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Custom IP address management, as a JSON object with `subnet`, `gateway` and `ipRange` keys. Leave unset to let Docker choose a subnet.
|
|
"""
|
|
return pulumi.get(self, "ipam")
|
|
|
|
@ipam.setter
|
|
def ipam(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "ipam", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def mtu(self) -> pulumi.Input[Optional[_builtins.int]]:
|
|
"""
|
|
Maximum transmission unit for the network. Leave unset to use Docker's default.
|
|
"""
|
|
return pulumi.get(self, "mtu")
|
|
|
|
@mtu.setter
|
|
def mtu(self, value: pulumi.Input[Optional[_builtins.int]]):
|
|
pulumi.set(self, "mtu", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Name of the Docker network.
|
|
"""
|
|
return pulumi.get(self, "name")
|
|
|
|
@name.setter
|
|
def name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serverId")
|
|
def server_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Remote server to create the network on. Omit to use the Dokploy host itself.
|
|
"""
|
|
return pulumi.get(self, "server_id")
|
|
|
|
@server_id.setter
|
|
def server_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "server_id", value)
|
|
|
|
|
|
@pulumi.input_type
|
|
class _NetworkState:
|
|
def __init__(__self__, *,
|
|
attachable: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
created_at: pulumi.Input[Optional[_builtins.str]] = None,
|
|
driver: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enable_ipv4: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
enable_ipv6: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
internal: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
ipam: pulumi.Input[Optional[_builtins.str]] = None,
|
|
mtu: pulumi.Input[Optional[_builtins.int]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
organization_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None):
|
|
"""
|
|
Input properties used for looking up and filtering Network resources.
|
|
|
|
:param pulumi.Input[_builtins.bool] attachable: Allow standalone containers to attach to an overlay network.
|
|
:param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the network was created.
|
|
:param pulumi.Input[_builtins.str] driver: Network driver. Use `overlay` for multi-node Swarm clusters and `bridge` for a single host. Valid values: `bridge`, `overlay`.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv4: Enable IPv4 address allocation.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv6: Enable IPv6 address allocation.
|
|
:param pulumi.Input[_builtins.bool] internal: Isolate the network from external access.
|
|
:param pulumi.Input[_builtins.str] ipam: Custom IP address management, as a JSON object with `subnet`, `gateway` and `ipRange` keys. Leave unset to let Docker choose a subnet.
|
|
:param pulumi.Input[_builtins.int] mtu: Maximum transmission unit for the network. Leave unset to use Docker's default.
|
|
:param pulumi.Input[_builtins.str] name: Name of the Docker network.
|
|
:param pulumi.Input[_builtins.str] organization_id: Organization that owns the network.
|
|
:param pulumi.Input[_builtins.str] server_id: Remote server to create the network on. Omit to use the Dokploy host itself.
|
|
"""
|
|
if attachable is not None:
|
|
pulumi.set(__self__, "attachable", attachable)
|
|
if created_at is not None:
|
|
pulumi.set(__self__, "created_at", created_at)
|
|
if driver is not None:
|
|
pulumi.set(__self__, "driver", driver)
|
|
if enable_ipv4 is not None:
|
|
pulumi.set(__self__, "enable_ipv4", enable_ipv4)
|
|
if enable_ipv6 is not None:
|
|
pulumi.set(__self__, "enable_ipv6", enable_ipv6)
|
|
if internal is not None:
|
|
pulumi.set(__self__, "internal", internal)
|
|
if ipam is not None:
|
|
pulumi.set(__self__, "ipam", ipam)
|
|
if mtu is not None:
|
|
pulumi.set(__self__, "mtu", mtu)
|
|
if name is not None:
|
|
pulumi.set(__self__, "name", name)
|
|
if organization_id is not None:
|
|
pulumi.set(__self__, "organization_id", organization_id)
|
|
if server_id is not None:
|
|
pulumi.set(__self__, "server_id", server_id)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def attachable(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Allow standalone containers to attach to an overlay network.
|
|
"""
|
|
return pulumi.get(self, "attachable")
|
|
|
|
@attachable.setter
|
|
def attachable(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "attachable", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="createdAt")
|
|
def created_at(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
RFC 3339 timestamp of when the network was created.
|
|
"""
|
|
return pulumi.get(self, "created_at")
|
|
|
|
@created_at.setter
|
|
def created_at(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "created_at", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def driver(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Network driver. Use `overlay` for multi-node Swarm clusters and `bridge` for a single host. Valid values: `bridge`, `overlay`.
|
|
"""
|
|
return pulumi.get(self, "driver")
|
|
|
|
@driver.setter
|
|
def driver(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "driver", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="enableIpv4")
|
|
def enable_ipv4(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Enable IPv4 address allocation.
|
|
"""
|
|
return pulumi.get(self, "enable_ipv4")
|
|
|
|
@enable_ipv4.setter
|
|
def enable_ipv4(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "enable_ipv4", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="enableIpv6")
|
|
def enable_ipv6(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Enable IPv6 address allocation.
|
|
"""
|
|
return pulumi.get(self, "enable_ipv6")
|
|
|
|
@enable_ipv6.setter
|
|
def enable_ipv6(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "enable_ipv6", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def internal(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Isolate the network from external access.
|
|
"""
|
|
return pulumi.get(self, "internal")
|
|
|
|
@internal.setter
|
|
def internal(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "internal", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def ipam(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Custom IP address management, as a JSON object with `subnet`, `gateway` and `ipRange` keys. Leave unset to let Docker choose a subnet.
|
|
"""
|
|
return pulumi.get(self, "ipam")
|
|
|
|
@ipam.setter
|
|
def ipam(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "ipam", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def mtu(self) -> pulumi.Input[Optional[_builtins.int]]:
|
|
"""
|
|
Maximum transmission unit for the network. Leave unset to use Docker's default.
|
|
"""
|
|
return pulumi.get(self, "mtu")
|
|
|
|
@mtu.setter
|
|
def mtu(self, value: pulumi.Input[Optional[_builtins.int]]):
|
|
pulumi.set(self, "mtu", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Name of the Docker network.
|
|
"""
|
|
return pulumi.get(self, "name")
|
|
|
|
@name.setter
|
|
def name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="organizationId")
|
|
def organization_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Organization that owns the network.
|
|
"""
|
|
return pulumi.get(self, "organization_id")
|
|
|
|
@organization_id.setter
|
|
def organization_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "organization_id", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serverId")
|
|
def server_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Remote server to create the network on. Omit to use the Dokploy host itself.
|
|
"""
|
|
return pulumi.get(self, "server_id")
|
|
|
|
@server_id.setter
|
|
def server_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "server_id", value)
|
|
|
|
|
|
@pulumi.type_token("dokploy:index/network:Network")
|
|
class Network(pulumi.CustomResource):
|
|
@overload
|
|
def __init__(__self__,
|
|
resource_name: str,
|
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
attachable: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
driver: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enable_ipv4: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
enable_ipv6: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
internal: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
ipam: pulumi.Input[Optional[_builtins.str]] = None,
|
|
mtu: pulumi.Input[Optional[_builtins.int]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
__props__=None):
|
|
"""
|
|
A Docker network managed by Dokploy.
|
|
|
|
Attach services to it with `network_ids` on `Application`, `Compose` and the database resources. Every service also joins the shared `dokploy-network` unless `detach_dokploy_network` is set.
|
|
|
|
> Docker networks are immutable. Dokploy has no update endpoint, so changing any attribute replaces the network — which detaches the services currently using it until they redeploy.
|
|
|
|
|
|
:param str resource_name: The name of the resource.
|
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
:param pulumi.Input[_builtins.bool] attachable: Allow standalone containers to attach to an overlay network.
|
|
:param pulumi.Input[_builtins.str] driver: Network driver. Use `overlay` for multi-node Swarm clusters and `bridge` for a single host. Valid values: `bridge`, `overlay`.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv4: Enable IPv4 address allocation.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv6: Enable IPv6 address allocation.
|
|
:param pulumi.Input[_builtins.bool] internal: Isolate the network from external access.
|
|
:param pulumi.Input[_builtins.str] ipam: Custom IP address management, as a JSON object with `subnet`, `gateway` and `ipRange` keys. Leave unset to let Docker choose a subnet.
|
|
:param pulumi.Input[_builtins.int] mtu: Maximum transmission unit for the network. Leave unset to use Docker's default.
|
|
:param pulumi.Input[_builtins.str] name: Name of the Docker network.
|
|
:param pulumi.Input[_builtins.str] server_id: Remote server to create the network on. Omit to use the Dokploy host itself.
|
|
"""
|
|
...
|
|
@overload
|
|
def __init__(__self__,
|
|
resource_name: str,
|
|
args: Optional[NetworkArgs] = None,
|
|
opts: Optional[pulumi.ResourceOptions] = None):
|
|
"""
|
|
A Docker network managed by Dokploy.
|
|
|
|
Attach services to it with `network_ids` on `Application`, `Compose` and the database resources. Every service also joins the shared `dokploy-network` unless `detach_dokploy_network` is set.
|
|
|
|
> Docker networks are immutable. Dokploy has no update endpoint, so changing any attribute replaces the network — which detaches the services currently using it until they redeploy.
|
|
|
|
|
|
:param str resource_name: The name of the resource.
|
|
:param NetworkArgs args: The arguments to use to populate this resource's properties.
|
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
"""
|
|
...
|
|
def __init__(__self__, resource_name: str, *args, **kwargs):
|
|
resource_args, opts = _utilities.get_resource_args_opts(NetworkArgs, pulumi.ResourceOptions, *args, **kwargs)
|
|
if resource_args is not None:
|
|
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
|
|
else:
|
|
__self__._internal_init(resource_name, *args, **kwargs)
|
|
|
|
def _internal_init(__self__,
|
|
resource_name: str,
|
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
attachable: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
driver: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enable_ipv4: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
enable_ipv6: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
internal: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
ipam: pulumi.Input[Optional[_builtins.str]] = None,
|
|
mtu: pulumi.Input[Optional[_builtins.int]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
__props__=None):
|
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
raise TypeError('Expected resource options to be a ResourceOptions instance')
|
|
if opts.id is None:
|
|
if __props__ is not None:
|
|
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
|
|
__props__ = NetworkArgs.__new__(NetworkArgs)
|
|
|
|
__props__.__dict__["attachable"] = attachable
|
|
__props__.__dict__["driver"] = driver
|
|
__props__.__dict__["enable_ipv4"] = enable_ipv4
|
|
__props__.__dict__["enable_ipv6"] = enable_ipv6
|
|
__props__.__dict__["internal"] = internal
|
|
__props__.__dict__["ipam"] = ipam
|
|
__props__.__dict__["mtu"] = mtu
|
|
__props__.__dict__["name"] = name
|
|
__props__.__dict__["server_id"] = server_id
|
|
__props__.__dict__["created_at"] = None
|
|
__props__.__dict__["organization_id"] = None
|
|
super(Network, __self__).__init__(
|
|
'dokploy:index/network:Network',
|
|
resource_name,
|
|
__props__,
|
|
opts)
|
|
|
|
@staticmethod
|
|
def get(resource_name: str,
|
|
id: pulumi.Input[str],
|
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
attachable: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
created_at: pulumi.Input[Optional[_builtins.str]] = None,
|
|
driver: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enable_ipv4: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
enable_ipv6: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
internal: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
ipam: pulumi.Input[Optional[_builtins.str]] = None,
|
|
mtu: pulumi.Input[Optional[_builtins.int]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
organization_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None) -> 'Network':
|
|
"""
|
|
Get an existing Network resource's state with the given name, id, and optional extra
|
|
properties used to qualify the lookup.
|
|
|
|
:param str resource_name: The unique name of the resulting resource.
|
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
:param pulumi.Input[_builtins.bool] attachable: Allow standalone containers to attach to an overlay network.
|
|
:param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the network was created.
|
|
:param pulumi.Input[_builtins.str] driver: Network driver. Use `overlay` for multi-node Swarm clusters and `bridge` for a single host. Valid values: `bridge`, `overlay`.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv4: Enable IPv4 address allocation.
|
|
:param pulumi.Input[_builtins.bool] enable_ipv6: Enable IPv6 address allocation.
|
|
:param pulumi.Input[_builtins.bool] internal: Isolate the network from external access.
|
|
:param pulumi.Input[_builtins.str] ipam: Custom IP address management, as a JSON object with `subnet`, `gateway` and `ipRange` keys. Leave unset to let Docker choose a subnet.
|
|
:param pulumi.Input[_builtins.int] mtu: Maximum transmission unit for the network. Leave unset to use Docker's default.
|
|
:param pulumi.Input[_builtins.str] name: Name of the Docker network.
|
|
:param pulumi.Input[_builtins.str] organization_id: Organization that owns the network.
|
|
:param pulumi.Input[_builtins.str] server_id: Remote server to create the network on. Omit to use the Dokploy host itself.
|
|
"""
|
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
|
|
__props__ = _NetworkState.__new__(_NetworkState)
|
|
|
|
__props__.__dict__["attachable"] = attachable
|
|
__props__.__dict__["created_at"] = created_at
|
|
__props__.__dict__["driver"] = driver
|
|
__props__.__dict__["enable_ipv4"] = enable_ipv4
|
|
__props__.__dict__["enable_ipv6"] = enable_ipv6
|
|
__props__.__dict__["internal"] = internal
|
|
__props__.__dict__["ipam"] = ipam
|
|
__props__.__dict__["mtu"] = mtu
|
|
__props__.__dict__["name"] = name
|
|
__props__.__dict__["organization_id"] = organization_id
|
|
__props__.__dict__["server_id"] = server_id
|
|
return Network(resource_name, opts=opts, __props__=__props__)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def attachable(self) -> pulumi.Output[_builtins.bool]:
|
|
"""
|
|
Allow standalone containers to attach to an overlay network.
|
|
"""
|
|
return pulumi.get(self, "attachable")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="createdAt")
|
|
def created_at(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
RFC 3339 timestamp of when the network was created.
|
|
"""
|
|
return pulumi.get(self, "created_at")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def driver(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Network driver. Use `overlay` for multi-node Swarm clusters and `bridge` for a single host. Valid values: `bridge`, `overlay`.
|
|
"""
|
|
return pulumi.get(self, "driver")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="enableIpv4")
|
|
def enable_ipv4(self) -> pulumi.Output[_builtins.bool]:
|
|
"""
|
|
Enable IPv4 address allocation.
|
|
"""
|
|
return pulumi.get(self, "enable_ipv4")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="enableIpv6")
|
|
def enable_ipv6(self) -> pulumi.Output[_builtins.bool]:
|
|
"""
|
|
Enable IPv6 address allocation.
|
|
"""
|
|
return pulumi.get(self, "enable_ipv6")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def internal(self) -> pulumi.Output[_builtins.bool]:
|
|
"""
|
|
Isolate the network from external access.
|
|
"""
|
|
return pulumi.get(self, "internal")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def ipam(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Custom IP address management, as a JSON object with `subnet`, `gateway` and `ipRange` keys. Leave unset to let Docker choose a subnet.
|
|
"""
|
|
return pulumi.get(self, "ipam")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def mtu(self) -> pulumi.Output[Optional[_builtins.int]]:
|
|
"""
|
|
Maximum transmission unit for the network. Leave unset to use Docker's default.
|
|
"""
|
|
return pulumi.get(self, "mtu")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def name(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Name of the Docker network.
|
|
"""
|
|
return pulumi.get(self, "name")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="organizationId")
|
|
def organization_id(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Organization that owns the network.
|
|
"""
|
|
return pulumi.get(self, "organization_id")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serverId")
|
|
def server_id(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Remote server to create the network on. Omit to use the Dokploy host itself.
|
|
"""
|
|
return pulumi.get(self, "server_id")
|
|
|