mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-08-18 13:16:08 +00:00
Centralize + rename controller names and list (#2936)
* Centralize + rename controller names and list Signed-off-by: Carlisia <carlisia@vmware.com> * Rename file Signed-off-by: Carlisia <carlisia@vmware.com> * Reset restic-repo name Signed-off-by: Carlisia <carlisia@vmware.com> * Reset gc controller name Signed-off-by: Carlisia <carlisia@vmware.com>
This commit is contained in:
@@ -106,7 +106,7 @@ func NewBackupController(
|
||||
volumeSnapshotContentLister snapshotv1beta1listers.VolumeSnapshotContentLister,
|
||||
) Interface {
|
||||
c := &backupController{
|
||||
genericController: newGenericController("backup", logger),
|
||||
genericController: newGenericController(Backup, logger),
|
||||
discoveryHelper: discoveryHelper,
|
||||
backupper: backupper,
|
||||
lister: backupInformer.Lister(),
|
||||
@@ -150,7 +150,7 @@ func NewBackupController(
|
||||
|
||||
key, err := cache.MetaNamespaceKeyFunc(backup)
|
||||
if err != nil {
|
||||
c.logger.WithError(err).WithField("backup", backup).Error("Error creating queue key, item not added to queue")
|
||||
c.logger.WithError(err).WithField(Backup, backup).Error("Error creating queue key, item not added to queue")
|
||||
return
|
||||
}
|
||||
c.queue.Add(key)
|
||||
@@ -509,7 +509,7 @@ func (c *backupController) validateAndGetSnapshotLocations(backup *velerov1api.B
|
||||
// causes the backup to be Failed; if no error is returned, the backup's status's Errors
|
||||
// field is checked to see if the backup was a partial failure.
|
||||
func (c *backupController) runBackup(backup *pkgbackup.Request) error {
|
||||
c.logger.WithField("backup", kubeutil.NamespaceAndName(backup)).Info("Setting up backup log")
|
||||
c.logger.WithField(Backup, kubeutil.NamespaceAndName(backup)).Info("Setting up backup log")
|
||||
|
||||
logFile, err := ioutil.TempFile("", "")
|
||||
if err != nil {
|
||||
@@ -529,7 +529,7 @@ func (c *backupController) runBackup(backup *pkgbackup.Request) error {
|
||||
logCounter := logging.NewLogCounterHook()
|
||||
logger.Hooks.Add(logCounter)
|
||||
|
||||
backupLog := logger.WithField("backup", kubeutil.NamespaceAndName(backup))
|
||||
backupLog := logger.WithField(Backup, kubeutil.NamespaceAndName(backup))
|
||||
|
||||
backupLog.Info("Setting up backup temp file")
|
||||
backupFile, err := ioutil.TempFile("", "")
|
||||
|
||||
@@ -103,7 +103,7 @@ func NewBackupDeletionController(
|
||||
helper discovery.Helper,
|
||||
) Interface {
|
||||
c := &backupDeletionController{
|
||||
genericController: newGenericController("backup-deletion", logger),
|
||||
genericController: newGenericController(BackupDeletion, logger),
|
||||
deleteBackupRequestClient: deleteBackupRequestClient,
|
||||
deleteBackupRequestLister: deleteBackupRequestInformer.Lister(),
|
||||
backupClient: backupClient,
|
||||
|
||||
+3
-3
@@ -53,7 +53,7 @@ type BackupStorageLocationReconciler struct {
|
||||
// +kubebuilder:rbac:groups=velero.io,resources=backupstoragelocations,verbs=get;list;watch;create;update;patch;delete
|
||||
// +kubebuilder:rbac:groups=velero.io,resources=backupstoragelocations/status,verbs=get;update;patch
|
||||
func (r *BackupStorageLocationReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
|
||||
log := r.Log.WithField("controller", "backupstoragelocation")
|
||||
log := r.Log.WithField("controller", BackupStorageLocation)
|
||||
|
||||
log.Info("Checking for existing backup locations ready to be verified; there needs to be at least 1 backup location available")
|
||||
|
||||
@@ -71,7 +71,7 @@ func (r *BackupStorageLocationReconciler) Reconcile(req ctrl.Request) (ctrl.Resu
|
||||
var anyVerified bool
|
||||
for i := range locationList.Items {
|
||||
location := &locationList.Items[i]
|
||||
log := r.Log.WithField("controller", "backupstoragelocation").WithField("backupstoragelocation", location.Name)
|
||||
log := r.Log.WithField("controller", BackupStorageLocation).WithField(BackupStorageLocation, location.Name)
|
||||
|
||||
if location.Name == r.DefaultBackupLocationInfo.StorageLocation {
|
||||
defaultFound = true
|
||||
@@ -129,7 +129,7 @@ func (r *BackupStorageLocationReconciler) logReconciledPhase(defaultFound bool,
|
||||
var availableBSLs []*velerov1api.BackupStorageLocation
|
||||
var unAvailableBSLs []*velerov1api.BackupStorageLocation
|
||||
var unknownBSLs []*velerov1api.BackupStorageLocation
|
||||
log := r.Log.WithField("controller", "backupstoragelocation")
|
||||
log := r.Log.WithField("controller", BackupStorageLocation)
|
||||
|
||||
for i, location := range locationList.Items {
|
||||
phase := location.Status.Phase
|
||||
@@ -76,7 +76,7 @@ func NewBackupSyncController(
|
||||
logger.Infof("Backup sync period is %v", syncPeriod)
|
||||
|
||||
c := &backupSyncController{
|
||||
genericController: newGenericController("backup-sync", logger),
|
||||
genericController: newGenericController(BackupSync, logger),
|
||||
backupClient: backupClient,
|
||||
kbClient: kbClient,
|
||||
podVolumeBackupClient: podVolumeBackupClient,
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
/*
|
||||
Copyright 2020 the Velero contributors.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package controller
|
||||
|
||||
const (
|
||||
Backup = "backup"
|
||||
BackupDeletion = "backup-deletion"
|
||||
BackupStorageLocation = "backup-storage-location"
|
||||
BackupSync = "backup-sync"
|
||||
DownloadRequest = "download-request"
|
||||
GarbageCollection = "gc"
|
||||
PodVolumeBackup = "pod-volume-backup"
|
||||
PodVolumeRestore = "pod-volume-restore"
|
||||
ResticRepo = "restic-repo"
|
||||
Restore = "restore"
|
||||
Schedule = "schedule"
|
||||
ServerStatusRequest = "server-status-request"
|
||||
)
|
||||
|
||||
// DisableableControllers is a list of controllers that can be disabled
|
||||
var DisableableControllers = []string{
|
||||
Backup,
|
||||
BackupDeletion,
|
||||
BackupSync,
|
||||
DownloadRequest,
|
||||
GarbageCollection,
|
||||
ResticRepo,
|
||||
Restore,
|
||||
Schedule,
|
||||
ServerStatusRequest,
|
||||
}
|
||||
@@ -65,7 +65,7 @@ func NewDownloadRequestController(
|
||||
logger logrus.FieldLogger,
|
||||
) Interface {
|
||||
c := &downloadRequestController{
|
||||
genericController: newGenericController("downloadrequest", logger),
|
||||
genericController: newGenericController(DownloadRequest, logger),
|
||||
downloadRequestClient: downloadRequestClient,
|
||||
downloadRequestLister: downloadRequestInformer.Lister(),
|
||||
restoreLister: restoreLister,
|
||||
@@ -89,7 +89,7 @@ func NewDownloadRequestController(
|
||||
if err != nil {
|
||||
downloadRequest := obj.(*velerov1api.DownloadRequest)
|
||||
c.logger.WithError(errors.WithStack(err)).
|
||||
WithField("downloadRequest", downloadRequest.Name).
|
||||
WithField(DownloadRequest, downloadRequest.Name).
|
||||
Error("Error creating queue key, item not added to queue")
|
||||
return
|
||||
}
|
||||
@@ -213,7 +213,7 @@ func (c *downloadRequestController) resync() {
|
||||
for _, dr := range list {
|
||||
key, err := cache.MetaNamespaceKeyFunc(dr)
|
||||
if err != nil {
|
||||
c.logger.WithError(errors.WithStack(err)).WithField("downloadRequest", dr.Name).Error("error generating key for download request")
|
||||
c.logger.WithError(errors.WithStack(err)).WithField(DownloadRequest, dr.Name).Error("error generating key for download request")
|
||||
continue
|
||||
}
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ func NewGCController(
|
||||
kbClient client.Client,
|
||||
) Interface {
|
||||
c := &gcController{
|
||||
genericController: newGenericController("gc-controller", logger),
|
||||
genericController: newGenericController(GarbageCollection, logger),
|
||||
clock: clock.RealClock{},
|
||||
backupLister: backupInformer.Lister(),
|
||||
deleteBackupRequestLister: deleteBackupRequestLister,
|
||||
|
||||
@@ -81,7 +81,7 @@ func NewPodVolumeBackupController(
|
||||
nodeName string,
|
||||
) Interface {
|
||||
c := &podVolumeBackupController{
|
||||
genericController: newGenericController("pod-volume-backup", logger),
|
||||
genericController: newGenericController(PodVolumeBackup, logger),
|
||||
podVolumeBackupClient: podVolumeBackupClient,
|
||||
podVolumeBackupLister: podVolumeBackupInformer.Lister(),
|
||||
podLister: corev1listers.NewPodLister(podInformer.GetIndexer()),
|
||||
|
||||
@@ -155,7 +155,7 @@ func TestPVBHandler(t *testing.T) {
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
c := &podVolumeBackupController{
|
||||
genericController: newGenericController("pod-volume-backup", velerotest.NewLogger()),
|
||||
genericController: newGenericController(PodVolumeBackup, velerotest.NewLogger()),
|
||||
nodeName: controllerNode,
|
||||
metrics: metrics.NewResticServerMetrics(),
|
||||
}
|
||||
|
||||
@@ -81,7 +81,7 @@ func NewPodVolumeRestoreController(
|
||||
nodeName string,
|
||||
) Interface {
|
||||
c := &podVolumeRestoreController{
|
||||
genericController: newGenericController("pod-volume-restore", logger),
|
||||
genericController: newGenericController(PodVolumeRestore, logger),
|
||||
podVolumeRestoreClient: podVolumeRestoreClient,
|
||||
podVolumeRestoreLister: podVolumeRestoreInformer.Lister(),
|
||||
podLister: corev1listers.NewPodLister(podInformer.GetIndexer()),
|
||||
|
||||
@@ -211,7 +211,7 @@ func TestPVRHandler(t *testing.T) {
|
||||
var (
|
||||
podInformer = cache.NewSharedIndexInformer(nil, new(corev1api.Pod), 0, cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc})
|
||||
c = &podVolumeRestoreController{
|
||||
genericController: newGenericController("pod-volume-restore", velerotest.NewLogger()),
|
||||
genericController: newGenericController(PodVolumeRestore, velerotest.NewLogger()),
|
||||
podLister: corev1listers.NewPodLister(podInformer.GetIndexer()),
|
||||
nodeName: controllerNode,
|
||||
}
|
||||
@@ -394,7 +394,7 @@ func TestPodHandler(t *testing.T) {
|
||||
informers = veleroinformers.NewSharedInformerFactory(client, 0)
|
||||
pvrInformer = informers.Velero().V1().PodVolumeRestores()
|
||||
c = &podVolumeRestoreController{
|
||||
genericController: newGenericController("pod-volume-restore", velerotest.NewLogger()),
|
||||
genericController: newGenericController(PodVolumeRestore, velerotest.NewLogger()),
|
||||
podVolumeRestoreLister: velerov1listers.NewPodVolumeRestoreLister(pvrInformer.Informer().GetIndexer()),
|
||||
nodeName: controllerNode,
|
||||
}
|
||||
|
||||
@@ -63,7 +63,7 @@ func NewResticRepositoryController(
|
||||
defaultMaintenanceFrequency time.Duration,
|
||||
) Interface {
|
||||
c := &resticRepositoryController{
|
||||
genericController: newGenericController("restic-repository", logger),
|
||||
genericController: newGenericController(ResticRepo, logger),
|
||||
resticRepositoryClient: resticRepositoryClient,
|
||||
resticRepositoryLister: resticRepositoryInformer.Lister(),
|
||||
kbClient: kbClient,
|
||||
|
||||
@@ -114,7 +114,7 @@ func NewRestoreController(
|
||||
logFormat logging.Format,
|
||||
) Interface {
|
||||
c := &restoreController{
|
||||
genericController: newGenericController("restore", logger),
|
||||
genericController: newGenericController(Restore, logger),
|
||||
namespace: namespace,
|
||||
restoreClient: restoreClient,
|
||||
podVolumeBackupClient: podVolumeBackupClient,
|
||||
|
||||
@@ -66,7 +66,7 @@ func NewScheduleController(
|
||||
metrics *metrics.ServerMetrics,
|
||||
) *scheduleController {
|
||||
c := &scheduleController{
|
||||
genericController: newGenericController("schedule", logger),
|
||||
genericController: newGenericController(Schedule, logger),
|
||||
namespace: namespace,
|
||||
schedulesClient: schedulesClient,
|
||||
backupsClient: backupsClient,
|
||||
|
||||
@@ -57,7 +57,7 @@ type ServerStatusRequestReconciler struct {
|
||||
// +kubebuilder:rbac:groups=velero.io,resources=serverstatusrequests/status,verbs=get;update;patch
|
||||
func (r *ServerStatusRequestReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
|
||||
log := r.Log.WithFields(logrus.Fields{
|
||||
"controller": "serverstatusrequest",
|
||||
"controller": ServerStatusRequest,
|
||||
"serverStatusRequest": req.NamespacedName,
|
||||
})
|
||||
|
||||
@@ -76,7 +76,7 @@ func (r *ServerStatusRequestReconciler) Reconcile(req ctrl.Request) (ctrl.Result
|
||||
}
|
||||
|
||||
log = r.Log.WithFields(logrus.Fields{
|
||||
"controller": "serverstatusrequest",
|
||||
"controller": ServerStatusRequest,
|
||||
"serverStatusRequest": req.NamespacedName,
|
||||
"phase": statusRequest.Status.Phase,
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user