| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase, class: CoprocClusterManager"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Collections;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.HashSet;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Objects;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Set;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.commons.lang3.StringUtils;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.AsyncAdmin;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.AsyncConnection;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.client.ConnectionFactory;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecRequest;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecResponse;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecService;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.util.Pair;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.slf4j.Logger;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37">/**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * Overrides commands to make use of coprocessor where possible. Only supports actions taken against</span> |
| <span class="source-line-no">039</span><span id="line-39"> * Master and Region Server hosts.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Private</span> |
| <span class="source-line-no">042</span><span id="line-42">@SuppressWarnings("unused") // no way to test this without a distributed cluster.</span> |
| <span class="source-line-no">043</span><span id="line-43">public class CoprocClusterManager extends HBaseClusterManager {</span> |
| <span class="source-line-no">044</span><span id="line-44"> private static final Logger LOG = LoggerFactory.getLogger(CoprocClusterManager.class);</span> |
| <span class="source-line-no">045</span><span id="line-45"> private static final Set<ServiceType> supportedServices = buildSupportedServicesSet();</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> @Override</span> |
| <span class="source-line-no">048</span><span id="line-48"> protected Pair<Integer, String> exec(String hostname, ServiceType service, String... cmd)</span> |
| <span class="source-line-no">049</span><span id="line-49"> throws IOException {</span> |
| <span class="source-line-no">050</span><span id="line-50"> if (!supportedServices.contains(service)) {</span> |
| <span class="source-line-no">051</span><span id="line-51"> throw unsupportedServiceType(service);</span> |
| <span class="source-line-no">052</span><span id="line-52"> }</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> // We only support actions vs. Master or Region Server processes. We're issuing those actions</span> |
| <span class="source-line-no">055</span><span id="line-55"> // via the coprocessor that's running within those processes. Thus, there's no support for</span> |
| <span class="source-line-no">056</span><span id="line-56"> // honoring the configured service user.</span> |
| <span class="source-line-no">057</span><span id="line-57"> final String command = StringUtils.join(cmd, " ");</span> |
| <span class="source-line-no">058</span><span id="line-58"> LOG.info("Executing remote command: {}, hostname:{}", command, hostname);</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> try (final AsyncConnection conn = ConnectionFactory.createAsyncConnection(getConf()).join()) {</span> |
| <span class="source-line-no">061</span><span id="line-61"> final AsyncAdmin admin = conn.getAdmin();</span> |
| <span class="source-line-no">062</span><span id="line-62"> final ShellExecRequest req =</span> |
| <span class="source-line-no">063</span><span id="line-63"> ShellExecRequest.newBuilder().setCommand(command).setAwaitResponse(false).build();</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> final ShellExecResponse resp;</span> |
| <span class="source-line-no">066</span><span id="line-66"> switch (service) {</span> |
| <span class="source-line-no">067</span><span id="line-67"> case HBASE_MASTER:</span> |
| <span class="source-line-no">068</span><span id="line-68"> // What happens if the intended action was killing a backup master? Right now we have</span> |
| <span class="source-line-no">069</span><span id="line-69"> // no `RestartBackupMasterAction` so it's probably fine.</span> |
| <span class="source-line-no">070</span><span id="line-70"> resp = masterExec(admin, req);</span> |
| <span class="source-line-no">071</span><span id="line-71"> break;</span> |
| <span class="source-line-no">072</span><span id="line-72"> case HBASE_REGIONSERVER:</span> |
| <span class="source-line-no">073</span><span id="line-73"> final ServerName targetHost = resolveRegionServerName(admin, hostname);</span> |
| <span class="source-line-no">074</span><span id="line-74"> resp = regionServerExec(admin, req, targetHost);</span> |
| <span class="source-line-no">075</span><span id="line-75"> break;</span> |
| <span class="source-line-no">076</span><span id="line-76"> default:</span> |
| <span class="source-line-no">077</span><span id="line-77"> throw new RuntimeException("should not happen");</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> LOG.debug("Executed remote command: {}, exit code:{} , output:{}", command,</span> |
| <span class="source-line-no">082</span><span id="line-82"> resp.getExitCode(), resp.getStdout());</span> |
| <span class="source-line-no">083</span><span id="line-83"> } else {</span> |
| <span class="source-line-no">084</span><span id="line-84"> LOG.info("Executed remote command: {}, exit code:{}", command, resp.getExitCode());</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</span> |
| <span class="source-line-no">086</span><span id="line-86"> return new Pair<>(resp.getExitCode(), resp.getStdout());</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> private static Set<ServiceType> buildSupportedServicesSet() {</span> |
| <span class="source-line-no">091</span><span id="line-91"> final Set<ServiceType> set = new HashSet<>();</span> |
| <span class="source-line-no">092</span><span id="line-92"> set.add(ServiceType.HBASE_MASTER);</span> |
| <span class="source-line-no">093</span><span id="line-93"> set.add(ServiceType.HBASE_REGIONSERVER);</span> |
| <span class="source-line-no">094</span><span id="line-94"> return Collections.unmodifiableSet(set);</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> private static ShellExecResponse masterExec(final AsyncAdmin admin, final ShellExecRequest req) {</span> |
| <span class="source-line-no">098</span><span id="line-98"> // TODO: Admin API provides no means of sending exec to a backup master.</span> |
| <span class="source-line-no">099</span><span id="line-99"> return admin.<ShellExecService.Stub, ShellExecResponse> coprocessorService(</span> |
| <span class="source-line-no">100</span><span id="line-100"> ShellExecService::newStub,</span> |
| <span class="source-line-no">101</span><span id="line-101"> (stub, controller, callback) -> stub.shellExec(controller, req, callback)).join();</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> private static ShellExecResponse regionServerExec(final AsyncAdmin admin,</span> |
| <span class="source-line-no">105</span><span id="line-105"> final ShellExecRequest req, final ServerName targetHost) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> return admin.<ShellExecService.Stub, ShellExecResponse> coprocessorService(</span> |
| <span class="source-line-no">107</span><span id="line-107"> ShellExecService::newStub,</span> |
| <span class="source-line-no">108</span><span id="line-108"> (stub, controller, callback) -> stub.shellExec(controller, req, callback), targetHost).join();</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> private static ServerName resolveRegionServerName(final AsyncAdmin admin, final String hostname) {</span> |
| <span class="source-line-no">112</span><span id="line-112"> return admin.getRegionServers()</span> |
| <span class="source-line-no">113</span><span id="line-113"> .thenApply(</span> |
| <span class="source-line-no">114</span><span id="line-114"> names -> names.stream().filter(sn -> Objects.equals(sn.getHostname(), hostname)).findAny())</span> |
| <span class="source-line-no">115</span><span id="line-115"> .join().orElseThrow(() -> serverNotFound(hostname));</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> private static RuntimeException serverNotFound(final String hostname) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> return new RuntimeException(</span> |
| <span class="source-line-no">120</span><span id="line-120"> String.format("Did not find %s amongst the servers known to the client.", hostname));</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> private static RuntimeException unsupportedServiceType(final ServiceType serviceType) {</span> |
| <span class="source-line-no">124</span><span id="line-124"> return new RuntimeException(</span> |
| <span class="source-line-no">125</span><span id="line-125"> String.format("Unable to service request for service=%s", serviceType));</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
