destroy

package

v0.31.0 Latest Latest Go to latest Published: Jan 29, 2026 License: Apache-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/loft-sh/vcluster

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Destroy(ctxWithoutTimeout context.Context, opts DeleteOptions) error
func DestroyDocker(ctx context.Context, ignoreNotFound bool, log log.Logger) error
type DeleteOptions

Constants ¶

View Source

const (
	// PlatformContainerName is the name of the docker container for vCluster platform
	PlatformContainerName = "vcluster-platform"
	// PlatformVolumeName is the name of the docker volume for vCluster platform
	PlatformVolumeName = "vcluster-platform"
)

Variables ¶

View Source

var ErrDockerPlatformNotFound = fmt.Errorf("no vCluster platform docker installation found (no container or volume)")

ErrDockerPlatformNotFound is returned when no docker platform installation is found

Functions ¶

func Destroy ¶

func Destroy(ctxWithoutTimeout context.Context, opts DeleteOptions) error

func DestroyDocker ¶ added in v0.31.0

func DestroyDocker(ctx context.Context, ignoreNotFound bool, log log.Logger) error

DestroyDocker stops and removes the vCluster platform docker container and volume. If ignoreNotFound is false and no container or volume is found, it returns ErrDockerPlatformNotFound.

Types ¶

type DeleteOptions ¶

type DeleteOptions struct {
	start.Options
	// cli options
	DeleteNamespace       bool
	IgnoreNotFound        bool
	Force                 bool
	ForceRemoveFinalizers bool
	NonInteractive        bool
	TimeoutMinutes        int
}

DeleteOptions holds cli options for the delete command

Source Files ¶

View all Source files

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