Skip to content
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

Functionality -> Feature in CODE #310

Merged
merged 2 commits into from
Apr 8, 2024
Merged

Functionality -> Feature in CODE #310

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
1e7697e
Functionali{ty,ties} -> Feature{s} in code
eaudetcobello Apr 8, 2024
61e2c6c
Something
eaudetcobello Apr 8, 2024
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
2 changes: 1 addition & 1 deletion docs/src/_parts/commands/k8s_enable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## k8s enable

Enable core cluster feature
Enable core cluster features

### Synopsis

Expand Down
24 changes: 12 additions & 12 deletions src/k8s/cmd/k8s/k8s_disable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,31 @@ import (
)

type DisableResult struct {
Functionalities []string `json:"functionalities" yaml:"functionalities"`
Features []string `json:"features" yaml:"features"`
}

func (d DisableResult) String() string {
return fmt.Sprintf("%s disabled.\n", strings.Join(d.Functionalities, ", "))
return fmt.Sprintf("%s disabled.\n", strings.Join(d.Features, ", "))
}

func newDisableCmd(env cmdutil.ExecutionEnvironment) *cobra.Command {
cmd := &cobra.Command{
Use: "disable <functionality> ...",
Short: "Disable core cluster functionalities",
Use: "disable <feature> ...",
Short: "Disable core cluster features",
Long: fmt.Sprintf("Disable one of %s.", strings.Join(componentList, ", ")),
Args: cmdutil.MinimumNArgs(env, 1),
PreRun: chainPreRunHooks(hookRequireRoot(env)),
Run: func(cmd *cobra.Command, args []string) {
config := api.UserFacingClusterConfig{}
functionalities := args
for _, functionality := range functionalities {
if !slices.Contains(componentList, functionality) {
cmd.PrintErrf("Error: Cannot disable %q, must be one of: %s\n", functionality, strings.Join(componentList, ", "))
features := args
for _, feature := range features {
if !slices.Contains(componentList, feature) {
cmd.PrintErrf("Error: Cannot disable %q, must be one of: %s\n", feature, strings.Join(componentList, ", "))
env.Exit(1)
return
}

switch functionality {
switch feature {
case "network":
config.Network = api.NetworkConfig{
Enabled: vals.Pointer(false),
Expand Down Expand Up @@ -78,14 +78,14 @@ func newDisableCmd(env cmdutil.ExecutionEnvironment) *cobra.Command {
return
}

cmd.PrintErrf("Disabling %s from the cluster. This may take a few seconds, please wait.\n", strings.Join(functionalities, ", "))
cmd.PrintErrf("Disabling %s from the cluster. This may take a few seconds, please wait.\n", strings.Join(features, ", "))
if err := client.UpdateClusterConfig(cmd.Context(), request); err != nil {
cmd.PrintErrf("Error: Failed to disable %s from the cluster.\n\nThe error was: %v\n", strings.Join(functionalities, ", "), err)
cmd.PrintErrf("Error: Failed to disable %s from the cluster.\n\nThe error was: %v\n", strings.Join(features, ", "), err)
env.Exit(1)
return
}

if err := cmdutil.FormatterFromContext(cmd.Context()).Print(DisableResult{Functionalities: functionalities}); err != nil {
if err := cmdutil.FormatterFromContext(cmd.Context()).Print(DisableResult{Features: features}); err != nil {
cmd.PrintErrf("WARNING: Failed to print the disable result.\n\nThe error was: %v\n", err)
}
},
Expand Down
24 changes: 12 additions & 12 deletions src/k8s/cmd/k8s/k8s_enable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,31 @@ import (
)

type EnableResult struct {
Functionalities []string `json:"functionalities" yaml:"functionalities"`
Features []string `json:"features" yaml:"features"`
}

func (e EnableResult) String() string {
return fmt.Sprintf("%s enabled.\n", strings.Join(e.Functionalities, ", "))
return fmt.Sprintf("%s enabled.\n", strings.Join(e.Features, ", "))
}

func newEnableCmd(env cmdutil.ExecutionEnvironment) *cobra.Command {
cmd := &cobra.Command{
Use: "enable <functionality> ...",
Short: "Enable core cluster functionalities",
Use: "enable <feature> ...",
Short: "Enable core cluster features",
Long: fmt.Sprintf("Enable one of %s.", strings.Join(componentList, ", ")),
Args: cmdutil.MinimumNArgs(env, 1),
PreRun: chainPreRunHooks(hookRequireRoot(env)),
Run: func(cmd *cobra.Command, args []string) {
config := api.UserFacingClusterConfig{}
functionalities := args
for _, functionality := range functionalities {
if !slices.Contains(componentList, functionality) {
cmd.PrintErrf("Error: Cannot enable %q, must be one of: %s\n", functionality, strings.Join(componentList, ", "))
features := args
for _, feature := range features {
if !slices.Contains(componentList, feature) {
cmd.PrintErrf("Error: Cannot enable %q, must be one of: %s\n", feature, strings.Join(componentList, ", "))
env.Exit(1)
return
}

switch functionality {
switch feature {
case "network":
config.Network = api.NetworkConfig{
Enabled: vals.Pointer(true),
Expand Down Expand Up @@ -78,14 +78,14 @@ func newEnableCmd(env cmdutil.ExecutionEnvironment) *cobra.Command {
return
}

cmd.PrintErrf("Enabling %s on the cluster. This may take a few seconds, please wait.\n", strings.Join(functionalities, ", "))
cmd.PrintErrf("Enabling %s on the cluster. This may take a few seconds, please wait.\n", strings.Join(features, ", "))
if err := client.UpdateClusterConfig(cmd.Context(), request); err != nil {
cmd.PrintErrf("Error: Failed to enable %s on the cluster.\n\nThe error was: %v\n", strings.Join(functionalities, ", "), err)
cmd.PrintErrf("Error: Failed to enable %s on the cluster.\n\nThe error was: %v\n", strings.Join(features, ", "), err)
env.Exit(1)
return
}

if err := cmdutil.FormatterFromContext(cmd.Context()).Print(EnableResult{Functionalities: functionalities}); err != nil {
if err := cmdutil.FormatterFromContext(cmd.Context()).Print(EnableResult{Features: features}); err != nil {
cmd.PrintErrf("WARNING: Failed to print the enable result.\n\nThe error was: %v\n", err)
}
},
Expand Down
2 changes: 1 addition & 1 deletion src/k8s/cmd/k8s/k8s_get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (

func newGetCmd(env cmdutil.ExecutionEnvironment) *cobra.Command {
getCmd := &cobra.Command{
Use: "get <functionality.key>",
Use: "get <feature.key>",
Short: "get cluster configuration",
Long: fmt.Sprintf("Show configuration of one of %s.", strings.Join(componentList, ", ")),
Args: cmdutil.MaximumNArgs(env, 1),
Expand Down
2 changes: 1 addition & 1 deletion src/k8s/cmd/k8s/k8s_set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func (s SetResult) String() string {

func newSetCmd(env cmdutil.ExecutionEnvironment) *cobra.Command {
return &cobra.Command{
Use: "set <functionality.key=value> ...",
Use: "set <feature.key=value> ...",
Short: "Set cluster configuration",
Long: fmt.Sprintf("Configure one of %s.\nUse `k8s get` to explore configuration options.", strings.Join(componentList, ", ")),
Args: cmdutil.MinimumNArgs(env, 1),
Expand Down
2 changes: 1 addition & 1 deletion src/k8s/pkg/k8sd/api/endpoints.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func (e *Endpoints) Endpoints() []rest.Endpoint {
Path: "k8sd/kubeconfig",
Get: rest.EndpointAction{Handler: e.getKubeconfig, AccessHandler: e.restrictWorkers},
},
// Get and modify the cluster configuration (e.g. to enable/disable functionalities)
// Get and modify the cluster configuration (e.g. to enable/disable features)
{
Name: "ClusterConfig",
Path: "k8sd/cluster/config",
Expand Down
Loading