Skip to content

OCPBUGS-33013: certsyncpod+installerpod: Swap secret/cm directories atomically #2009

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

OCPBUGS-33013: certsyncpod+installerpod: Swap secret/cm directories atomically #2009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
130 changes: 69 additions & 61 deletions pkg/operator/staticpod/certsyncpod/certsync_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ package certsyncpod

import (
"context"
"fmt"
"os"
"path/filepath"
"reflect"

"github.com/openshift/library-go/pkg/operator/staticpod/internal/atomicdir/types"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
Expand All @@ -17,17 +19,19 @@ import (

"github.com/openshift/library-go/pkg/controller/factory"
"github.com/openshift/library-go/pkg/operator/events"
"github.com/openshift/library-go/pkg/operator/staticpod"
"github.com/openshift/library-go/pkg/operator/staticpod/controller/installer"
"github.com/openshift/library-go/pkg/operator/staticpod/internal/atomicdir"
)

const stagingDirUID = "cert-sync"

type CertSyncController struct {
destinationDir string
namespace string
configMaps []installer.UnrevisionedResource
secrets []installer.UnrevisionedResource

configmapGetter corev1interface.ConfigMapInterface
configMapGetter corev1interface.ConfigMapInterface
configMapLister v1.ConfigMapLister
secretGetter corev1interface.SecretInterface
secretLister v1.SecretLister
Expand All @@ -42,10 +46,10 @@ func NewCertSyncController(targetDir, targetNamespace string, configmaps, secret
secrets: secrets,
eventRecorder: eventRecorder.WithComponentSuffix("cert-sync-controller"),

configmapGetter: kubeClient.CoreV1().ConfigMaps(targetNamespace),
configMapGetter: kubeClient.CoreV1().ConfigMaps(targetNamespace),
configMapLister: informers.Core().V1().ConfigMaps().Lister(),
secretLister: informers.Core().V1().Secrets().Lister(),
secretGetter: kubeClient.CoreV1().Secrets(targetNamespace),
secretLister: informers.Core().V1().Secrets().Lister(),
}

return factory.New().
Expand All @@ -60,15 +64,12 @@ func NewCertSyncController(targetDir, targetNamespace string, configmaps, secret
)
}

func getConfigMapDir(targetDir, configMapName string) string {
return filepath.Join(targetDir, "configmaps", configMapName)
}

func getSecretDir(targetDir, secretName string) string {
return filepath.Join(targetDir, "secrets", secretName)
}

func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncContext) error {
if err := os.RemoveAll(getStagingDir(c.destinationDir)); err != nil {
c.eventRecorder.Warningf("CertificateUpdateFailed", fmt.Sprintf("Failed to prune staging directory: %v", err))
return err
}

errors := []error{}

klog.Infof("Syncing configmaps: %v", c.configMaps)
Expand All @@ -80,15 +81,15 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
continue

case apierrors.IsNotFound(err) && cm.Optional:
configMapFile := getConfigMapDir(c.destinationDir, cm.Name)
configMapFile := getConfigMapTargetDir(c.destinationDir, cm.Name)
if _, err := os.Stat(configMapFile); os.IsNotExist(err) {
// if the configmap file does not exist, there is no work to do, so skip making any live check and just return.
// if the configmap actually exists in the API, we'll eventually see it on the watch.
continue
}

// Check with the live call it is really missing
configMap, err = c.configmapGetter.Get(ctx, cm.Name, metav1.GetOptions{})
configMap, err = c.configMapGetter.Get(ctx, cm.Name, metav1.GetOptions{})
if err == nil {
klog.Infof("Caches are stale. They don't see configmap '%s/%s', yet it is present", configMap.Namespace, configMap.Name)
// We will get re-queued when we observe the change
Expand All @@ -113,9 +114,10 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
continue
}

contentDir := getConfigMapDir(c.destinationDir, cm.Name)
contentDir := getConfigMapTargetDir(c.destinationDir, cm.Name)
stagingDir := getConfigMapStagingDir(c.destinationDir, cm.Name)

data := map[string]string{}
data := make(map[string]string, len(configMap.Data))
for filename := range configMap.Data {
fullFilename := filepath.Join(contentDir, filename)

Expand All @@ -138,7 +140,7 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
klog.V(2).Infof("Syncing updated configmap '%s/%s'.", configMap.Namespace, configMap.Name)

// We need to do a live get here so we don't overwrite a newer file with one from a stale cache
configMap, err = c.configmapGetter.Get(ctx, configMap.Name, metav1.GetOptions{})
configMap, err = c.configMapGetter.Get(ctx, configMap.Name, metav1.GetOptions{})
if err != nil {
// Even if the error is not exists we will act on it when caches catch up
c.eventRecorder.Warningf("CertificateUpdateFailed", "Failed getting configmap: %s/%s: %v", c.namespace, cm.Name, err)
Expand All @@ -152,27 +154,11 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
continue
}

klog.Infof("Creating directory %q ...", contentDir)
if err := os.MkdirAll(contentDir, 0755); err != nil && !os.IsExist(err) {
c.eventRecorder.Warningf("CertificateUpdateFailed", "Failed creating directory for configmap: %s/%s: %v", configMap.Namespace, configMap.Name, err)
errors = append(errors, err)
continue
}
for filename, content := range configMap.Data {
fullFilename := filepath.Join(contentDir, filename)
// if the existing is the same, do nothing
if reflect.DeepEqual(data[fullFilename], content) {
continue
}

klog.Infof("Writing configmap manifest %q ...", fullFilename)
if err := staticpod.WriteFileAtomic([]byte(content), 0644, fullFilename); err != nil {
c.eventRecorder.Warningf("CertificateUpdateFailed", "Failed writing file for configmap: %s/%s: %v", configMap.Namespace, configMap.Name, err)
errors = append(errors, err)
continue
}
files := make(map[string][]byte, len(configMap.Data))
for k, v := range configMap.Data {
files[k] = []byte(v)
}
c.eventRecorder.Eventf("CertificateUpdated", "Wrote updated configmap: %s/%s", configMap.Namespace, configMap.Name)
errors = append(errors, syncDirectory(c.eventRecorder, "configmap", configMap.ObjectMeta, contentDir, 0755, stagingDir, files, 0644))
}

klog.Infof("Syncing secrets: %v", c.secrets)
Expand All @@ -184,7 +170,7 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
continue

case apierrors.IsNotFound(err) && s.Optional:
secretFile := getSecretDir(c.destinationDir, s.Name)
secretFile := getSecretTargetDir(c.destinationDir, s.Name)
if _, err := os.Stat(secretFile); os.IsNotExist(err) {
// if the secret file does not exist, there is no work to do, so skip making any live check and just return.
// if the secret actually exists in the API, we'll eventually see it on the watch.
Expand Down Expand Up @@ -218,9 +204,10 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
continue
}

contentDir := getSecretDir(c.destinationDir, s.Name)
contentDir := getSecretTargetDir(c.destinationDir, s.Name)
stagingDir := getSecretStagingDir(c.destinationDir, s.Name)

data := map[string][]byte{}
data := make(map[string][]byte, len(secret.Data))
for filename := range secret.Data {
fullFilename := filepath.Join(contentDir, filename)

Expand Down Expand Up @@ -257,29 +244,50 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
continue
}

klog.Infof("Creating directory %q ...", contentDir)
if err := os.MkdirAll(contentDir, 0755); err != nil && !os.IsExist(err) {
c.eventRecorder.Warningf("CertificateUpdateFailed", "Failed creating directory for secret: %s/%s: %v", secret.Namespace, secret.Name, err)
errors = append(errors, err)
continue
}
for filename, content := range secret.Data {
// TODO fix permissions
fullFilename := filepath.Join(contentDir, filename)
// if the existing is the same, do nothing
if reflect.DeepEqual(data[fullFilename], content) {
continue
}
errors = append(errors, syncDirectory(c.eventRecorder, "secret", secret.ObjectMeta, contentDir, 0755, stagingDir, secret.Data, 0600))
}
return utilerrors.NewAggregate(errors)
}

klog.Infof("Writing secret manifest %q ...", fullFilename)
if err := staticpod.WriteFileAtomic(content, 0600, fullFilename); err != nil {
c.eventRecorder.Warningf("CertificateUpdateFailed", "Failed writing file for secret: %s/%s: %v", secret.Namespace, secret.Name, err)
errors = append(errors, err)
continue
}
func syncDirectory(
eventRecorder events.Recorder,
typeName string, o metav1.ObjectMeta,
targetDir string, targetDirPerm os.FileMode, stagingDir string,
fileContents map[string][]byte, filePerm os.FileMode,
) error {
files := make(map[string]types.File, len(fileContents))
for filename, content := range fileContents {
files[filename] = types.File{
Content: content,
Perm: filePerm,
}
c.eventRecorder.Eventf("CertificateUpdated", "Wrote updated secret: %s/%s", secret.Namespace, secret.Name)
}

return utilerrors.NewAggregate(errors)
if err := atomicdir.Sync(targetDir, targetDirPerm, stagingDir, files); err != nil {
err = fmt.Errorf("failed to sync %s %s/%s (directory %q): %w", typeName, o.Name, o.Namespace, targetDir, err)
eventRecorder.Warning("CertificateUpdateFailed", err.Error())
return err
}
eventRecorder.Eventf("CertificateUpdated", "Wrote updated %s: %s/%s", typeName, o.Namespace, o.Name)
return nil
}

func getStagingDir(targetDir string) string {
return filepath.Join(targetDir, "staging", stagingDirUID)
}

func getConfigMapTargetDir(targetDir, configMapName string) string {
return filepath.Join(targetDir, "configmaps", configMapName)
}

func getConfigMapStagingDir(targetDir, configMapName string) string {
return filepath.Join(getStagingDir(targetDir), "configmaps", configMapName)
}

func getSecretTargetDir(targetDir, secretName string) string {
return filepath.Join(targetDir, "secrets", secretName)
}

func getSecretStagingDir(targetDir, secretName string) string {
return filepath.Join(getStagingDir(targetDir), "secrets", secretName)
}
Loading