[
https://issues.apache.org/jira/browse/BEAM-4267?focusedWorklogId=103540&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-103540
]
ASF GitHub Bot logged work on BEAM-4267:
----------------------------------------
Author: ASF GitHub Bot
Created on: 18/May/18 19:56
Start Date: 18/May/18 19:56
Worklog Time Spent: 10m
Work Description: bsidhom commented on a change in pull request #5392:
[BEAM-4267] JobBundleFactory that uses Docker-backed environments
URL: https://github.com/apache/beam/pull/5392#discussion_r189374884
##########
File path:
runners/java-fn-execution/src/main/java/org/apache/beam/runners/fnexecution/control/DockerJobBundleFactory.java
##########
@@ -0,0 +1,339 @@
+/*
+ * 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.beam.runners.fnexecution.control;
+
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import com.google.common.cache.LoadingCache;
+import com.google.common.cache.RemovalNotification;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.Iterables;
+import com.google.common.net.HostAndPort;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.io.IOException;
+import java.time.Duration;
+import java.util.Map;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import javax.annotation.concurrent.ThreadSafe;
+import org.apache.beam.model.fnexecution.v1.BeamFnApi.Target;
+import org.apache.beam.model.fnexecution.v1.ProvisionApi.ProvisionInfo;
+import org.apache.beam.model.pipeline.v1.RunnerApi.Environment;
+import org.apache.beam.runners.core.construction.graph.ExecutableStage;
+import org.apache.beam.runners.fnexecution.GrpcContextHeaderAccessorProvider;
+import org.apache.beam.runners.fnexecution.GrpcFnServer;
+import org.apache.beam.runners.fnexecution.ServerFactory;
+import org.apache.beam.runners.fnexecution.artifact.ArtifactRetrievalService;
+import org.apache.beam.runners.fnexecution.artifact.ArtifactSource;
+import
org.apache.beam.runners.fnexecution.control.ProcessBundleDescriptors.ExecutableProcessBundleDescriptor;
+import
org.apache.beam.runners.fnexecution.control.SdkHarnessClient.BundleProcessor;
+import org.apache.beam.runners.fnexecution.data.GrpcDataService;
+import org.apache.beam.runners.fnexecution.data.RemoteInputDestination;
+import org.apache.beam.runners.fnexecution.environment.DockerCommand;
+import
org.apache.beam.runners.fnexecution.environment.DockerEnvironmentFactory;
+import org.apache.beam.runners.fnexecution.environment.RemoteEnvironment;
+import org.apache.beam.runners.fnexecution.logging.GrpcLoggingService;
+import org.apache.beam.runners.fnexecution.logging.Slf4jLogWriter;
+import
org.apache.beam.runners.fnexecution.provisioning.StaticGrpcProvisionService;
+import org.apache.beam.runners.fnexecution.state.GrpcStateService;
+import org.apache.beam.runners.fnexecution.state.StateRequestHandler;
+import org.apache.beam.sdk.coders.Coder;
+import org.apache.beam.sdk.fn.IdGenerator;
+import org.apache.beam.sdk.fn.IdGenerators;
+import org.apache.beam.sdk.fn.data.FnDataReceiver;
+import org.apache.beam.sdk.util.WindowedValue;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * A {@link JobBundleFactory} that uses a {@link DockerEnvironmentFactory} for
environment
+ * management. Note that returned {@link StageBundleFactory stage bundle
factories} are not
+ * thread-safe. Instead, a new stage factory should be created for each client.
+ */
+@ThreadSafe
+public class DockerJobBundleFactory implements JobBundleFactory {
+ private static final Logger LOG =
LoggerFactory.getLogger(DockerJobBundleFactory.class);
+
+ // TODO: This host name seems to change with every other Docker release. Do
we attempt to keep up
+ // or attempt to document the supported Docker version(s)?
+ private static final String DOCKER_FOR_MAC_HOST = "host.docker.internal";
+
+ private final IdGenerator stageIdGenerator;
+ private final GrpcFnServer<FnApiControlClientPoolService> controlServer;
+ private final GrpcFnServer<GrpcLoggingService> loggingServer;
+ private final GrpcFnServer<ArtifactRetrievalService> retrievalServer;
+ private final GrpcFnServer<StaticGrpcProvisionService> provisioningServer;
+
+ private final LoadingCache<Environment, WrappedSdkHarnessClient>
environmentCache;
+
+ public static DockerJobBundleFactory create(ArtifactSource artifactSource)
throws Exception {
+ DockerCommand dockerCommand = DockerCommand.forExecutable("docker",
Duration.ofSeconds(60));
+ ServerFactory serverFactory = getServerFactory();
+ IdGenerator stageIdGenerator = IdGenerators.incrementingLongs();
+ ControlClientPool clientPool = MapControlClientPool.create();
+
+ GrpcFnServer<FnApiControlClientPoolService> controlServer =
+ GrpcFnServer.allocatePortAndCreateFor(
+ FnApiControlClientPoolService.offeringClientsToPool(
+ clientPool.getSink(),
GrpcContextHeaderAccessorProvider.getHeaderAccessor()),
+ serverFactory);
+ GrpcFnServer<GrpcLoggingService> loggingServer =
+ GrpcFnServer.allocatePortAndCreateFor(
+ GrpcLoggingService.forWriter(Slf4jLogWriter.getDefault()),
serverFactory);
+ // TODO: Wire in artifact retrieval service once implemented.
+ GrpcFnServer<ArtifactRetrievalService> retrievalServer =
+ GrpcFnServer.allocatePortAndCreateFor(null, serverFactory);
+ GrpcFnServer<StaticGrpcProvisionService> provisioningServer =
+ GrpcFnServer.allocatePortAndCreateFor(
+
StaticGrpcProvisionService.create(ProvisionInfo.newBuilder().build()),
serverFactory);
+ DockerEnvironmentFactory environmentFactory =
+ DockerEnvironmentFactory.forServices(
+ dockerCommand,
+ controlServer,
+ loggingServer,
+ retrievalServer,
+ provisioningServer,
+ clientPool.getSource(),
+ IdGenerators.incrementingLongs());
+ return new DockerJobBundleFactory(
+ environmentFactory,
+ serverFactory,
+ stageIdGenerator,
+ controlServer,
+ loggingServer,
+ retrievalServer,
+ provisioningServer);
+ }
+
+ private DockerJobBundleFactory(
+ DockerEnvironmentFactory environmentFactory,
+ ServerFactory serverFactory,
+ IdGenerator stageIdGenerator,
+ GrpcFnServer<FnApiControlClientPoolService> controlServer,
+ GrpcFnServer<GrpcLoggingService> loggingServer,
+ GrpcFnServer<ArtifactRetrievalService> retrievalServer,
+ GrpcFnServer<StaticGrpcProvisionService> provisioningServer) {
+ this.stageIdGenerator = stageIdGenerator;
+ this.controlServer = controlServer;
+ this.loggingServer = loggingServer;
+ this.retrievalServer = retrievalServer;
+ this.provisioningServer = provisioningServer;
+ this.environmentCache =
+ CacheBuilder.newBuilder()
+ .weakValues()
+ .removalListener(
+ ((RemovalNotification<Environment, WrappedSdkHarnessClient>
notification) -> {
+ LOG.debug("Cleaning up for environment {}",
notification.getKey().getUrl());
+ try {
+ notification.getValue().close();
+ } catch (Exception e) {
+ LOG.warn("Error cleaning up environment",
notification.getKey(), e);
+ }
+ }))
+ .build(
+ new CacheLoader<Environment, WrappedSdkHarnessClient>() {
+ @Override
+ public WrappedSdkHarnessClient load(Environment environment)
throws Exception {
+ RemoteEnvironment remoteEnvironment =
+ environmentFactory.createEnvironment(environment);
+ return WrappedSdkHarnessClient.wrapping(remoteEnvironment,
serverFactory);
+ }
+ });
+ }
+
+ @Override
+ public <T> StageBundleFactory<T> forStage(ExecutableStage executableStage) {
+ WrappedSdkHarnessClient wrappedClient =
+ environmentCache.getUnchecked(executableStage.getEnvironment());
+ ExecutableProcessBundleDescriptor processBundleDescriptor;
+ try {
+ processBundleDescriptor =
+ ProcessBundleDescriptors.fromExecutableStage(
+ stageIdGenerator.getId(),
+ executableStage,
+ wrappedClient.getDataServer().getApiServiceDescriptor());
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ return SimpleStageBundleFactory.create(wrappedClient,
processBundleDescriptor);
+ }
+
+ @Override
+ public void close() throws Exception {
+ // Clear the cache. This closes all active environments.
+ environmentCache.invalidateAll();
+ environmentCache.cleanUp();
+
+ // Tear down common servers.
+ controlServer.close();
+ loggingServer.close();
+ retrievalServer.close();
+ provisioningServer.close();
+ }
+
+ private static ServerFactory getServerFactory() {
+ switch (getPlatform()) {
+ case LINUX:
+ return ServerFactory.createDefault();
+ case MAC:
+ return ServerFactory.createWithUrlFactory(
+ (host, port) -> HostAndPort.fromParts(DOCKER_FOR_MAC_HOST,
port).toString());
+ default:
+ LOG.warn("Unknown Docker platform. Falling back to default server
factory");
+ return ServerFactory.createDefault();
+ }
+ }
+
+ private static Platform getPlatform() {
+ String osName = System.getProperty("os.name").toLowerCase();
+ // TODO: Make this more robust?
+ if (osName.startsWith("mac")) {
+ return Platform.MAC;
+ } else if (osName.startsWith("linux")) {
+ return Platform.LINUX;
+ }
+ return Platform.OTHER;
+ }
+
+ private static class SimpleStageBundleFactory<InputT> implements
StageBundleFactory<InputT> {
+
+ private final BundleProcessor<InputT> processor;
+ private final ExecutableProcessBundleDescriptor processBundleDescriptor;
+
+ // Store the wrapped client in order to keep a live reference into the
cache.
+ @SuppressFBWarnings private WrappedSdkHarnessClient wrappedClient;
+
+ static <InputT> SimpleStageBundleFactory<InputT> create(
+ WrappedSdkHarnessClient wrappedClient,
+ ExecutableProcessBundleDescriptor processBundleDescriptor) {
+ @SuppressWarnings("unchecked")
+ BundleProcessor<InputT> processor =
+ wrappedClient
+ .getClient()
+ .getProcessor(
+ processBundleDescriptor.getProcessBundleDescriptor(),
+ (RemoteInputDestination)
processBundleDescriptor.getRemoteInputDestination(),
+ wrappedClient.getStateServer().getService());
+ return new SimpleStageBundleFactory<>(processBundleDescriptor,
processor, wrappedClient);
+ }
+
+ SimpleStageBundleFactory(
+ ExecutableProcessBundleDescriptor processBundleDescriptor,
+ BundleProcessor<InputT> processor,
+ WrappedSdkHarnessClient wrappedClient) {
+ this.processBundleDescriptor = processBundleDescriptor;
+ this.processor = processor;
+ this.wrappedClient = wrappedClient;
+ }
+
+ @Override
+ public RemoteBundle<InputT> getBundle(
+ OutputReceiverFactory outputReceiverFactory, StateRequestHandler
stateRequestHandler)
+ throws Exception {
+ // TODO: Consider having BundleProcessor#newBundle take in an
OutputReceiverFactory rather
Review comment:
Leaving for now.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 103540)
Time Spent: 50m (was: 40m)
> Implement a reusable library that can run an ExecutableStage with a given
> Environment
> -------------------------------------------------------------------------------------
>
> Key: BEAM-4267
> URL: https://issues.apache.org/jira/browse/BEAM-4267
> Project: Beam
> Issue Type: Improvement
> Components: runner-flink
> Reporter: Axel Magnuson
> Assignee: Ben Sidhom
> Priority: Major
> Time Spent: 50m
> Remaining Estimate: 0h
>
> Build off of the interfaces introduced in
> [BEAM-3327|https://github.com/apache/beam/pull/5152] to provide a reusable
> execution library to runners.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
