+ * 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 org.apache.hadoop.ozone.om;
+
+import org.apache.commons.lang3.RandomStringUtils;
+import org.apache.hadoop.hdds.conf.OzoneConfiguration;
+import org.apache.hadoop.hdds.utils.IOUtils;
+import org.apache.hadoop.ozone.MiniOzoneCluster;
+import org.apache.hadoop.ozone.MiniOzoneHAClusterImpl;
+import org.apache.hadoop.ozone.client.ObjectStore;
+import org.apache.hadoop.ozone.client.OzoneClient;
+import org.apache.hadoop.ozone.client.OzoneVolume;
+import org.apache.ozone.test.LambdaTestUtils;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.Timeout;
+
+import java.util.UUID;
+
+/**
+ * Integration test to verify that if snapshot feature is disabled, OM start up
+ * will fail when there are still snapshots remaining.
+ */
+@Disabled("HDDS-8945")
+public class TestOmSnapshotDisabledRestart {
+
+ private static MiniOzoneHAClusterImpl cluster = null;
+ private static OzoneClient client;
+ private static ObjectStore store;
+
+ @BeforeAll
+ @Timeout(60)
+ public static void init() throws Exception {
+ OzoneConfiguration conf = new OzoneConfiguration();
+ String clusterId = UUID.randomUUID().toString();
+ String scmId = UUID.randomUUID().toString();
+
+ // Enable filesystem snapshot feature at the beginning
+ conf.setBoolean(OMConfigKeys.OZONE_FILESYSTEM_SNAPSHOT_ENABLED_KEY, true);
+
+ cluster = (MiniOzoneHAClusterImpl) MiniOzoneCluster.newOMHABuilder(conf)
+ .setClusterId(clusterId)
+ .setScmId(scmId)
+ .setOMServiceId("om-service-test2")
+ .setNumOfOzoneManagers(3)
+ .build();
+ cluster.waitForClusterToBeReady();
+ client = cluster.newClient();
+
+ OzoneManager leaderOzoneManager = cluster.getOMLeader();
+ OzoneConfiguration leaderConfig = leaderOzoneManager.getConfiguration();
+ cluster.setConf(leaderConfig);
+ store = client.getObjectStore();
+ }
+
+ @AfterAll
+ public static void tearDown() throws Exception {
+ IOUtils.closeQuietly(client);
+ if (cluster != null) {
+ cluster.shutdown();
+ }
+ }
+
+ @Test
+ public void testSnapshotFeatureFlag() throws Exception {
+ // Verify that OM start up will indeed fail when there are still snapshots
+ // while snapshot feature is disabled.
+
+ String volumeName = "vol-" + RandomStringUtils.randomNumeric(5);
+ String bucketName = "buck-" + RandomStringUtils.randomNumeric(5);
+ String snapshotName = "snap-" + RandomStringUtils.randomNumeric(5);
+
+ store.createVolume(volumeName);
+ OzoneVolume volume = store.getVolume(volumeName);
+ volume.createBucket(bucketName);
+ // Create a snapshot
+ store.createSnapshot(volumeName, bucketName, snapshotName);
+
+ cluster.getOzoneManagersList().forEach(om -> {
+ try {
+ cluster.shutdownOzoneManager(om);
+ // Disable snapshot feature
+ om.getConfiguration().setBoolean(
+ OMConfigKeys.OZONE_FILESYSTEM_SNAPSHOT_ENABLED_KEY, false);
+ // Restart OM, expect OM start up failure
+ LambdaTestUtils.intercept(RuntimeException.class, "snapshots remaining",
+ () -> cluster.restartOzoneManager(om, true));
+ // Enable snapshot feature again
+ om.getConfiguration().setBoolean(
+ OMConfigKeys.OZONE_FILESYSTEM_SNAPSHOT_ENABLED_KEY, true);
+ // Should pass this time
+ cluster.restartOzoneManager(om, true);
+ } catch (Exception e) {
+ Assertions.fail("Failed to restart OM", e);
+ }
+ });
+ }
+}
diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmSnapshotManager.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmSnapshotManager.java
index c1fdbc017209..eac9e7fe0443 100644
--- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmSnapshotManager.java
+++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmSnapshotManager.java
@@ -60,8 +60,6 @@
import org.apache.hadoop.ozone.om.helpers.OmKeyInfo;
import org.apache.hadoop.ozone.om.helpers.RepeatedOmKeyInfo;
import org.apache.hadoop.ozone.om.helpers.SnapshotInfo;
-import org.apache.hadoop.ozone.om.request.key.OMDirectoriesPurgeRequestWithFSO;
-import org.apache.hadoop.ozone.om.request.key.OMKeyPurgeRequest;
import org.apache.hadoop.ozone.om.service.SnapshotDiffCleanupService;
import org.apache.hadoop.ozone.om.snapshot.SnapshotDiffObject;
import org.apache.hadoop.ozone.om.helpers.SnapshotDiffJob;
@@ -170,17 +168,25 @@ public final class OmSnapshotManager implements AutoCloseable {
// Soft limit of the snapshot cache size.
private final int softCacheSize;
- /**
- * TODO: [SNAPSHOT] HDDS-8529: Refactor the constructor in a way that when
- * ozoneManager.isFilesystemSnapshotEnabled() returns false,
- * no snapshot-related background job or initialization would run,
- * except for applying previously committed Ratis transactions in e.g.:
- * 1. {@link OMKeyPurgeRequest#validateAndUpdateCache}
- * 2. {@link OMDirectoriesPurgeRequestWithFSO#validateAndUpdateCache}
- */
public OmSnapshotManager(OzoneManager ozoneManager) {
+
+ boolean isFilesystemSnapshotEnabled =
+ ozoneManager.isFilesystemSnapshotEnabled();
LOG.info("Ozone filesystem snapshot feature is {}.",
- ozoneManager.isFilesystemSnapshotEnabled() ? "enabled" : "disabled");
+ isFilesystemSnapshotEnabled ? "enabled" : "disabled");
+
+ // Confirm that snapshot feature can be safely disabled.
+ // Throw unchecked exception if that is not the case.
+ if (!isFilesystemSnapshotEnabled &&
+ !canDisableFsSnapshot(ozoneManager.getMetadataManager())) {
+ throw new RuntimeException("Ozone Manager is refusing to start up" +
+ "because filesystem snapshot feature is disabled in config while" +
+ "there are still snapshots remaining in the system (including the " +
+ "ones that are marked as deleted but not yet cleaned up by the " +
+ "background worker thread). " +
+ "Please set config ozone.filesystem.snapshot.enabled to true and " +
+ "try to start this Ozone Manager again.");
+ }
this.options = new ManagedDBOptions();
this.options.setCreateIfMissing(true);
@@ -302,6 +308,27 @@ public OmSnapshotManager(OzoneManager ozoneManager) {
}
}
+ /**
+ * Help reject OM startup if snapshot feature is disabled
+ * but there are snapshots remaining in this OM. Note: snapshots that are
+ * already deleted but not cleaned up yet still counts.
+ * @param ommm OMMetadataManager
+ * @return true if SnapshotInfoTable is empty, false otherwise.
+ */
+ @VisibleForTesting
+ public boolean canDisableFsSnapshot(OMMetadataManager ommm) {
+
+ boolean isSnapshotInfoTableEmpty;
+ try {
+ isSnapshotInfoTableEmpty = ommm.getSnapshotInfoTable().isEmpty();
+ } catch (IOException e) {
+ throw new IllegalStateException(
+ "Unable to check SnapshotInfoTable emptiness", e);
+ }
+
+ return isSnapshotInfoTableEmpty;
+ }
+
private CacheLoader