volume

Documentation

Overview

Package volume provides the ability for Vela to manage and manipulate a volume provided for a container.

Usage:

import "github.com/go-vela/worker/internal/volume"

Index

• type Volume
  • func Parse(_volume string) *Volume
  • func ParseWithError(_volume string) (*Volume, error)

Types

type Volume

type Volume struct {
	Source      string `json:"source,omitempty"`
	Destination string `json:"destination,omitempty"`
	AccessMode  string `json:"access_mode,omitempty"`
}

Volume represents the volume definition used to create volumes for a container.

func Parse

func Parse(_volume string) *Volume

Parse digests the provided volume into a fully qualified volume reference. If an error occurs, it will return a nil volume.

func ParseWithError

func ParseWithError(_volume string) (*Volume, error)

ParseWithError digests the provided volume into a fully qualified volume reference. If an error occurs, it will return a nil volume and the produced error.