internal

package

v0.29.25 Latest Latest Go to latest Published: Apr 13, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Details

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

Repository

github.com/deckhouse/deckhouse-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ChannelIsValid(c string) bool
func GetAllDefaultReleaseChannels() []string
func InstallPathByMirrorType(mirrorType MirrorType) string
type EnvVar
type Flag
type KubernetesRequirement
type MirrorType
type ModuleRequirement
type Plugin
type PluginRequirement
type Requirements

Constants ¶

View Source

const (
	InstallSegment           = "install"
	InstallStandaloneSegment = "install-standalone"
	ReleaseChannelSegment    = "release-channel"

	ModulesSegment        = "modules"
	ModulesReleaseSegment = "release"
	ModulesExtraSegment   = "extra"

	SecuritySegment = "security"

	SecurityTrivyDBSegment     = "trivy-db"
	SecurityTrivyBDUSegment    = "trivy-bdu"
	SecurityTrivyJavaDBSegment = "trivy-java-db"
	SecurityTrivyChecksSegment = "trivy-checks"
)

deckhouse repo structure (relative to root path like registry.deckhouse.io/deckhouse/fe)

Platform:

<root>:<version>                                    - Deckhouse main image
<root>/release-channel:<channel>                    - Release channel metadata
<root>/install:<version>                            - Installer image
<root>/install-standalone:<version>                 - Standalone installer

Security:

<root>/security/<security-name>:<version>           - Security databases (trivy-db, trivy-bdu, etc.)

Modules:

<root>/modules/<module-name>:<version>                    - Module main image
<root>/modules/<module-name>/release:<channel>            - Module release channel metadata
<root>/modules/<module-name>/extra/<extra-name>:<version> - Module extra images

View Source

const (
	AlphaChannel       = "alpha"
	BetaChannel        = "beta"
	EarlyAccessChannel = "early-access"
	StableChannel      = "stable"
	RockSolidChannel   = "rock-solid"
	LTSChannel         = "lts"
)

Variables ¶

This section is empty.

Functions ¶

func ChannelIsValid ¶ added in v0.20.14

func ChannelIsValid(c string) bool

func GetAllDefaultReleaseChannels ¶ added in v0.20.14

func GetAllDefaultReleaseChannels() []string

func InstallPathByMirrorType ¶ added in v0.22.9

func InstallPathByMirrorType(mirrorType MirrorType) string

InstallPathByMirrorType returns the path segment for install based on the mirror type.

Types ¶

type EnvVar ¶

type EnvVar struct {
	Name string
}

EnvVar represents an environment variable required by the plugin

type Flag ¶

type Flag struct {
	Name string
}

Flag represents a command-line flag supported by the plugin

type KubernetesRequirement ¶

type KubernetesRequirement struct {
	Constraint string
}

KubernetesRequirement represents Kubernetes version constraint

type MirrorType ¶ added in v0.22.1

type MirrorType int

const (
	MirrorTypeDeckhouse MirrorType = iota
	MirrorTypeDeckhouseInstall
	MirrorTypeDeckhouseInstallStandalone
	MirrorTypeDeckhouseReleaseChannels
	MirrorTypeModules
	MirrorTypeModulesReleaseChannels
	MirrorTypeSecurity
	MirrorTypeSecurityTrivyDBSegment
	MirrorTypeSecurityTrivyBDUSegment
	MirrorTypeSecurityTrivyJavaDBSegment
	MirrorTypeSecurityTrivyChecksSegment
)

type ModuleRequirement ¶

type ModuleRequirement struct {
	Name       string
	Constraint string
}

ModuleRequirement represents a required Deckhouse module

type Plugin ¶

type Plugin struct {
	Name         string
	Version      string
	Description  string
	Env          []EnvVar
	Flags        []Flag
	Requirements Requirements
}

Plugin represents a plugin domain entity

type PluginRequirement ¶ added in v0.26.4

type PluginRequirement struct {
	Name       string
	Constraint string
}

PluginRequirement represents a required plugin

type Requirements ¶

type Requirements struct {
	Kubernetes KubernetesRequirement
	Modules    []ModuleRequirement
	Plugins    []PluginRequirement
}

Requirements represents plugin dependencies

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
auth
tokenexchange
tokenexchange/cmd
backup
cmd
cmd/cluster-config
cmd/etcd
cmd/loki
configs/configmaps
configs/crds
configs/roles
configs/secrets
configs/storageclasses
configs/tarball
configs/whitelist
cni
api/v1alpha1
data
cmd
dataexport/api/v1alpha1
dataexport/cmd
dataexport/cmd/create
dataexport/cmd/delete
dataexport/cmd/download
dataexport/cmd/list
dataexport/util
dataimport/api/v1alpha1
dataimport/cmd
dataimport/cmd/create
dataimport/cmd/delete
dataimport/cmd/upload
dataimport/util
mirror
api/v1alpha1
chunked
cmd
cmd/pull
cmd/pull/errdetect Package errdetect classifies registry errors for d8 mirror pull with pull-specific causes and solutions.	Package errdetect classifies registry errors for d8 mirror pull with pull-specific causes and solutions.
cmd/pull/flags
cmd/push
cmd/push/errdetect Package errdetect classifies registry errors for d8 mirror push with push-specific causes and solutions.	Package errdetect classifies registry errors for d8 mirror push with push-specific causes and solutions.
errmatch Package errmatch provides error matchers for container registry responses.	Package errmatch provides error matchers for container registry responses.
gostsums
installer
modules
platform
puller
pusher
security
validation
network
cnimigration/cmd
progress
status
cmd
objects/clusteralerts
objects/cni_modules
objects/edition
objects/masters
objects/pods
objects/queue
objects/registry
objects/releases
objects/settings
tools/constants
tools/queuefetcher
tools/statusresult
tools/timeutil
system
cmd
cmd/collect-debug-info
cmd/collect-debug-info/debugtar
cmd/edit
cmd/edit/cluster-configuration
cmd/edit/editconfig
cmd/edit/flags
cmd/edit/provider-cluster-configuration
cmd/edit/static-cluster-configuration
cmd/get
cmd/get/cluster-configuration
cmd/get/getconfig
cmd/get/provider-cluster-configuration
cmd/get/static-cluster-configuration
cmd/logs
cmd/module/api/v1alpha1
cmd/module/cli
cmd/module/cmd
cmd/module/cmd/applynow
cmd/module/cmd/approve
cmd/module/cmd/disable
cmd/module/cmd/enable
cmd/module/cmd/list
cmd/module/cmd/snapshots
cmd/module/cmd/values
cmd/module/const
cmd/module/deckhouse
cmd/module/moduleconfig
cmd/module/modulereleases
cmd/package/cmd
cmd/package/cmd/scan
cmd/queue
cmd/queue/flags
cmd/queue/list
cmd/queue/mainqueue
cmd/queue/operatequeue
flags
tools
farconverter
farconverter/cmd
gostsum
gostsum/cmd
imagedigest
imagedigest/cmd
imagedigest/cmd/add
imagedigest/cmd/calculate
imagedigest/cmd/calculatefromfile
imagedigest/cmd/validate
sigmigrate
sigmigrate/cmd
useroperation
cmd
utilk8s
version

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