YARN-3662. Federation Membership State Store internal APIs.
Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/a48c8e65 Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/a48c8e65 Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/a48c8e65 Branch: refs/heads/YARN-2915 Commit: a48c8e65ed23fd546e33950a70a1e6a36f25cb6a Parents: ad03510 Author: Subru Krishnan <su...@apache.org> Authored: Fri Jul 29 16:53:40 2016 -0700 Committer: Subru Krishnan <su...@apache.org> Committed: Mon Oct 3 14:15:36 2016 -0700 ---------------------------------------------------------------------- .../hadoop/yarn/api/BasePBImplRecordsTest.java | 263 ++++++++++++++++++ .../hadoop/yarn/api/TestPBImplRecords.java | 259 +----------------- .../hadoop-yarn-server-common/pom.xml | 8 + .../store/FederationMembershipStateStore.java | 126 +++++++++ .../server/federation/store/package-info.java | 17 ++ .../store/records/GetSubClusterInfoRequest.java | 62 +++++ .../records/GetSubClusterInfoResponse.java | 62 +++++ .../records/GetSubClustersInfoRequest.java | 66 +++++ .../records/GetSubClustersInfoResponse.java | 66 +++++ .../records/SubClusterDeregisterRequest.java | 89 +++++++ .../records/SubClusterDeregisterResponse.java | 42 +++ .../records/SubClusterHeartbeatRequest.java | 149 +++++++++++ .../records/SubClusterHeartbeatResponse.java | 45 ++++ .../federation/store/records/SubClusterId.java | 100 +++++++ .../store/records/SubClusterInfo.java | 263 ++++++++++++++++++ .../records/SubClusterRegisterRequest.java | 74 +++++ .../records/SubClusterRegisterResponse.java | 44 +++ .../store/records/SubClusterState.java | 60 +++++ .../impl/pb/GetSubClusterInfoRequestPBImpl.java | 125 +++++++++ .../pb/GetSubClusterInfoResponsePBImpl.java | 134 ++++++++++ .../pb/GetSubClustersInfoRequestPBImpl.java | 108 ++++++++ .../pb/GetSubClustersInfoResponsePBImpl.java | 184 +++++++++++++ .../pb/SubClusterDeregisterRequestPBImpl.java | 156 +++++++++++ .../pb/SubClusterDeregisterResponsePBImpl.java | 77 ++++++ .../pb/SubClusterHeartbeatRequestPBImpl.java | 192 +++++++++++++ .../pb/SubClusterHeartbeatResponsePBImpl.java | 77 ++++++ .../records/impl/pb/SubClusterIdPBImpl.java | 75 ++++++ .../records/impl/pb/SubClusterInfoPBImpl.java | 267 +++++++++++++++++++ .../pb/SubClusterRegisterRequestPBImpl.java | 134 ++++++++++ .../pb/SubClusterRegisterResponsePBImpl.java | 77 ++++++ .../store/records/impl/pb/package-info.java | 17 ++ .../federation/store/records/package-info.java | 17 ++ .../proto/yarn_server_federation_protos.proto | 93 +++++++ .../records/TestFederationProtocolRecords.java | 133 +++++++++ 34 files changed, 3409 insertions(+), 252 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/BasePBImplRecordsTest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/BasePBImplRecordsTest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/BasePBImplRecordsTest.java new file mode 100644 index 0000000..98d8222 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/BasePBImplRecordsTest.java @@ -0,0 +1,263 @@ +/** + * 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.hadoop.yarn.api; + +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import com.google.common.collect.Sets; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.junit.Assert; + +import java.lang.reflect.*; +import java.nio.ByteBuffer; +import java.util.*; + +/** + * Generic helper class to validate protocol records. + */ +public class BasePBImplRecordsTest { + static final Log LOG = LogFactory.getLog(BasePBImplRecordsTest.class); + + protected static HashMap<Type, Object> typeValueCache = + new HashMap<Type, Object>(); + private static Random rand = new Random(); + private static byte [] bytes = new byte[] {'1', '2', '3', '4'}; + + @SuppressWarnings({"rawtypes", "unchecked"}) + private static Object genTypeValue(Type type) { + Object ret = typeValueCache.get(type); + if (ret != null) { + return ret; + } + // only use positive primitive values + if (type.equals(boolean.class)) { + return rand.nextBoolean(); + } else if (type.equals(byte.class)) { + return bytes[rand.nextInt(4)]; + } else if (type.equals(int.class) || type.equals(Integer.class)) { + return rand.nextInt(1000000); + } else if (type.equals(long.class)) { + return Long.valueOf(rand.nextInt(1000000)); + } else if (type.equals(float.class)) { + return rand.nextFloat(); + } else if (type.equals(double.class)) { + return rand.nextDouble(); + } else if (type.equals(String.class)) { + return String.format("%c%c%c", + 'a' + rand.nextInt(26), + 'a' + rand.nextInt(26), + 'a' + rand.nextInt(26)); + } else if (type instanceof Class) { + Class clazz = (Class)type; + if (clazz.isArray()) { + Class compClass = clazz.getComponentType(); + if (compClass != null) { + ret = Array.newInstance(compClass, 2); + Array.set(ret, 0, genTypeValue(compClass)); + Array.set(ret, 1, genTypeValue(compClass)); + } + } else if (clazz.isEnum()) { + Object [] values = clazz.getEnumConstants(); + ret = values[rand.nextInt(values.length)]; + } else if (clazz.equals(ByteBuffer.class)) { + // return new ByteBuffer every time + // to prevent potential side effects + ByteBuffer buff = ByteBuffer.allocate(4); + rand.nextBytes(buff.array()); + return buff; + } + } else if (type instanceof ParameterizedType) { + ParameterizedType pt = (ParameterizedType)type; + Type rawType = pt.getRawType(); + Type [] params = pt.getActualTypeArguments(); + // only support EnumSet<T>, List<T>, Set<T>, Map<K,V> + if (rawType.equals(EnumSet.class)) { + if (params[0] instanceof Class) { + Class c = (Class)(params[0]); + return EnumSet.allOf(c); + } + } if (rawType.equals(List.class)) { + ret = Lists.newArrayList(genTypeValue(params[0])); + } else if (rawType.equals(Set.class)) { + ret = Sets.newHashSet(genTypeValue(params[0])); + } else if (rawType.equals(Map.class)) { + Map<Object, Object> map = Maps.newHashMap(); + map.put(genTypeValue(params[0]), genTypeValue(params[1])); + ret = map; + } + } + if (ret == null) { + throw new IllegalArgumentException("type " + type + " is not supported"); + } + typeValueCache.put(type, ret); + return ret; + } + + /** + * this method generate record instance by calling newIntance + * using reflection, add register the generated value to typeValueCache + */ + @SuppressWarnings("rawtypes") + protected static Object generateByNewInstance(Class clazz) throws Exception { + Object ret = typeValueCache.get(clazz); + if (ret != null) { + return ret; + } + Method newInstance = null; + Type [] paramTypes = new Type[0]; + // get newInstance method with most parameters + for (Method m : clazz.getMethods()) { + int mod = m.getModifiers(); + if (m.getDeclaringClass().equals(clazz) && + Modifier.isPublic(mod) && + Modifier.isStatic(mod) && + m.getName().equals("newInstance")) { + Type [] pts = m.getGenericParameterTypes(); + if (newInstance == null + || (pts.length > paramTypes.length)) { + newInstance = m; + paramTypes = pts; + } + } + } + if (newInstance == null) { + throw new IllegalArgumentException("type " + clazz.getName() + + " does not have newInstance method"); + } + Object [] args = new Object[paramTypes.length]; + for (int i=0;i<args.length;i++) { + args[i] = genTypeValue(paramTypes[i]); + } + ret = newInstance.invoke(null, args); + typeValueCache.put(clazz, ret); + return ret; + } + + private class GetSetPair { + public String propertyName; + public Method getMethod; + public Method setMethod; + public Type type; + public Object testValue; + + @Override + public String toString() { + return String.format("{ name=%s, class=%s, value=%s }", propertyName, + type, testValue); + } + } + + private <R> Map<String, GetSetPair> getGetSetPairs(Class<R> recordClass) + throws Exception { + Map<String, GetSetPair> ret = new HashMap<String, GetSetPair>(); + Method [] methods = recordClass.getDeclaredMethods(); + // get all get methods + for (int i = 0; i < methods.length; i++) { + Method m = methods[i]; + int mod = m.getModifiers(); + if (m.getDeclaringClass().equals(recordClass) && + Modifier.isPublic(mod) && + (!Modifier.isStatic(mod))) { + String name = m.getName(); + if (name.equals("getProto")) { + continue; + } + if ((name.length() > 3) && name.startsWith("get") && + (m.getParameterTypes().length == 0)) { + String propertyName = name.substring(3); + Type valueType = m.getGenericReturnType(); + GetSetPair p = ret.get(propertyName); + if (p == null) { + p = new GetSetPair(); + p.propertyName = propertyName; + p.type = valueType; + p.getMethod = m; + ret.put(propertyName, p); + } else { + Assert.fail("Multiple get method with same name: " + recordClass + + p.propertyName); + } + } + } + } + // match get methods with set methods + for (int i = 0; i < methods.length; i++) { + Method m = methods[i]; + int mod = m.getModifiers(); + if (m.getDeclaringClass().equals(recordClass) && + Modifier.isPublic(mod) && + (!Modifier.isStatic(mod))) { + String name = m.getName(); + if (name.startsWith("set") && (m.getParameterTypes().length == 1)) { + String propertyName = name.substring(3); + Type valueType = m.getGenericParameterTypes()[0]; + GetSetPair p = ret.get(propertyName); + if (p != null && p.type.equals(valueType)) { + p.setMethod = m; + } + } + } + } + // exclude incomplete get/set pair, and generate test value + Iterator<Map.Entry<String, GetSetPair>> itr = ret.entrySet().iterator(); + while (itr.hasNext()) { + Map.Entry<String, GetSetPair> cur = itr.next(); + GetSetPair gsp = cur.getValue(); + if ((gsp.getMethod == null) || + (gsp.setMethod == null)) { + LOG.info(String.format("Exclude protential property: %s\n", gsp.propertyName)); + itr.remove(); + } else { + LOG.info(String.format("New property: %s type: %s", gsp.toString(), gsp.type)); + gsp.testValue = genTypeValue(gsp.type); + LOG.info(String.format(" testValue: %s\n", gsp.testValue)); + } + } + return ret; + } + + protected <R, P> void validatePBImplRecord(Class<R> recordClass, + Class<P> protoClass) + throws Exception { + LOG.info(String.format("Validate %s %s\n", recordClass.getName(), + protoClass.getName())); + Constructor<R> emptyConstructor = recordClass.getConstructor(); + Constructor<R> pbConstructor = recordClass.getConstructor(protoClass); + Method getProto = recordClass.getDeclaredMethod("getProto"); + Map<String, GetSetPair> getSetPairs = getGetSetPairs(recordClass); + R origRecord = emptyConstructor.newInstance(); + for (GetSetPair gsp : getSetPairs.values()) { + gsp.setMethod.invoke(origRecord, gsp.testValue); + } + Object ret = getProto.invoke(origRecord); + Assert.assertNotNull(recordClass.getName() + "#getProto returns null", ret); + if (!(protoClass.isAssignableFrom(ret.getClass()))) { + Assert.fail("Illegal getProto method return type: " + ret.getClass()); + } + R deserRecord = pbConstructor.newInstance(ret); + Assert.assertEquals("whole " + recordClass + " records should be equal", + origRecord, deserRecord); + for (GetSetPair gsp : getSetPairs.values()) { + Object origValue = gsp.getMethod.invoke(origRecord); + Object deserValue = gsp.getMethod.invoke(deserRecord); + Assert.assertEquals("property " + recordClass.getName() + "#" + + gsp.propertyName + " should be equal", origValue, deserValue); + } + } +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/TestPBImplRecords.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/TestPBImplRecords.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/TestPBImplRecords.java index 5270486..4b71282 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/TestPBImplRecords.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/java/org/apache/hadoop/yarn/api/TestPBImplRecords.java @@ -16,26 +16,8 @@ * limitations under the License. */ package org.apache.hadoop.yarn.api; -import java.io.IOException; -import java.lang.reflect.Array; -import java.lang.reflect.Constructor; -import java.lang.reflect.Method; -import java.lang.reflect.Modifier; -import java.lang.reflect.ParameterizedType; -import java.lang.reflect.Type; -import java.nio.ByteBuffer; -import java.util.EnumSet; -import java.util.HashMap; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import java.util.Random; -import java.util.Set; - +import com.google.common.collect.ImmutableSet; import org.apache.commons.lang.math.LongRange; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.apache.hadoop.security.proto.SecurityProtos.CancelDelegationTokenRequestProto; import org.apache.hadoop.security.proto.SecurityProtos.CancelDelegationTokenResponseProto; import org.apache.hadoop.security.proto.SecurityProtos.GetDelegationTokenRequestProto; @@ -343,127 +325,12 @@ import org.junit.BeforeClass; import org.junit.Ignore; import org.junit.Test; -import com.google.common.collect.ImmutableSet; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; -import com.google.common.collect.Sets; - -public class TestPBImplRecords { - static final Log LOG = LogFactory.getLog(TestPBImplRecords.class); - - private static HashMap<Type, Object> typeValueCache = new HashMap<Type, Object>(); - private static Random rand = new Random(); - private static byte [] bytes = new byte[] {'1', '2', '3', '4'}; - - @SuppressWarnings({"rawtypes", "unchecked"}) - private static Object genTypeValue(Type type) { - Object ret = typeValueCache.get(type); - if (ret != null) { - return ret; - } - // only use positive primitive values - if (type.equals(boolean.class)) { - return rand.nextBoolean(); - } else if (type.equals(byte.class)) { - return bytes[rand.nextInt(4)]; - } else if (type.equals(int.class) || type.equals(Integer.class)) { - return rand.nextInt(1000000); - } else if (type.equals(long.class) || type.equals(Long.class)) { - return Long.valueOf(rand.nextInt(1000000)); - } else if (type.equals(float.class)) { - return rand.nextFloat(); - } else if (type.equals(double.class)) { - return rand.nextDouble(); - } else if (type.equals(String.class)) { - return String.format("%c%c%c", - 'a' + rand.nextInt(26), - 'a' + rand.nextInt(26), - 'a' + rand.nextInt(26)); - } else if (type instanceof Class) { - Class clazz = (Class)type; - if (clazz.isArray()) { - Class compClass = clazz.getComponentType(); - if (compClass != null) { - ret = Array.newInstance(compClass, 2); - Array.set(ret, 0, genTypeValue(compClass)); - Array.set(ret, 1, genTypeValue(compClass)); - } - } else if (clazz.isEnum()) { - Object [] values = clazz.getEnumConstants(); - ret = values[rand.nextInt(values.length)]; - } else if (clazz.equals(ByteBuffer.class)) { - // return new ByteBuffer every time - // to prevent potential side effects - ByteBuffer buff = ByteBuffer.allocate(4); - rand.nextBytes(buff.array()); - return buff; - } - } else if (type instanceof ParameterizedType) { - ParameterizedType pt = (ParameterizedType)type; - Type rawType = pt.getRawType(); - Type [] params = pt.getActualTypeArguments(); - // only support EnumSet<T>, List<T>, Set<T>, Map<K,V> - if (rawType.equals(EnumSet.class)) { - if (params[0] instanceof Class) { - Class c = (Class)(params[0]); - return EnumSet.allOf(c); - } - } if (rawType.equals(List.class)) { - ret = Lists.newArrayList(genTypeValue(params[0])); - } else if (rawType.equals(Set.class)) { - ret = Sets.newHashSet(genTypeValue(params[0])); - } else if (rawType.equals(Map.class)) { - Map<Object, Object> map = Maps.newHashMap(); - map.put(genTypeValue(params[0]), genTypeValue(params[1])); - ret = map; - } - } - if (ret == null) { - throw new IllegalArgumentException("type " + type + " is not supported"); - } - typeValueCache.put(type, ret); - return ret; - } - - /** - * this method generate record instance by calling newIntance - * using reflection, add register the generated value to typeValueCache - */ - @SuppressWarnings("rawtypes") - private static Object generateByNewInstance(Class clazz) throws Exception { - Object ret = typeValueCache.get(clazz); - if (ret != null) { - return ret; - } - Method newInstance = null; - Type [] paramTypes = new Type[0]; - // get newInstance method with most parameters - for (Method m : clazz.getMethods()) { - int mod = m.getModifiers(); - if (m.getDeclaringClass().equals(clazz) && - Modifier.isPublic(mod) && - Modifier.isStatic(mod) && - m.getName().equals("newInstance")) { - Type [] pts = m.getGenericParameterTypes(); - if (newInstance == null - || (pts.length > paramTypes.length)) { - newInstance = m; - paramTypes = pts; - } - } - } - if (newInstance == null) { - throw new IllegalArgumentException("type " + clazz.getName() + - " does not have newInstance method"); - } - Object [] args = new Object[paramTypes.length]; - for (int i=0;i<args.length;i++) { - args[i] = genTypeValue(paramTypes[i]); - } - ret = newInstance.invoke(null, args); - typeValueCache.put(clazz, ret); - return ret; - } +import java.io.IOException; + +/** + * Test class for YARN API protocol records. + */ +public class TestPBImplRecords extends BasePBImplRecordsTest { @BeforeClass public static void setup() throws Exception { @@ -532,118 +399,6 @@ public class TestPBImplRecords { generateByNewInstance(CommitResponse.class); } - private class GetSetPair { - public String propertyName; - public Method getMethod; - public Method setMethod; - public Type type; - public Object testValue; - - @Override - public String toString() { - return String.format("{ name=%s, class=%s, value=%s }", propertyName, - type, testValue); - } - } - - private <R> Map<String, GetSetPair> getGetSetPairs(Class<R> recordClass) - throws Exception { - Map<String, GetSetPair> ret = new HashMap<String, GetSetPair>(); - Method [] methods = recordClass.getDeclaredMethods(); - // get all get methods - for (int i = 0; i < methods.length; i++) { - Method m = methods[i]; - int mod = m.getModifiers(); - if (m.getDeclaringClass().equals(recordClass) && - Modifier.isPublic(mod) && - (!Modifier.isStatic(mod))) { - String name = m.getName(); - if (name.equals("getProto")) { - continue; - } - if ((name.length() > 3) && name.startsWith("get") && - (m.getParameterTypes().length == 0)) { - String propertyName = name.substring(3); - Type valueType = m.getGenericReturnType(); - GetSetPair p = ret.get(propertyName); - if (p == null) { - p = new GetSetPair(); - p.propertyName = propertyName; - p.type = valueType; - p.getMethod = m; - ret.put(propertyName, p); - } else { - Assert.fail("Multiple get method with same name: " + recordClass - + p.propertyName); - } - } - } - } - // match get methods with set methods - for (int i = 0; i < methods.length; i++) { - Method m = methods[i]; - int mod = m.getModifiers(); - if (m.getDeclaringClass().equals(recordClass) && - Modifier.isPublic(mod) && - (!Modifier.isStatic(mod))) { - String name = m.getName(); - if (name.startsWith("set") && (m.getParameterTypes().length == 1)) { - String propertyName = name.substring(3); - Type valueType = m.getGenericParameterTypes()[0]; - GetSetPair p = ret.get(propertyName); - if (p != null && p.type.equals(valueType)) { - p.setMethod = m; - } - } - } - } - // exclude incomplete get/set pair, and generate test value - Iterator<Entry<String, GetSetPair>> itr = ret.entrySet().iterator(); - while (itr.hasNext()) { - Entry<String, GetSetPair> cur = itr.next(); - GetSetPair gsp = cur.getValue(); - if ((gsp.getMethod == null) || - (gsp.setMethod == null)) { - LOG.info(String.format("Exclude protential property: %s\n", gsp.propertyName)); - itr.remove(); - } else { - LOG.info(String.format("New property: %s type: %s", gsp.toString(), gsp.type)); - gsp.testValue = genTypeValue(gsp.type); - LOG.info(String.format(" testValue: %s\n", gsp.testValue)); - } - } - return ret; - } - - private <R, P> void validatePBImplRecord(Class<R> recordClass, - Class<P> protoClass) - throws Exception { - LOG.info(String.format("Validate %s %s\n", recordClass.getName(), - protoClass.getName())); - Constructor<R> emptyConstructor = recordClass.getConstructor(); - Constructor<R> pbConstructor = recordClass.getConstructor(protoClass); - Method getProto = recordClass.getDeclaredMethod("getProto"); - Map<String, GetSetPair> getSetPairs = getGetSetPairs(recordClass); - R origRecord = emptyConstructor.newInstance(); - for (GetSetPair gsp : getSetPairs.values()) { - gsp.setMethod.invoke(origRecord, gsp.testValue); - } - Object ret = getProto.invoke(origRecord); - Assert.assertNotNull(recordClass.getName() + "#getProto returns null", ret); - if (!(protoClass.isAssignableFrom(ret.getClass()))) { - Assert.fail("Illegal getProto method return type: " + ret.getClass()); - } - R deserRecord = pbConstructor.newInstance(ret); - Assert.assertEquals("whole " + recordClass + " records should be equal", - origRecord, deserRecord); - for (GetSetPair gsp : getSetPairs.values()) { - Object origValue = gsp.getMethod.invoke(origRecord); - Object deserValue = gsp.getMethod.invoke(deserRecord); - Assert.assertEquals("property " + recordClass.getName() + "#" - + gsp.propertyName + " should be equal", origValue, deserValue); - } - } - @Test public void testAllocateRequestPBImpl() throws Exception { validatePBImplRecord(AllocateRequestPBImpl.class, AllocateRequestProto.class); http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/pom.xml ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/pom.xml b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/pom.xml index b9e10ee..4216f76 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/pom.xml +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/pom.xml @@ -59,6 +59,13 @@ <groupId>org.apache.hadoop</groupId> <artifactId>hadoop-yarn-common</artifactId> </dependency> + <!-- 'mvn dependency:analyze' fails to detect use of this dependency --> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-yarn-common</artifactId> + <type>test-jar</type> + <scope>test</scope> + </dependency> <dependency> <groupId>com.google.guava</groupId> @@ -148,6 +155,7 @@ <include>yarn_server_common_protos.proto</include> <include>yarn_server_common_service_protos.proto</include> <include>yarn_server_common_service_protos.proto</include> + <include>yarn_server_federation_protos.proto</include> <include>ResourceTracker.proto</include> <include>SCMUploader.proto</include> <include>collectornodemanager_protocol.proto</include> http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.java new file mode 100644 index 0000000..378eadc --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.java @@ -0,0 +1,126 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.exceptions.YarnException; +import org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterInfoRequest; +import org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterInfoResponse; +import org.apache.hadoop.yarn.server.federation.store.records.GetSubClustersInfoRequest; +import org.apache.hadoop.yarn.server.federation.store.records.GetSubClustersInfoResponse; +import org.apache.hadoop.yarn.server.federation.store.records.SubClusterDeregisterRequest; +import org.apache.hadoop.yarn.server.federation.store.records.SubClusterDeregisterResponse; +import org.apache.hadoop.yarn.server.federation.store.records.SubClusterHeartbeatRequest; +import org.apache.hadoop.yarn.server.federation.store.records.SubClusterHeartbeatResponse; +import org.apache.hadoop.yarn.server.federation.store.records.SubClusterRegisterRequest; +import org.apache.hadoop.yarn.server.federation.store.records.SubClusterRegisterResponse; +import org.apache.hadoop.yarn.server.records.Version; + +/** + * FederationMembershipStateStore maintains the state of all + * <em>subcluster(s)</em> as encapsulated by {@code SubClusterInfo} for all the + * subcluster(s) that are participating in federation. + */ +@Private +@Unstable +public interface FederationMembershipStateStore { + + /** + * Get the {@link Version} of the underlying federation membership state + * store. + * + * @return the {@link Version} of the underlying federation membership state + * store + */ + Version getMembershipStateStoreVersion(); + + /** + * Register a <em>subcluster</em> by publishing capabilities as represented by + * {@code SubClusterInfo} to indicate participation in federation. This is + * typically done during initialization or restart/failover of the + * subcluster's <code>ResourceManager</code>. Upon successful registration, an + * identifier for the <em>subcluster</em> which is unique across the federated + * cluster is returned. The identifier is static, i.e. preserved across + * restarts and failover. + * + * @param registerSubClusterRequest the capabilities of the subcluster that + * wants to participate in federation. The subcluster id is also + * specified in case registration is triggered by restart/failover + * @return response empty on successfully if registration was successful + * @throws YarnException if the request is invalid/fails + */ + SubClusterRegisterResponse registerSubCluster( + SubClusterRegisterRequest registerSubClusterRequest) throws YarnException; + + /** + * Deregister a <em>subcluster</em> identified by {@code SubClusterId} to + * change state in federation. This can be done to mark the sub cluster lost, + * deregistered, or decommissioned. + * + * @param subClusterDeregisterRequest - the request to deregister the + * sub-cluster from federation. + * @return response empty on successfully deregistering the subcluster state + * @throws YarnException if the request is invalid/fails + */ + SubClusterDeregisterResponse deregisterSubCluster( + SubClusterDeregisterRequest subClusterDeregisterRequest) + throws YarnException; + + /** + * Periodic heartbeat from a <code>ResourceManager</code> participating in + * federation to indicate liveliness. The heartbeat publishes the current + * capabilities as represented by {@code SubClusterInfo} of the subcluster. + * Currently response is empty if the operation was successful, if not an + * exception reporting reason for a failure. + * + * @param subClusterHeartbeatRequest the capabilities of the subcluster that + * wants to keep alive its participation in federation + * @return response currently empty on if heartbeat was successfully processed + * @throws YarnException if the request is invalid/fails + */ + SubClusterHeartbeatResponse subClusterHeartbeat( + SubClusterHeartbeatRequest subClusterHeartbeatRequest) + throws YarnException; + + /** + * Get the membership information of <em>subcluster</em> as identified by + * {@code SubClusterId}. The membership information includes the cluster + * endpoint and current capabilities as represented by {@code SubClusterInfo}. + * + * @param subClusterRequest the subcluster whose information is required + * @return the {@code SubClusterInfo} + * @throws YarnException if the request is invalid/fails + */ + GetSubClusterInfoResponse getSubCluster( + GetSubClusterInfoRequest subClusterRequest) throws YarnException; + + /** + * Get the membership information of all the <em>subclusters</em> that are + * currently participating in federation. The membership information includes + * the cluster endpoint and current capabilities as represented by + * {@code SubClusterInfo}. + * + * @param subClustersRequest request for sub-clusters information + * @return a map of {@code SubClusterInfo} keyed by the {@code SubClusterId} + * @throws YarnException if the request is invalid/fails + */ + GetSubClustersInfoResponse getSubClusters( + GetSubClustersInfoRequest subClustersRequest) throws YarnException; + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/package-info.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/package-info.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/package-info.java new file mode 100644 index 0000000..33179e9 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/package-info.java @@ -0,0 +1,17 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoRequest.java new file mode 100644 index 0000000..656dea9 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoRequest.java @@ -0,0 +1,62 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * Request class to obtain information about a sub-cluster identified by its + * {@link SubClusterId}. + */ +@Private +@Unstable +public abstract class GetSubClusterInfoRequest { + + @Private + @Unstable + public static GetSubClusterInfoRequest newInstance( + SubClusterId subClusterId) { + GetSubClusterInfoRequest subClusterRequest = + Records.newRecord(GetSubClusterInfoRequest.class); + subClusterRequest.setSubClusterId(subClusterId); + return subClusterRequest; + } + + /** + * Get the {@link SubClusterId} representing the unique identifier of the + * subcluster. + * + * @return the subcluster identifier + */ + @Public + @Unstable + public abstract SubClusterId getSubClusterId(); + + /** + * Set the {@link SubClusterId} representing the unique identifier of the + * subcluster. + * + * @param subClusterId the subcluster identifier + */ + @Public + @Unstable + public abstract void setSubClusterId(SubClusterId subClusterId); +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoResponse.java new file mode 100644 index 0000000..f7bc74d --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoResponse.java @@ -0,0 +1,62 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * Response to a query with {@link SubClusterInfo} about a sub-cluster. + */ +@Private +@Unstable +public abstract class GetSubClusterInfoResponse { + + @Private + @Unstable + public static GetSubClusterInfoResponse newInstance( + SubClusterInfo subClusterInfo) { + GetSubClusterInfoResponse registerSubClusterRequest = + Records.newRecord(GetSubClusterInfoResponse.class); + registerSubClusterRequest.setSubClusterInfo(subClusterInfo); + return registerSubClusterRequest; + } + + /** + * Get the {@link SubClusterInfo} encapsulating the information about the + * sub-cluster. + * + * @return the information pertaining to the sub-cluster + */ + @Public + @Unstable + public abstract SubClusterInfo getSubClusterInfo(); + + /** + * Set the {@link SubClusterInfo} encapsulating the information about the + * sub-cluster. + * + * @param subClusterInfo the information pertaining to the sub-cluster + */ + @Private + @Unstable + public abstract void setSubClusterInfo(SubClusterInfo subClusterInfo); + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoRequest.java new file mode 100644 index 0000000..3264d81 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoRequest.java @@ -0,0 +1,66 @@ +/** + * 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.hadoop.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * Request class to obtain information about all sub-clusters that are + * participating in federation. + */ +@Private +@Unstable +public abstract class GetSubClustersInfoRequest { + + @Public + @Unstable + public static GetSubClustersInfoRequest newInstance( + boolean filterInactiveSubClusters) { + GetSubClustersInfoRequest request = + Records.newRecord(GetSubClustersInfoRequest.class); + request.setFilterInactiveSubClusters(filterInactiveSubClusters); + return request; + } + + /** + * Get the flag that indicates whether only active sub-clusters should be + * returned. + * + * @return whether to filter out inactive sub-clusters + */ + @Public + @Unstable + public abstract boolean getFilterInactiveSubClusters(); + + /** + * Set the flag that indicates whether only active sub-clusters should be + * returned. + * + * @param filterInactiveSubClusters whether to filter out inactive + * sub-clusters + */ + @Public + @Unstable + public abstract void setFilterInactiveSubClusters( + boolean filterInactiveSubClusters); + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoResponse.java new file mode 100644 index 0000000..bcf75ab --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoResponse.java @@ -0,0 +1,66 @@ +/** + * 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.hadoop.yarn.server.federation.store.records; + +import java.util.List; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * Response to a query with list of {@link SubClusterInfo} about all + * sub-clusters that are currently participating in Federation. + */ +@Private +@Unstable +public abstract class GetSubClustersInfoResponse { + + @Public + @Unstable + public static GetSubClustersInfoResponse newInstance( + List<SubClusterInfo> subClusters) { + GetSubClustersInfoResponse subClusterInfos = + Records.newRecord(GetSubClustersInfoResponse.class); + subClusterInfos.setSubClusters(subClusters); + return subClusterInfos; + } + + /** + * Get the list of {@link SubClusterInfo} representing the information about + * all sub-clusters that are currently participating in Federation. + * + * @return the list of {@link SubClusterInfo} + */ + @Public + @Unstable + public abstract List<SubClusterInfo> getSubClusters(); + + /** + * Set the list of {@link SubClusterInfo} representing the information about + * all sub-clusters that are currently participating in Federation. + * + * @param subClusters the list of {@link SubClusterInfo} + */ + @Private + @Unstable + public abstract void setSubClusters(List<SubClusterInfo> subClusters); + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterRequest.java new file mode 100644 index 0000000..50a50a1 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterRequest.java @@ -0,0 +1,89 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * <p> + * The request sent to set the state of a subcluster to either + * SC_DECOMMISSIONED, SC_LOST, or SC_DEREGISTERED. + * + * <p> + * The update includes details such as: + * <ul> + * <li>{@link SubClusterId}</li> + * <li>{@link SubClusterState}</li> + * </ul> + */ +@Private +@Unstable +public abstract class SubClusterDeregisterRequest { + + @Private + @Unstable + public static SubClusterDeregisterRequest newInstance( + SubClusterId subClusterId, SubClusterState subClusterState) { + SubClusterDeregisterRequest registerRequest = + Records.newRecord(SubClusterDeregisterRequest.class); + registerRequest.setSubClusterId(subClusterId); + registerRequest.setState(subClusterState); + return registerRequest; + } + + /** + * Get the {@link SubClusterId} representing the unique identifier of the + * subcluster. + * + * @return the subcluster identifier + */ + @Public + @Unstable + public abstract SubClusterId getSubClusterId(); + + /** + * Set the {@link SubClusterId} representing the unique identifier of the + * subcluster. + * + * @param subClusterId the subcluster identifier + */ + @Private + @Unstable + public abstract void setSubClusterId(SubClusterId subClusterId); + + /** + * Get the {@link SubClusterState} of the subcluster. + * + * @return the state of the subcluster + */ + @Public + @Unstable + public abstract SubClusterState getState(); + + /** + * Set the {@link SubClusterState} of the subcluster. + * + * @param state the state of the subCluster + */ + @Private + @Unstable + public abstract void setState(SubClusterState state); +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterResponse.java new file mode 100644 index 0000000..74fe994 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterResponse.java @@ -0,0 +1,42 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * SubClusterDeregisterResponse contains the answer from the {@code + * FederationMembershipStateStore} to a request to deregister the sub cluster. + * Currently response is empty if the operation was successful, if not an + * exception reporting reason for a failure. + */ +@Private +@Unstable +public abstract class SubClusterDeregisterResponse { + + @Private + @Unstable + public static SubClusterDeregisterResponse newInstance() { + SubClusterDeregisterResponse response = + Records.newRecord(SubClusterDeregisterResponse.class); + return response; + } + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatRequest.java new file mode 100644 index 0000000..3a07c18 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatRequest.java @@ -0,0 +1,149 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * <p> + * SubClusterHeartbeatRequest is a report of the runtime information of the + * subcluster that is participating in federation. + * + * <p> + * It includes information such as: + * <ul> + * <li>{@link SubClusterId}</li> + * <li>The URL of the subcluster</li> + * <li>The timestamp representing the last start time of the subCluster</li> + * <li>{@code FederationsubClusterState}</li> + * <li>The current capacity and utilization of the subCluster</li> + * </ul> + */ +@Private +@Unstable +public abstract class SubClusterHeartbeatRequest { + + @Private + @Unstable + public static SubClusterHeartbeatRequest newInstance( + SubClusterId subClusterId, SubClusterState state, String capability) { + return newInstance(subClusterId, 0, state, capability); + } + + @Private + @Unstable + public static SubClusterHeartbeatRequest newInstance( + SubClusterId subClusterId, long lastHeartBeat, SubClusterState state, + String capability) { + SubClusterHeartbeatRequest subClusterHeartbeatRequest = + Records.newRecord(SubClusterHeartbeatRequest.class); + subClusterHeartbeatRequest.setSubClusterId(subClusterId); + subClusterHeartbeatRequest.setLastHeartBeat(lastHeartBeat); + subClusterHeartbeatRequest.setState(state); + subClusterHeartbeatRequest.setCapability(capability); + return subClusterHeartbeatRequest; + } + + /** + * Get the {@link SubClusterId} representing the unique identifier of the + * subcluster. + * + * @return the subcluster identifier + */ + @Public + @Unstable + public abstract SubClusterId getSubClusterId(); + + /** + * Set the {@link SubClusterId} representing the unique identifier of the + * subCluster. + * + * @param subClusterId the subCluster identifier + */ + @Private + @Unstable + public abstract void setSubClusterId(SubClusterId subClusterId); + + /** + * Get the last heart beat time of the subcluster. + * + * @return the state of the subcluster + */ + @Public + @Unstable + public abstract long getLastHeartBeat(); + + /** + * Set the last heartbeat time of the subcluster. + * + * @param time the last heartbeat time of the subcluster + */ + @Private + @Unstable + public abstract void setLastHeartBeat(long time); + + /** + * Get the {@link SubClusterState} of the subcluster. + * + * @return the state of the subcluster + */ + @Public + @Unstable + public abstract SubClusterState getState(); + + /** + * Set the {@link SubClusterState} of the subcluster. + * + * @param state the state of the subCluster + */ + @Private + @Unstable + public abstract void setState(SubClusterState state); + + /** + * Get the current capacity and utilization of the subcluster. This is the + * JAXB marshalled string representation of the <code>ClusterMetrics</code>. + * + * @return the current capacity and utilization of the subcluster + */ + @Public + @Unstable + public abstract String getCapability(); + + /** + * Set the current capacity and utilization of the subCluster. This is the + * JAXB marshalled string representation of the <code>ClusterMetrics</code>. + * + * @param capability the current capacity and utilization of the subcluster + */ + @Private + @Unstable + public abstract void setCapability(String capability); + + @Override + public String toString() { + return "SubClusterHeartbeatRequest [getSubClusterId() = " + + getSubClusterId() + ", getState() = " + getState() + + ", getLastHeartBeat = " + getLastHeartBeat() + ", getCapability() = " + + getCapability() + "]"; + } + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatResponse.java new file mode 100644 index 0000000..0b7fd8c --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatResponse.java @@ -0,0 +1,45 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * SubClusterHeartbeatResponse contains the response from the {@code + * FederationMembershipStateStore} to a periodic heartbeat to indicate + * liveliness from a <code>ResourceManager</code> participating in federation. + * Currently response is empty if the operation was successful, if not an + * exception reporting reason for a failure. + * <p> + * NOTE: This can be extended to push down policies in future + */ +@Private +@Unstable +public abstract class SubClusterHeartbeatResponse { + + @Private + @Unstable + public static SubClusterHeartbeatResponse newInstance() { + SubClusterHeartbeatResponse response = + Records.newRecord(SubClusterHeartbeatResponse.class); + return response; + } + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.java new file mode 100644 index 0000000..fec967d --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.java @@ -0,0 +1,100 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * <p> + * SubClusterId represents the <em>globally unique</em> identifier for a + * subcluster that is participating in federation. + * + * <p> + * The globally unique nature of the identifier is obtained from the + * <code>FederationMembershipStateStore</code> on initialization. + */ +@Private +@Unstable +public abstract class SubClusterId implements Comparable<SubClusterId> { + + @Private + @Unstable + public static SubClusterId newInstance(String subClusterId) { + SubClusterId id = Records.newRecord(SubClusterId.class); + id.setId(subClusterId); + return id; + } + + /** + * Get the string identifier of the <em>subcluster</em> which is unique across + * the federated cluster. The identifier is static, i.e. preserved across + * restarts and failover. + * + * @return unique identifier of the subcluster + */ + @Public + @Unstable + public abstract String getId(); + + /** + * Set the string identifier of the <em>subcluster</em> which is unique across + * the federated cluster. The identifier is static, i.e. preserved across + * restarts and failover. + * + * @param subClusterId unique identifier of the subcluster + */ + @Private + @Unstable + protected abstract void setId(String subClusterId); + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + SubClusterId other = (SubClusterId) obj; + return this.getId().equals(other.getId()); + } + + @Override + public int hashCode() { + return getId().hashCode(); + } + + @Override + public int compareTo(SubClusterId other) { + return getId().compareTo(other.getId()); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append(getId()); + return sb.toString(); + } + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.java new file mode 100644 index 0000000..f13c8f1 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.java @@ -0,0 +1,263 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * <p> + * SubClusterInfo is a report of the runtime information of the subcluster that + * is participating in federation. + * + * <p> + * It includes information such as: + * <ul> + * <li>{@link SubClusterId}</li> + * <li>The URL of the subcluster</li> + * <li>The timestamp representing the last start time of the subCluster</li> + * <li>{@code FederationsubClusterState}</li> + * <li>The current capacity and utilization of the subCluster</li> + * </ul> + */ +@Private +@Unstable +public abstract class SubClusterInfo { + + @Private + @Unstable + public static SubClusterInfo newInstance(SubClusterId subClusterId, + String amRMServiceAddress, String clientRMServiceAddress, + String rmAdminServiceAddress, String rmWebServiceAddress, + SubClusterState state, long lastStartTime, String capability) { + return newInstance(subClusterId, amRMServiceAddress, clientRMServiceAddress, + rmAdminServiceAddress, rmWebServiceAddress, 0, state, lastStartTime, + capability); + } + + @Private + @Unstable + public static SubClusterInfo newInstance(SubClusterId subClusterId, + String amRMServiceAddress, String clientRMServiceAddress, + String rmAdminServiceAddress, String rmWebServiceAddress, + long lastHeartBeat, SubClusterState state, long lastStartTime, + String capability) { + SubClusterInfo subClusterInfo = Records.newRecord(SubClusterInfo.class); + subClusterInfo.setSubClusterId(subClusterId); + subClusterInfo.setAMRMServiceAddress(amRMServiceAddress); + subClusterInfo.setClientRMServiceAddress(clientRMServiceAddress); + subClusterInfo.setRMAdminServiceAddress(rmAdminServiceAddress); + subClusterInfo.setRMWebServiceAddress(rmWebServiceAddress); + subClusterInfo.setLastHeartBeat(lastHeartBeat); + subClusterInfo.setState(state); + subClusterInfo.setLastStartTime(lastStartTime); + subClusterInfo.setCapability(capability); + return subClusterInfo; + } + + /** + * Get the {@link SubClusterId} representing the unique identifier of the + * subcluster. + * + * @return the subcluster identifier + */ + @Public + @Unstable + public abstract SubClusterId getSubClusterId(); + + /** + * Set the {@link SubClusterId} representing the unique identifier of the + * subCluster. + * + * @param subClusterId the subCluster identifier + */ + @Private + @Unstable + public abstract void setSubClusterId(SubClusterId subClusterId); + + /** + * Get the URL of the AM-RM service endpoint of the subcluster + * <code>ResourceManager</code>. + * + * @return the URL of the AM-RM service endpoint of the subcluster + * <code>ResourceManager</code> + */ + @Public + @Unstable + public abstract String getAMRMServiceAddress(); + + /** + * Set the URL of the AM-RM service endpoint of the subcluster + * <code>ResourceManager</code>. + * + * @param amRMServiceAddress the URL of the AM-RM service endpoint of the + * subcluster <code>ResourceManager</code> + */ + @Private + @Unstable + public abstract void setAMRMServiceAddress(String amRMServiceAddress); + + /** + * Get the URL of the client-RM service endpoint of the subcluster + * <code>ResourceManager</code>. + * + * @return the URL of the client-RM service endpoint of the subcluster + * <code>ResourceManager</code> + */ + @Public + @Unstable + public abstract String getClientRMServiceAddress(); + + /** + * Set the URL of the client-RM service endpoint of the subcluster + * <code>ResourceManager</code>. + * + * @param clientRMServiceAddress the URL of the client-RM service endpoint of + * the subCluster <code>ResourceManager</code> + */ + @Private + @Unstable + public abstract void setClientRMServiceAddress(String clientRMServiceAddress); + + /** + * Get the URL of the <code>ResourceManager</code> administration service. + * + * @return the URL of the <code>ResourceManager</code> administration service + */ + @Public + @Unstable + public abstract String getRMAdminServiceAddress(); + + /** + * Set the URL of the <code>ResourceManager</code> administration service. + * + * @param rmAdminServiceAddress the URL of the <code>ResourceManager</code> + * administration service. + */ + @Private + @Unstable + public abstract void setRMAdminServiceAddress(String rmAdminServiceAddress); + + /** + * Get the URL of the <code>ResourceManager</code> web application interface. + * + * @return the URL of the <code>ResourceManager</code> web application + * interface. + */ + @Public + @Unstable + public abstract String getRMWebServiceAddress(); + + /** + * Set the URL of the <code>ResourceManager</code> web application interface. + * + * @param rmWebServiceAddress the URL of the <code>ResourceManager</code> web + * application interface. + */ + @Private + @Unstable + public abstract void setRMWebServiceAddress(String rmWebServiceAddress); + + /** + * Get the last heart beat time of the subcluster. + * + * @return the state of the subcluster + */ + @Public + @Unstable + public abstract long getLastHeartBeat(); + + /** + * Set the last heartbeat time of the subcluster. + * + * @param time the last heartbeat time of the subcluster + */ + @Private + @Unstable + public abstract void setLastHeartBeat(long time); + + /** + * Get the {@link SubClusterState} of the subcluster. + * + * @return the state of the subcluster + */ + @Public + @Unstable + public abstract SubClusterState getState(); + + /** + * Set the {@link SubClusterState} of the subcluster. + * + * @param state the state of the subCluster + */ + @Private + @Unstable + public abstract void setState(SubClusterState state); + + /** + * Get the timestamp representing the last start time of the subcluster. + * + * @return the timestamp representing the last start time of the subcluster + */ + @Public + @Unstable + public abstract long getLastStartTime(); + + /** + * Set the timestamp representing the last start time of the subcluster. + * + * @param lastStartTime the timestamp representing the last start time of the + * subcluster + */ + @Private + @Unstable + public abstract void setLastStartTime(long lastStartTime); + + /** + * Get the current capacity and utilization of the subcluster. This is the + * JAXB marshalled string representation of the <code>ClusterMetrics</code>. + * + * @return the current capacity and utilization of the subcluster + */ + @Public + @Unstable + public abstract String getCapability(); + + /** + * Set the current capacity and utilization of the subCluster. This is the + * JAXB marshalled string representation of the <code>ClusterMetrics</code>. + * + * @param capability the current capacity and utilization of the subcluster + */ + @Private + @Unstable + public abstract void setCapability(String capability); + + @Override + public String toString() { + return "SubClusterInfo [getSubClusterId() = " + getSubClusterId() + + ", getAMRMServiceAddress() = " + getAMRMServiceAddress() + + ", getClientRMServiceAddress() = " + getClientRMServiceAddress() + + ", getRMAdminServiceAddress() = " + getRMAdminServiceAddress() + + ", getRMWebServiceAddress() = " + getRMWebServiceAddress() + + ", getState() = " + getState() + ", getLastStartTime() = " + + getLastStartTime() + ", getCapability() = " + getCapability() + "]"; + } +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterRequest.java new file mode 100644 index 0000000..8864fe3 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterRequest.java @@ -0,0 +1,74 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceAudience.Public; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * <p> + * SubClusterRegisterRequest is a request by a sub-cluster + * {@code ResourceManager} to participate in federation. + * + * <p> + * It includes information such as: + * <ul> + * <li>{@link SubClusterId}</li> + * <li>The URL of the subcluster</li> + * <li>The timestamp representing the last start time of the subCluster</li> + * <li>{@code FederationsubClusterState}</li> + * <li>The current capacity and utilization of the subCluster</li> + * </ul> + */ +@Private +@Unstable +public abstract class SubClusterRegisterRequest { + + @Private + @Unstable + public static SubClusterRegisterRequest newInstance( + SubClusterInfo subClusterInfo) { + SubClusterRegisterRequest registerSubClusterRequest = + Records.newRecord(SubClusterRegisterRequest.class); + registerSubClusterRequest.setSubClusterInfo(subClusterInfo); + return registerSubClusterRequest; + } + + /** + * Get the {@link SubClusterInfo} encapsulating the information about the + * sub-cluster. + * + * @return the information pertaining to the sub-cluster + */ + @Public + @Unstable + public abstract SubClusterInfo getSubClusterInfo(); + + /** + * Set the {@link SubClusterInfo} encapsulating the information about the + * sub-cluster. + * + * @param subClusterInfo the information pertaining to the sub-cluster + */ + @Public + @Unstable + public abstract void setSubClusterInfo(SubClusterInfo subClusterInfo); + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterResponse.java new file mode 100644 index 0000000..060a857 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterResponse.java @@ -0,0 +1,44 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceStability.Unstable; +import org.apache.hadoop.yarn.util.Records; + +/** + * SubClusterRegisterResponse contains the response from the {@code + * FederationMembershipStateStore} to a registration request from a + * <code>ResourceManager</code> to participate in federation. + * + * Currently response is empty if the operation was successful, if not an + * exception reporting reason for a failure. + */ +@Private +@Unstable +public abstract class SubClusterRegisterResponse { + + @Private + @Unstable + public static SubClusterRegisterResponse newInstance() { + SubClusterRegisterResponse response = + Records.newRecord(SubClusterRegisterResponse.class); + return response; + } + +} http://git-wip-us.apache.org/repos/asf/hadoop/blob/a48c8e65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterState.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterState.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterState.java new file mode 100644 index 0000000..22cec99 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/SubClusterState.java @@ -0,0 +1,60 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.yarn.server.federation.store.records; + +import org.apache.hadoop.classification.InterfaceAudience.Private; +import org.apache.hadoop.classification.InterfaceStability.Unstable; + +/** + * <p> + * State of a <code>SubCluster</code>. + * </p> + */ +@Private +@Unstable +public enum SubClusterState { + /** Newly registered subcluster, before the first heartbeat. */ + SC_NEW, + + /** Subcluster is registered and the RM sent a heartbeat recently. */ + SC_RUNNING, + + /** Subcluster is unhealthy. */ + SC_UNHEALTHY, + + /** Subcluster is in the process of being out of service. */ + SC_DECOMMISSIONING, + + /** Subcluster is out of service. */ + SC_DECOMMISSIONED, + + /** RM has not sent a heartbeat for some configured time threshold. */ + SC_LOST, + + /** Subcluster has unregistered. */ + SC_UNREGISTERED; + + public boolean isUnusable() { + return (this != SC_RUNNING && this != SC_NEW); + } + + public boolean isFinal() { + return (this == SC_UNREGISTERED || this == SC_DECOMMISSIONED + || this == SC_LOST); + } +} --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org