Files
pulumi-dokploy/sdk/python/pulumi_dokploy/registry.py
T
max-voitcov 73386ba0ff
build / build (push) Failing after 11m22s
release / plugin (push) Failing after 31m35s
release / sdks (push) Has been skipped
Bridge what Dokploy v0.30 added, and let the docs through
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`.
2026-08-26 00:46:32 +03:00

472 lines
20 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__ = ['RegistryArgs', 'Registry']
@pulumi.input_type
class RegistryArgs:
def __init__(__self__, *,
password: pulumi.Input[_builtins.str],
registry_name: pulumi.Input[_builtins.str],
registry_url: pulumi.Input[_builtins.str],
username: pulumi.Input[_builtins.str],
image_prefix: pulumi.Input[Optional[_builtins.str]] = None,
registry_type: pulumi.Input[Optional[_builtins.str]] = None,
server_id: pulumi.Input[Optional[_builtins.str]] = None):
"""
The set of arguments for constructing a Registry resource.
:param pulumi.Input[_builtins.str] password: Password or access token used to authenticate.
:param pulumi.Input[_builtins.str] registry_name: Display name of the registry.
:param pulumi.Input[_builtins.str] registry_url: Registry hostname, for example `ghcr.io`.
:param pulumi.Input[_builtins.str] username: Username used to authenticate to the registry.
:param pulumi.Input[_builtins.str] image_prefix: Prefix prepended to pushed image names, for example an organization or namespace.
:param pulumi.Input[_builtins.str] registry_type: Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
:param pulumi.Input[_builtins.str] server_id: Server this registry is scoped to.
"""
pulumi.set(__self__, "password", password)
pulumi.set(__self__, "registry_name", registry_name)
pulumi.set(__self__, "registry_url", registry_url)
pulumi.set(__self__, "username", username)
if image_prefix is not None:
pulumi.set(__self__, "image_prefix", image_prefix)
if registry_type is not None:
pulumi.set(__self__, "registry_type", registry_type)
if server_id is not None:
pulumi.set(__self__, "server_id", server_id)
@_builtins.property
@pulumi.getter
def password(self) -> pulumi.Input[_builtins.str]:
"""
Password or access token used to authenticate.
"""
return pulumi.get(self, "password")
@password.setter
def password(self, value: pulumi.Input[_builtins.str]):
pulumi.set(self, "password", value)
@_builtins.property
@pulumi.getter(name="registryName")
def registry_name(self) -> pulumi.Input[_builtins.str]:
"""
Display name of the registry.
"""
return pulumi.get(self, "registry_name")
@registry_name.setter
def registry_name(self, value: pulumi.Input[_builtins.str]):
pulumi.set(self, "registry_name", value)
@_builtins.property
@pulumi.getter(name="registryUrl")
def registry_url(self) -> pulumi.Input[_builtins.str]:
"""
Registry hostname, for example `ghcr.io`.
"""
return pulumi.get(self, "registry_url")
@registry_url.setter
def registry_url(self, value: pulumi.Input[_builtins.str]):
pulumi.set(self, "registry_url", value)
@_builtins.property
@pulumi.getter
def username(self) -> pulumi.Input[_builtins.str]:
"""
Username used to authenticate to the registry.
"""
return pulumi.get(self, "username")
@username.setter
def username(self, value: pulumi.Input[_builtins.str]):
pulumi.set(self, "username", value)
@_builtins.property
@pulumi.getter(name="imagePrefix")
def image_prefix(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Prefix prepended to pushed image names, for example an organization or namespace.
"""
return pulumi.get(self, "image_prefix")
@image_prefix.setter
def image_prefix(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "image_prefix", value)
@_builtins.property
@pulumi.getter(name="registryType")
def registry_type(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
"""
return pulumi.get(self, "registry_type")
@registry_type.setter
def registry_type(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "registry_type", value)
@_builtins.property
@pulumi.getter(name="serverId")
def server_id(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Server this registry is scoped to.
"""
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 _RegistryState:
def __init__(__self__, *,
created_at: pulumi.Input[Optional[_builtins.str]] = None,
image_prefix: pulumi.Input[Optional[_builtins.str]] = None,
password: pulumi.Input[Optional[_builtins.str]] = None,
registry_name: pulumi.Input[Optional[_builtins.str]] = None,
registry_type: pulumi.Input[Optional[_builtins.str]] = None,
registry_url: pulumi.Input[Optional[_builtins.str]] = None,
server_id: pulumi.Input[Optional[_builtins.str]] = None,
username: pulumi.Input[Optional[_builtins.str]] = None):
"""
Input properties used for looking up and filtering Registry resources.
:param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the registry was created.
:param pulumi.Input[_builtins.str] image_prefix: Prefix prepended to pushed image names, for example an organization or namespace.
:param pulumi.Input[_builtins.str] password: Password or access token used to authenticate.
:param pulumi.Input[_builtins.str] registry_name: Display name of the registry.
:param pulumi.Input[_builtins.str] registry_type: Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
:param pulumi.Input[_builtins.str] registry_url: Registry hostname, for example `ghcr.io`.
:param pulumi.Input[_builtins.str] server_id: Server this registry is scoped to.
:param pulumi.Input[_builtins.str] username: Username used to authenticate to the registry.
"""
if created_at is not None:
pulumi.set(__self__, "created_at", created_at)
if image_prefix is not None:
pulumi.set(__self__, "image_prefix", image_prefix)
if password is not None:
pulumi.set(__self__, "password", password)
if registry_name is not None:
pulumi.set(__self__, "registry_name", registry_name)
if registry_type is not None:
pulumi.set(__self__, "registry_type", registry_type)
if registry_url is not None:
pulumi.set(__self__, "registry_url", registry_url)
if server_id is not None:
pulumi.set(__self__, "server_id", server_id)
if username is not None:
pulumi.set(__self__, "username", username)
@_builtins.property
@pulumi.getter(name="createdAt")
def created_at(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
RFC 3339 timestamp of when the registry 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(name="imagePrefix")
def image_prefix(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Prefix prepended to pushed image names, for example an organization or namespace.
"""
return pulumi.get(self, "image_prefix")
@image_prefix.setter
def image_prefix(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "image_prefix", value)
@_builtins.property
@pulumi.getter
def password(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Password or access token used to authenticate.
"""
return pulumi.get(self, "password")
@password.setter
def password(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "password", value)
@_builtins.property
@pulumi.getter(name="registryName")
def registry_name(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Display name of the registry.
"""
return pulumi.get(self, "registry_name")
@registry_name.setter
def registry_name(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "registry_name", value)
@_builtins.property
@pulumi.getter(name="registryType")
def registry_type(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
"""
return pulumi.get(self, "registry_type")
@registry_type.setter
def registry_type(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "registry_type", value)
@_builtins.property
@pulumi.getter(name="registryUrl")
def registry_url(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Registry hostname, for example `ghcr.io`.
"""
return pulumi.get(self, "registry_url")
@registry_url.setter
def registry_url(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "registry_url", value)
@_builtins.property
@pulumi.getter(name="serverId")
def server_id(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Server this registry is scoped to.
"""
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)
@_builtins.property
@pulumi.getter
def username(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Username used to authenticate to the registry.
"""
return pulumi.get(self, "username")
@username.setter
def username(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "username", value)
@pulumi.type_token("dokploy:index/registry:Registry")
class Registry(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
image_prefix: pulumi.Input[Optional[_builtins.str]] = None,
password: pulumi.Input[Optional[_builtins.str]] = None,
registry_name: pulumi.Input[Optional[_builtins.str]] = None,
registry_type: pulumi.Input[Optional[_builtins.str]] = None,
registry_url: pulumi.Input[Optional[_builtins.str]] = None,
server_id: pulumi.Input[Optional[_builtins.str]] = None,
username: pulumi.Input[Optional[_builtins.str]] = None,
__props__=None):
"""
A container registry that Dokploy pushes built images to and pulls them from.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[_builtins.str] image_prefix: Prefix prepended to pushed image names, for example an organization or namespace.
:param pulumi.Input[_builtins.str] password: Password or access token used to authenticate.
:param pulumi.Input[_builtins.str] registry_name: Display name of the registry.
:param pulumi.Input[_builtins.str] registry_type: Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
:param pulumi.Input[_builtins.str] registry_url: Registry hostname, for example `ghcr.io`.
:param pulumi.Input[_builtins.str] server_id: Server this registry is scoped to.
:param pulumi.Input[_builtins.str] username: Username used to authenticate to the registry.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: RegistryArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
A container registry that Dokploy pushes built images to and pulls them from.
:param str resource_name: The name of the resource.
:param RegistryArgs 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(RegistryArgs, 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,
image_prefix: pulumi.Input[Optional[_builtins.str]] = None,
password: pulumi.Input[Optional[_builtins.str]] = None,
registry_name: pulumi.Input[Optional[_builtins.str]] = None,
registry_type: pulumi.Input[Optional[_builtins.str]] = None,
registry_url: pulumi.Input[Optional[_builtins.str]] = None,
server_id: pulumi.Input[Optional[_builtins.str]] = None,
username: 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__ = RegistryArgs.__new__(RegistryArgs)
__props__.__dict__["image_prefix"] = image_prefix
if password is None and not opts.urn:
raise TypeError("Missing required property 'password'")
__props__.__dict__["password"] = None if password is None else pulumi.Output.secret(password)
if registry_name is None and not opts.urn:
raise TypeError("Missing required property 'registry_name'")
__props__.__dict__["registry_name"] = registry_name
__props__.__dict__["registry_type"] = registry_type
if registry_url is None and not opts.urn:
raise TypeError("Missing required property 'registry_url'")
__props__.__dict__["registry_url"] = registry_url
__props__.__dict__["server_id"] = server_id
if username is None and not opts.urn:
raise TypeError("Missing required property 'username'")
__props__.__dict__["username"] = username
__props__.__dict__["created_at"] = None
secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["password"])
opts = pulumi.ResourceOptions.merge(opts, secret_opts)
super(Registry, __self__).__init__(
'dokploy:index/registry:Registry',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
created_at: pulumi.Input[Optional[_builtins.str]] = None,
image_prefix: pulumi.Input[Optional[_builtins.str]] = None,
password: pulumi.Input[Optional[_builtins.str]] = None,
registry_name: pulumi.Input[Optional[_builtins.str]] = None,
registry_type: pulumi.Input[Optional[_builtins.str]] = None,
registry_url: pulumi.Input[Optional[_builtins.str]] = None,
server_id: pulumi.Input[Optional[_builtins.str]] = None,
username: pulumi.Input[Optional[_builtins.str]] = None) -> 'Registry':
"""
Get an existing Registry 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.str] created_at: RFC 3339 timestamp of when the registry was created.
:param pulumi.Input[_builtins.str] image_prefix: Prefix prepended to pushed image names, for example an organization or namespace.
:param pulumi.Input[_builtins.str] password: Password or access token used to authenticate.
:param pulumi.Input[_builtins.str] registry_name: Display name of the registry.
:param pulumi.Input[_builtins.str] registry_type: Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
:param pulumi.Input[_builtins.str] registry_url: Registry hostname, for example `ghcr.io`.
:param pulumi.Input[_builtins.str] server_id: Server this registry is scoped to.
:param pulumi.Input[_builtins.str] username: Username used to authenticate to the registry.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _RegistryState.__new__(_RegistryState)
__props__.__dict__["created_at"] = created_at
__props__.__dict__["image_prefix"] = image_prefix
__props__.__dict__["password"] = password
__props__.__dict__["registry_name"] = registry_name
__props__.__dict__["registry_type"] = registry_type
__props__.__dict__["registry_url"] = registry_url
__props__.__dict__["server_id"] = server_id
__props__.__dict__["username"] = username
return Registry(resource_name, opts=opts, __props__=__props__)
@_builtins.property
@pulumi.getter(name="createdAt")
def created_at(self) -> pulumi.Output[_builtins.str]:
"""
RFC 3339 timestamp of when the registry was created.
"""
return pulumi.get(self, "created_at")
@_builtins.property
@pulumi.getter(name="imagePrefix")
def image_prefix(self) -> pulumi.Output[Optional[_builtins.str]]:
"""
Prefix prepended to pushed image names, for example an organization or namespace.
"""
return pulumi.get(self, "image_prefix")
@_builtins.property
@pulumi.getter
def password(self) -> pulumi.Output[_builtins.str]:
"""
Password or access token used to authenticate.
"""
return pulumi.get(self, "password")
@_builtins.property
@pulumi.getter(name="registryName")
def registry_name(self) -> pulumi.Output[_builtins.str]:
"""
Display name of the registry.
"""
return pulumi.get(self, "registry_name")
@_builtins.property
@pulumi.getter(name="registryType")
def registry_type(self) -> pulumi.Output[_builtins.str]:
"""
Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
"""
return pulumi.get(self, "registry_type")
@_builtins.property
@pulumi.getter(name="registryUrl")
def registry_url(self) -> pulumi.Output[_builtins.str]:
"""
Registry hostname, for example `ghcr.io`.
"""
return pulumi.get(self, "registry_url")
@_builtins.property
@pulumi.getter(name="serverId")
def server_id(self) -> pulumi.Output[Optional[_builtins.str]]:
"""
Server this registry is scoped to.
"""
return pulumi.get(self, "server_id")
@_builtins.property
@pulumi.getter
def username(self) -> pulumi.Output[_builtins.str]:
"""
Username used to authenticate to the registry.
"""
return pulumi.get(self, "username")