bind

package
v0.0.0-...-47649f3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2024 License: BSD-3-Clause Imports: 2 Imported by: 7

Documentation

Overview

Package bind provides interfaces and types for use when binding an app to a service.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddInstanceArgs

type AddInstanceArgs struct {
	Envs          []bindTypes.ServiceEnvVar
	Writer        io.Writer
	ShouldRestart bool
}

type App

type App interface {
	// GetAddresses returns the app addresses.
	GetAddresses() ([]string, error)

	// GetInternalAddresses returns the app bindable addresses inside the cluster, if any.
	GetInternalBindableAddresses() ([]string, error)

	// GetName returns the app name.
	GetName() string

	// GetUUID returns the App v4 UUID
	GetUUID() (string, error)

	// AddInstance adds an instance to the application.
	AddInstance(args AddInstanceArgs) error

	// RemoveInstance removes an instance from the application.
	RemoveInstance(args RemoveInstanceArgs) error
}

type RemoveInstanceArgs

type RemoveInstanceArgs struct {
	ServiceName   string
	InstanceName  string
	Writer        io.Writer
	ShouldRestart bool
}

type SetEnvArgs

type SetEnvArgs struct {
	Envs          []bindTypes.EnvVar
	Writer        io.Writer
	ManagedBy     string
	PruneUnused   bool
	ShouldRestart bool
}

type UnsetEnvArgs

type UnsetEnvArgs struct {
	VariableNames []string
	Writer        io.Writer
	ShouldRestart bool
}

Jump to

Keyboard shortcuts

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