actions

Documentation

Overview

Copyright © 2020-2023 The k3d Author(s)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type ExecAction
  • func (act ExecAction) Info() string
  • func (act ExecAction) Name() string
  • func (act ExecAction) Run(ctx context.Context, node *k3d.Node) error
• type RewriteFileAction
  • func (act RewriteFileAction) Info() string
  • func (act RewriteFileAction) Name() string
  • func (act RewriteFileAction) Run(ctx context.Context, node *k3d.Node) error
• type RewriteFileActionOpts
• type WriteFileAction
  • func (act WriteFileAction) Info() string
  • func (act WriteFileAction) Name() string
  • func (act WriteFileAction) Run(ctx context.Context, node *k3d.Node) error

Types

type ExecAction

type ExecAction struct {
	Runtime     runtimes.Runtime
	Command     []string
	Retries     int
	Description string
}

ExecAction executes some command inside the node

func (ExecAction) Info

func (act ExecAction) Info() string

func (ExecAction) Name

func (act ExecAction) Name() string

func (ExecAction) Run

func (act ExecAction) Run(ctx context.Context, node *k3d.Node) error

type RewriteFileAction

type RewriteFileAction struct {
	Runtime     runtimes.Runtime
	Path        string
	RewriteFunc func([]byte) ([]byte, error)
	Mode        os.FileMode
	Description string
	Opts        RewriteFileActionOpts
}

RewriteFileAction takes an existing file from the node filesystem and rewrites it using a specified rewrite function

func (RewriteFileAction) Info

func (act RewriteFileAction) Info() string

func (RewriteFileAction) Name

func (act RewriteFileAction) Name() string

func (RewriteFileAction) Run

func (act RewriteFileAction) Run(ctx context.Context, node *k3d.Node) error

type RewriteFileActionOpts

type RewriteFileActionOpts struct {
	NoCopy bool // do not copy over the file, but rather overwrite the contents of the target (e.g. to avoid "Resource busy" error on /etc/hosts)
}

type WriteFileAction

type WriteFileAction struct {
	Runtime     runtimes.Runtime
	Content     []byte
	Dest        string
	Mode        os.FileMode
	Description string
}

WriteFileAction writes a file inside into the node filesystem

func (WriteFileAction) Info

func (act WriteFileAction) Info() string

func (WriteFileAction) Name

func (act WriteFileAction) Name() string

func (WriteFileAction) Run

func (act WriteFileAction) Run(ctx context.Context, node *k3d.Node) error