mirrors/k3d
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

👌 PR review

Browse Source 
Use `log.Fatalln(err)` instead of `log.Errorln(err)` + `os.Exit(1)`
Use Label prefix instead of LabelName suffix
Rename all secret occurence with token
This commit is contained in:
Antoine 2020-06-03 02:01:25 +02:00
parent 07be211bca
commit e3bf18660e
No known key found for this signature in database
GPG Key ID: 098FB66FC0475E70
9 changed files with 38 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmd/create/createCluster.go
View File

@ -115,7 +115,7 @@ func NewCmdCreateCluster() *cobra.Command {
cmd.Flags().IntP("workers", "w", 0, "Specify how many workers you want to create") cmd.Flags().IntP("workers", "w", 0, "Specify how many workers you want to create")
cmd.Flags().StringP("image", "i", fmt.Sprintf("%s:%s", k3d.DefaultK3sImageRepo, version.GetK3sVersion(false)), "Specify k3s image that you want to use for the nodes") cmd.Flags().StringP("image", "i", fmt.Sprintf("%s:%s", k3d.DefaultK3sImageRepo, version.GetK3sVersion(false)), "Specify k3s image that you want to use for the nodes")
cmd.Flags().String("network", "", "Join an existing network") cmd.Flags().String("network", "", "Join an existing network")
cmd.Flags().String("secret", "", "Specify a cluster secret. By default, we generate one.") cmd.Flags().String("token", "", "Specify a cluster token. By default, we generate one.")
cmd.Flags().StringArrayP("volume", "v", nil, "Mount volumes into the nodes (Format: `--volume [SOURCE:]DEST[@NODEFILTER[;NODEFILTER...]]`\n - Example: `k3d create -w 2 -v /my/path@worker[0,1] -v /tmp/test:/tmp/other@master[0]`") cmd.Flags().StringArrayP("volume", "v", nil, "Mount volumes into the nodes (Format: `--volume [SOURCE:]DEST[@NODEFILTER[;NODEFILTER...]]`\n - Example: `k3d create -w 2 -v /my/path@worker[0,1] -v /tmp/test:/tmp/other@master[0]`")
cmd.Flags().StringArrayP("port", "p", nil, "Map ports from the node containers to the host (Format: `[HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER]`)\n - Example: `k3d create -w 2 -p 8080:80@worker[0] -p 8081@worker[1]`") cmd.Flags().StringArrayP("port", "p", nil, "Map ports from the node containers to the host (Format: `[HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER]`)\n - Example: `k3d create -w 2 -p 8080:80@worker[0] -p 8081@worker[1]`")
cmd.Flags().BoolVar(&createClusterOpts.WaitForMaster, "wait", false, "Wait for the master(s) to be ready before returning. Use '--timeout DURATION' to not wait forever.") cmd.Flags().BoolVar(&createClusterOpts.WaitForMaster, "wait", false, "Wait for the master(s) to be ready before returning. Use '--timeout DURATION' to not wait forever.")
@ -206,8 +206,8 @@ func parseCreateClusterCmd(cmd *cobra.Command, args []string, createClusterOpts
log.Fatalln("Can only run a single node in hostnetwork mode") log.Fatalln("Can only run a single node in hostnetwork mode")
} }
// --secret // --token
secret, err := cmd.Flags().GetString("secret") token, err := cmd.Flags().GetString("token")
if err != nil { if err != nil {
log.Fatalln(err) log.Fatalln(err)
} }
@ -309,7 +309,7 @@ func parseCreateClusterCmd(cmd *cobra.Command, args []string, createClusterOpts
cluster := &k3d.Cluster{ cluster := &k3d.Cluster{
Name: clustername, Name: clustername,
Network: network, Network: network,
Secret: secret, Token: token,
CreateClusterOpts: createClusterOpts, CreateClusterOpts: createClusterOpts,
ExposeAPI: exposeAPI, ExposeAPI: exposeAPI,
} }

10
cmd/get/getClusterToken.go
View File

@ -74,8 +74,8 @@ func NewCmdGetClusterToken() *cobra.Command {
} }
} }
// pretty print secret // pretty print token
printSecret(clusters, getClusterTokenFlags.noHeader) printToken(clusters, getClusterTokenFlags.noHeader)
}, },
} }
@ -87,13 +87,13 @@ func NewCmdGetClusterToken() *cobra.Command {
return cmd return cmd
} }
func printSecret(clusters []*k3d.Cluster, headersOff bool) { func printToken(clusters []*k3d.Cluster, headersOff bool) {
tabwriter := tabwriter.NewWriter(os.Stdout, 6, 4, 3, ' ', tabwriter.RememberWidths) tabwriter := tabwriter.NewWriter(os.Stdout, 6, 4, 3, ' ', tabwriter.RememberWidths)
defer tabwriter.Flush() defer tabwriter.Flush()
if !headersOff { if !headersOff {
headers := []string{"CLUSTER", "SECRET"} headers := []string{"CLUSTER", "TOKEN"}
_, err := fmt.Fprintf(tabwriter, "%s\n", strings.Join(headers, "\t")) _, err := fmt.Fprintf(tabwriter, "%s\n", strings.Join(headers, "\t"))
if err != nil { if err != nil {
log.Fatalln("Failed to print headers") log.Fatalln("Failed to print headers")
@ -106,6 +106,6 @@ func printSecret(clusters []*k3d.Cluster, headersOff bool) {
}) })
for _, cluster := range clusters { for _, cluster := range clusters {
fmt.Fprintf(tabwriter, "%s\t%s\n", cluster.Name, string(cluster.Secret)) fmt.Fprintf(tabwriter, "%s\t%s\n", cluster.Name, string(cluster.Token))
} }
} }

6
cmd/root.go
View File

@ -67,8 +67,7 @@ All Nodes of a k3d cluster are part of the same docker network.`,
printVersion() printVersion()
} else { } else {
if err := cmd.Usage(); err != nil { if err := cmd.Usage(); err != nil {
log.Errorln(err) log.Fatalln(err)
os.Exit(1)
} }
} }
}, },
@ -78,8 +77,7 @@ All Nodes of a k3d cluster are part of the same docker network.`,
// This is called by main.main(). It only needs to happen once to the rootCmd. // This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() { func Execute() {
if err := rootCmd.Execute(); err != nil { if err := rootCmd.Execute(); err != nil {
log.Errorln(err) log.Fatalln(err)
os.Exit(1)
} }
} }

2
docs/usage/commands.md
View File

@ -14,7 +14,7 @@ k3d
--network # specify a network you want to connect to --network # specify a network you want to connect to
--no-image-volume # disable the creation of a volume for storing images (used for the 'k3d load image' command) --no-image-volume # disable the creation of a volume for storing images (used for the 'k3d load image' command)
-p, --port # add some more port mappings -p, --port # add some more port mappings
--secret # specify a cluster secret (default: auto-generated) --token # specify a cluster token (default: auto-generated)
--timeout # specify a timeout, after which the cluster creation will be interrupted and changes rolled back --timeout # specify a timeout, after which the cluster creation will be interrupted and changes rolled back
--update-kubeconfig # enable the automated update of the default kubeconfig with the details of the newly created cluster (also sets '--wait=true') --update-kubeconfig # enable the automated update of the default kubeconfig with the details of the newly created cluster (also sets '--wait=true')
--switch # (implies --update-kubeconfig) automatically sets the current-context of your default kubeconfig to the new cluster's context --switch # (implies --update-kubeconfig) automatically sets the current-context of your default kubeconfig to the new cluster's context

36
pkg/cluster/cluster.go
View File

@ -79,19 +79,19 @@ func CreateCluster(ctx context.Context, runtime k3drt.Runtime, cluster *k3d.Clus
} }
cluster.Network.Name = networkID cluster.Network.Name = networkID
extraLabels := map[string]string{ extraLabels := map[string]string{
k3d.NetworkLabelName: networkID, k3d.LabelNetwork: networkID,
k3d.NetworkExternalLabelName: strconv.FormatBool(cluster.Network.External), k3d.LabelNetworkExternal: strconv.FormatBool(cluster.Network.External),
} }
if networkExists { if networkExists {
extraLabels[k3d.NetworkExternalLabelName] = "true" // if the network wasn't created, we say that it's managed externally (important for cluster deletion) extraLabels[k3d.LabelNetworkExternal] = "true" // if the network wasn't created, we say that it's managed externally (important for cluster deletion)
} }
/* /*
* Cluster Secret * Cluster Token
*/ */
if cluster.Secret == "" { if cluster.Token == "" {
cluster.Secret = GenerateClusterSecret() cluster.Token = GenerateClusterToken()
} }
/* /*
@ -105,7 +105,7 @@ func CreateCluster(ctx context.Context, runtime k3drt.Runtime, cluster *k3d.Clus
return err return err
} }
extraLabels[k3d.ImageVolumeLabelName] = imageVolumeName extraLabels[k3d.LabelImageVolume] = imageVolumeName
// attach volume to nodes // attach volume to nodes
for _, node := range cluster.Nodes { for _, node := range cluster.Nodes {
@ -127,8 +127,8 @@ func CreateCluster(ctx context.Context, runtime k3drt.Runtime, cluster *k3d.Clus
node.Labels = make(map[string]string) // TODO: maybe create an init function? node.Labels = make(map[string]string) // TODO: maybe create an init function?
} }
node.Labels["k3d.cluster"] = cluster.Name node.Labels["k3d.cluster"] = cluster.Name
node.Env = append(node.Env, fmt.Sprintf("K3S_TOKEN=%s", cluster.Secret)) node.Env = append(node.Env, fmt.Sprintf("K3S_TOKEN=%s", cluster.Token))
node.Labels[k3d.SecretLabelName] = cluster.Secret node.Labels[k3d.LabelToken] = cluster.Token
node.Labels["k3d.cluster.url"] = connectionURL node.Labels["k3d.cluster.url"] = connectionURL
// append extra labels // append extra labels
@ -419,7 +419,7 @@ func populateClusterFieldsFromLabels(cluster *k3d.Cluster) error {
// get the name of the cluster network // get the name of the cluster network
if cluster.Network.Name == "" { if cluster.Network.Name == "" {
if networkName, ok := node.Labels[k3d.NetworkLabelName]; ok { if networkName, ok := node.Labels[k3d.LabelNetwork]; ok {
cluster.Network.Name = networkName cluster.Network.Name = networkName
} }
} }
@ -427,7 +427,7 @@ func populateClusterFieldsFromLabels(cluster *k3d.Cluster) error {
// check if the network is external // check if the network is external
// since the struct value is a bool, initialized as false, we cannot check if it's unset // since the struct value is a bool, initialized as false, we cannot check if it's unset
if !cluster.Network.External && !networkExternalSet { if !cluster.Network.External && !networkExternalSet {
if networkExternalString, ok := node.Labels[k3d.NetworkExternalLabelName]; ok { if networkExternalString, ok := node.Labels[k3d.LabelNetworkExternal]; ok {
if networkExternal, err := strconv.ParseBool(networkExternalString); err == nil { if networkExternal, err := strconv.ParseBool(networkExternalString); err == nil {
cluster.Network.External = networkExternal cluster.Network.External = networkExternal
networkExternalSet = true networkExternalSet = true
@ -437,15 +437,15 @@ func populateClusterFieldsFromLabels(cluster *k3d.Cluster) error {
// get image volume // TODO: enable external image volumes the same way we do it with networks // get image volume // TODO: enable external image volumes the same way we do it with networks
if cluster.ImageVolume == "" { if cluster.ImageVolume == "" {
if imageVolumeName, ok := node.Labels[k3d.ImageVolumeLabelName]; ok { if imageVolumeName, ok := node.Labels[k3d.LabelImageVolume]; ok {
cluster.ImageVolume = imageVolumeName cluster.ImageVolume = imageVolumeName
} }
} }
// get k3s cluster's secret // get k3s cluster's token
if cluster.Secret == "" { if cluster.Token == "" {
if secretToken, ok := node.Labels[k3d.SecretLabelName]; ok { if token, ok := node.Labels[k3d.LabelToken]; ok {
cluster.Secret = secretToken cluster.Token = token
} }
} }
} }
@ -493,8 +493,8 @@ func GetCluster(ctx context.Context, runtime k3drt.Runtime, cluster *k3d.Cluster
return cluster, nil return cluster, nil
} }
// GenerateClusterSecret generates a random 20 character string // GenerateClusterToken generates a random 20 character string
func GenerateClusterSecret() string { func GenerateClusterToken() string {
return util.GenerateRandomString(20) return util.GenerateRandomString(20)
} }

2
pkg/tools/tools.go
View File

@ -50,7 +50,7 @@ func LoadImagesIntoCluster(ctx context.Context, runtime runtimes.Runtime, images
var ok bool var ok bool
for _, node := range cluster.Nodes { for _, node := range cluster.Nodes {
if node.Role == k3d.MasterRole || node.Role == k3d.WorkerRole { if node.Role == k3d.MasterRole || node.Role == k3d.WorkerRole {
if imageVolume, ok = node.Labels[k3d.ImageVolumeLabelName]; ok { if imageVolume, ok = node.Labels[k3d.LabelImageVolume]; ok {
break break
} }
} }

10
pkg/types/types.go
View File

@ -76,10 +76,10 @@ var DefaultObjectLabels = map[string]string{
// List of k3d technical label name // List of k3d technical label name
const ( const (
SecretLabelName string = "k3d.cluster.secret" LabelToken string = "k3d.cluster.token"
ImageVolumeLabelName string = "k3d.cluster.imageVolume" LabelImageVolume string = "k3d.cluster.imageVolume"
NetworkExternalLabelName string = "k3d.cluster.network.external" LabelNetworkExternal string = "k3d.cluster.network.external"
NetworkLabelName string = "k3d.cluster.network" LabelNetwork string = "k3d.cluster.network"
) )
// DefaultRoleCmds maps the node roles to their respective default commands // DefaultRoleCmds maps the node roles to their respective default commands
@ -160,7 +160,7 @@ type ClusterNetwork struct {
type Cluster struct { type Cluster struct {
Name string `yaml:"name" json:"name,omitempty"` Name string `yaml:"name" json:"name,omitempty"`
Network ClusterNetwork `yaml:"network" json:"network,omitempty"` Network ClusterNetwork `yaml:"network" json:"network,omitempty"`
Secret string `yaml:"cluster_secret" json:"clusterSecret,omitempty"` Token string `yaml:"cluster_token" json:"clusterToken,omitempty"`
Nodes []*Node `yaml:"nodes" json:"nodes,omitempty"` Nodes []*Node `yaml:"nodes" json:"nodes,omitempty"`
InitNode *Node // init master node InitNode *Node // init master node
ExternalDatastore ExternalDatastore `yaml:"external_datastore" json:"externalDatastore,omitempty"` ExternalDatastore ExternalDatastore `yaml:"external_datastore" json:"externalDatastore,omitempty"`

2
pkg/util/files.go
View File

@ -43,7 +43,7 @@ func GetConfigDirOrCreate() (string, error) {
// create directories if necessary // create directories if necessary
if err := createDirIfNotExists(configDir); err != nil { if err := createDirIfNotExists(configDir); err != nil {
log.Errorln("Failed to create config path '%s'", configDir) log.Errorf("Failed to create config path '%s'", configDir)
return "", err return "", err
} }

2
pkg/util/randomString.go
View File

@ -37,7 +37,7 @@ const (
var src = rand.NewSource(time.Now().UnixNano()) var src = rand.NewSource(time.Now().UnixNano())
// GenerateRandomString thanks to https://stackoverflow.com/a/31832326/6450189 // GenerateRandomString thanks to https://stackoverflow.com/a/31832326/6450189
// GenerateRandomString is used to generate a random string that is used as a cluster secret // GenerateRandomString is used to generate a random string that is used as a cluster token
func GenerateRandomString(n int) string { func GenerateRandomString(n int) string {
sb := strings.Builder{} sb := strings.Builder{}