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.

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

Fix multi process kubeconfig access support #2380

Merged
merged 1 commit into from
Jun 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 20 additions & 20 deletions pkg/utils/kubeconfig/kubeconfig.go
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,10 @@ func AppendAuthenticator(config *clientcmdapi.Config, clusterMeta *api.ClusterMe
}
}

func lockFileName(filePath string) string {
return filePath + ".eksctl.lock"
}

// ensureDirectory should probably be handled in flock
func ensureDirectory(filePath string) error {
dir := filepath.Dir(filePath)
Expand All @@ -191,29 +195,25 @@ func ensureDirectory(filePath string) error {
return nil
}

func lockConfigFile(filePath string) error {
func lockConfigFile(filePath string) (*flock.Flock, error) {
lockFileName := lockFileName(filePath)
// Make sure the directory exists, otherwise flock fails
if err := ensureDirectory(filePath); err != nil {
return err
if err := ensureDirectory(lockFileName); err != nil {
return nil, err
}
flock := flock.New(filePath)
flock := flock.New(lockFileName)
err := flock.Lock()
if err != nil {
return errors.Wrap(err, "flock: failed to obtain exclusive lock on kubeconfig file")
return nil, errors.Wrap(err, "failed to obtain exclusive lock on kubeconfig lockfile")
}

return nil
return flock, nil
}

func unlockConfigFile(filePath string) error {
// Make sure the directory exists, otherwise flock fails
if err := ensureDirectory(filePath); err != nil {
return err
}
flock := flock.New(filePath)
err := flock.Unlock()
func unlockConfigFile(fl *flock.Flock) error {
err := fl.Unlock()
if err != nil {
return errors.Wrap(err, "flock: failed to release exclusive lock on kubeconfig file")
return errors.Wrap(err, "failed to release exclusive lock on kubeconfig lockfile")
}

return nil
Expand All @@ -226,13 +226,13 @@ func unlockConfigFile(filePath string) error {
func Write(path string, newConfig clientcmdapi.Config, setContext bool) (string, error) {
configAccess := getConfigAccess(path)
configFileName := configAccess.GetDefaultFilename()
err := lockConfigFile(configFileName)
fl, err := lockConfigFile(configFileName)
if err != nil {
return "", err
}

defer func() {
if err := unlockConfigFile(configFileName); err != nil {
if err := unlockConfigFile(fl); err != nil {
logger.Critical(err.Error())
}
}()
Expand Down Expand Up @@ -314,13 +314,13 @@ func MaybeDeleteConfig(meta *api.ClusterMeta) {
p := AutoPath(meta.Name)

if file.Exists(p) {
err := lockConfigFile(p)
fl, err := lockConfigFile(p)
if err != nil {
logger.Critical(err.Error())
}

defer func() {
if err := unlockConfigFile(p); err != nil {
if err := unlockConfigFile(fl); err != nil {
logger.Critical(err.Error())
}
}()
Expand All @@ -337,13 +337,13 @@ func MaybeDeleteConfig(meta *api.ClusterMeta) {

configAccess := getConfigAccess(DefaultPath())
defaultFilename := configAccess.GetDefaultFilename()
err := lockConfigFile(defaultFilename)
fl, err := lockConfigFile(defaultFilename)
if err != nil {
logger.Critical(err.Error())
}

defer func() {
if err := unlockConfigFile(defaultFilename); err != nil {
if err := unlockConfigFile(fl); err != nil {
logger.Critical(err.Error())
}
}()
Expand Down
27 changes: 16 additions & 11 deletions pkg/utils/kubeconfig/kubeconfig_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -312,35 +312,40 @@ var _ = Describe("Kubeconfig", func() {

It("safely handles concurrent read-modify-write operations", func() {
var (
oneClusterAsBytes []byte
twoClustersAsBytes []byte
oneCluster *api.Config
twoClusters *api.Config
)
ChangeKubeconfig()

var err error
tmp, err := ioutil.TempFile("", "")
Expect(err).To(BeNil())

if oneClusterAsBytes, err = ioutil.ReadFile("testdata/one_cluster.golden"); err != nil {
GinkgoT().Fatalf("failed reading .golden: %v", err)
}
{
if oneCluster, err = clientcmd.LoadFromFile("testdata/one_cluster.golden"); err != nil {
GinkgoT().Fatalf("failed reading .golden: %v", err)
}

if twoClustersAsBytes, err = ioutil.ReadFile("testdata/two_clusters.golden"); err != nil {
GinkgoT().Fatalf("failed reading .golden: %v", err)
if twoClusters, err = clientcmd.LoadFromFile("testdata/two_clusters.golden"); err != nil {
GinkgoT().Fatalf("failed reading .golden: %v", err)
}
}

var wg sync.WaitGroup
multiplier := 3
iters := 100
iters := 10
for i := 0; i < multiplier; i++ {
for k := 0; k < iters; k++ {
wg.Add(2)
wg.Add(1)
go func() {
defer wg.Done()
_, err := configFile.Write(oneClusterAsBytes)
_, err := kubeconfig.Write(tmp.Name(), *oneCluster, false)
Expect(err).To(BeNil())
}()
wg.Add(1)
go func() {
defer wg.Done()
_, err := configFile.Write(twoClustersAsBytes)
_, err := kubeconfig.Write(tmp.Name(), *twoClusters, false)
Expect(err).To(BeNil())
}()
}
Expand Down