Examples with IndexScopedSettings org.opensearch.common.settings.IndexScopedSettings used on opensource projects

Example 1 with IndexScopedSettings

use of org.opensearch.common.settings.IndexScopedSettings in project OpenSearch by opensearch-project.

the class GetIndexResponseTests method createServerTestInstance.

@Override
protected org.opensearch.action.admin.indices.get.GetIndexResponse createServerTestInstance(XContentType xContentType) {
    String[] indices = generateRandomStringArray(5, 5, false, false);
    ImmutableOpenMap.Builder<String, MappingMetadata> mappings = ImmutableOpenMap.builder();
    ImmutableOpenMap.Builder<String, List<AliasMetadata>> aliases = ImmutableOpenMap.builder();
    ImmutableOpenMap.Builder<String, Settings> settings = ImmutableOpenMap.builder();
    ImmutableOpenMap.Builder<String, Settings> defaultSettings = ImmutableOpenMap.builder();
    ImmutableOpenMap.Builder<String, String> dataStreams = ImmutableOpenMap.builder();
    IndexScopedSettings indexScopedSettings = IndexScopedSettings.DEFAULT_SCOPED_SETTINGS;
    boolean includeDefaults = randomBoolean();
    for (String index : indices) {
        mappings.put(index, createMappingsForIndex());
        List<AliasMetadata> aliasMetadataList = new ArrayList<>();
        int aliasesNum = randomIntBetween(0, 3);
        for (int i = 0; i < aliasesNum; i++) {
            aliasMetadataList.add(GetAliasesResponseTests.createAliasMetadata());
        }
        CollectionUtil.timSort(aliasMetadataList, Comparator.comparing(AliasMetadata::alias));
        aliases.put(index, Collections.unmodifiableList(aliasMetadataList));
        Settings.Builder builder = Settings.builder();
        builder.put(RandomCreateIndexGenerator.randomIndexSettings());
        settings.put(index, builder.build());
        if (includeDefaults) {
            defaultSettings.put(index, indexScopedSettings.diff(settings.get(index), Settings.EMPTY));
        }
        if (randomBoolean()) {
            dataStreams.put(index, randomAlphaOfLength(5).toLowerCase(Locale.ROOT));
        }
    }
    return new org.opensearch.action.admin.indices.get.GetIndexResponse(indices, mappings.build(), aliases.build(), settings.build(), defaultSettings.build(), dataStreams.build());
}

Example 2 with IndexScopedSettings

use of org.opensearch.common.settings.IndexScopedSettings in project OpenSearch by opensearch-project.

the class ActionModule method initRestHandlers.

public void initRestHandlers(Supplier<DiscoveryNodes> nodesInCluster) {
    List<AbstractCatAction> catActions = new ArrayList<>();
    Consumer<RestHandler> registerHandler = handler -> {
        if (handler instanceof AbstractCatAction) {
            catActions.add((AbstractCatAction) handler);
        }
        restController.registerHandler(handler);
    };
    registerHandler.accept(new RestAddVotingConfigExclusionAction());
    registerHandler.accept(new RestClearVotingConfigExclusionsAction());
    registerHandler.accept(new RestMainAction());
    registerHandler.accept(new RestNodesInfoAction(settingsFilter));
    registerHandler.accept(new RestRemoteClusterInfoAction());
    registerHandler.accept(new RestNodesStatsAction());
    registerHandler.accept(new RestNodesUsageAction());
    registerHandler.accept(new RestNodesHotThreadsAction());
    registerHandler.accept(new RestClusterAllocationExplainAction());
    registerHandler.accept(new RestClusterStatsAction());
    registerHandler.accept(new RestClusterStateAction(settingsFilter));
    registerHandler.accept(new RestClusterHealthAction());
    registerHandler.accept(new RestClusterUpdateSettingsAction());
    registerHandler.accept(new RestClusterGetSettingsAction(settings, clusterSettings, settingsFilter));
    registerHandler.accept(new RestClusterRerouteAction(settingsFilter));
    registerHandler.accept(new RestClusterSearchShardsAction());
    registerHandler.accept(new RestPendingClusterTasksAction());
    registerHandler.accept(new RestPutRepositoryAction());
    registerHandler.accept(new RestGetRepositoriesAction(settingsFilter));
    registerHandler.accept(new RestDeleteRepositoryAction());
    registerHandler.accept(new RestVerifyRepositoryAction());
    registerHandler.accept(new RestCleanupRepositoryAction());
    registerHandler.accept(new RestGetSnapshotsAction());
    registerHandler.accept(new RestCreateSnapshotAction());
    registerHandler.accept(new RestCloneSnapshotAction());
    registerHandler.accept(new RestRestoreSnapshotAction());
    registerHandler.accept(new RestDeleteSnapshotAction());
    registerHandler.accept(new RestSnapshotsStatusAction());
    registerHandler.accept(new RestGetIndicesAction());
    registerHandler.accept(new RestIndicesStatsAction());
    registerHandler.accept(new RestIndicesSegmentsAction());
    registerHandler.accept(new RestIndicesShardStoresAction());
    registerHandler.accept(new RestGetAliasesAction());
    registerHandler.accept(new RestIndexDeleteAliasesAction());
    registerHandler.accept(new RestIndexPutAliasAction());
    registerHandler.accept(new RestIndicesAliasesAction());
    registerHandler.accept(new RestCreateIndexAction());
    registerHandler.accept(new RestResizeHandler.RestShrinkIndexAction());
    registerHandler.accept(new RestResizeHandler.RestSplitIndexAction());
    registerHandler.accept(new RestResizeHandler.RestCloneIndexAction());
    registerHandler.accept(new RestRolloverIndexAction());
    registerHandler.accept(new RestDeleteIndexAction());
    registerHandler.accept(new RestCloseIndexAction());
    registerHandler.accept(new RestOpenIndexAction());
    registerHandler.accept(new RestAddIndexBlockAction());
    registerHandler.accept(new RestUpdateSettingsAction());
    registerHandler.accept(new RestGetSettingsAction());
    registerHandler.accept(new RestAnalyzeAction());
    registerHandler.accept(new RestGetIndexTemplateAction());
    registerHandler.accept(new RestPutIndexTemplateAction());
    registerHandler.accept(new RestDeleteIndexTemplateAction());
    registerHandler.accept(new RestPutComponentTemplateAction());
    registerHandler.accept(new RestGetComponentTemplateAction());
    registerHandler.accept(new RestDeleteComponentTemplateAction());
    registerHandler.accept(new RestPutComposableIndexTemplateAction());
    registerHandler.accept(new RestGetComposableIndexTemplateAction());
    registerHandler.accept(new RestDeleteComposableIndexTemplateAction());
    registerHandler.accept(new RestSimulateIndexTemplateAction());
    registerHandler.accept(new RestSimulateTemplateAction());
    registerHandler.accept(new RestPutMappingAction());
    registerHandler.accept(new RestGetMappingAction(threadPool));
    registerHandler.accept(new RestGetFieldMappingAction());
    registerHandler.accept(new RestRefreshAction());
    registerHandler.accept(new RestFlushAction());
    registerHandler.accept(new RestSyncedFlushAction());
    registerHandler.accept(new RestForceMergeAction());
    registerHandler.accept(new RestUpgradeAction());
    registerHandler.accept(new RestUpgradeStatusAction());
    registerHandler.accept(new RestClearIndicesCacheAction());
    registerHandler.accept(new RestIndexAction());
    registerHandler.accept(new CreateHandler());
    registerHandler.accept(new AutoIdHandler(nodesInCluster));
    registerHandler.accept(new RestGetAction());
    registerHandler.accept(new RestGetSourceAction());
    registerHandler.accept(new RestMultiGetAction(settings));
    registerHandler.accept(new RestDeleteAction());
    registerHandler.accept(new RestCountAction());
    registerHandler.accept(new RestTermVectorsAction());
    registerHandler.accept(new RestMultiTermVectorsAction());
    registerHandler.accept(new RestBulkAction(settings));
    registerHandler.accept(new RestUpdateAction());
    registerHandler.accept(new RestSearchAction());
    registerHandler.accept(new RestSearchScrollAction());
    registerHandler.accept(new RestClearScrollAction());
    registerHandler.accept(new RestMultiSearchAction(settings));
    registerHandler.accept(new RestValidateQueryAction());
    registerHandler.accept(new RestExplainAction());
    registerHandler.accept(new RestRecoveryAction());
    registerHandler.accept(new RestReloadSecureSettingsAction());
    // Scripts API
    registerHandler.accept(new RestGetStoredScriptAction());
    registerHandler.accept(new RestPutStoredScriptAction());
    registerHandler.accept(new RestDeleteStoredScriptAction());
    registerHandler.accept(new RestGetScriptContextAction());
    registerHandler.accept(new RestGetScriptLanguageAction());
    registerHandler.accept(new RestFieldCapabilitiesAction());
    // Tasks API
    registerHandler.accept(new RestListTasksAction(nodesInCluster));
    registerHandler.accept(new RestGetTaskAction());
    registerHandler.accept(new RestCancelTasksAction(nodesInCluster));
    // Ingest API
    registerHandler.accept(new RestPutPipelineAction());
    registerHandler.accept(new RestGetPipelineAction());
    registerHandler.accept(new RestDeletePipelineAction());
    registerHandler.accept(new RestSimulatePipelineAction());
    // Dangling indices API
    registerHandler.accept(new RestListDanglingIndicesAction());
    registerHandler.accept(new RestImportDanglingIndexAction());
    registerHandler.accept(new RestDeleteDanglingIndexAction());
    // Data Stream API
    registerHandler.accept(new RestCreateDataStreamAction());
    registerHandler.accept(new RestDeleteDataStreamAction());
    registerHandler.accept(new RestGetDataStreamsAction());
    registerHandler.accept(new RestResolveIndexAction());
    registerHandler.accept(new RestDataStreamsStatsAction());
    // CAT API
    registerHandler.accept(new RestAllocationAction());
    registerHandler.accept(new RestShardsAction());
    registerHandler.accept(new RestMasterAction());
    registerHandler.accept(new RestNodesAction());
    registerHandler.accept(new RestTasksAction(nodesInCluster));
    registerHandler.accept(new RestIndicesAction());
    registerHandler.accept(new RestSegmentsAction());
    // Fully qualified to prevent interference with rest.action.count.RestCountAction
    registerHandler.accept(new org.opensearch.rest.action.cat.RestCountAction());
    // Fully qualified to prevent interference with rest.action.indices.RestRecoveryAction
    registerHandler.accept(new RestCatRecoveryAction());
    registerHandler.accept(new RestHealthAction());
    registerHandler.accept(new org.opensearch.rest.action.cat.RestPendingClusterTasksAction());
    registerHandler.accept(new RestAliasAction());
    registerHandler.accept(new RestThreadPoolAction());
    registerHandler.accept(new RestPluginsAction());
    registerHandler.accept(new RestFielddataAction());
    registerHandler.accept(new RestNodeAttrsAction());
    registerHandler.accept(new RestRepositoriesAction());
    registerHandler.accept(new RestSnapshotAction());
    registerHandler.accept(new RestTemplatesAction());
    for (ActionPlugin plugin : actionPlugins) {
        for (RestHandler handler : plugin.getRestHandlers(settings, restController, clusterSettings, indexScopedSettings, settingsFilter, indexNameExpressionResolver, nodesInCluster)) {
            registerHandler.accept(handler);
        }
    }
    registerHandler.accept(new RestCatAction(catActions));
}

Example 3 with IndexScopedSettings

use of org.opensearch.common.settings.IndexScopedSettings in project OpenSearch by opensearch-project.

the class MetadataCreateIndexService method applyCreateIndexRequestWithV1Templates.

private ClusterState applyCreateIndexRequestWithV1Templates(final ClusterState currentState, final CreateIndexClusterStateUpdateRequest request, final boolean silent, final List<IndexTemplateMetadata> templates, final BiConsumer<Metadata.Builder, IndexMetadata> metadataTransformer) throws Exception {
    logger.debug("applying create index request using legacy templates {}", templates.stream().map(IndexTemplateMetadata::name).collect(Collectors.toList()));
    final Map<String, Map<String, Object>> mappings = Collections.unmodifiableMap(parseV1Mappings(request.mappings(), templates.stream().map(IndexTemplateMetadata::getMappings).map(iom -> {
        Map<String, CompressedXContent> converted = new HashMap<>(iom.size());
        for (ObjectObjectCursor<String, CompressedXContent> cursor : iom) {
            converted.put(cursor.key, cursor.value);
        }
        return converted;
    }).collect(toList()), xContentRegistry));
    final Settings aggregatedIndexSettings = aggregateIndexSettings(currentState, request, MetadataIndexTemplateService.resolveSettings(templates), null, settings, indexScopedSettings, shardLimitValidator, indexSettingProviders);
    int routingNumShards = getIndexNumberOfRoutingShards(aggregatedIndexSettings, null);
    IndexMetadata tmpImd = buildAndValidateTemporaryIndexMetadata(currentState, aggregatedIndexSettings, request, routingNumShards);
    return applyCreateIndexWithTemporaryService(currentState, request, silent, null, tmpImd, Collections.singletonList(mappings), indexService -> resolveAndValidateAliases(request.index(), request.aliases(), MetadataIndexTemplateService.resolveAliases(templates), currentState.metadata(), aliasValidator, // shard id and the current timestamp
    xContentRegistry, indexService.newQueryShardContext(0, null, () -> 0L, null)), templates.stream().map(IndexTemplateMetadata::getName).collect(toList()), metadataTransformer);
}

Example 4 with IndexScopedSettings

use of org.opensearch.common.settings.IndexScopedSettings in project OpenSearch by opensearch-project.

the class MetadataCreateIndexService method aggregateIndexSettings.

/**
 * Validates and creates the settings for the new index based on the explicitly configured settings via the
 * {@link CreateIndexClusterStateUpdateRequest}, inherited from templates and, if recovering from another index (ie. split, shrink,
 * clone), the resize settings.
 *
 * The template mappings are applied in the order they are encountered in the list (clients should make sure the lower index, closer
 * to the head of the list, templates have the highest {@link IndexTemplateMetadata#order()})
 *
 * @return the aggregated settings for the new index
 */
static Settings aggregateIndexSettings(ClusterState currentState, CreateIndexClusterStateUpdateRequest request, Settings combinedTemplateSettings, @Nullable IndexMetadata sourceMetadata, Settings settings, IndexScopedSettings indexScopedSettings, ShardLimitValidator shardLimitValidator, Set<IndexSettingProvider> indexSettingProviders) {
    // Create builders for the template and request settings. We transform these into builders
    // because we may want settings to be "removed" from these prior to being set on the new
    // index (see more comments below)
    final Settings.Builder templateSettings = Settings.builder().put(combinedTemplateSettings);
    final Settings.Builder requestSettings = Settings.builder().put(request.settings());
    final Settings.Builder indexSettingsBuilder = Settings.builder();
    if (sourceMetadata == null) {
        final Settings.Builder additionalIndexSettings = Settings.builder();
        final Settings templateAndRequestSettings = Settings.builder().put(combinedTemplateSettings).put(request.settings()).build();
        final boolean isDataStreamIndex = request.dataStreamName() != null;
        // additionalIndexSettings map
        for (IndexSettingProvider provider : indexSettingProviders) {
            additionalIndexSettings.put(provider.getAdditionalIndexSettings(request.index(), isDataStreamIndex, templateAndRequestSettings));
        }
        // value).
        for (String explicitSetting : additionalIndexSettings.keys()) {
            if (templateSettings.keys().contains(explicitSetting) && templateSettings.get(explicitSetting) == null) {
                logger.debug("removing default [{}] setting as it in set to null in a template for [{}] creation", explicitSetting, request.index());
                additionalIndexSettings.remove(explicitSetting);
                templateSettings.remove(explicitSetting);
            }
            if (requestSettings.keys().contains(explicitSetting) && requestSettings.get(explicitSetting) == null) {
                logger.debug("removing default [{}] setting as it in set to null in the request for [{}] creation", explicitSetting, request.index());
                additionalIndexSettings.remove(explicitSetting);
                requestSettings.remove(explicitSetting);
            }
        }
        // Finally, we actually add the explicit defaults prior to the template settings and the
        // request settings, so that the precedence goes:
        // Explicit Defaults -> Template -> Request -> Necessary Settings (# of shards, uuid, etc)
        indexSettingsBuilder.put(additionalIndexSettings.build());
        indexSettingsBuilder.put(templateSettings.build());
    }
    // now, put the request settings, so they override templates
    indexSettingsBuilder.put(requestSettings.build());
    if (indexSettingsBuilder.get(IndexMetadata.SETTING_INDEX_VERSION_CREATED.getKey()) == null) {
        final DiscoveryNodes nodes = currentState.nodes();
        final Version createdVersion = Version.min(Version.CURRENT, nodes.getSmallestNonClientNodeVersion());
        indexSettingsBuilder.put(IndexMetadata.SETTING_INDEX_VERSION_CREATED.getKey(), createdVersion);
    }
    if (INDEX_NUMBER_OF_SHARDS_SETTING.exists(indexSettingsBuilder) == false) {
        final int numberOfShards;
        if (INDEX_NUMBER_OF_SHARDS_SETTING.exists(settings)) {
            numberOfShards = INDEX_NUMBER_OF_SHARDS_SETTING.get(settings);
        } else {
            numberOfShards = getNumberOfShards(indexSettingsBuilder);
        }
        indexSettingsBuilder.put(SETTING_NUMBER_OF_SHARDS, numberOfShards);
    }
    if (INDEX_NUMBER_OF_REPLICAS_SETTING.exists(indexSettingsBuilder) == false) {
        indexSettingsBuilder.put(SETTING_NUMBER_OF_REPLICAS, INDEX_NUMBER_OF_REPLICAS_SETTING.get(settings));
    }
    if (settings.get(SETTING_AUTO_EXPAND_REPLICAS) != null && indexSettingsBuilder.get(SETTING_AUTO_EXPAND_REPLICAS) == null) {
        indexSettingsBuilder.put(SETTING_AUTO_EXPAND_REPLICAS, settings.get(SETTING_AUTO_EXPAND_REPLICAS));
    }
    if (indexSettingsBuilder.get(SETTING_CREATION_DATE) == null) {
        indexSettingsBuilder.put(SETTING_CREATION_DATE, Instant.now().toEpochMilli());
    }
    indexSettingsBuilder.put(IndexMetadata.SETTING_INDEX_PROVIDED_NAME, request.getProvidedName());
    indexSettingsBuilder.put(SETTING_INDEX_UUID, UUIDs.randomBase64UUID());
    if (sourceMetadata != null) {
        assert request.resizeType() != null;
        prepareResizeIndexSettings(currentState, indexSettingsBuilder, request.recoverFrom(), request.index(), request.resizeType(), request.copySettings(), indexScopedSettings);
    }
    Settings indexSettings = indexSettingsBuilder.build();
    /*
         * We can not validate settings until we have applied templates, otherwise we do not know the actual settings
         * that will be used to create this index.
         */
    shardLimitValidator.validateShardLimit(indexSettings, currentState);
    if (IndexSettings.INDEX_SOFT_DELETES_SETTING.get(indexSettings) == false && IndexMetadata.SETTING_INDEX_VERSION_CREATED.get(indexSettings).onOrAfter(Version.V_2_0_0)) {
        throw new IllegalArgumentException("Creating indices with soft-deletes disabled is no longer supported. " + "Please do not specify a value for setting [index.soft_deletes.enabled].");
    }
    validateTranslogRetentionSettings(indexSettings);
    validateStoreTypeSettings(indexSettings);
    return indexSettings;
}

Example 5 with IndexScopedSettings

use of org.opensearch.common.settings.IndexScopedSettings in project OpenSearch by opensearch-project.

the class MetadataCreateIndexService method applyCreateIndexRequestWithV2Template.

private ClusterState applyCreateIndexRequestWithV2Template(final ClusterState currentState, final CreateIndexClusterStateUpdateRequest request, final boolean silent, final String templateName, final BiConsumer<Metadata.Builder, IndexMetadata> metadataTransformer) throws Exception {
    logger.debug("applying create index request using composable template [{}]", templateName);
    ComposableIndexTemplate template = currentState.getMetadata().templatesV2().get(templateName);
    if (request.dataStreamName() == null && template.getDataStreamTemplate() != null) {
        throw new IllegalArgumentException("cannot create index with name [" + request.index() + "], because it matches with template [" + templateName + "] that creates data streams only, " + "use create data stream api instead");
    }
    final List<Map<String, Map<String, Object>>> mappings = collectV2Mappings(request.mappings(), currentState, templateName, xContentRegistry, request.index());
    final Settings aggregatedIndexSettings = aggregateIndexSettings(currentState, request, MetadataIndexTemplateService.resolveSettings(currentState.metadata(), templateName), null, settings, indexScopedSettings, shardLimitValidator, indexSettingProviders);
    int routingNumShards = getIndexNumberOfRoutingShards(aggregatedIndexSettings, null);
    IndexMetadata tmpImd = buildAndValidateTemporaryIndexMetadata(currentState, aggregatedIndexSettings, request, routingNumShards);
    return applyCreateIndexWithTemporaryService(currentState, request, silent, null, tmpImd, mappings, indexService -> resolveAndValidateAliases(request.index(), request.aliases(), MetadataIndexTemplateService.resolveAliases(currentState.metadata(), templateName), currentState.metadata(), aliasValidator, // shard id and the current timestamp
    xContentRegistry, indexService.newQueryShardContext(0, null, () -> 0L, null)), Collections.singletonList(templateName), metadataTransformer);
}