mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-01-09 22:47:27 +00:00
5150ce4891
Added ItemSnapshotter.proto Added item_snapshotter Go interface Added framework components for item_snapshotter Updated plugins doc with ItemSnapshotter info Added SnapshotPhase to item_snapshotter.go ProgressOutputOutput now includes a phase as well as an error string for problems that occured Signed-off-by: Dave Smith-Uchida <dsmithuchida@vmware.com>
88 lines
3.4 KiB
Go
88 lines
3.4 KiB
Go
/*
|
|
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 clientmgmt contains the plugin client for Velero.
|
|
package clientmgmt
|
|
|
|
import (
|
|
"os"
|
|
"os/exec"
|
|
|
|
hclog "github.com/hashicorp/go-hclog"
|
|
hcplugin "github.com/hashicorp/go-plugin"
|
|
"github.com/sirupsen/logrus"
|
|
|
|
"github.com/vmware-tanzu/velero/pkg/features"
|
|
"github.com/vmware-tanzu/velero/pkg/plugin/framework"
|
|
)
|
|
|
|
// clientBuilder builds go-plugin Clients.
|
|
type clientBuilder struct {
|
|
commandName string
|
|
commandArgs []string
|
|
clientLogger logrus.FieldLogger
|
|
pluginLogger hclog.Logger
|
|
}
|
|
|
|
// newClientBuilder returns a new clientBuilder with commandName to name. If the command matches the currently running
|
|
// process (i.e. velero), this also sets commandArgs to the internal Velero command to run plugins.
|
|
func newClientBuilder(command string, logger logrus.FieldLogger, logLevel logrus.Level) *clientBuilder {
|
|
b := &clientBuilder{
|
|
commandName: command,
|
|
clientLogger: logger,
|
|
pluginLogger: newLogrusAdapter(logger, logLevel),
|
|
}
|
|
if command == os.Args[0] {
|
|
// For plugins compiled into the velero executable, we need to run "velero run-plugins"
|
|
b.commandArgs = []string{"run-plugins"}
|
|
}
|
|
|
|
b.commandArgs = append(b.commandArgs, "--log-level", logLevel.String())
|
|
if len(features.All()) > 0 {
|
|
b.commandArgs = append(b.commandArgs, "--features", features.Serialize())
|
|
}
|
|
|
|
return b
|
|
}
|
|
|
|
func newLogrusAdapter(pluginLogger logrus.FieldLogger, logLevel logrus.Level) *logrusAdapter {
|
|
return &logrusAdapter{impl: pluginLogger, level: logLevel}
|
|
}
|
|
|
|
func (b *clientBuilder) clientConfig() *hcplugin.ClientConfig {
|
|
return &hcplugin.ClientConfig{
|
|
HandshakeConfig: framework.Handshake(),
|
|
AllowedProtocols: []hcplugin.Protocol{hcplugin.ProtocolGRPC},
|
|
Plugins: map[string]hcplugin.Plugin{
|
|
string(framework.PluginKindBackupItemAction): framework.NewBackupItemActionPlugin(framework.ClientLogger(b.clientLogger)),
|
|
string(framework.PluginKindVolumeSnapshotter): framework.NewVolumeSnapshotterPlugin(framework.ClientLogger(b.clientLogger)),
|
|
string(framework.PluginKindObjectStore): framework.NewObjectStorePlugin(framework.ClientLogger(b.clientLogger)),
|
|
string(framework.PluginKindPluginLister): &framework.PluginListerPlugin{},
|
|
string(framework.PluginKindRestoreItemAction): framework.NewRestoreItemActionPlugin(framework.ClientLogger(b.clientLogger)),
|
|
string(framework.PluginKindDeleteItemAction): framework.NewDeleteItemActionPlugin(framework.ClientLogger(b.clientLogger)),
|
|
string(framework.PluginKindItemSnapshotter): framework.NewItemSnapshotterPlugin(framework.ClientLogger(b.clientLogger)),
|
|
},
|
|
Logger: b.pluginLogger,
|
|
Cmd: exec.Command(b.commandName, b.commandArgs...),
|
|
}
|
|
}
|
|
|
|
// client creates a new go-plugin Client with support for all of Velero's plugin kinds (BackupItemAction, VolumeSnapshotter,
|
|
// ObjectStore, PluginLister, RestoreItemAction).
|
|
func (b *clientBuilder) client() *hcplugin.Client {
|
|
return hcplugin.NewClient(b.clientConfig())
|
|
}
|