deployment

type BindingName string

type Bindings struct {
	// contains filtered or unexported fields
}

type BundleDirectory struct {
	// Path is the absolute path of the protected directory view.
	Path string
	// SHA256 identifies the artifact that supplies this bundle.
	SHA256 SHA256
}

type Copy struct {
	// Ordinal is the provider's stable copy number, starting at one.
	Ordinal int
	// Endpoint addresses this copy's declared private listener.
	Endpoint Endpoint
	// SecretFile is empty when no secret file path is included in this descriptor.
	SecretFile string
}

type DirectoryAccess string

type Endpoint struct {
	// Role identifies the producer of this endpoint.
	Role RoleName
	// Listener identifies the producer's listener.
	Listener ListenerName
	// Scheme selects HTTP, TCP or Unix addressing.
	Scheme EndpointScheme
	// Address is the allocated loopback address.
	Address netip.Addr
	// Port is the allocated private port, not the public edge port.
	Port uint16
	// Path is the full Unix socket path; it is empty for TCP and HTTP endpoints.
	Path string
	// Directory is the shared instance socket directory for Unix endpoints.
	Directory string
	// Name is the Unix socket file name within Directory.
	Name string
}

type EndpointScheme string

type Executable struct {
	// Path is the absolute path of the host-verified executable.
	Path string
	// SHA256 identifies the executable source recorded by the host.
	SHA256 SHA256
}

type InstanceID string

type ListenerName string

type ListenerTransport string

type PublicListener struct {
	// Role identifies the role that owns the listener.
	Role RoleName
	// Listener identifies the declared listener within its role.
	Listener ListenerName
	// Hostname is the public DNS hostname selected by the profile.
	Hostname string
	// Port is the first copy's public port, retained for singleton consumers.
	Port uint16
	// Ports contains every placed copy's public port, ordered by ordinal.
	Ports []PublicPort
	// TLS is the TLS mode declared by the topology.
	TLS TLSMode
	// Transport is the network transport declared by the topology.
	Transport ListenerTransport
	// PublicAddresses contains the profile's explicit public addresses, not a DNS lookup.
	PublicAddresses []netip.Addr
}

type PublicPort struct {
	// Ordinal is the provider's copy number, starting at one.
	Ordinal int
	// Port is the public port selected by the profile.
	Port uint16
}

type RoleName string

type Runtime struct {
	// Release is the absolute path of the selected release.
	Release string
	// Instance is the deployed instance name.
	Instance string
	// User is the instance account used to run the application.
	User string
	// ConfigFile is the selected release's application configuration file.
	ConfigFile string
	// EnvFile is the selected runtime environment file.
	EnvFile string
	// WorkDir is the application working directory.
	WorkDir string
	// PublicDir is the selected release's public asset directory.
	PublicDir string
}

type SHA256 string

type SharedDirectory struct {
	// Path is the absolute directory path within the role's filesystem view.
	Path string
	// Access is enforced by the systemd sandbox, not by the shared account's mode bits.
	Access DirectoryAccess
	// MaxBytes limits allocated file data. It does not reserve memory or bound sparse file lengths.
	MaxBytes int64
}

type TLSMode string

type Unit struct {
	// Instance identifies the deployed environment instance.
	Instance InstanceID
	// Role identifies the placed service role.
	Role RoleName
	// Ordinal is the service copy number, from 1 through 128.
	Ordinal uint16
}