feat(import): add support for multiple hbase snapshot imports #4600
There are no files selected for viewing
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| /* | ||
| * Copyright 2024 Google LLC | ||
| * | ||
| * 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 com.google.cloud.bigtable.beam.hbasesnapshots; | ||
|
|
||
| import com.google.api.core.InternalExtensionOnly; | ||
| import com.google.cloud.bigtable.beam.hbasesnapshots.conf.ImportConfig; | ||
| import com.google.cloud.bigtable.beam.hbasesnapshots.conf.SnapshotConfig; | ||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.gson.Gson; | ||
| import com.google.gson.GsonBuilder; | ||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import org.apache.beam.sdk.extensions.gcp.options.GcsOptions; | ||
| import org.apache.beam.sdk.options.PipelineOptionsFactory; | ||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.hadoop.fs.FileSystem; | ||
| import org.apache.hadoop.fs.Path; | ||
| import org.apache.hadoop.hbase.snapshot.RestoreSnapshotHelper; | ||
|
|
||
| /** | ||
| * Tool to restore HBase snapshots in GCS for scanning. This tool runs locally (without Dataflow) | ||
| * and copies snapshot files to a restore path, resolving HLinks and References so that they can be | ||
| * read by a scanner. | ||
| * | ||
|
Contributor
There was a problem hiding this comment. This needs to be a bit more descriptive, see for an example. |
||
| * <p>Execute the following command to run the tool directly using system properties: | ||
| * | ||
| * <pre> | ||
| * {@code mvn compile exec:java \ | ||
| * -Dexec.mainClass=com.google.cloud.bigtable.beam.hbasesnapshots.HBaseSnapshotRestoreTool \ | ||
| * -Dproject=[PROJECT_ID] \ | ||
| * -DhbaseSnapshotSourceDir=gs://[BUCKET]/[HBASE_EXPORT_ROOT_PATH]/data \ | ||
| * -Dsnapshots=[SNAPSHOT_NAMES] \ | ||
| * -DrestorePath=gs://[BUCKET]/[HBASE_EXPORT_ROOT_PATH]/restore | ||
| * } | ||
| * </pre> | ||
| * | ||
| * <p>Alternatively, you can provide a path to a JSON configuration file: | ||
| * | ||
| * <pre> | ||
| * {@code mvn compile exec:java \ | ||
| * -Dexec.mainClass=com.google.cloud.bigtable.beam.hbasesnapshots.HBaseSnapshotRestoreTool \ | ||
| * -Dproject=[PROJECT_ID] \ | ||
| * -DimportConfigFilePath=[PATH_TO_JSON_CONFIG] | ||
| * } | ||
| * </pre> | ||
| * | ||
| * <p>The JSON configuration file should have the following format: | ||
| * | ||
| * <pre> | ||
| * { | ||
| * "sourcepath": "gs://[BUCKET]/[HBASE_EXPORT_ROOT_PATH]/data", | ||
| * "restorepath": "gs://[BUCKET]/[HBASE_EXPORT_ROOT_PATH]/restore", | ||
| * "snapshots": { | ||
| * "snapshot1": "table1", | ||
| * "snapshot2": "table2" | ||
| * } | ||
| * } | ||
| * </pre> | ||
| */ | ||
| @InternalExtensionOnly | ||
| public class HBaseSnapshotRestoreTool { | ||
| private static final Log LOG = LogFactory.getLog(HBaseSnapshotRestoreTool.class); | ||
|
|
||
| private static final String PROJECT_PROPERTY = "project"; | ||
| private static final String IMPORT_CONFIG_FILE_PATH_PROPERTY = "importConfigFilePath"; | ||
| private static final String HBASE_SNAPSHOT_SOURCE_DIR_PROPERTY = "hbaseSnapshotSourceDir"; | ||
| private static final String SNAPSHOTS_PROPERTY = "snapshots"; | ||
| private static final String RESTORE_PATH_PROPERTY = "restorePath"; | ||
|
|
||
| public static void main(String[] args) throws Exception { | ||
| GcsOptions options = PipelineOptionsFactory.create().as(GcsOptions.class); | ||
| String project = System.getProperty(PROJECT_PROPERTY); | ||
| if (project != null) { | ||
| options.setProject(project); | ||
| } | ||
|
|
||
| ImportConfig importConfig = | ||
| System.getProperty(IMPORT_CONFIG_FILE_PATH_PROPERTY) != null | ||
| ? buildImportConfigFromConfigFile(System.getProperty(IMPORT_CONFIG_FILE_PATH_PROPERTY)) | ||
| : buildImportConfigFromArgs(options); | ||
|
|
||
| LOG.info( | ||
| String.format( | ||
| "SourcePath:%s, RestorePath:%s", | ||
| importConfig.getSourcepath(), importConfig.getRestorepath())); | ||
|
|
||
| Map<String, String> configurations = | ||
| SnapshotUtils.getConfiguration( | ||
| null, // invoke from a DirectRunner without using dataflow | ||
| options.getProject(), | ||
| importConfig.getSourcepath(), | ||
| importConfig.getHbaseConfiguration()); | ||
|
|
||
| List<SnapshotConfig> snapshotConfigs = | ||
| SnapshotUtils.buildSnapshotConfigs( | ||
| importConfig.getSnapshots(), | ||
| configurations, | ||
| options.getProject(), | ||
| importConfig.getSourcepath(), | ||
| importConfig.getRestorepath()); | ||
|
|
||
| for (SnapshotConfig config : snapshotConfigs) { | ||
| restoreSnapshot(config); | ||
| } | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static ImportConfig buildImportConfigFromArgs(GcsOptions gcsOptions) throws IOException { | ||
| String sourceDir = System.getProperty(HBASE_SNAPSHOT_SOURCE_DIR_PROPERTY); | ||
| String snapshotsProperty = System.getProperty(SNAPSHOTS_PROPERTY); | ||
| Map<String, String> snapshots = null; | ||
| if (snapshotsProperty != null) { | ||
| snapshots = | ||
| (sourceDir != null && SnapshotUtils.isRegex(snapshotsProperty)) | ||
| ? SnapshotUtils.getSnapshotsFromSnapshotPath( | ||
| sourceDir, gcsOptions.getGcsUtil(), snapshotsProperty) | ||
| : SnapshotUtils.getSnapshotsFromString(snapshotsProperty); | ||
| } | ||
|
|
||
| ImportConfig importConfig = new ImportConfig(); | ||
| importConfig.setSourcepath(sourceDir); | ||
| if (snapshots != null) { | ||
| importConfig.setSnapshotsFromMap(snapshots); | ||
| } | ||
| importConfig.validate(); | ||
| SnapshotUtils.setRestorePath(System.getProperty(RESTORE_PATH_PROPERTY), importConfig); | ||
|
|
||
| return importConfig; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static ImportConfig buildImportConfigFromConfigFile(String configFilePath) throws Exception { | ||
| Gson gson = new GsonBuilder().create(); | ||
| ImportConfig importConfig = | ||
| gson.fromJson(SnapshotUtils.readFileContents(configFilePath), ImportConfig.class); | ||
| Preconditions.checkNotNull(importConfig, "ImportConfig parsed from file cannot be null."); | ||
| importConfig.validate(); | ||
| SnapshotUtils.setRestorePath(importConfig.getRestorepath(), importConfig); | ||
| return importConfig; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| /** | ||
| * Creates a copy of Snasphsot from the source path into restore path. | ||
| * | ||
| * @param snapshotConfig - Snapshot Configuration | ||
| * @throws IOException | ||
| */ | ||
| static void restoreSnapshot(SnapshotConfig snapshotConfig) throws IOException { | ||
| Path sourcePath = snapshotConfig.getSourcePath(); | ||
| Path restorePath = snapshotConfig.getRestorePath(); | ||
| Configuration configuration = snapshotConfig.getConfiguration(); | ||
| LOG.info( | ||
| String.format("RestoreSnapshot - sourcePath:%s restorePath: %s", sourcePath, restorePath)); | ||
| FileSystem fileSystem = sourcePath.getFileSystem(configuration); | ||
| if (fileSystem.exists(restorePath)) { | ||
| LOG.info( | ||
| String.format( | ||
| "Restore path %s already exists, deleting it for idempotency", restorePath)); | ||
| fileSystem.delete(restorePath, true); | ||
| } | ||
| RestoreSnapshotHelper.copySnapshotForScanner( | ||
| configuration, fileSystem, sourcePath, restorePath, snapshotConfig.getSnapshotName()); | ||
|
tianlei2 marked this conversation as resolved.
|
||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are they added in dependency management instead of dependencies?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are annotations only needed for compilation. Placing them here with provided scope ensures they don't get included in the final shaded JAR if other libraries pull them in.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But why are they added to
<dependencyManagement>block instead of<dependencies>?Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we don't want to add those as dependencies, it's used to control the version and scope of transitive dependencies. Other libraries that use them will pull them in automatically as transitive dependencies.
From gemini:
<dependencies>: This block actually adds the dependency to your project. If you put a dependency here, Maven will download it and include it in your project's classpath.
<dependencyManagement>: This block does NOT add the dependency to your project. Instead, it acts as a version map or rule book. It tells Maven: "IF this project (or any of its child modules) uses this dependency, use THIS specific version and THIS scope."