You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by tv...@apache.org on 2023/07/13 17:29:44 UTC

[beam] branch tvalentyn-patch-3 updated: Update README.md

This is an automated email from the ASF dual-hosted git repository.

tvalentyn pushed a commit to branch tvalentyn-patch-3
in repository https://gitbox.apache.org/repos/asf/beam.git


The following commit(s) were added to refs/heads/tvalentyn-patch-3 by this push:
     new 393bc27f2c0 Update README.md
393bc27f2c0 is described below

commit 393bc27f2c006e2f3197bcc337fd20e1dcf49383
Author: tvalentyn <tv...@users.noreply.github.com>
AuthorDate: Thu Jul 13 10:29:37 2023 -0700

    Update README.md
---
 README.md | 148 --------------------------------------------------------------
 1 file changed, 148 deletions(-)

diff --git a/README.md b/README.md
index ea3c6d53ef2..8b137891791 100644
--- a/README.md
+++ b/README.md
@@ -1,149 +1 @@
-<!--
-    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.
--->
-
-# Apache Beam
-
-[Apache Beam](http://beam.apache.org/) is a unified model for defining both batch and streaming data-parallel processing pipelines, as well as a set of language-specific SDKs for constructing pipelines and Runners for executing them on distributed processing backends, including [Apache Flink](http://flink.apache.org/), [Apache Spark](http://spark.apache.org/), [Google Cloud Dataflow](http://cloud.google.com/dataflow/), and [Hazelcast Jet](https://jet.hazelcast.org/).
-
-## Status
-
-[![Maven Version](https://maven-badges.herokuapp.com/maven-central/org.apache.beam/beam-sdks-java-core/badge.svg)](http://search.maven.org/#search|gav|1|g:"org.apache.beam")
-[![PyPI version](https://badge.fury.io/py/apache-beam.svg)](https://badge.fury.io/py/apache-beam)
-[![Go version](https://pkg.go.dev/badge/github.com/apache/beam/sdks/v2/go.svg)](https://pkg.go.dev/github.com/apache/beam/sdks/v2/go)
-[![Python coverage](https://codecov.io/gh/apache/beam/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/beam)
-[![Build python source distribution and wheels](https://github.com/apache/beam/workflows/Build%20python%20source%20distribution%20and%20wheels/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
-[![Python tests](https://github.com/apache/beam/workflows/Python%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
-[![Java tests](https://github.com/apache/beam/workflows/Java%20Tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
-[![Go tests (Jenkins)](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/badge/icon?subject=Go%20Tests%28Jenkins%29)](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/)
-[![Java tests (Jenkins)](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/badge/icon?subject=Java%20Tests%28Jenkins%29)](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/)
-[![Python tests (Jenkins)](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/badge/icon?subject=Python%20Tests%28Jenkins%29)](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)
-
-## Overview
-
-Beam provides a general approach to expressing [embarrassingly parallel](https://en.wikipedia.org/wiki/Embarrassingly_parallel) data processing pipelines and supports three categories of users, each of which have relatively disparate backgrounds and needs.
-
-1. _End Users_: Writing pipelines with an existing SDK, running it on an existing runner. These users want to focus on writing their application logic and have everything else just work.
-2. _SDK Writers_: Developing a Beam SDK targeted at a specific user community (Java, Python, Scala, Go, R, graphical, etc). These users are language geeks and would prefer to be shielded from all the details of various runners and their implementations.
-3. _Runner Writers_: Have an execution environment for distributed processing and would like to support programs written against the Beam Model. Would prefer to be shielded from details of multiple SDKs.
-
-### The Beam Model
-
-The model behind Beam evolved from several internal Google data processing projects, including [MapReduce](http://research.google.com/archive/mapreduce.html), [FlumeJava](http://research.google.com/pubs/pub35650.html), and [Millwheel](http://research.google.com/pubs/pub41378.html). This model was originally known as the “[Dataflow Model](http://www.vldb.org/pvldb/vol8/p1792-Akidau.pdf)”.
-
-To learn more about the Beam Model (though still under the original name of Dataflow), see the World Beyond Batch: [Streaming 101](https://www.oreilly.com/ideas/the-world-beyond-batch-streaming-101) and [Streaming 102](https://www.oreilly.com/ideas/the-world-beyond-batch-streaming-102) posts on O’Reilly’s Radar site, and the [VLDB 2015 paper](http://www.vldb.org/pvldb/vol8/p1792-Akidau.pdf).
-
-The key concepts in the Beam programming model are:
-
-* `PCollection`: represents a collection of data, which could be bounded or unbounded in size.
-* `PTransform`: represents a computation that transforms input PCollections into output PCollections.
-* `Pipeline`: manages a directed acyclic graph of PTransforms and PCollections that is ready for execution.
-* `PipelineRunner`: specifies where and how the pipeline should execute.
-
-### SDKs
-
-Beam supports multiple language-specific SDKs for writing pipelines against the Beam Model.
-
-Currently, this repository contains SDKs for Java, Python and Go.
-
-Have ideas for new SDKs or DSLs? See the [sdk-ideas label](https://github.com/apache/beam/issues?q=is%3Aopen+is%3Aissue+label%3Asdk-ideas).
-
-### Runners
-
-Beam supports executing programs on multiple distributed processing backends through PipelineRunners. Currently, the following PipelineRunners are available:
-
-- The `DirectRunner` runs the pipeline on your local machine.
-- The `DataflowRunner` submits the pipeline to the [Google Cloud Dataflow](http://cloud.google.com/dataflow/).
-- The `FlinkRunner` runs the pipeline on an Apache Flink cluster. The code has been donated from [dataArtisans/flink-dataflow](https://github.com/dataArtisans/flink-dataflow) and is now part of Beam.
-- The `SparkRunner` runs the pipeline on an Apache Spark cluster.
-- The `JetRunner` runs the pipeline on a Hazelcast Jet cluster. The code has been donated from [hazelcast/hazelcast-jet](https://github.com/hazelcast/hazelcast-jet) and is now part of Beam.
-- The `Twister2Runner` runs the pipeline on a Twister2 cluster. The code has been donated from [DSC-SPIDAL/twister2](https://github.com/DSC-SPIDAL/twister2) and is now part of Beam.
-
-Have ideas for new Runners? See the [runner-ideas label](https://github.com/apache/beam/issues?q=is%3Aopen+is%3Aissue+label%3Arunner-ideas).
-
-## Getting Started
-
-To learn how to write Beam pipelines, read the Quickstart for [[Java](https://beam.apache.org/get-started/quickstart-java), [Python](https://beam.apache.org/get-started/quickstart-py), or
-[Go](https://beam.apache.org/get-started/quickstart-go)] available on our website.
-To play with some Beam examples, try [Beam Playground](https://play.beam.apache.org/?path=SDK_JAVA_MinimalWordCount&sdk=java).
-To learn basic Beam concepts, try [Tour of Beam](https://tour.beam.apache.org/).
-
-
-
-## Contact Us
-
-To get involved in Apache Beam:
-
-* [Subscribe](mailto:user-subscribe@beam.apache.org) or [mail](mailto:user@beam.apache.org) the [user@beam.apache.org](http://mail-archives.apache.org/mod_mbox/beam-user/) list.
-* [Subscribe](mailto:dev-subscribe@beam.apache.org) or [mail](mailto:dev@beam.apache.org) the [dev@beam.apache.org](http://mail-archives.apache.org/mod_mbox/beam-dev/) list.
-* [Join ASF Slack](https://s.apache.org/slack-invite) on [#beam channel](https://s.apache.org/beam-slack-channel)
-* [Report an issue](https://github.com/apache/beam/issues/new/choose).
-
-Instructions for building and testing Beam itself
-are in the [contribution guide](https://beam.apache.org/contribute/).
-
-## More Information
-
-* [Apache Beam](https://beam.apache.org)
-* [Overview](https://beam.apache.org/use/beam-overview/)
-* Quickstart: [Java](https://beam.apache.org/get-started/quickstart-java), [Python](https://beam.apache.org/get-started/quickstart-py), [Go](https://beam.apache.org/get-started/quickstart-go)
-* [Community metrics](https://s.apache.org/beam-community-metrics)
-
-
-## Test Sequence Diagram
-
-```mermaid
-sequenceDiagram
-participant User 
-participant "Apache Beam SDK"
-participant "DF service"
-participant "Worker VM"
-participant "Kubelet"
-participant Harness
-participant "SDK boot entrypoint" 
-participant "SDK worker"
-User -> "Apache Beam SDK" : Run the pipeline\n python -m pipeline.py ...
-"Apache Beam SDK" -> "DF service": Send pipeline graph
-
-"DF service" ->> "Worker VM":  Start Worker VM
-"DF service" ->> User:  "Workers have started successfully!"
-"Worker VM" -> "Kubelet":  Start container pod
-Note over "Kubelet": Start Harness container
-Note over Kubelet: Download SDK container image
-Note over Kubelet: Start SDK containers 
-Kubelet -> "SDK boot entrypoint": Start SDK container 
-Note over "SDK boot entrypoint": Retrieve staged artifacts 
-Note over "SDK boot entrypoint": Create a virtual environment
-Note over "SDK boot entrypoint": Install Beam SDK \n(no-op if already installed)
-Note over "SDK boot entrypoint": Install deps --requirements_file
-Note over "SDK boot entrypoint": Install --extra_package(s) 
-Note over "SDK boot entrypoint": Install workflow package (if any)
-Note over "SDK boot entrypoint": Start SDK worker process
-Note over "SDK worker": Load main session
-Note over Harness: Wait for ALL SDK workers to init
-"SDK worker" -> Harness: SDK is intialized, ready to work
-Note over Harness: All SDKs have registered.
-Harness -> "DF service": Request work
-"DF service" -> User:  "All workers have finished the \nstartup processes and began to receive work requests!"
-"DF service" -> Harness: Assign work item
-Harness -> "SDK worker": Assign work item
-Note over "SDK worker": Do work
-"SDK worker" -> Harness: Work completed
-Harness -> "DF service": Work completed
-"DF service" -> User: Job finished
-```