Skip to content

feat[WIP]: plan freezing #554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
drey wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

feat[WIP]: plan freezing #554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02f1645
feat: plan freezing
drey Feb 2, 2026
4b80e41
refactor: resolve linter issues
drey Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions cmd/nelm/release_install.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,14 @@ func newReleaseInstallCommand(ctx context.Context, afterAllCommandsBuiltFuncs ma
return fmt.Errorf("add flag: %w", err)
}

if err := cli.AddFlag(cmd, &cfg.PlanArtifactPath, "plan-file", "", "Path to pre-build install plan artifact to perform release install", cli.AddFlagOptions{
GetEnvVarRegexesFunc: cli.GetFlagLocalEnvVarRegexes,
Group: mainFlagGroup,
Type: cli.FlagTypeFile,
}); err != nil {
return fmt.Errorf("add flag: %w", err)
}

if err := cli.AddFlag(cmd, &cfg.ReleaseHistoryLimit, "release-history-limit", common.DefaultReleaseHistoryLimit, "Limit the number of releases in release history. When limit is exceeded the oldest releases are deleted. Release resources are not affected", cli.AddFlagOptions{
GetEnvVarRegexesFunc: cli.GetFlagGlobalEnvVarRegexes,
Group: miscFlagGroup,
Expand Down
8 changes: 8 additions & 0 deletions cmd/nelm/release_plan_install.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,14 @@ func newReleasePlanInstallCommand(ctx context.Context, afterAllCommandsBuiltFunc
return fmt.Errorf("add flag: %w", err)
}

if err := cli.AddFlag(cmd, &cfg.PlanArtifactPath, "out", "", "Save install plan artifact to the specified file", cli.AddFlagOptions{
GetEnvVarRegexesFunc: cli.GetFlagLocalEnvVarRegexes,
Group: mainFlagGroup,
Type: cli.FlagTypeFile,
}); err != nil {
return fmt.Errorf("add flag: %w", err)
}

if err := cli.AddFlag(cmd, &cfg.TempDirPath, "temp-dir", "", "The directory for temporary files. By default, create a new directory in the default system directory for temporary files", cli.AddFlagOptions{
GetEnvVarRegexesFunc: cli.GetFlagGlobalEnvVarRegexes,
Group: miscFlagGroup,
Expand Down
152 changes: 120 additions & 32 deletions internal/plan/operation_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package plan

import (
"fmt"
"regexp"
"time"

Expand Down Expand Up @@ -35,7 +36,7 @@ type OperationConfig interface {
}

type OperationConfigNoop struct {
OpID string
OpID string `json:"opId"`
}

func (c *OperationConfigNoop) ID() string {
Expand All @@ -47,8 +48,8 @@ func (c *OperationConfigNoop) IDHuman() string {
}

type OperationConfigCreate struct {
ResourceSpec *spec.ResourceSpec
ForceReplicas *int
ResourceSpec *spec.ResourceSpec `json:"resourceSpec"`
ForceReplicas *int `json:"forceReplicas,omitempty"`
}

func (c *OperationConfigCreate) ID() string {
Expand All @@ -60,9 +61,9 @@ func (c *OperationConfigCreate) IDHuman() string {
}

type OperationConfigRecreate struct {
ResourceSpec *spec.ResourceSpec
DeletePropagation metav1.DeletionPropagation
ForceReplicas *int
ResourceSpec *spec.ResourceSpec `json:"resourceSpec"`
DeletePropagation metav1.DeletionPropagation `json:"deletePropagation"`
ForceReplicas *int `json:"forceReplicas,omitempty"`
}

func (c *OperationConfigRecreate) ID() string {
Expand All @@ -74,7 +75,7 @@ func (c *OperationConfigRecreate) IDHuman() string {
}

type OperationConfigUpdate struct {
ResourceSpec *spec.ResourceSpec
ResourceSpec *spec.ResourceSpec `json:"resourceSpec"`
}

func (c *OperationConfigUpdate) ID() string {
Expand All @@ -86,7 +87,7 @@ func (c *OperationConfigUpdate) IDHuman() string {
}

type OperationConfigApply struct {
ResourceSpec *spec.ResourceSpec
ResourceSpec *spec.ResourceSpec `json:"resourceSpec"`
}

func (c *OperationConfigApply) ID() string {
Expand All @@ -98,8 +99,8 @@ func (c *OperationConfigApply) IDHuman() string {
}

type OperationConfigDelete struct {
ResourceMeta *spec.ResourceMeta
DeletePropagation metav1.DeletionPropagation
ResourceMeta *spec.ResourceMeta `json:"resourceMeta"`
DeletePropagation metav1.DeletionPropagation `json:"deletePropagation"`
}

func (c *OperationConfigDelete) ID() string {
Expand All @@ -111,21 +112,26 @@ func (c *OperationConfigDelete) IDHuman() string {
}

type OperationConfigTrackReadiness struct {
ResourceMeta *spec.ResourceMeta

FailMode multitrack.FailMode
FailuresAllowed int
IgnoreLogs bool
IgnoreLogsForContainers []string
IgnoreLogsByRegex *regexp.Regexp
IgnoreLogsByRegexForContainers map[string]*regexp.Regexp
IgnoreReadinessProbeFailsByContainerName map[string]time.Duration
NoActivityTimeout time.Duration
SaveEvents bool
SaveLogsByRegex *regexp.Regexp
SaveLogsByRegexForContainers map[string]*regexp.Regexp
SaveLogsOnlyForContainers []string
SaveLogsOnlyForNumberOfReplicas int
ResourceMeta *spec.ResourceMeta `json:"resourceMeta"`

FailMode multitrack.FailMode `json:"failMode"`
FailuresAllowed int `json:"failuresAllowed"`
IgnoreLogs bool `json:"ignoreLogs"`
IgnoreLogsForContainers []string `json:"ignoreLogsForContainers,omitempty"`
IgnoreLogsByRegex *regexp.Regexp `json:"-"`
IgnoreLogsByRegexForContainers map[string]*regexp.Regexp `json:"-"`
IgnoreReadinessProbeFailsByContainerName map[string]time.Duration `json:"ignoreReadinessProbeFailsByContainerName,omitempty"`
NoActivityTimeout time.Duration `json:"noActivityTimeout"`
SaveEvents bool `json:"saveEvents"`
SaveLogsByRegex *regexp.Regexp `json:"-"`
SaveLogsByRegexForContainers map[string]*regexp.Regexp `json:"-"`
SaveLogsOnlyForContainers []string `json:"saveLogsOnlyForContainers,omitempty"`
SaveLogsOnlyForNumberOfReplicas int `json:"saveLogsOnlyForNumberOfReplicas"`

IgnoreLogsByRegexStr string `json:"ignoreLogsByRegex,omitempty"`
IgnoreLogsByRegexForContainersStr map[string]string `json:"ignoreLogsByRegexForContainers,omitempty"`
SaveLogsByRegexStr string `json:"saveLogsByRegex,omitempty"`
SaveLogsByRegexForContainersStr map[string]string `json:"saveLogsByRegexForContainers,omitempty"`
}

func (c *OperationConfigTrackReadiness) ID() string {
Expand All @@ -136,8 +142,90 @@ func (c *OperationConfigTrackReadiness) IDHuman() string {
return c.ResourceMeta.IDHuman()
}

func (c *OperationConfigTrackReadiness) PrepareForMarshal() {
if c.IgnoreLogsByRegex != nil {
c.IgnoreLogsByRegexStr = c.IgnoreLogsByRegex.String()
}

if c.SaveLogsByRegex != nil {
c.SaveLogsByRegexStr = c.SaveLogsByRegex.String()
}

if c.IgnoreLogsByRegexForContainers != nil {
c.IgnoreLogsByRegexForContainersStr = make(map[string]string, len(c.IgnoreLogsByRegexForContainers))
for k, v := range c.IgnoreLogsByRegexForContainers {
if v != nil {
c.IgnoreLogsByRegexForContainersStr[k] = v.String()
}
}
}

if c.SaveLogsByRegexForContainers != nil {
c.SaveLogsByRegexForContainersStr = make(map[string]string, len(c.SaveLogsByRegexForContainers))
for k, v := range c.SaveLogsByRegexForContainers {
if v != nil {
c.SaveLogsByRegexForContainersStr[k] = v.String()
}
}
}
}

func (c *OperationConfigTrackReadiness) RestoreFromUnmarshal() error {
if c.IgnoreLogsByRegexStr != "" {
r, err := regexp.Compile(c.IgnoreLogsByRegexStr)
if err != nil {
return fmt.Errorf("compile ignoreLogsByRegex: %w", err)
}

c.IgnoreLogsByRegex = r
}

if c.SaveLogsByRegexStr != "" {
r, err := regexp.Compile(c.SaveLogsByRegexStr)
if err != nil {
return fmt.Errorf("compile saveLogsByRegex: %w", err)
}

c.SaveLogsByRegex = r
}

if c.IgnoreLogsByRegexForContainersStr != nil {
c.IgnoreLogsByRegexForContainers = make(map[string]*regexp.Regexp, len(c.IgnoreLogsByRegexForContainersStr))
for k, v := range c.IgnoreLogsByRegexForContainersStr {
if v == "" {
continue
}

r, err := regexp.Compile(v)
if err != nil {
return fmt.Errorf("compile ignoreLogsByRegexForContainers[%q]: %w", k, err)
}

c.IgnoreLogsByRegexForContainers[k] = r
}
}

if c.SaveLogsByRegexForContainersStr != nil {
c.SaveLogsByRegexForContainers = make(map[string]*regexp.Regexp, len(c.SaveLogsByRegexForContainersStr))
for k, v := range c.SaveLogsByRegexForContainersStr {
if v == "" {
continue
}

r, err := regexp.Compile(v)
if err != nil {
return fmt.Errorf("compile saveLogsByRegexForContainers[%q]: %w", k, err)
}

c.SaveLogsByRegexForContainers[k] = r
}
}

return nil
}

type OperationConfigTrackPresence struct {
ResourceMeta *spec.ResourceMeta
ResourceMeta *spec.ResourceMeta `json:"resourceMeta"`
}

func (c *OperationConfigTrackPresence) ID() string {
Expand All @@ -149,7 +237,7 @@ func (c *OperationConfigTrackPresence) IDHuman() string {
}

type OperationConfigTrackAbsence struct {
ResourceMeta *spec.ResourceMeta
ResourceMeta *spec.ResourceMeta `json:"resourceMeta"`
}

func (c *OperationConfigTrackAbsence) ID() string {
Expand All @@ -161,7 +249,7 @@ func (c *OperationConfigTrackAbsence) IDHuman() string {
}

type OperationConfigCreateRelease struct {
Release *helmrelease.Release
Release *helmrelease.Release `json:"release"`
}

func (c *OperationConfigCreateRelease) ID() string {
Expand All @@ -173,7 +261,7 @@ func (c *OperationConfigCreateRelease) IDHuman() string {
}

type OperationConfigUpdateRelease struct {
Release *helmrelease.Release
Release *helmrelease.Release `json:"release"`
}

func (c *OperationConfigUpdateRelease) ID() string {
Expand All @@ -185,9 +273,9 @@ func (c *OperationConfigUpdateRelease) IDHuman() string {
}

type OperationConfigDeleteRelease struct {
ReleaseName string
ReleaseNamespace string
ReleaseRevision int
ReleaseName string `json:"releaseName"`
ReleaseNamespace string `json:"releaseNamespace"`
ReleaseRevision int `json:"releaseRevision"`
}

func (c *OperationConfigDeleteRelease) ID() string {
Expand Down
Loading