volume

Documentation

Overview

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2024, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

Index

• func DefaultStrategyName() string
• func DriverNames() []string
• func NewVolumeV1alpha1ServiceIterator(ctx context.Context) (volumev1alpha1.VolumeService, error)
• func Strategies() map[string]*Strategy
• type NewStrategyConstructor
• type Strategy

Functions

func DefaultStrategyName

func DefaultStrategyName() string

DefaultStrategyName return the name of the default strategy of the platform.

func DriverNames

func DriverNames() []string

DriverNames returns the list of registered platform driver implementation names.

func NewVolumeV1alpha1ServiceIterator

func NewVolumeV1alpha1ServiceIterator(ctx context.Context) (volumev1alpha1.VolumeService, error)

NewVolumeV1alpha1ServiceIterator returns a volumev1alpha1.VolumeService -compatible implementation which iterates over each supported volume driver and calls the representing method. This is useful in circumstances where the driver is not supplied. The first volume driver to succeed is returned in all circumstances.

func Strategies

func Strategies() map[string]*Strategy

Strategies returns the list of registered platform implementations.

Types

type NewStrategyConstructor

type NewStrategyConstructor[T any] func(context.Context, ...any) (T, error)

NewStrategyConstructor is a prototype for the instantiation function of a platform driver implementation.

type Strategy

type Strategy struct {
	IsCompatible      func(string, kconfig.KeyValueMap) (bool, error)
	NewVolumeV1alpha1 NewStrategyConstructor[volumev1alpha1.VolumeService]
}

Strategy represents canonical reference of a machine driver and their platform.