def _internal_direct_post_snapshot(self, request): """Post Snapshot Wrapper for direct plugins. Executed after creating a snapshot. This plugin operation is run after creating a snapshot for a direct source. Run post-snapshot operation for a direct source. Args: request (DirectPostSnapshotRequest): Post Snapshot arguments. Returns: DirectPostSnapshotResponse: A response containing the return value - DirectPostSnapshotResult which has the snapshot metadata on success. In case of errors, response object will contain PluginErrorResult. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import RepositoryDefinition from generated.definitions import LinkedSourceDefinition from generated.definitions import SourceConfigDefinition from generated.definitions import SnapshotDefinition def to_protobuf(snapshot): parameters = common_pb2.PluginDefinedObject() parameters.json = json.dumps(snapshot.to_dict()) snapshot_protobuf = common_pb2.Snapshot() snapshot_protobuf.parameters.CopyFrom(parameters) return snapshot_protobuf if not self.post_snapshot_impl: raise OperationNotDefinedError(Op.LINKED_POST_SNAPSHOT) direct_source_definition = LinkedSourceDefinition.from_dict( json.loads(request.direct_source.linked_source.parameters.json)) direct_source = DirectSource( guid=request.direct_source.linked_source.guid, connection=RemoteConnection.from_proto( request.direct_source.connection), parameters=direct_source_definition) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) snapshot = self.post_snapshot_impl(direct_source=direct_source, repository=repository, source_config=source_config) # Validate that this is a SnapshotDefinition object if not isinstance(snapshot, SnapshotDefinition): raise IncorrectReturnTypeError(Op.LINKED_POST_SNAPSHOT, type(snapshot), SnapshotDefinition) direct_post_snapshot_response = ( platform_pb2.DirectPostSnapshotResponse()) direct_post_snapshot_response.return_value.snapshot.CopyFrom( to_protobuf(snapshot)) return direct_post_snapshot_response
def _internal_worker(self, request): """Staged Worker Wrapper for staged plugins. Executed as part of validated sync. This plugin operation is run to sync staging source as part of the validated sync operation. Run worker operation for a staged source. Args: request (StagedWorkerRequest): Worker arguments. Returns: StagedWorkerResponse: A response containing StagedWorkerResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import RepositoryDefinition from generated.definitions import LinkedSourceDefinition from generated.definitions import SourceConfigDefinition # # While linked.worker() is not a required operation, this should # not be called if it wasn't implemented. # if not self.worker_impl: raise OperationNotDefinedError(Op.LINKED_WORKER) staged_source_definition = LinkedSourceDefinition.from_dict( json.loads(request.staged_source.linked_source.parameters.json)) mount = Mount( remote_environment=(RemoteEnvironment.from_proto( request.staged_source.staged_mount.remote_environment)), mount_path=request.staged_source.staged_mount.mount_path, shared_path=request.staged_source.staged_mount.shared_path) staged_source = StagedSource( guid=request.staged_source.linked_source.guid, source_connection=RemoteConnection.from_proto( request.staged_source.source_connection), parameters=staged_source_definition, mount=mount, staged_connection=RemoteConnection.from_proto( request.staged_source.staged_connection)) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) self.worker_impl(staged_source=staged_source, repository=repository, source_config=source_config) staged_worker_response = platform_pb2.StagedWorkerResponse() staged_worker_response.return_value.CopyFrom( platform_pb2.StagedWorkerResult()) return staged_worker_response
def _internal_status(self, request): """Virtual status operation wrapper. Executed to get the status of a virtual source - active or inactive. Run status operation for a virtual source. Args: request (VirtualStatusRequest): Virtual status operation arguments. Returns: VirtualStatusResponse: A response containing VirtualStatusResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import VirtualSourceDefinition from generated.definitions import RepositoryDefinition from generated.definitions import SourceConfigDefinition # # While virtual.status() is not a required operation, this should # not be called if it wasn't implemented. # if not self.status_impl: raise OperationNotDefinedError(Op.VIRTUAL_STATUS) virtual_source_definition = VirtualSourceDefinition.from_dict( json.loads(request.virtual_source.parameters.json)) mounts = [ VirtualOperations._from_protobuf_single_subset_mount(m) for m in request.virtual_source.mounts ] virtual_source = VirtualSource(guid=request.virtual_source.guid, connection=RemoteConnection.from_proto( request.virtual_source.connection), parameters=virtual_source_definition, mounts=mounts) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) virtual_status = self.status_impl(repository=repository, source_config=source_config, virtual_source=virtual_source) # Validate that this is a Status object. if not isinstance(virtual_status, Status): raise IncorrectReturnTypeError(Op.VIRTUAL_STATUS, type(virtual_status), Status) virtual_status_response = platform_pb2.VirtualStatusResponse() virtual_status_response.return_value.status = virtual_status.value return virtual_status_response
def _internal_reconfigure(self, request): """Reconfigure operation wrapper. Executed while attaching a VDB during a virtual source enable job and returns a virtual source config. Args: request (ReconfigureRequest): Reconfigure operation arguments. Returns: ReconfigureResponse: A response containing the return value of the reconfigure operation, as a ReconfigureResult. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import VirtualSourceDefinition from generated.definitions import SnapshotDefinition from generated.definitions import SourceConfigDefinition from generated.definitions import RepositoryDefinition if not self.reconfigure_impl: raise OperationNotDefinedError(Op.VIRTUAL_RECONFIGURE) virtual_source_definition = VirtualSourceDefinition.from_dict( json.loads(request.virtual_source.parameters.json)) mounts = [ VirtualOperations._from_protobuf_single_subset_mount(m) for m in request.virtual_source.mounts ] virtual_source = VirtualSource(guid=request.virtual_source.guid, connection=RemoteConnection.from_proto( request.virtual_source.connection), parameters=virtual_source_definition, mounts=mounts) snapshot = SnapshotDefinition.from_dict( json.loads(request.snapshot.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) config = self.reconfigure_impl(snapshot=snapshot, repository=repository, source_config=source_config, virtual_source=virtual_source) # Validate that this is a SourceConfigDefinition object. if not isinstance(config, SourceConfigDefinition): raise IncorrectReturnTypeError(Op.VIRTUAL_RECONFIGURE, type(config), SourceConfigDefinition) reconfigure_response = platform_pb2.ReconfigureResponse() reconfigure_response.return_value.source_config.parameters.json = ( json.dumps(config.to_dict())) return reconfigure_response
def _internal_pre_snapshot(self, request): """Virtual pre snapshot operation wrapper. Executed before creating a ZFS snapshot. This plugin operation is run prior to creating a snapshot for a virtual source. Run pre-snapshot operation for a virtual source. Args: virtual_pre_snapshot_request (VirtualPreSnapshotRequest): Virtual pre snapshot operation arguments. Returns: VirtualPreSnapshotResponse: A response containing VirtualPreSnapshotResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import VirtualSourceDefinition from generated.definitions import RepositoryDefinition from generated.definitions import SourceConfigDefinition # # While virtual.pre_snapshot() is not a required operation, this should # not be called if it wasn't implemented. # if not self.pre_snapshot_impl: raise OperationNotDefinedError(Op.VIRTUAL_PRE_SNAPSHOT) virtual_source_definition = VirtualSourceDefinition.from_dict( json.loads(request.virtual_source.parameters.json)) mounts = [ VirtualOperations._from_protobuf_single_subset_mount(m) for m in request.virtual_source.mounts ] virtual_source = VirtualSource(guid=request.virtual_source.guid, connection=RemoteConnection.from_proto( request.virtual_source.connection), parameters=virtual_source_definition, mounts=mounts) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) self.pre_snapshot_impl(repository=repository, source_config=source_config, virtual_source=virtual_source) virtual_pre_snapshot_response = ( platform_pb2.VirtualPreSnapshotResponse()) virtual_pre_snapshot_response.return_value.CopyFrom( platform_pb2.VirtualPreSnapshotResult()) return virtual_pre_snapshot_response
def _internal_unconfigure(self, request): """Unconfigure operation wrapper. Executed when disabling or deleting an existing virtual source which has already been mounted to a target environment. This plugin operation is run before unmounting the virtual source from the target environment. Args: request (UnconfigureRequest): Unconfigure operation arguments. Returns: UnconfigureResponse: A response containing UnconfigureResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import VirtualSourceDefinition from generated.definitions import RepositoryDefinition from generated.definitions import SourceConfigDefinition # # While virtual.unconfigure() is not a required operation, this should # not be called if it wasn't implemented. # if not self.unconfigure_impl: raise OperationNotDefinedError(Op.VIRTUAL_UNCONFIGURE) virtual_source_definition = VirtualSourceDefinition.from_dict( json.loads(request.virtual_source.parameters.json)) mounts = [ VirtualOperations._from_protobuf_single_subset_mount(m) for m in request.virtual_source.mounts ] virtual_source = VirtualSource(guid=request.virtual_source.guid, connection=RemoteConnection.from_proto( request.virtual_source.connection), parameters=virtual_source_definition, mounts=mounts) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) self.unconfigure_impl(repository=repository, source_config=source_config, virtual_source=virtual_source) unconfigure_response = platform_pb2.UnconfigureResponse() unconfigure_response.return_value.CopyFrom( platform_pb2.UnconfigureResult()) return unconfigure_response
def _internal_direct_pre_snapshot(self, request): """Pre Snapshot Wrapper for direct plugins. Executed before creating a snapshot. This plugin operation is run prior to creating a snapshot for a direct source. Run pre-snapshot operation for a direct source. Args: request (DirectPreSnapshotRequest): Pre Snapshot arguments. Returns: DirectPreSnapshotResponse: A response containing DirectPreSnapshotResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import RepositoryDefinition from generated.definitions import LinkedSourceDefinition from generated.definitions import SourceConfigDefinition # # While linked.pre_snapshot() is not a required operation, this should # not be called if it wasn't implemented. # if not self.pre_snapshot_impl: raise OperationNotDefinedError(Op.LINKED_PRE_SNAPSHOT) direct_source_definition = LinkedSourceDefinition.from_dict( json.loads(request.direct_source.linked_source.parameters.json)) direct_source = DirectSource( guid=request.direct_source.linked_source.guid, connection=RemoteConnection.from_proto( request.direct_source.connection), parameters=direct_source_definition) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) self.pre_snapshot_impl(direct_source=direct_source, repository=repository, source_config=source_config) direct_pre_snapshot_response = platform_pb2.DirectPreSnapshotResponse() direct_pre_snapshot_response.return_value.CopyFrom( platform_pb2.DirectPreSnapshotResult()) return direct_pre_snapshot_response
def _internal_start(self, request): """Start operation wrapper. Executed after attaching a VDB during a virtual source enable job to start the database. Args: request (StartRequest): Start operation arguments. Returns: StartResponse: A response containing StartResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import VirtualSourceDefinition from generated.definitions import RepositoryDefinition from generated.definitions import SourceConfigDefinition # # While virtual.start() is not a required operation, this should # not be called if it wasn't implemented. # if not self.start_impl: raise OperationNotDefinedError(Op.VIRTUAL_START) virtual_source_definition = VirtualSourceDefinition.from_dict( json.loads(request.virtual_source.parameters.json)) mounts = [ VirtualOperations._from_protobuf_single_subset_mount(m) for m in request.virtual_source.mounts ] virtual_source = VirtualSource(guid=request.virtual_source.guid, connection=RemoteConnection.from_proto( request.virtual_source.connection), parameters=virtual_source_definition, mounts=mounts) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) self.start_impl(repository=repository, source_config=source_config, virtual_source=virtual_source) start_response = platform_pb2.StartResponse() start_response.return_value.CopyFrom(platform_pb2.StartResult()) return start_response
def _internal_initialize(self, request): """Initialize operation wrapper. Executed during VDB creation after mounting onto the target environment. Run initialize operation for an empty virtual source. Args: request (InitializeRequest): Initialize operation arguments. Returns: InitializeResponse: A response containing InitializeResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import VirtualSourceDefinition from generated.definitions import RepositoryDefinition from generated.definitions import SourceConfigDefinition if not self.initialize_impl: raise OperationNotDefinedError(Op.VIRTUAL_INITIALIZE) virtual_source_definition = VirtualSourceDefinition.from_dict( json.loads(request.virtual_source.parameters.json)) mounts = [ VirtualOperations._from_protobuf_single_subset_mount(m) for m in request.virtual_source.mounts ] virtual_source = VirtualSource(guid=request.virtual_source.guid, connection=RemoteConnection.from_proto( request.virtual_source.connection), parameters=virtual_source_definition, mounts=mounts) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) self.initialize_impl(repository=repository, source_config=source_config, virtual_source=virtual_source) initialize_response = platform_pb2.InitializeResponse() initialize_response.return_value.CopyFrom( platform_pb2.InitializeResult()) return initialize_response
def _internal_status(self, request): """Staged Status Wrapper for staged plugins. Executed as part of several operations to get the status of a staged source - active or inactive. Run status operation for a staged source. Args: request (StagedStatusRequest): Post Snapshot arguments. Returns: StagedStatusResponse: A response containing the return value - StagedStatusResult which has active or inactive status. In case of errors, response object will contain PluginErrorResult. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import RepositoryDefinition from generated.definitions import LinkedSourceDefinition from generated.definitions import SourceConfigDefinition # # While linked.status() is not a required operation, this should # not be called if it wasn't implemented. # if not self.status_impl: raise OperationNotDefinedError(Op.LINKED_STATUS) staged_source_definition = LinkedSourceDefinition.from_dict( json.loads(request.staged_source.linked_source.parameters.json)) mount = Mount( remote_environment=(RemoteEnvironment.from_proto( request.staged_source.staged_mount.remote_environment)), mount_path=request.staged_source.staged_mount.mount_path, shared_path=request.staged_source.staged_mount.shared_path) staged_source = StagedSource( guid=request.staged_source.linked_source.guid, source_connection=RemoteConnection.from_proto( request.staged_source.source_connection), parameters=staged_source_definition, mount=mount, staged_connection=RemoteConnection.from_proto( request.staged_source.staged_connection)) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) status = self.status_impl(staged_source=staged_source, repository=repository, source_config=source_config) # Validate that this is a Status object. if not isinstance(status, Status): raise IncorrectReturnTypeError(Op.LINKED_STATUS, type(status), Status) staged_status_response = platform_pb2.StagedStatusResponse() staged_status_response.return_value.status = status.value return staged_status_response
def _internal_staged_pre_snapshot(self, request): """Pre Snapshot Wrapper for staged plugins. Executed before creating a snapshot. This plugin operation is run prior to creating a snapshot for a staged source. Run pre-snapshot operation for a staged source. Args: request (StagedPreSnapshotRequest): Pre Snapshot arguments. Returns: StagedPreSnapshotResponse: A response containing StagedPreSnapshotResult if successful or PluginErrorResult in case of an error. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import RepositoryDefinition from generated.definitions import LinkedSourceDefinition from generated.definitions import SourceConfigDefinition from generated.definitions import SnapshotParametersDefinition # # While linked.pre_snapshot() is not a required operation, this should # not be called if it wasn't implemented. # if not self.pre_snapshot_impl: raise OperationNotDefinedError(Op.LINKED_PRE_SNAPSHOT) linked_source = request.staged_source.linked_source staged_source_definition = (LinkedSourceDefinition.from_dict( json.loads(linked_source.parameters.json))) staged_mount = request.staged_source.staged_mount mount = Mount(remote_environment=RemoteEnvironment.from_proto( staged_mount.remote_environment), mount_path=staged_mount.mount_path, shared_path=staged_mount.shared_path) staged_source = StagedSource( guid=linked_source.guid, source_connection=RemoteConnection.from_proto( request.staged_source.source_connection), parameters=staged_source_definition, mount=mount, staged_connection=RemoteConnection.from_proto( request.staged_source.staged_connection)) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) snapshot_parameters = SnapshotParametersDefinition.from_dict( json.loads(request.snapshot_parameters.parameters.json)) self.pre_snapshot_impl(staged_source=staged_source, repository=repository, source_config=source_config, snapshot_parameters=snapshot_parameters) response = platform_pb2.StagedPreSnapshotResponse() response.return_value.CopyFrom(platform_pb2.StagedPreSnapshotResult()) return response
def _internal_post_snapshot(self, request): """Virtual post snapshot operation wrapper. Executed after creating a ZFS snapshot. This plugin operation is run after creating a snapshot for a virtual source. Run post-snapshot operation for a virtual source. Args: request (VirtualPostSnapshotRequest): Virtual post snapshot operation arguments. Returns: VirtualPostSnapshotResponse: A response containing the return value of the virtual post snapshot operation, as a VirtualPostSnapshotResult. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import VirtualSourceDefinition from generated.definitions import RepositoryDefinition from generated.definitions import SnapshotDefinition from generated.definitions import SourceConfigDefinition def to_protobuf(snapshot): parameters = common_pb2.PluginDefinedObject() parameters.json = json.dumps(snapshot.to_dict()) snapshot_protobuf = common_pb2.Snapshot() snapshot_protobuf.parameters.CopyFrom(parameters) return snapshot_protobuf if not self.post_snapshot_impl: raise OperationNotDefinedError(Op.VIRTUAL_POST_SNAPSHOT) virtual_source_definition = VirtualSourceDefinition.from_dict( json.loads(request.virtual_source.parameters.json)) mounts = [ VirtualOperations._from_protobuf_single_subset_mount(m) for m in request.virtual_source.mounts ] virtual_source = VirtualSource(guid=request.virtual_source.guid, connection=RemoteConnection.from_proto( request.virtual_source.connection), parameters=virtual_source_definition, mounts=mounts) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) snapshot = self.post_snapshot_impl(repository=repository, source_config=source_config, virtual_source=virtual_source) # Validate that this is a SnapshotDefinition object if not isinstance(snapshot, SnapshotDefinition): raise IncorrectReturnTypeError(Op.VIRTUAL_POST_SNAPSHOT, type(snapshot), SnapshotDefinition) virtual_post_snapshot_response = ( platform_pb2.VirtualPostSnapshotResponse()) virtual_post_snapshot_response.return_value.snapshot.CopyFrom( to_protobuf(snapshot)) return virtual_post_snapshot_response
def _internal_staged_post_snapshot(self, request): """Post Snapshot Wrapper for staged plugins. Executed after creating a snapshot. This plugin operation is run after creating a snapshot for a staged source. Run post-snapshot operation for a staged source. Args: request (StagedPostSnapshotRequest): Post Snapshot arguments. Returns: StagedPostSnapshotResponse: A response containing the return value StagedPostSnapshotResult which has the snapshot metadata on success. In case of errors, response object will contain PluginErrorResult. """ # Reasoning for method imports are in this file's docstring. from generated.definitions import RepositoryDefinition from generated.definitions import LinkedSourceDefinition from generated.definitions import SourceConfigDefinition from generated.definitions import SnapshotDefinition from generated.definitions import SnapshotParametersDefinition def to_protobuf(snapshot): parameters = common_pb2.PluginDefinedObject() parameters.json = json.dumps(snapshot.to_dict()) snapshot_protobuf = common_pb2.Snapshot() snapshot_protobuf.parameters.CopyFrom(parameters) return snapshot_protobuf if not self.post_snapshot_impl: raise OperationNotDefinedError(Op.LINKED_POST_SNAPSHOT) staged_source_definition = LinkedSourceDefinition.from_dict( json.loads(request.staged_source.linked_source.parameters.json)) mount = Mount( remote_environment=RemoteEnvironment.from_proto( request.staged_source.staged_mount.remote_environment), mount_path=request.staged_source.staged_mount.mount_path, shared_path=request.staged_source.staged_mount.shared_path) staged_source = StagedSource( guid=request.staged_source.linked_source.guid, source_connection=RemoteConnection.from_proto( request.staged_source.source_connection), parameters=staged_source_definition, mount=mount, staged_connection=RemoteConnection.from_proto( request.staged_source.staged_connection)) repository = RepositoryDefinition.from_dict( json.loads(request.repository.parameters.json)) source_config = SourceConfigDefinition.from_dict( json.loads(request.source_config.parameters.json)) snap_params = json.loads(request.snapshot_parameters.parameters.json) # # The snapshot_parameters object should be set to None if the json from # the protobuf is None to differentiate no snapshot parameters vs empty # snapshot parameters. # snapshot_parameters = ( None if snap_params is None else SnapshotParametersDefinition.from_dict(snap_params)) snapshot = self.post_snapshot_impl( staged_source=staged_source, repository=repository, source_config=source_config, optional_snapshot_parameters=snapshot_parameters) # Validate that this is a SnapshotDefinition object if not isinstance(snapshot, SnapshotDefinition): raise IncorrectReturnTypeError(Op.LINKED_POST_SNAPSHOT, type(snapshot), SnapshotDefinition) response = platform_pb2.StagedPostSnapshotResponse() response.return_value.snapshot.CopyFrom(to_protobuf(snapshot)) return response