Files
pulumi-dokploy/sdk/python/pulumi_dokploy/ssh_key.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

365 lines
14 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__ = ['SshKeyArgs', 'SshKey']
@pulumi.input_type
class SshKeyArgs:
def __init__(__self__, *,
private_key: pulumi.Input[_builtins.str],
public_key: pulumi.Input[_builtins.str],
description: pulumi.Input[Optional[_builtins.str]] = None,
name: pulumi.Input[Optional[_builtins.str]] = None):
"""
The set of arguments for constructing a SshKey resource.
:param pulumi.Input[_builtins.str] private_key: PEM-encoded private key.
:param pulumi.Input[_builtins.str] public_key: OpenSSH-formatted public key.
:param pulumi.Input[_builtins.str] description: Free-form description.
:param pulumi.Input[_builtins.str] name: Display name of the key pair.
"""
pulumi.set(__self__, "private_key", private_key)
pulumi.set(__self__, "public_key", public_key)
if description is not None:
pulumi.set(__self__, "description", description)
if name is not None:
pulumi.set(__self__, "name", name)
@_builtins.property
@pulumi.getter(name="privateKey")
def private_key(self) -> pulumi.Input[_builtins.str]:
"""
PEM-encoded private key.
"""
return pulumi.get(self, "private_key")
@private_key.setter
def private_key(self, value: pulumi.Input[_builtins.str]):
pulumi.set(self, "private_key", value)
@_builtins.property
@pulumi.getter(name="publicKey")
def public_key(self) -> pulumi.Input[_builtins.str]:
"""
OpenSSH-formatted public key.
"""
return pulumi.get(self, "public_key")
@public_key.setter
def public_key(self, value: pulumi.Input[_builtins.str]):
pulumi.set(self, "public_key", value)
@_builtins.property
@pulumi.getter
def description(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Free-form description.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "description", value)
@_builtins.property
@pulumi.getter
def name(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Display name of the key pair.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class _SshKeyState:
def __init__(__self__, *,
created_at: pulumi.Input[Optional[_builtins.str]] = None,
description: pulumi.Input[Optional[_builtins.str]] = None,
last_used_at: pulumi.Input[Optional[_builtins.str]] = None,
name: pulumi.Input[Optional[_builtins.str]] = None,
private_key: pulumi.Input[Optional[_builtins.str]] = None,
public_key: pulumi.Input[Optional[_builtins.str]] = None):
"""
Input properties used for looking up and filtering SshKey resources.
:param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the key was created.
:param pulumi.Input[_builtins.str] description: Free-form description.
:param pulumi.Input[_builtins.str] last_used_at: RFC 3339 timestamp of when the key was last used, if ever.
:param pulumi.Input[_builtins.str] name: Display name of the key pair.
:param pulumi.Input[_builtins.str] private_key: PEM-encoded private key.
:param pulumi.Input[_builtins.str] public_key: OpenSSH-formatted public key.
"""
if created_at is not None:
pulumi.set(__self__, "created_at", created_at)
if description is not None:
pulumi.set(__self__, "description", description)
if last_used_at is not None:
pulumi.set(__self__, "last_used_at", last_used_at)
if name is not None:
pulumi.set(__self__, "name", name)
if private_key is not None:
pulumi.set(__self__, "private_key", private_key)
if public_key is not None:
pulumi.set(__self__, "public_key", public_key)
@_builtins.property
@pulumi.getter(name="createdAt")
def created_at(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
RFC 3339 timestamp of when the key 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 description(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Free-form description.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "description", value)
@_builtins.property
@pulumi.getter(name="lastUsedAt")
def last_used_at(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
RFC 3339 timestamp of when the key was last used, if ever.
"""
return pulumi.get(self, "last_used_at")
@last_used_at.setter
def last_used_at(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "last_used_at", value)
@_builtins.property
@pulumi.getter
def name(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
Display name of the key pair.
"""
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="privateKey")
def private_key(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
PEM-encoded private key.
"""
return pulumi.get(self, "private_key")
@private_key.setter
def private_key(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "private_key", value)
@_builtins.property
@pulumi.getter(name="publicKey")
def public_key(self) -> pulumi.Input[Optional[_builtins.str]]:
"""
OpenSSH-formatted public key.
"""
return pulumi.get(self, "public_key")
@public_key.setter
def public_key(self, value: pulumi.Input[Optional[_builtins.str]]):
pulumi.set(self, "public_key", value)
@pulumi.type_token("dokploy:index/sshKey:SshKey")
class SshKey(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: pulumi.Input[Optional[_builtins.str]] = None,
name: pulumi.Input[Optional[_builtins.str]] = None,
private_key: pulumi.Input[Optional[_builtins.str]] = None,
public_key: pulumi.Input[Optional[_builtins.str]] = None,
__props__=None):
"""
An SSH key pair Dokploy uses to clone private Git repositories and to reach remote servers.
> The private key is stored in Terraform state. Use a state backend with encryption at rest.
> Dokploy's update endpoint only accepts `name` and `description`. Changing either key forces a new resource.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[_builtins.str] description: Free-form description.
:param pulumi.Input[_builtins.str] name: Display name of the key pair.
:param pulumi.Input[_builtins.str] private_key: PEM-encoded private key.
:param pulumi.Input[_builtins.str] public_key: OpenSSH-formatted public key.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: SshKeyArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
An SSH key pair Dokploy uses to clone private Git repositories and to reach remote servers.
> The private key is stored in Terraform state. Use a state backend with encryption at rest.
> Dokploy's update endpoint only accepts `name` and `description`. Changing either key forces a new resource.
:param str resource_name: The name of the resource.
:param SshKeyArgs 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(SshKeyArgs, 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,
description: pulumi.Input[Optional[_builtins.str]] = None,
name: pulumi.Input[Optional[_builtins.str]] = None,
private_key: pulumi.Input[Optional[_builtins.str]] = None,
public_key: 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__ = SshKeyArgs.__new__(SshKeyArgs)
__props__.__dict__["description"] = description
__props__.__dict__["name"] = name
if private_key is None and not opts.urn:
raise TypeError("Missing required property 'private_key'")
__props__.__dict__["private_key"] = None if private_key is None else pulumi.Output.secret(private_key)
if public_key is None and not opts.urn:
raise TypeError("Missing required property 'public_key'")
__props__.__dict__["public_key"] = public_key
__props__.__dict__["created_at"] = None
__props__.__dict__["last_used_at"] = None
secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["privateKey"])
opts = pulumi.ResourceOptions.merge(opts, secret_opts)
super(SshKey, __self__).__init__(
'dokploy:index/sshKey:SshKey',
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,
description: pulumi.Input[Optional[_builtins.str]] = None,
last_used_at: pulumi.Input[Optional[_builtins.str]] = None,
name: pulumi.Input[Optional[_builtins.str]] = None,
private_key: pulumi.Input[Optional[_builtins.str]] = None,
public_key: pulumi.Input[Optional[_builtins.str]] = None) -> 'SshKey':
"""
Get an existing SshKey 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 key was created.
:param pulumi.Input[_builtins.str] description: Free-form description.
:param pulumi.Input[_builtins.str] last_used_at: RFC 3339 timestamp of when the key was last used, if ever.
:param pulumi.Input[_builtins.str] name: Display name of the key pair.
:param pulumi.Input[_builtins.str] private_key: PEM-encoded private key.
:param pulumi.Input[_builtins.str] public_key: OpenSSH-formatted public key.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _SshKeyState.__new__(_SshKeyState)
__props__.__dict__["created_at"] = created_at
__props__.__dict__["description"] = description
__props__.__dict__["last_used_at"] = last_used_at
__props__.__dict__["name"] = name
__props__.__dict__["private_key"] = private_key
__props__.__dict__["public_key"] = public_key
return SshKey(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 key was created.
"""
return pulumi.get(self, "created_at")
@_builtins.property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[_builtins.str]]:
"""
Free-form description.
"""
return pulumi.get(self, "description")
@_builtins.property
@pulumi.getter(name="lastUsedAt")
def last_used_at(self) -> pulumi.Output[_builtins.str]:
"""
RFC 3339 timestamp of when the key was last used, if ever.
"""
return pulumi.get(self, "last_used_at")
@_builtins.property
@pulumi.getter
def name(self) -> pulumi.Output[_builtins.str]:
"""
Display name of the key pair.
"""
return pulumi.get(self, "name")
@_builtins.property
@pulumi.getter(name="privateKey")
def private_key(self) -> pulumi.Output[_builtins.str]:
"""
PEM-encoded private key.
"""
return pulumi.get(self, "private_key")
@_builtins.property
@pulumi.getter(name="publicKey")
def public_key(self) -> pulumi.Output[_builtins.str]:
"""
OpenSSH-formatted public key.
"""
return pulumi.get(self, "public_key")