Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-25 23:49:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Allow unset 'name' key but print warning if unset (#1208)

Browse Source 
* Allow unset name key in config but print warning if unset

* Print deprecation warnings for config to os.Stderr

---------

Signed-off-by: Daniel Weiße <dw@edgeless.systems>
This commit is contained in:
Daniel Weiße 2023-02-17 09:05:42 +01:00 committed by GitHub
parent d90828cb3c
commit f70447bf7d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
internal/config/config.go
View File

@ -50,6 +50,8 @@ type Digests = idkeydigest.IDKeyDigests
const ( const (
// Version2 is the second version number for Constellation config file. // Version2 is the second version number for Constellation config file.
Version2 = "v2" Version2 = "v2"
defaultName = "constell"
) )
// Config defines configuration used by CLI. // Config defines configuration used by CLI.
@ -62,7 +64,7 @@ type Config struct {
Image string `yaml:"image" validate:"required,version_compatibility"` Image string `yaml:"image" validate:"required,version_compatibility"`
// description: | // description: |
// Name of the cluster. // Name of the cluster.
Name string `yaml:"name" validate:"required,valid_name"` Name string `yaml:"name" validate:"valid_name"` // TODO: v2.7: Use "required" validation for name
// description: | // description: |
// Size (in GB) of a node's disk to store the non-volatile state. // Size (in GB) of a node's disk to store the non-volatile state.
StateDiskSizeGB int `yaml:"stateDiskSizeGB" validate:"min=0"` StateDiskSizeGB int `yaml:"stateDiskSizeGB" validate:"min=0"`
@ -255,7 +257,7 @@ func Default() *Config {
return &Config{ return &Config{
Version: Version2, Version: Version2,
Image: defaultImage, Image: defaultImage,
Name: "constell", Name: defaultName,
MicroserviceVersion: compatibility.EnsurePrefixV(constants.VersionInfo), MicroserviceVersion: compatibility.EnsurePrefixV(constants.VersionInfo),
KubernetesVersion: string(versions.Default), KubernetesVersion: string(versions.Default),
StateDiskSizeGB: 30, StateDiskSizeGB: 30,

2
internal/config/config_doc.go
View File

@ -37,7 +37,7 @@ func init() {
ConfigDoc.Fields[1].Comments[encoder.LineComment] = "Machine image version used to create Constellation nodes." ConfigDoc.Fields[1].Comments[encoder.LineComment] = "Machine image version used to create Constellation nodes."
ConfigDoc.Fields[2].Name = "name" ConfigDoc.Fields[2].Name = "name"
ConfigDoc.Fields[2].Type = "string" ConfigDoc.Fields[2].Type = "string"
ConfigDoc.Fields[2].Note = "" ConfigDoc.Fields[2].Note = "TODO: v2.7: Use \"required\" validation for name\n"
ConfigDoc.Fields[2].Description = "Name of the cluster." ConfigDoc.Fields[2].Description = "Name of the cluster."
ConfigDoc.Fields[2].Comments[encoder.LineComment] = "Name of the cluster." ConfigDoc.Fields[2].Comments[encoder.LineComment] = "Name of the cluster."
ConfigDoc.Fields[3].Name = "stateDiskSizeGB" ConfigDoc.Fields[3].Name = "stateDiskSizeGB"

9
internal/config/validation.go
View File

@ -11,6 +11,7 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"os"
"sort" "sort"
"strconv" "strconv"
"strings" "strings"
@ -384,7 +385,7 @@ func validateUpgradeConfig(sl validator.StructLevel) {
if config.Image == "" && config.CSP == cloudprovider.Unknown && config.Measurements == nil { if config.Image == "" && config.CSP == cloudprovider.Unknown && config.Measurements == nil {
return return
} }
fmt.Println("WARNING: the config key `upgrade` will be deprecated in an upcoming version. Please check the documentation for more information.") fmt.Fprintln(os.Stderr, "WARNING: the config key `upgrade` will be deprecated in an upcoming version. Please check the documentation for more information.")
} }
func registerValidateNameError(ut ut.Translator) error { func registerValidateNameError(ut ut.Translator) error {
@ -406,6 +407,12 @@ func (c *Config) translateValidateNameError(ut ut.Translator, fe validator.Field
// Since this value may differ between providers, we can't simply use built-in validation. // Since this value may differ between providers, we can't simply use built-in validation.
// This also allows us to eventually add more validation rules for constellation names if necessary. // This also allows us to eventually add more validation rules for constellation names if necessary.
func (c *Config) validateName(fl validator.FieldLevel) bool { func (c *Config) validateName(fl validator.FieldLevel) bool {
// TODO: v2.7: remove fallback to defaultName and make name a required field
if c.Name == "" {
fmt.Fprintln(os.Stderr, "WARNING: the config key `name` is not set. This key will be required in the next version. Falling back to default name.")
c.Name = defaultName
}
if c.Provider.AWS != nil { if c.Provider.AWS != nil {
return len(fl.Field().String()) <= constants.AWSConstellationNameLength return len(fl.Field().String()) <= constants.AWSConstellationNameLength
} }