/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch licenses this file to you 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. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ package org.opensearch.cluster.coordination; import joptsimple.OptionSet; import joptsimple.OptionSpec; import org.opensearch.cli.ExitCodes; import org.opensearch.cli.Terminal; import org.opensearch.cli.UserException; import org.opensearch.cluster.ClusterState; import org.opensearch.cluster.metadata.Metadata; import org.opensearch.common.collect.Tuple; import org.opensearch.common.regex.Regex; import org.opensearch.env.Environment; import org.opensearch.gateway.PersistedClusterStateService; import java.io.IOException; import java.nio.file.Path; import java.util.List; /** * Removes custom metadata * * @opensearch.internal */ public class RemoveCustomsCommand extends OpenSearchNodeCommand { static final String CUSTOMS_REMOVED_MSG = "Customs were successfully removed from the cluster state"; static final String CONFIRMATION_MSG = DELIMITER + "\n" + "You should only run this tool if you have broken custom metadata in the\n" + "cluster state that prevents the cluster state from being loaded.\n" + "This tool can cause data loss and its use should be your last resort.\n" + "\n" + "Do you want to proceed?\n"; private final OptionSpec arguments; public RemoveCustomsCommand() { super("Removes custom metadata from the cluster state"); arguments = parser.nonOptions("custom metadata names"); } @Override protected void processNodePaths(Terminal terminal, Path[] dataPaths, int nodeLockId, OptionSet options, Environment env) throws IOException, UserException { final List customsToRemove = arguments.values(options); if (customsToRemove.isEmpty()) { throw new UserException(ExitCodes.USAGE, "Must supply at least one custom metadata name to remove"); } final PersistedClusterStateService persistedClusterStateService = createPersistedClusterStateService(env.settings(), dataPaths); terminal.println(Terminal.Verbosity.VERBOSE, "Loading cluster state"); final Tuple termAndClusterState = loadTermAndClusterState(persistedClusterStateService, env); final ClusterState oldClusterState = termAndClusterState.v2(); terminal.println(Terminal.Verbosity.VERBOSE, "custom metadata names: " + oldClusterState.metadata().customs().keySet()); final Metadata.Builder metadataBuilder = Metadata.builder(oldClusterState.metadata()); for (String customToRemove : customsToRemove) { boolean matched = false; for (final String customKey : oldClusterState.metadata().customs().keySet()) { if (Regex.simpleMatch(customToRemove, customKey)) { metadataBuilder.removeCustom(customKey); if (matched == false) { terminal.println("The following customs will be removed:"); } matched = true; terminal.println(customKey); } } if (matched == false) { throw new UserException(ExitCodes.USAGE, "No custom metadata matching [" + customToRemove + "] were found on this node"); } } final ClusterState newClusterState = ClusterState.builder(oldClusterState).metadata(metadataBuilder.build()).build(); terminal.println( Terminal.Verbosity.VERBOSE, "[old cluster state = " + oldClusterState + ", new cluster state = " + newClusterState + "]" ); confirm(terminal, CONFIRMATION_MSG); try (PersistedClusterStateService.Writer writer = persistedClusterStateService.createWriter()) { writer.writeFullStateAndCommit(termAndClusterState.v1(), newClusterState); } terminal.println(CUSTOMS_REMOVED_MSG); } }