| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF 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.apache.brooklyn.entity.nosql.elasticsearch; |
| |
| import org.apache.brooklyn.api.catalog.Catalog; |
| import org.apache.brooklyn.api.entity.ImplementedBy; |
| import org.apache.brooklyn.api.sensor.AttributeSensor; |
| import org.apache.brooklyn.config.ConfigKey; |
| import org.apache.brooklyn.core.config.ConfigKeys; |
| import org.apache.brooklyn.core.location.PortRanges; |
| import org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey; |
| import org.apache.brooklyn.core.sensor.BasicAttributeSensorAndConfigKey.StringAttributeSensorAndConfigKey; |
| import org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey; |
| import org.apache.brooklyn.core.sensor.Sensors; |
| import org.apache.brooklyn.entity.database.DatastoreMixins; |
| import org.apache.brooklyn.entity.java.UsesJava; |
| import org.apache.brooklyn.entity.software.base.SoftwareProcess; |
| import org.apache.brooklyn.entity.webapp.WebAppServiceConstants; |
| import org.apache.brooklyn.util.core.ResourcePredicates; |
| import org.apache.brooklyn.util.core.flags.SetFromFlag; |
| |
| /** |
| * An {@link org.apache.brooklyn.api.entity.Entity} that represents an ElasticSearch node |
| */ |
| @Catalog(name="Elastic Search Node", description="Elasticsearch is an open-source search server based on Lucene. " |
| + "It provides a distributed, multitenant-capable full-text search engine with a RESTful web interface and " |
| + "schema-free JSON documents.") |
| @ImplementedBy(ElasticSearchNodeImpl.class) |
| public interface ElasticSearchNode extends SoftwareProcess, UsesJava, DatastoreMixins.HasDatastoreUrl { |
| |
| @SetFromFlag("version") |
| ConfigKey<String> SUGGESTED_VERSION = ConfigKeys.newConfigKeyWithDefault(SoftwareProcess.SUGGESTED_VERSION, "1.2.1"); |
| |
| @SetFromFlag("archiveNameFormat") |
| ConfigKey<String> ARCHIVE_DIRECTORY_NAME_FORMAT = ConfigKeys.newConfigKeyWithDefault(SoftwareProcess.ARCHIVE_DIRECTORY_NAME_FORMAT, "elasticsearch-%s"); |
| |
| @SetFromFlag("downloadUrl") |
| AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL = ConfigKeys.newSensorAndConfigKeyWithDefault(SoftwareProcess.DOWNLOAD_URL, |
| "https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-${version}.tar.gz"); |
| |
| @SetFromFlag("dataDir") |
| ConfigKey<String> DATA_DIR = ConfigKeys.newStringConfigKey("elasticsearch.node.data.dir", "Directory for writing data files", null); |
| |
| @SetFromFlag("logDir") |
| ConfigKey<String> LOG_DIR = ConfigKeys.newStringConfigKey("elasticsearch.node.log.dir", "Directory for writing log files", null); |
| |
| @SetFromFlag("configFileUrl") |
| ConfigKey<String> TEMPLATE_CONFIGURATION_URL = ConfigKeys.builder(String.class) |
| .name("elasticsearch.node.template.configuration.url") |
| .description("URL where the elasticsearch configuration file (in freemarker format) can be found") |
| .defaultValue(null) |
| .constraint(ResourcePredicates.urlIsBlankOrExists()) |
| .build(); |
| |
| @SetFromFlag("multicastEnabled") |
| ConfigKey<Boolean> MULTICAST_ENABLED = ConfigKeys.newBooleanConfigKey("elasticsearch.node.multicast.enabled", |
| "Indicates whether zen discovery multicast should be enabled for a node", null); |
| |
| @SetFromFlag("multicastEnabled") |
| ConfigKey<Boolean> UNICAST_ENABLED = ConfigKeys.newBooleanConfigKey("elasticsearch.node.UNicast.enabled", |
| "Indicates whether zen discovery unicast should be enabled for a node", null); |
| |
| @SetFromFlag("httpPort") |
| PortAttributeSensorAndConfigKey HTTP_PORT = new PortAttributeSensorAndConfigKey(WebAppServiceConstants.HTTP_PORT, PortRanges.fromString("9200+")); |
| |
| @SetFromFlag("nodeName") |
| StringAttributeSensorAndConfigKey NODE_NAME = new StringAttributeSensorAndConfigKey("elasticsearch.node.name", |
| "Node name (or randomly selected if not set", null); |
| |
| @SetFromFlag("clusterName") |
| StringAttributeSensorAndConfigKey CLUSTER_NAME = new StringAttributeSensorAndConfigKey("elasticsearch.node.cluster.name", |
| "Cluster name (or elasticsearch selected if not set", null); |
| |
| @SetFromFlag("useHttpMonitoring") |
| ConfigKey<Boolean> USE_HTTP_MONITORING = ConfigKeys.newConfigKey("httpMonitoring.enabled", "HTTP(S) monitoring enabled", Boolean.TRUE); |
| |
| AttributeSensor<String> NODE_ID = Sensors.newStringSensor("elasticsearch.node.id"); |
| AttributeSensor<Integer> DOCUMENT_COUNT = Sensors.newIntegerSensor("elasticsearch.node.docs.count"); |
| AttributeSensor<Integer> STORE_BYTES = Sensors.newIntegerSensor("elasticsearch.node.store.bytes"); |
| AttributeSensor<Integer> GET_TOTAL = Sensors.newIntegerSensor("elasticsearch.node.get.total"); |
| AttributeSensor<Integer> GET_TIME_IN_MILLIS = Sensors.newIntegerSensor("elasticsearch.node.get.time.in.millis"); |
| AttributeSensor<Integer> SEARCH_QUERY_TOTAL = Sensors.newIntegerSensor("elasticsearch.node.search.query.total"); |
| AttributeSensor<Integer> SEARCH_QUERY_TIME_IN_MILLIS = Sensors.newIntegerSensor("elasticsearch.node.search.query.time.in.millis"); |
| |
| } |