Using settings from elasticsearch.yml in a plugin

rahulkarajgikar · June 2, 2020, 11:25am

Hi,

I'm creating a plugin that blacklists certain API calls. Right now I've created a .yml file in the src/main/resources directory of my project, where I read the blacklisted APIs from.
The problem is, if I want to add more blacklisted API's to the list, I have to remove the plugin, change the yml file, rebuild and reinstall the plugin. I'd like my plugin to be able to read directly from elasticsearch.yml, so that I don't have to do this. Is this possible?
Any suggestions would be greatly appreciated.

Thanks

dadoonet · June 2, 2020, 1:17pm

It's possible. You need to declare some settings for that.

Here is an example of settings:

github.com

elastic/elasticsearch/blob/master/plugins/discovery-ec2/src/main/java/org/elasticsearch/discovery/ec2/Ec2ClientSettings.java

/*
 * 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.
 */

package org.elasticsearch.discovery.ec2;

This file has been truncated. show original

And how you declare them in the plugin:

github.com

elastic/elasticsearch/blob/5b454000755dc4c8c1c8cdce78656facf751d6d0/plugins/discovery-ec2/src/main/java/org/elasticsearch/discovery/ec2/Ec2DiscoveryPlugin.java#L104-L126


@Override
public List<Setting<?>> getSettings() {
    return Arrays.asList(
    // Register EC2 discovery settings: discovery.ec2
    Ec2ClientSettings.ACCESS_KEY_SETTING,
    Ec2ClientSettings.SECRET_KEY_SETTING,
    Ec2ClientSettings.SESSION_TOKEN_SETTING,
    Ec2ClientSettings.ENDPOINT_SETTING,
    Ec2ClientSettings.PROTOCOL_SETTING,
    Ec2ClientSettings.PROXY_HOST_SETTING,
    Ec2ClientSettings.PROXY_PORT_SETTING,
    Ec2ClientSettings.PROXY_USERNAME_SETTING,
    Ec2ClientSettings.PROXY_PASSWORD_SETTING,
    Ec2ClientSettings.READ_TIMEOUT_SETTING,
    AwsEc2Service.HOST_TYPE_SETTING,
    AwsEc2Service.ANY_GROUP_SETTING,
    AwsEc2Service.GROUPS_SETTING,
    AwsEc2Service.AVAILABILITY_ZONES_SETTING,
    AwsEc2Service.NODE_CACHE_TIME_SETTING,
    AwsEc2Service.TAG_SETTING,

This file has been truncated. show original

HTH

rahulkarajgikar · June 2, 2020, 1:28pm

Thanks a lot! This is exactly what I needed

system · June 30, 2020, 1:28pm

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.