stack.go

// Code generated by lesiw.io/ctrctl. DO NOT EDIT.
package ctrctl

import (
	"fmt"
	"os/exec"
)

type StackConfigOpts struct {
	// Base exec.Cmd.
	Cmd *exec.Cmd

	// Path to a Compose file, or `-` to read from stdin.
	ComposeFile string

	// Print usage.
	Help bool

	// Orchestrator to use (swarm|all).
	Orchestrator string

	// Skip interpolation and output only merged config.
	SkipInterpolation bool
}

// Outputs the final config file, after doing merges and interpolations.
func StackConfig(opts *StackConfigOpts) (string, error) {
	return runCtrCmd(
		[]string{"stack", "config"},
		[]string{},
		opts,
		0,
	)
}

type StackDeployOpts struct {
	// Base exec.Cmd.
	Cmd *exec.Cmd

	// Path to a Compose file, or `-` to read from stdin.
	ComposeFile string

	// Exit immediately instead of waiting for the stack services to converge.
	Detach bool

	// Print usage.
	Help bool

	// Orchestrator to use (swarm|all).
	Orchestrator string

	// Prune services that are no longer referenced.
	Prune bool

	// Suppress progress output.
	Quiet bool

	// Query the registry to resolve image digest and supported platforms (`always`, `changed`, `never`).
	ResolveImage string

	// Send registry authentication details to Swarm agents.
	WithRegistryAuth bool
}

// Deploy a new stack or update an existing stack.
func StackDeploy(opts *StackDeployOpts, stack string) (string, error) {
	return runCtrCmd(
		[]string{"stack", "deploy"},
		[]string{stack},
		opts,
		0,
	)
}

type StackLsOpts struct {
	// Base exec.Cmd.
	Cmd *exec.Cmd

	// Format output using a custom template:
	// 'table':            Print output in table format with column headers (default).
	// 'table TEMPLATE':   Print output in table format using the given Go template.
	// 'json':             Print in JSON format.
	// 'TEMPLATE':         Print output using the given Go template.
	// Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates.
	Format string

	// Print usage.
	Help bool

	// Orchestrator to use (swarm|all).
	Orchestrator string
}

// List stacks.
func StackLs(opts *StackLsOpts) (string, error) {
	return runCtrCmd(
		[]string{"stack", "ls"},
		[]string{},
		opts,
		0,
	)
}

type StackPsOpts struct {
	// Base exec.Cmd.
	Cmd *exec.Cmd

	// Filter output based on conditions provided.
	Filter string

	// Format output using a custom template:
	// 'table':            Print output in table format with column headers (default).
	// 'table TEMPLATE':   Print output in table format using the given Go template.
	// 'json':             Print in JSON format.
	// 'TEMPLATE':         Print output using the given Go template.
	// Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates.
	Format string

	// Print usage.
	Help bool

	// Do not map IDs to Names.
	NoResolve bool

	// Do not truncate output.
	NoTrunc bool

	// Orchestrator to use (swarm|all).
	Orchestrator string

	// Only display task IDs.
	Quiet bool
}

// List the tasks in the stack.
func StackPs(opts *StackPsOpts, stack string) (string, error) {
	return runCtrCmd(
		[]string{"stack", "ps"},
		[]string{stack},
		opts,
		0,
	)
}

type StackRmOpts struct {
	// Base exec.Cmd.
	Cmd *exec.Cmd

	// Do not wait for stack removal.
	Detach bool

	// Print usage.
	Help bool

	// Orchestrator to use (swarm|all).
	Orchestrator string
}

// Remove one or more stacks.
func StackRm(opts *StackRmOpts, stack ...string) (string, error) {
	if len(stack) == 0 {
		return "", fmt.Errorf("stack must have at least one value")
	}
	return runCtrCmd(
		[]string{"stack", "rm"},
		stack,
		opts,
		0,
	)
}

type StackServicesOpts struct {
	// Base exec.Cmd.
	Cmd *exec.Cmd

	// Filter output based on conditions provided.
	Filter string

	// Format output using a custom template:
	// 'table':            Print output in table format with column headers (default).
	// 'table TEMPLATE':   Print output in table format using the given Go template.
	// 'json':             Print in JSON format.
	// 'TEMPLATE':         Print output using the given Go template.
	// Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates.
	Format string

	// Print usage.
	Help bool

	// Orchestrator to use (swarm|all).
	Orchestrator string

	// Only display IDs.
	Quiet bool
}

// List the services in the stack.
func StackServices(opts *StackServicesOpts, stack string) (string, error) {
	return runCtrCmd(
		[]string{"stack", "services"},
		[]string{stack},
		opts,
		0,
	)
}