api

package

Go to main page

Versions in this module

v0

v0.17.2

Nov 2, 2026

v0.17.1

Nov 1, 2026

v0.17.0

Oct 29, 2026

Changes in this version

+ const DefaultPromoteHealthTimeout

+ const DefaultStandbyCopies

type BackupCapabilities

+ OffHost bool

type BundlePlan

+ Failover FailoverPlan

type Capacity

+ HeldDiskBytes int64

+ type DumpPlan struct

+ Dump []string

+ Load []string

+ Volumes []string

+ Workload string

type EdgePlan

+ CertificateDir string

type EdgeRequest

+ Clustered bool

+ type FailoverPlan struct

+ AllowOversubscription bool

+ Priority int

type ObservedBundle

+ Host string

+ type PromoteRequest struct

+ Bundle BundlePlan

+ HealthTimeout time.Duration

+ Host string

+ PollEvery time.Duration

+ type PromoteResult struct

+ Copy int

+ FellBack bool

+ FormerHost string

+ Healthy bool

+ Host string

+ type ReplicaRequest struct

+ Handle ServiceHandle

+ Primary ProvisionResult

+ Type spec.SlotType

+ type ReplicaServices interface

+ ApplyReplica func(ctx context.Context, req ReplicaRequest) (ProvisionResult, error)

+ PromoteReplica func(ctx context.Context, h ServiceHandle) error

type RouteRequest

+ func RouteFor(appID string, r spec.Routing, upstream string) RouteRequest

type RoutingCapabilities

+ CertificatesPerEdge bool

+ type RunRequest struct

+ Command []string

+ Stdin io.Reader

+ Stdout io.Writer

type RuntimeAdapter

+ Run func(ctx context.Context, ref WorkloadRef, req RunRequest) error

type RuntimeCapabilities

+ SupportsStandby bool

type ServicesAdapter

+ Dump func(h ServiceHandle, t spec.SlotType) (DumpPlan, bool)

type ServicesCapabilities

+ ReplicaTypes []spec.SlotType

+ func (c ServicesCapabilities) Replicates(t spec.SlotType) bool

+ type ShipRequest struct

+ BundleID string

+ Host string

+ Keep int

+ VolumeIDs []string

+ type ShipResult struct

+ BytesSent int64

+ Copies int

+ FilesSent int

+ Unchanged bool

+ type StaleCopyOptions struct

+ AppDeleted bool

+ KeepVolumes bool

+ type StandbyHandle struct

+ Home string

+ Host string

+ type StandbyRequest struct

+ Bundle BundlePlan

+ Host string

+ type StandbyRuntime interface

+ ApplyStandby func(ctx context.Context, req StandbyRequest) (StandbyHandle, error)

+ PromoteStandby func(ctx context.Context, req PromoteRequest) (PromoteResult, error)

+ RemoveStaleCopy func(ctx context.Context, ref BundleRef, host string, opts StaleCopyOptions) error

+ RemoveStandby func(ctx context.Context, ref BundleRef) error

+ ShipVolumes func(ctx context.Context, req ShipRequest) (ShipResult, error)

v0.16.0

Oct 26, 2026

v0.15.1

Oct 25, 2026

v0.15.0

Oct 24, 2026

v0.14.0

Oct 23, 2026

Changes in this version

+ const RefLoginURL

type TrialRequest

+ Egress EgressRules

v0.13.0

Oct 21, 2026

Changes in this version

type NotificationKind

+ const NotifyAppOrphaned

v0.12.0

Oct 20, 2026

v0.11.0

Oct 20, 2026

Changes in this version

+ const CredentialWebhookSecret

type Authorization

+ Form *AuthorizeForm

type AuthorizationMode

+ const AuthorizationInstall

+ const AuthorizationManual

type AuthorizationRequest

+ Grant secret.Value

+ HomepageURL string

+ SetupURL string

+ WebhookURL string

type AuthorizationResult

+ ContinueURL string

+ type AuthorizeForm struct

+ Action string

+ Fields map[string]string

type Notification

+ Channel string

type NotifyAdapter

+ BeginAuthorization func(ctx context.Context, req AuthorizationRequest) (Authorization, error)

+ Channels func(ctx context.Context, query string) ([]NotifyChannel, error)

+ CompleteAuthorization func(ctx context.Context, req AuthorizationCompletion) (AuthorizationResult, error)

type NotifyCapabilities

+ Authorized bool

+ Channels bool

+ IconSet bool

+ ManageURL string

+ ManualAuthorization bool

+ WebAuthorization bool

+ type NotifyChannel struct

+ ID string

+ Name string

+ Private bool

type Option

+ Recommended bool

type SourceCapabilities

+ ManageURL string

+ Webhook bool

v0.10.0

Oct 19, 2026

Changes in this version

+ const PresetOther

+ const RefCallbackURL

+ const RefEntityID

+ type Action struct

+ Table *Table

+ Text string

type Field

+ List bool

+ Presets []string

+ Suggest string

type ImageRegistryAdapter

+ Health func(ctx context.Context) (notes []string, err error)

type KindInfo

+ Check func(config json.RawMessage, credentials map[string]secret.Value, stored []string) error

+ Managed bool

+ OtherPreset string

+ Steps []Step

+ Warn func(config json.RawMessage) []string

+ type Link struct

+ Label string

+ URL string

+ type Step struct

+ Do []Action

+ Fields []string

+ ID string

+ Label string

+ Lede string

+ Links []Link

+ Presets []string

+ ShownWhen *Condition

+ Title string

+ type Table struct

+ Columns []string

+ Rows [][]string

v0.9.0

Oct 18, 2026

v0.8.0

Oct 16, 2026

Changes in this version

type ResourcePlan

+ DiskBytes int64

type RoutingCapabilities

+ Domains []string

+ ReservedHostnames []string

v0.7.0

Oct 15, 2026

v0.6.1

Oct 14, 2026

v0.6.0

Oct 14, 2026

v0.5.0

Oct 13, 2026

Changes in this version

type BuildPlan

+ Context string

type BuildRequest

+ Steer bool

type BuildResult

+ GeneratedFiles map[string]string

+ type HTTPAnswer struct

+ Port int

+ Status int

type ProvisionRequest

+ Scheme string

type RuntimeAdapter

+ HasImage func(ctx context.Context, ref string) (bool, error)

type RuntimeCapabilities

+ RegistryMirrors []string

+ SupportsHTTPProbe bool

type TrialResult

+ HTTPAnswers []HTTPAnswer

+ HTTPProbedPorts []int

type WorkloadPlan

+ Aliases []string

v0.4.0

Oct 11, 2026

Changes in this version

+ const AuditFormatNative

+ const AuditFormatOCSF

+ const ChallengeDNS01

+ const ChallengeHTTP01

+ const ImageLabelBundle

+ const LookupLimit

+ var Categories = []Category

+ func IsAssignable(f AIFunction) bool

+ func Offers(list []EdgeConfig, c EdgeConfig) bool

+ func ScopedRead[T any](ctx context.Context, key any, read func() (T, error)) (T, error)

+ func WithReadScope(ctx context.Context) context.Context

+ type AIAdapter interface

+ AnswerQuestions func(ctx context.Context, req ScreenRequest) (ScreenResult, error)

+ AnswerReference func(ctx context.Context, req ReferenceRequest) (ReferenceAnswer, error)

+ Capabilities func(ctx context.Context) (AICapabilities, error)

+ DraftAccess func(ctx context.Context, req AccessRequest) (AccessDraft, error)

+ DraftPolicy func(ctx context.Context, req PolicyRequest) (PolicyDraft, error)

+ RepairPlan func(ctx context.Context, req ScreenRequest) (ScreenResult, error)

+ RevisePlan func(ctx context.Context, req ScreenRequest) (ScreenResult, error)

+ SearchAudit func(ctx context.Context, req AuditSearchRequest) (AuditSearch, error)

+ SummarizeAudit func(ctx context.Context, req AuditSummaryRequest) (AuditSummary, error)

+ type AIAssignment struct

+ AdapterRef string

+ Function AIFunction

+ Model string

+ type AICapabilities struct

+ ChoosesModel bool

+ Functions []AIFunction

+ LooksUp bool

+ MaxBytes int64

+ MaxFiles int

+ Model string

+ Models []string

+ func (c AICapabilities) Does(f AIFunction) bool

+ type AIFunction string

+ const AIFunctionAnswerQuestions

+ const AIFunctionAnswerReference

+ const AIFunctionDraftAccess

+ const AIFunctionDraftPolicy

+ const AIFunctionReadReadme

+ const AIFunctionRepairPlan

+ const AIFunctionRevisePlan

+ const AIFunctionSearchAudit

+ func AIFunctions() []AIFunction

+ func (f AIFunction) Title() string

+ type AccessDraft struct

+ Group *GroupDraft

+ Model string

+ Reply string

+ Role *RoleDraft

+ type AccessRequest struct

+ Current *AccessDraft

+ Description string

+ Groups []GroupInfo

+ Lookup *Lookup

+ Model string

+ People []PersonInfo

+ Roles []RoleInfo

+ Verbs []VerbInfo

+ type Adapter interface

+ Category func() Category

+ Configure func(ctx context.Context, raw json.RawMessage) error

+ HealthCheck func(ctx context.Context) error

+ Kind func() string

+ type Amendment struct

+ Command []string

+ Evidence []string

+ Key string

+ Kind AmendmentKind

+ Path string

+ Port int

+ Reason string

+ Required bool

+ SlotType spec.SlotType

+ Value string

+ Workload string

+ type AmendmentKind string

+ const AmendAddSlot

+ const AmendAddVolume

+ const AmendAddWarning

+ const AmendAnswerQuestion

+ const AmendSetBuildContext

+ const AmendSetCommand

+ const AmendSetDockerfile

+ const AmendSetEnv

+ const AmendSetHealth

+ const AmendSetPort

+ const AmendSetStaticDir

+ type AppInfo struct

+ ID string

+ Name string

+ Slug string

+ type AuditBatch struct

+ Actions []string

+ Events []json.RawMessage

+ IDs []int64

+ type AuditFilter struct

+ Actions []string

+ AppID string

+ Involving string

+ PrincipalID string

+ PrincipalKind string

+ Since *time.Time

+ TargetID string

+ TargetKind string

+ Until *time.Time

+ type AuditRecordView struct

+ Action string

+ AppID string

+ At time.Time

+ Detail map[string]any

+ PrincipalID string

+ PrincipalKind string

+ TargetID string

+ TargetKind string

+ type AuditSearch struct

+ Filter AuditFilter

+ Model string

+ Note string

+ type AuditSearchRequest struct

+ Actions []string

+ Apps []AppInfo

+ Lookup *Lookup

+ Model string

+ Now time.Time

+ People []PersonInfo

+ Question string

+ type AuditSinkAdapter interface

+ AuditSinkCapabilities func() AuditSinkCapabilities

+ Send func(ctx context.Context, b AuditBatch) error

+ type AuditSinkCapabilities struct

+ Actions []string

+ Endpoint string

+ Exclude []string

+ Format string

+ MaxBatch int

+ StartAtNow bool

+ Transport string

+ type AuditSummary struct

+ Model string

+ Summary string

+ type AuditSummaryRequest struct

+ Apps []AppInfo

+ Filter AuditFilter

+ Model string

+ People []PersonInfo

+ Question string

+ Records []AuditRecordView

+ Truncated bool

+ type Authorization struct

+ AuthorizeURL string

+ ExpiresAt time.Time

+ Flow secret.Value

+ Interval time.Duration

+ Mode AuthorizationMode

+ UserCode string

+ VerificationURL string

+ type AuthorizationCompletion struct

+ Code string

+ Flow secret.Value

+ Mode AuthorizationMode

+ RedirectURL string

+ type AuthorizationMode string

+ const AuthorizationDevice

+ const AuthorizationWeb

+ type AuthorizationRequest struct

+ Mode AuthorizationMode

+ RedirectURL string

+ State string

+ type AuthorizationResult struct

+ Credentials map[string]secret.Value

+ ExpiresAt time.Time

+ Pending bool

+ SlowDown bool

+ type BackupAdapter interface

+ Capabilities func() BackupCapabilities

+ Delete func(ctx context.Context, name string) error

+ List func(ctx context.Context) ([]StoredBundle, error)

+ Reader func(ctx context.Context, name string) (io.ReadCloser, error)

+ Writer func(ctx context.Context, name string) (io.WriteCloser, error)

+ type BackupCapabilities struct

+ Immutable bool

+ MaxBundleBytes int64

+ OwnsRetention bool

+ type BeginRequest struct

+ State string

+ type Bid struct

+ Confidence float64

+ Evidence []string

+ Questions []Question

+ Strategy BuildStrategy

+ type BuildPlan struct

+ Declared *PlanDeclaration

+ Entry string

+ Files map[string]string

+ Ports []int

+ Start string

+ type BuildRequest struct

+ Args map[string]string

+ CacheNamespace string

+ Context string

+ Dockerfile string

+ EgressAllow []string

+ EgressMode EgressMode

+ GeneratedFiles map[string]string

+ ImageSink io.Writer

+ IsolationFloor IsolationClass

+ LogSink io.Writer

+ Push *PushTarget

+ Source SourceView

+ StartCommand string

+ StaticDir string

+ Strategy BuildStrategy

+ Tag string

+ Target string

+ Timeout time.Duration

+ type BuildResult struct

+ Digest string

+ ImageRef string

+ type BuildStrategy = spec.BuildStrategy

+ type BuilderAdapter interface

+ Bid func(ctx context.Context, src SourceView) (Bid, error)

+ Build func(ctx context.Context, req BuildRequest) (BuildResult, error)

+ Capabilities func(ctx context.Context) (BuilderCapabilities, error)

+ Forget func(ctx context.Context, namespace string) error

+ type BuilderCapabilities struct

+ IsolationClass IsolationClass

+ Strategies []BuildStrategy

+ SupportsCache bool

+ SupportsEgressRestriction bool

+ SupportsPush bool

+ func (c BuilderCapabilities) Supports(strategy BuildStrategy) bool

+ type BundleEvent struct

+ At time.Time

+ BundleID string

+ Kind BundleEventKind

+ Workload string

+ type BundleEventKind string

+ const BundleEventExited

+ const BundleEventHealth

+ const BundleEventMissed

+ const BundleEventOOMKilled

+ const BundleEventRemoved

+ const BundleEventStarted

+ const BundleEventWatching

+ type BundleHandle struct

+ BundleID string

+ Handle string

+ type BundlePlan struct

+ BundleID string

+ FirstDeploy bool

+ Labels map[string]string

+ Network NetworkPlan

+ Volumes []VolumePlan

+ Workloads []WorkloadPlan

+ type BundleRef struct

+ BundleID string

+ type BundleUsage struct

+ Reported time.Time

+ Volumes []VolumeUsage

+ Workloads []WorkloadUsage

+ type Capacity struct

+ Details map[string]any

+ LargestFit *Fit

+ Reported time.Time

+ RunningWorkloads int

+ TotalCPUMillis int

+ TotalDiskBytes int64

+ TotalMemoryBytes int64

+ type Category string

+ const CategoryAI

+ const CategoryAuditSink

+ const CategoryBackup

+ const CategoryBuilder

+ const CategoryIdentity

+ const CategoryImageRegistry

+ const CategoryNotify

+ const CategoryRouting

+ const CategoryRuntime

+ const CategoryScanner

+ const CategorySecrets

+ const CategoryServices

+ const CategorySource

+ type CertificateIssue struct

+ Challenge string

+ DNSCredentials map[string]secret.Value

+ DNSProvider string

+ Email string

+ Orders []CertificateOrder

+ type CertificateOrder struct

+ Domains []string

+ Name string

+ type Condition struct

+ Key string

+ Values []string

+ type Credential struct

+ Callback url.Values

+ Flow []byte

+ Password secret.Value

+ Username string

+ type DestroyOptions struct

+ KeepVolumes bool

+ type EdgeCertificate struct

+ CertPEM []byte

+ KeyPEM secret.Value

+ Name string

+ type EdgeConfig string

+ const EdgeConfigKubernetesAPI

+ const EdgeConfigSharedMount

+ type EdgeMount struct

+ Path string

+ ReadOnly bool

+ SharedWithPando string

+ Volume string

+ type EdgePlan struct

+ Args []string

+ Certificates []EdgeCertificate

+ Env map[string]secret.Value

+ Image string

+ Issue *CertificateIssue

+ Mounts []EdgeMount

+ Name string

+ Ports []EdgePort

+ ProxyAlias string

+ ReadsRoutesFrom EdgeConfig

+ type EdgePort struct

+ Container int

+ Host int

+ Protocol string

+ type EdgeRequest struct

+ EdgeConfig []EdgeConfig

+ ProxyUpstream string

+ Ref string

+ type EdgeState struct

+ Detail string

+ Present bool

+ Running bool

+ type EgressMode = spec.EgressMode

+ type EgressRules = egress.Rules

+ type Endpoints struct

+ CallbackURL string

+ EntityID string

+ type ExecRequest struct

+ Command []string

+ Env map[string]string

+ TTY bool

+ type ExecSession interface

+ ExitCode func() (int, bool)

+ Resize func(rows, cols uint16) error

+ type Field struct

+ Advanced bool

+ Credential bool

+ Default string

+ Help string

+ Key string

+ Label string

+ Multiline bool

+ Options []Option

+ Other bool

+ Placeholder string

+ Required bool

+ ShownWhen *Condition

+ Type string

+ type FileInfo struct

+ IsDir bool

+ Name string

+ Size int64

+ type FilePlan struct

+ Content string

+ Mode int

+ Path string

+ type Finding struct

+ Fix string

+ ID string

+ Severity Severity

+ Target string

+ Title string

+ type Fit struct

+ CPUMillis int

+ MemoryBytes int64

+ type GitCredential struct

+ BearerToken secret.Value

+ CABundle []byte

+ ExpiresAt time.Time

+ KnownHosts string

+ Password secret.Value

+ Rotated map[string]secret.Value

+ SSHPassphrase secret.Value

+ SSHPrivateKey secret.Value

+ SSHUser string

+ URL string

+ Username string

+ type GroupDraft struct

+ Members []string

+ Name string

+ type GroupInfo struct

+ ID string

+ Name string

+ type HealthPlan struct

+ Command []string

+ IntervalSeconds int

+ Path string

+ Port int

+ Retries int

+ TimeoutSeconds int

+ type HelperSpec struct

+ Args []string

+ Env map[string]secret.Value

+ type IdentityAdapter interface

+ Authenticate func(ctx context.Context, c Credential) (Subject, error)

+ Begin func(ctx context.Context, req BeginRequest) (*Redirect, error)

+ ServiceMetadata func(ctx context.Context, e Endpoints) (*Metadata, error)

+ SessionPolicy func() SessionPolicy

+ SupportsPush func() bool

+ type ImageDelivery string

+ const ImageDeliveryImport

+ const ImageDeliveryRegistry

+ type ImageRegistryAdapter interface

+ DeleteApp func(ctx context.Context, appID string, workloads []string) (int, error)

+ ImageRegistryCapabilities func() ImageRegistryCapabilities

+ Owns func(ref string) bool

+ PullAuth func(ctx context.Context) (*RegistryAuth, error)

+ Target func(ctx context.Context, appID, workload, deploymentID string) (PushTarget, error)

+ type ImageRegistryCapabilities struct

+ CreatesRepositoriesOnPush bool

+ Host string

+ RepositoryPerApp bool

+ SendsEveryBuild bool

+ type InUse struct

+ CPUMillis int

+ MemoryBytes int64

+ Reported time.Time

+ type IsolationClass = spec.IsolationClass

+ type KindInfo struct

+ Category Category

+ Description string

+ Fields []Field

+ IDPrefix string

+ Kind string

+ Name string

+ Presets []Preset

+ func (k KindInfo) Validate() error

+ type ListRepositoriesRequest struct

+ Limit int

+ Query string

+ type LogOptions struct

+ Follow bool

+ Since time.Time

+ Tail int

+ type LogRetentionCapability struct

+ CanChangeWithoutRecreate bool

+ MinBytes int64

+ ReportsUsage bool

+ SupportsSizeCap bool

+ type Lookup struct

+ Apps func(ctx context.Context, query string) ([]AppInfo, error)

+ Groups func(ctx context.Context, query string) ([]GroupInfo, error)

+ People func(ctx context.Context, query string) ([]PersonInfo, error)

+ type Metadata struct

+ Body []byte

+ ContentType string

+ type MountPlan struct

+ Path string

+ ReadOnly bool

+ VolumeID string

+ type NetworkPlan struct

+ Egress EgressRules

+ Private bool

+ type Notification struct

+ AppID string

+ Body string

+ EventID string

+ Fields []NotificationField

+ Kind NotificationKind

+ Link string

+ Recipients []Recipient

+ Subject string

+ type NotificationField struct

+ Label string

+ Value string

+ type NotificationKind string

+ const NotifyAppDisk

+ const NotifyAppFailed

+ const NotifyAppIdle

+ const NotifyAppShared

+ const NotifyAuditSinkDisabled

+ const NotifyBackupFailed

+ const NotifyDeployApproval

+ const NotifyDeployFailed

+ const NotifyPolicyViolation

+ const NotifySubscriptionDisabled

+ const NotifyUpdateAvailable

+ const NotifyUpgradeFailed

+ type NotifyAdapter interface

+ Capabilities func() NotifyCapabilities

+ Notify func(ctx context.Context, n Notification) error

+ type NotifyAudience string

+ const AudienceChannel

+ const AudiencePeople

+ type NotifyCapabilities struct

+ Audience NotifyAudience

+ type ObservedBundle struct

+ Exists bool

+ Volumes []ObservedVolume

+ Workloads []ObservedWorkload

+ type ObservedVolume struct

+ Handle string

+ Present bool

+ VolumeID string

+ type ObservedWorkload struct

+ ExitCode *int

+ Healthy *bool

+ ImageDigest string

+ Name string

+ Present bool

+ RestartCount int

+ Restarting bool

+ Running bool

+ StartedAt time.Time

+ type Option struct

+ Description string

+ Label string

+ Value string

+ type PersonInfo struct

+ Email string

+ ID string

+ Name string

+ Username string

+ type PlanDeclaration struct

+ Confidence float64

+ Source string

+ Why string

+ type PolicyDraft struct

+ Changes map[string]json.RawMessage

+ Model string

+ Reply string

+ type PolicyField struct

+ Fixed bool

+ Key string

+ Meaning string

+ Type string

+ type PolicyRequest struct

+ Current json.RawMessage

+ Description string

+ Draft json.RawMessage

+ Fields []PolicyField

+ Model string

+ Verbs []VerbInfo

+ type PortPlan struct

+ Number int

+ Protocol string

+ type Preset struct

+ Help string

+ ID string

+ Label string

+ Values map[string]string

+ type ProvisionRequest struct

+ AppID string

+ BundleID string

+ ExistingSecret secret.Value

+ ServiceID string

+ SlotKey string

+ Type spec.SlotType

+ type ProvisionResult struct

+ ConnectionSecret secret.Value

+ Handle ServiceHandle

+ Volumes []VolumePlan

+ Workloads []WorkloadPlan

+ type PushTarget struct

+ Auth *RegistryAuth

+ Insecure bool

+ Repository string

+ Tag string

+ type Question struct

+ Key string

+ Kind QuestionKind

+ Options []string

+ Prompt string

+ Why string

+ type QuestionKind string

+ const QuestionChoice

+ const QuestionPath

+ const QuestionPort

+ const QuestionText

+ type Recipient struct

+ Email string

+ UserID string

+ type Redirect struct

+ Flow []byte

+ URL string

+ type ReferenceAnswer struct

+ Answer string

+ Cites []string

+ Covered bool

+ Model string

+ type ReferenceRequest struct

+ Model string

+ Question string

+ Reference string

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) AI(ref string) (AIAdapter, bool)

+ func (r *Registry) AIAssignments() []AIAssignment

+ func (r *Registry) AIFor(fn AIFunction) (AIAdapter, AIAssignment, bool)

+ func (r *Registry) AuditSink(ref string) (AuditSinkAdapter, bool)

+ func (r *Registry) Backup(ref string) (BackupAdapter, bool)

+ func (r *Registry) Builder(ref string) (BuilderAdapter, bool)

+ func (r *Registry) ByCategory(c Category) []string

+ func (r *Registry) Default(c Category) (string, bool)

+ func (r *Registry) DefaultScanner() (ScannerAdapter, string, bool)

+ func (r *Registry) Get(ref string) (Adapter, bool)

+ func (r *Registry) HealthCheckAll(ctx context.Context) map[string]error

+ func (r *Registry) ImageRegistry(ref string) (ImageRegistryAdapter, bool)

+ func (r *Registry) Notify(ref string) (NotifyAdapter, bool)

+ func (r *Registry) Refs() []string

+ func (r *Registry) Register(ref string, a Adapter) error

+ func (r *Registry) Routing(ref string) (RoutingAdapter, bool)

+ func (r *Registry) Runtime(ref string) (RuntimeAdapter, bool)

+ func (r *Registry) Scanner(ref string) (ScannerAdapter, bool)

+ func (r *Registry) Secrets(ref string) (SecretsAdapter, bool)

+ func (r *Registry) Services(ref string) (ServicesAdapter, bool)

+ func (r *Registry) ServicesFor(t spec.SlotType) (ServicesAdapter, string, bool)

+ func (r *Registry) SetAIAssignments(assignments []AIAssignment)

+ func (r *Registry) SetDefault(c Category, ref string) error

+ type RegistryAuth struct

+ IdentityToken secret.Value

+ Password secret.Value

+ Registry string

+ Username string

+ type Repository struct

+ DefaultBranch string

+ FullName string

+ Private bool

+ URL string

+ type ResourcePlan struct

+ CPUMillis int

+ MemoryBytes int64

+ type RevocationMode string

+ const RevocationExpiryOnly

+ const RevocationPush

+ const RevocationRefresh

+ type RoleDraft struct

+ Name string

+ Scope string

+ Verbs []string

+ type RoleInfo struct

+ Builtin bool

+ ID string

+ Name string

+ Scope string

+ Verbs []string

+ type RouteHandle struct

+ AppID string

+ Handle string

+ type RouteRequest struct

+ AppID string

+ Hostname string

+ Mode RoutingMode

+ PathPrefix string

+ Port int

+ ProxyUpstream string

+ TLS TLSRequest

+ type RouteState struct

+ Address string

+ Present bool

+ type RoutingAdapter interface

+ Capabilities func(ctx context.Context) (RoutingCapabilities, error)

+ Edge func(ctx context.Context, r EdgeRequest) (EdgePlan, bool, error)

+ Ensure func(ctx context.Context, r RouteRequest) (RouteHandle, error)

+ Observe func(ctx context.Context, h RouteHandle) (RouteState, error)

+ Remove func(ctx context.Context, h RouteHandle) error

+ type RoutingCapabilities struct

+ BaseDomain string

+ DefaultMode RoutingMode

+ Modes []RoutingMode

+ RequiresPublicReachability bool

+ SupportsTLS bool

+ SupportsWildcardTLS bool

+ func (c RoutingCapabilities) Supports(mode RoutingMode) bool

+ type RoutingMode = spec.RoutingMode

+ type RuntimeAdapter interface

+ Apply func(ctx context.Context, p BundlePlan) (BundleHandle, error)

+ ApplyEdge func(ctx context.Context, p EdgePlan) error

+ Capabilities func(ctx context.Context) (RuntimeCapabilities, error)

+ Capacity func(ctx context.Context) (Capacity, error)

+ CreateVolume func(ctx context.Context, req VolumeRequest) (VolumeHandle, error)

+ Destroy func(ctx context.Context, ref BundleRef, opts DestroyOptions) error

+ DestroyVolume func(ctx context.Context, h VolumeHandle) error

+ EdgeVolumes func(ctx context.Context) ([]VolumeHandle, error)

+ Edges func(ctx context.Context) ([]string, error)

+ Exec func(ctx context.Context, ref WorkloadRef, req ExecRequest) (ExecSession, error)

+ ImportImage func(ctx context.Context, r io.Reader) (string, error)

+ InUse func(ctx context.Context) (InUse, error)

+ LargestFitFor func(ctx context.Context, bundleID string) (*Fit, error)

+ Logs func(ctx context.Context, ref WorkloadRef, opts LogOptions) (io.ReadCloser, error)

+ Observe func(ctx context.Context, ref BundleRef) (ObservedBundle, error)

+ ObserveEdge func(ctx context.Context, name string) (EdgeState, error)

+ RemoveEdge func(ctx context.Context, name string) error

+ RestoreVolume func(ctx context.Context, h VolumeHandle, src io.Reader) error

+ SnapshotVolume func(ctx context.Context, h VolumeHandle, dst io.Writer) error

+ Stop func(ctx context.Context, ref BundleRef) error

+ Trial func(ctx context.Context, req TrialRequest) (TrialResult, error)

+ Upstream func(ctx context.Context, ref WorkloadRef, port int) (Upstream, error)

+ Usage func(ctx context.Context, ref BundleRef) (BundleUsage, error)

+ WatchBundles func(ctx context.Context, sink func(BundleEvent)) error

+ type RuntimeCapabilities struct

+ EdgeConfig []EdgeConfig

+ ImageDelivery []ImageDelivery

+ IsolationClass IsolationClass

+ LogRetention LogRetentionCapability

+ MaxWorkloadsPerBundle int

+ Platform string

+ ReportsUsage bool

+ ResourceLimitsRemedy string

+ SupportsBundleEvents bool

+ SupportsCarriedFiles bool

+ SupportsEdge bool

+ SupportsEgressRestriction bool

+ SupportsExec bool

+ SupportsMultipleWorkloads bool

+ SupportsPersistentVolumes bool

+ SupportsPortObservation bool

+ SupportsPrivateNetwork bool

+ SupportsResourceLimits bool

+ SupportsSelfUpgrade bool

+ SupportsStartThenSwap bool

+ SupportsTrialRun bool

+ SupportsWriteObservation bool

+ func (c RuntimeCapabilities) Delivers(d ImageDelivery) bool

+ type ScanRequest struct

+ AppID string

+ Commit string

+ Image string

+ PullAuth *RegistryAuth

+ SourceDir string

+ SpecID string

+ type ScanResult struct

+ Findings []Finding

+ Ran time.Time

+ Scanner string

+ type ScannerAdapter interface

+ Scan func(ctx context.Context, req ScanRequest) (ScanResult, error)

+ ScannerCapabilities func() ScannerCapabilities

+ type ScannerCapabilities struct

+ ScansImages bool

+ ScansSource bool

+ type ScreenBudget struct

+ MaxBytes int64

+ MaxFiles int

+ Timeout time.Duration

+ type ScreenRequest struct

+ Budget ScreenBudget

+ Conversation []Turn

+ Evidence []string

+ Instruction string

+ Known []string

+ Model string

+ Questions []Question

+ Source SourceView

+ Spec spec.AppSpec

+ Trial TrialSummary

+ Values []string

+ type ScreenResult struct

+ Amendments []Amendment

+ FilesRead []string

+ Model string

+ Notes []string

+ Reply string

+ type SecretRef struct

+ AppID string

+ Key string

+ type SecretsAdapter interface

+ Delete func(ctx context.Context, ref StoredRef) error

+ Get func(ctx context.Context, ref StoredRef) (secret.Value, error)

+ Put func(ctx context.Context, ref SecretRef, v secret.Value) (StoredRef, error)

+ type SelfUpgrader interface

+ PullImage func(ctx context.Context, ref string) error

+ RemoveHelpers func(ctx context.Context) error

+ Self func(ctx context.Context) (SelfWorkload, error)

+ StartHelper func(ctx context.Context, spec HelperSpec) (string, error)

+ type SelfWorkload struct

+ ID string

+ Image string

+ type ServiceHandle struct

+ Handle string

+ ServiceID string

+ type ServicesAdapter interface

+ Capabilities func() ServicesCapabilities

+ Destroy func(ctx context.Context, h ServiceHandle) error

+ Provision func(ctx context.Context, req ProvisionRequest) (ProvisionResult, error)

+ Restore func(ctx context.Context, h ServiceHandle, src io.Reader) error

+ Snapshot func(ctx context.Context, h ServiceHandle, dst io.Writer) error

+ Supports func() []spec.SlotType

+ type ServicesCapabilities struct

+ DataInAppVolumes bool

+ type SessionPolicy struct

+ MaxLifetime time.Duration

+ RefreshInterval time.Duration

+ RevocationMode RevocationMode

+ type Severity string

+ const SeverityCritical

+ const SeverityHigh

+ const SeverityLow

+ const SeverityMedium

+ const SeverityUnknown

+ type SourceAdapter interface

+ BeginAuthorization func(ctx context.Context, req AuthorizationRequest) (Authorization, error)

+ CompleteAuthorization func(ctx context.Context, req AuthorizationCompletion) (AuthorizationResult, error)

+ Covers func(repoURL string) int

+ GitCredential func(ctx context.Context, repoURL string) (GitCredential, error)

+ ListBranches func(ctx context.Context, repoURL string) ([]string, error)

+ ListRepositories func(ctx context.Context, req ListRepositoriesRequest) ([]Repository, error)

+ Refresh func(ctx context.Context) (map[string]secret.Value, error)

+ SourceCapabilities func() SourceCapabilities

+ type SourceCapabilities struct

+ Authorized bool

+ DeviceAuthorization bool

+ Host string

+ ListRepositories bool

+ Method string

+ Scope string

+ WebAuthorization bool

+ type SourceView interface

+ Glob func(pattern string) ([]string, error)

+ Open func(name string) (io.ReadCloser, error)

+ Stat func(name string) (FileInfo, error)

+ type StoredBundle struct

+ Name string

+ SizeBytes int64

+ StoredAt time.Time

+ type StoredRef struct

+ AppID string

+ Ciphertext []byte

+ Handle string

+ Key string

+ type Subject struct

+ Attributes map[string][]string

+ DisplayName string

+ Email string

+ EmailVerified bool

+ ExternalID string

+ Groups []string

+ OneTimeID string

+ OneTimeUntil time.Time

+ Username string

+ type TLSRequest struct

+ Enabled bool

+ Hostname string

+ type TrialRequest struct

+ Command []string

+ DeclaredPaths []string

+ Entrypoint []string

+ Env map[string]secret.Value

+ Image string

+ IsolationFloor IsolationClass

+ LogSink io.Writer

+ PullAuth *RegistryAuth

+ Timeout time.Duration

+ TrialID string

+ WorkingDir string

+ type TrialResult struct

+ ExitCode *int

+ ImageVolumes []string

+ Log string

+ LoopbackPorts []int

+ ObservedPorts []int

+ ObservedWrites []string

+ Started bool

+ type TrialSummary struct

+ Crashed bool

+ Log string

+ ObservedPorts []int

+ ObservedWrites []string

+ Ran bool

+ type Turn struct

+ From string

+ Text string

+ type Upstream struct

+ Dial func(ctx context.Context) (net.Conn, error)

+ PoolKey string

+ URL string

+ type VerbInfo struct

+ Meaning string

+ Name string

+ Scope string

+ type VolumeHandle struct

+ Handle string

+ VolumeID string

+ type VolumePlan struct

+ Name string

+ VolumeID string

+ type VolumeRequest struct

+ BundleID string

+ Name string

+ SizeBytes int64

+ VolumeID string

+ type VolumeUsage struct

+ Bytes int64

+ VolumeID string

+ type WorkloadPlan struct

+ Command []string

+ DependsOn []string

+ Entrypoint []string

+ Env map[string]secret.Value

+ Exposed bool

+ Files []FilePlan

+ Health *HealthPlan

+ Image string

+ LogBytes int64

+ Mounts []MountPlan

+ Name string

+ Ports []PortPlan

+ PullAuth *RegistryAuth

+ Resources ResourcePlan

+ WorkingDir string

+ type WorkloadRef struct

+ BundleID string

+ Workload string

+ type WorkloadUsage struct

+ CPULimitMillis int

+ CPUMillis int

+ DiskBytes int64

+ MemoryBytes int64

+ MemoryLimitBytes int64

+ Running bool

+ Workload string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL