|
| 1 | +/* |
| 2 | +Copyright 2020 The Skaffold Authors |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package cluster |
| 18 | + |
| 19 | +import ( |
| 20 | + "encoding/json" |
| 21 | + "errors" |
| 22 | + "fmt" |
| 23 | + "net/url" |
| 24 | + "os" |
| 25 | + "os/exec" |
| 26 | + "path/filepath" |
| 27 | + |
| 28 | + "github.com/sirupsen/logrus" |
| 29 | + "k8s.io/apimachinery/pkg/runtime/schema" |
| 30 | + "k8s.io/client-go/rest" |
| 31 | + "k8s.io/client-go/util/homedir" |
| 32 | + |
| 33 | + "github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants" |
| 34 | + "github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes/context" |
| 35 | + "github.com/GoogleContainerTools/skaffold/pkg/skaffold/util" |
| 36 | +) |
| 37 | + |
| 38 | +var GetClient = getClient |
| 39 | + |
| 40 | +// To override during tests |
| 41 | +var ( |
| 42 | + minikubeBinaryFunc = minikubeBinary |
| 43 | + getRestClientConfigFunc = context.GetRestClientConfig |
| 44 | + getClusterInfo = context.GetClusterInfo |
| 45 | +) |
| 46 | + |
| 47 | +const ( |
| 48 | + VirtualBox = "virtualbox" |
| 49 | + HyperKit = "hyperkit" |
| 50 | +) |
| 51 | + |
| 52 | +type Client interface { |
| 53 | + // IsMinikube returns true if the given kubeContext maps to a minikube cluster |
| 54 | + IsMinikube(kubeContext string) bool |
| 55 | + // MinikubeExec returns the Cmd struct to execute minikube with given arguments |
| 56 | + MinikubeExec(arg ...string) (*exec.Cmd, error) |
| 57 | +} |
| 58 | + |
| 59 | +type clientImpl struct{} |
| 60 | + |
| 61 | +func getClient() Client { |
| 62 | + return clientImpl{} |
| 63 | +} |
| 64 | + |
| 65 | +func (clientImpl) IsMinikube(kubeContext string) bool { |
| 66 | + // short circuit if context is 'minikube' |
| 67 | + if kubeContext == constants.DefaultMinikubeContext { |
| 68 | + return true |
| 69 | + } |
| 70 | + if _, err := minikubeBinaryFunc(); err != nil { |
| 71 | + logrus.Tracef("Minikube cluster not detected: %v", err) |
| 72 | + return false |
| 73 | + } |
| 74 | + |
| 75 | + if ok, err := matchClusterCertPath(kubeContext); err != nil { |
| 76 | + logrus.Tracef("failed to match cluster certificate path: %v", err) |
| 77 | + } else if ok { |
| 78 | + logrus.Debugf("Minikube cluster detected: cluster certificate for context %q found inside the minikube directory", kubeContext) |
| 79 | + return true |
| 80 | + } |
| 81 | + |
| 82 | + if ok, err := matchProfileAndServerURL(kubeContext); err != nil { |
| 83 | + logrus.Tracef("failed to match minikube profile: %v", err) |
| 84 | + } else if ok { |
| 85 | + logrus.Debugf("Minikube cluster detected: context %q has matching profile name or server url", kubeContext) |
| 86 | + return true |
| 87 | + } |
| 88 | + logrus.Tracef("Minikube cluster not detected for context %q", kubeContext) |
| 89 | + return false |
| 90 | +} |
| 91 | + |
| 92 | +func (clientImpl) MinikubeExec(arg ...string) (*exec.Cmd, error) { |
| 93 | + return minikubeExec(arg...) |
| 94 | +} |
| 95 | + |
| 96 | +func minikubeExec(arg ...string) (*exec.Cmd, error) { |
| 97 | + b, err := minikubeBinaryFunc() |
| 98 | + if err != nil { |
| 99 | + return nil, fmt.Errorf("getting minikube executable: %w", err) |
| 100 | + } |
| 101 | + return exec.Command(b, arg...), nil |
| 102 | +} |
| 103 | + |
| 104 | +func minikubeBinary() (string, error) { |
| 105 | + execName := "minikube" |
| 106 | + if found, _ := util.DetectWSL(); found { |
| 107 | + execName = "minikube.exe" |
| 108 | + } |
| 109 | + filename, err := exec.LookPath(execName) |
| 110 | + if err != nil { |
| 111 | + return "", errors.New("unable to find minikube executable. Please add it to PATH environment variable") |
| 112 | + } |
| 113 | + if _, err := os.Stat(filename); os.IsNotExist(err) { |
| 114 | + return "", fmt.Errorf("unable to find minikube executable. File not found %s", filename) |
| 115 | + } |
| 116 | + return filename, nil |
| 117 | +} |
| 118 | + |
| 119 | +// matchClusterCertPath checks if the cluster certificate for this context is from inside the minikube directory |
| 120 | +func matchClusterCertPath(kubeContext string) (bool, error) { |
| 121 | + c, err := getClusterInfo(kubeContext) |
| 122 | + if err != nil { |
| 123 | + return false, fmt.Errorf("getting kubernetes config: %w", err) |
| 124 | + } |
| 125 | + if c.CertificateAuthority == "" { |
| 126 | + return false, nil |
| 127 | + } |
| 128 | + return util.IsSubPath(minikubePath(), c.CertificateAuthority), nil |
| 129 | +} |
| 130 | + |
| 131 | +// matchProfileAndServerURL checks if kubecontext matches any valid minikube profile |
| 132 | +// and for selected drivers if the k8s server url is same as any of the minikube nodes IPs |
| 133 | +func matchProfileAndServerURL(kubeContext string) (bool, error) { |
| 134 | + config, err := getRestClientConfigFunc() |
| 135 | + if err != nil { |
| 136 | + return false, fmt.Errorf("getting kubernetes config: %w", err) |
| 137 | + } |
| 138 | + apiServerURL, _, err := rest.DefaultServerURL(config.Host, config.APIPath, schema.GroupVersion{}, false) |
| 139 | + |
| 140 | + if err != nil { |
| 141 | + return false, fmt.Errorf("getting kubernetes server url: %w", err) |
| 142 | + } |
| 143 | + |
| 144 | + logrus.Tracef("kubernetes server url: %s", apiServerURL) |
| 145 | + |
| 146 | + ok, err := matchServerURLFor(kubeContext, apiServerURL) |
| 147 | + if err != nil { |
| 148 | + return false, fmt.Errorf("checking minikube node url: %w", err) |
| 149 | + } |
| 150 | + return ok, nil |
| 151 | +} |
| 152 | + |
| 153 | +func matchServerURLFor(kubeContext string, serverURL *url.URL) (bool, error) { |
| 154 | + cmd, _ := minikubeExec("profile", "list", "-o", "json") |
| 155 | + out, err := util.RunCmdOut(cmd) |
| 156 | + if err != nil { |
| 157 | + return false, fmt.Errorf("getting minikube profiles: %w", err) |
| 158 | + } |
| 159 | + |
| 160 | + var data data |
| 161 | + if err = json.Unmarshal(out, &data); err != nil { |
| 162 | + return false, fmt.Errorf("failed to unmarshal data: %w", err) |
| 163 | + } |
| 164 | + |
| 165 | + for _, v := range data.Valid { |
| 166 | + if v.Config.Name != kubeContext { |
| 167 | + continue |
| 168 | + } |
| 169 | + |
| 170 | + if v.Config.Driver != HyperKit && v.Config.Driver != VirtualBox { |
| 171 | + // Since node IPs don't match server API for other drivers we assume profile name match is enough. |
| 172 | + // TODO: Revisit once https://github.com/kubernetes/minikube/issues/6642 is fixed |
| 173 | + return true, nil |
| 174 | + } |
| 175 | + for _, n := range v.Config.Nodes { |
| 176 | + if serverURL.Host == fmt.Sprintf("%s:%d", n.IP, n.Port) { |
| 177 | + return true, nil |
| 178 | + } |
| 179 | + } |
| 180 | + } |
| 181 | + return false, nil |
| 182 | +} |
| 183 | + |
| 184 | +// minikubePath returns the path to the user's minikube dir |
| 185 | +func minikubePath() string { |
| 186 | + minikubeHomeEnv := os.Getenv("MINIKUBE_HOME") |
| 187 | + if minikubeHomeEnv == "" { |
| 188 | + return filepath.Join(homedir.HomeDir(), ".minikube") |
| 189 | + } |
| 190 | + if filepath.Base(minikubeHomeEnv) == ".minikube" { |
| 191 | + return minikubeHomeEnv |
| 192 | + } |
| 193 | + return filepath.Join(minikubeHomeEnv, ".minikube") |
| 194 | +} |
| 195 | + |
| 196 | +type data struct { |
| 197 | + Valid []profile `json:"valid,omitempty"` |
| 198 | + Invalid []profile `json:"invalid,omitempty"` |
| 199 | +} |
| 200 | + |
| 201 | +type profile struct { |
| 202 | + Config config |
| 203 | +} |
| 204 | + |
| 205 | +type config struct { |
| 206 | + Name string |
| 207 | + Driver string |
| 208 | + Nodes []node |
| 209 | +} |
| 210 | + |
| 211 | +type node struct { |
| 212 | + IP string |
| 213 | + Port int32 |
| 214 | +} |
0 commit comments