Skip to content

Remove global console config variables #162

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
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Remove global console config variables #162

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
202dcb1
Initial plan
Copilot Feb 5, 2026
b474a22
Remove CONSOLE_CONFIGS, CONSOLE_CONFIGS_HELP, and DefaultConsoleConfi…
Copilot Feb 5, 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
55 changes: 45 additions & 10 deletions cmd/crowdsec-cli/cliconsole/console.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,16 @@ func (cli *cliConsole) enroll(ctx context.Context, key string, name string, over
return err
}

helpTexts := map[string]string{
csconfig.SEND_CUSTOM_SCENARIOS: "Forward alerts from custom scenarios to the console",
csconfig.SEND_MANUAL_SCENARIOS: "Forward manual decisions to the console",
csconfig.SEND_TAINTED_SCENARIOS: "Forward alerts from tainted scenarios to the console",
csconfig.SEND_CONTEXT: "Forward context with alerts to the console",
csconfig.CONSOLE_MANAGEMENT: "Receive decisions from console",
}

for _, opt := range opts {
log.Infof("Enabled %s : %s", opt, csconfig.CONSOLE_CONFIGS_HELP[opt])
log.Infof("Enabled %s : %s", opt, helpTexts[opt])
}

log.Info("Watcher successfully enrolled. Visit https://app.crowdsec.net to accept it.")
Expand All @@ -115,18 +123,20 @@ func (cli *cliConsole) enroll(ctx context.Context, key string, name string, over
}

func optionFilterEnable(opts []string, enableOpts []string) ([]string, error) {
validOptions := []string{csconfig.SEND_CUSTOM_SCENARIOS, csconfig.SEND_MANUAL_SCENARIOS, csconfig.SEND_TAINTED_SCENARIOS, csconfig.SEND_CONTEXT, csconfig.CONSOLE_MANAGEMENT}

if len(enableOpts) == 0 {
return opts, nil
}

for _, opt := range enableOpts {
if opt == "all" {
opts = append(opts, csconfig.CONSOLE_CONFIGS...)
opts = append(opts, validOptions...)
// keep validating the rest of the option names
continue
}

if !slices.Contains(csconfig.CONSOLE_CONFIGS, opt) {
if !slices.Contains(validOptions, opt) {
return nil, fmt.Errorf("option %s doesn't exist", opt)
}

Expand All @@ -139,6 +149,8 @@ func optionFilterEnable(opts []string, enableOpts []string) ([]string, error) {
}

func optionFilterDisable(opts []string, disableOpts []string) ([]string, error) {
validOptions := []string{csconfig.SEND_CUSTOM_SCENARIOS, csconfig.SEND_MANUAL_SCENARIOS, csconfig.SEND_TAINTED_SCENARIOS, csconfig.SEND_CONTEXT, csconfig.CONSOLE_MANAGEMENT}

if len(disableOpts) == 0 {
return opts, nil
}
Expand All @@ -150,7 +162,7 @@ func optionFilterDisable(opts []string, disableOpts []string) ([]string, error)
continue
}

if !slices.Contains(csconfig.CONSOLE_CONFIGS, opt) {
if !slices.Contains(validOptions, opt) {
return nil, fmt.Errorf("option %s doesn't exist", opt)
}

Expand Down Expand Up @@ -192,7 +204,14 @@ cscli console enroll --name [instance_name] --tags [tag_1] --tags [tag_2] YOUR-E
cscli console enroll --enable console_management YOUR-ENROLL-KEY
cscli console enroll --disable context YOUR-ENROLL-KEY

valid options are : %s,all (see 'cscli console status' for details)`, strings.Join(csconfig.CONSOLE_CONFIGS, ",")),
valid options are : %s,all (see 'cscli console status' for details)`, strings.Join(
[]string{
csconfig.SEND_CUSTOM_SCENARIOS,
csconfig.SEND_MANUAL_SCENARIOS,
csconfig.SEND_TAINTED_SCENARIOS,
csconfig.SEND_CONTEXT,
csconfig.CONSOLE_MANAGEMENT,
}, ",")),
Args: args.ExactArgs(1),
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down Expand Up @@ -225,17 +244,25 @@ valid options are : %s,all (see 'cscli console status' for details)`, strings.Jo
func (cli *cliConsole) newEnableCmd() *cobra.Command {
var enableAll bool

allOptions := []string{
csconfig.SEND_CUSTOM_SCENARIOS,
csconfig.SEND_MANUAL_SCENARIOS,
csconfig.SEND_TAINTED_SCENARIOS,
csconfig.SEND_CONTEXT,
csconfig.CONSOLE_MANAGEMENT,
}

cmd := &cobra.Command{
Use: "enable [option]...",
Short: "Enable a console option",
Example: "sudo cscli console enable tainted",
Long: `
Enable given information push to the central API. Allows to empower the console`,
ValidArgs: csconfig.CONSOLE_CONFIGS,
ValidArgs: allOptions,
DisableAutoGenTag: true,
RunE: func(_ *cobra.Command, args []string) error {
if enableAll {
if err := cli.setConsoleOpts(csconfig.CONSOLE_CONFIGS, true); err != nil {
if err := cli.setConsoleOpts(allOptions, true); err != nil {
return err
}

Expand Down Expand Up @@ -267,17 +294,25 @@ Enable given information push to the central API. Allows to empower the console`
func (cli *cliConsole) newDisableCmd() *cobra.Command {
var disableAll bool

allOptions := []string{
csconfig.SEND_CUSTOM_SCENARIOS,
csconfig.SEND_MANUAL_SCENARIOS,
csconfig.SEND_TAINTED_SCENARIOS,
csconfig.SEND_CONTEXT,
csconfig.CONSOLE_MANAGEMENT,
}

cmd := &cobra.Command{
Use: "disable [option]",
Short: "Disable a console option",
Example: "sudo cscli console disable tainted",
Long: `
Disable given information push to the central API.`,
ValidArgs: csconfig.CONSOLE_CONFIGS,
ValidArgs: allOptions,
DisableAutoGenTag: true,
RunE: func(_ *cobra.Command, args []string) error {
if disableAll {
if err := cli.setConsoleOpts(csconfig.CONSOLE_CONFIGS, false); err != nil {
if err := cli.setConsoleOpts(allOptions, false); err != nil {
return err
}

Expand Down Expand Up @@ -376,7 +411,7 @@ func (cli *cliConsole) dumpConfig() error {
}

if serverCfg.ConsoleConfigPath == "" {
serverCfg.ConsoleConfigPath = csconfig.DefaultConsoleConfigFilePath
serverCfg.ConsoleConfigPath = csconfig.DefaultConfigPath("console.yaml")
log.Debugf("Empty console_path, defaulting to %s", serverCfg.ConsoleConfigPath)
}

Expand Down
41 changes: 16 additions & 25 deletions cmd/crowdsec-cli/cliconsole/console_table.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,24 @@ func cmdConsoleStatusTable(out io.Writer, wantColor string, consoleCfg csconfig.
t.SetHeaders("Option Name", "Activated", "Description")
t.SetHeaderAlignment(text.AlignLeft, text.AlignLeft, text.AlignLeft)

for _, option := range csconfig.CONSOLE_CONFIGS {
activated := emoji.CrossMark
consoleOptions := []struct {
name string
enabled bool
description string
}{
{csconfig.SEND_CUSTOM_SCENARIOS, *consoleCfg.ShareCustomScenarios, "Forward alerts from custom scenarios to the console"},
{csconfig.SEND_MANUAL_SCENARIOS, *consoleCfg.ShareManualDecisions, "Forward manual decisions to the console"},
{csconfig.SEND_TAINTED_SCENARIOS, *consoleCfg.ShareTaintedScenarios, "Forward alerts from tainted scenarios to the console"},
{csconfig.SEND_CONTEXT, *consoleCfg.ShareContext, "Forward context with alerts to the console"},
{csconfig.CONSOLE_MANAGEMENT, *consoleCfg.ConsoleManagement, "Receive decisions from console"},
}

switch option {
case csconfig.SEND_CUSTOM_SCENARIOS:
if *consoleCfg.ShareCustomScenarios {
activated = emoji.CheckMarkButton
}
case csconfig.SEND_MANUAL_SCENARIOS:
if *consoleCfg.ShareManualDecisions {
activated = emoji.CheckMarkButton
}
case csconfig.SEND_TAINTED_SCENARIOS:
if *consoleCfg.ShareTaintedScenarios {
activated = emoji.CheckMarkButton
}
case csconfig.SEND_CONTEXT:
if *consoleCfg.ShareContext {
activated = emoji.CheckMarkButton
}
case csconfig.CONSOLE_MANAGEMENT:
if *consoleCfg.ConsoleManagement {
activated = emoji.CheckMarkButton
}
for _, option := range consoleOptions {
activated := emoji.CrossMark
if option.enabled {
activated = emoji.CheckMarkButton
}

t.AddRow(option, activated, csconfig.CONSOLE_CONFIGS_HELP[option])
t.AddRow(option.name, activated, option.description)
}

t.Render()
Expand Down
2 changes: 1 addition & 1 deletion pkg/csconfig/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ func (c *Config) LoadAPIServer(inCli bool, skipOnlineCreds bool) error {
}

if c.API.Server.ConsoleConfigPath == "" {
c.API.Server.ConsoleConfigPath = DefaultConsoleConfigFilePath
c.API.Server.ConsoleConfigPath = DefaultConfigPath("console.yaml")
}

if err := c.API.Server.LoadConsoleConfig(); err != nil {
Expand Down
11 changes: 0 additions & 11 deletions pkg/csconfig/console.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,6 @@ const (
SEND_CONTEXT = "context"
)

var CONSOLE_CONFIGS = []string{SEND_CUSTOM_SCENARIOS, SEND_MANUAL_SCENARIOS, SEND_TAINTED_SCENARIOS, SEND_CONTEXT, CONSOLE_MANAGEMENT}
var CONSOLE_CONFIGS_HELP = map[string]string{
SEND_CUSTOM_SCENARIOS: "Forward alerts from custom scenarios to the console",
SEND_MANUAL_SCENARIOS: "Forward manual decisions to the console",
SEND_TAINTED_SCENARIOS: "Forward alerts from tainted scenarios to the console",
SEND_CONTEXT: "Forward context with alerts to the console",
CONSOLE_MANAGEMENT: "Receive decisions from console",
}

var DefaultConsoleConfigFilePath = DefaultConfigPath("console.yaml")

type ConsoleConfig struct {
ShareManualDecisions *bool `yaml:"share_manual_decisions"`
ShareTaintedScenarios *bool `yaml:"share_tainted"`
Expand Down