You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

This page describes the release process of Apache Flink.

 

Verifying a Release Candidate

Legal: (required checks for a valid ASF compilant release)

  • Check if checksums and GPG files match the corresponding release files

  • Verify that the source archives do not contains any binaries

  • Check if the source release is building properly with Maven (including license header check (default) and checkstyle). Also the tests should be executed (mvn clean verify)

  • Verify that the LICENSE and NOTICE file is correct for the binary and source release.
    • All dependencies must be checked for their license and the license must be ASL 2.0 compatible (http://www.apache.org/legal/resolved.html#category-x)
    • The LICENSE and NOTICE files in the root directory refer to dependencies in the source release, i.e., files in the git repository (such as fonts, css, JavaScript, images)
    • The LICENSE and NOTICE files in flink-dist/src/main/flink-bin refer to the binary distribution and mention all of Flink's Maven dependencies as well

  • Check that all POM files point to the same version (mostly relevant to examine quickstart artifact files)

  • Check the README.md file

 

Functional: (checks for delivering a release with good quality)

  • Run the start-local.sh, start-cluster.sh, start-webclient.sh scripts and verify that the processes come up
    • Examine the *.out files (should be empty) and the log files (should contain no exceptions)
    • Test for Linux, OS X, Windows (for Windows as far as possible, not all scripts exist)
    • Shutdown and verify there are no exceptions in the log output (after shutdown)
    • Check all start+submission scripts for paths with and without spaces (./bin/* scripts are quite fragile for paths with spaces)
  • Verify that the examples are running from both ./bin/flink and from the web-based job submission tool
    • Should be run on
      • local mode (start-local.sh)
      • cluster mode (start-cluster.sh)
      • multi-node cluster (can simulate locally by starting two taskmanagers)
    • The flink-conf.yml should define more than one task slot

    • Results of job are produced and correct
    • Check also that the examples are running with the build-in data and external sources.

    • Examine the log output - no error messages should be encountered
    • Web interface shows progress and finished job in history

  • Test on a cluster with HDFS.
    • Check that a good amount of input splits is read locally (JobManager log reveals local assignments)

  • Test against a Kafka installation

  • Test the ./bin/flink command line client
    • Test "info" option, paste the JSON into the plan visualizer HTML file, check that plan is rendered
    • Test the parallelism flag (-p) to override the configured default parallelism

  • Verify the plan visualizer with different browsers/operating systems

  • Verify that the quickstarts for scala and java are working with the staging repository for both IntelliJ and Eclipse.
    • in particular the dependencies of the quickstart project need to be set correctly and the QS project needs to build from the staging repository (replace the snapshot repo URL with the staging repo URL)
    • The dependency tree of the QuickStart project must not contain any dependencies we shade away upstream (guava, netty, ...)

  • Run examples on a YARN cluster

  • Run all examples from the IDE (Eclipse & IntelliJ)

  • Run an example with the RemoteEnvironment against a cluster started from the shell script

 

Creating a release candidate

  • Read and understand: http://www.apache.org/dev/release-publishing.html
  • Read http://www.apache.org/dev/release-signing.html and create yourself a PGP key

  • run the ./tools/create_release_files.sh script from the Flink repo, with the following parameters: (the call below as used to create RC1 of Flink 0.8.1

    sonatype_user=YOURAPACHEID sonatype_pw=YOURAPACHEIDPASSWORD NEW_VERSION=0.8.1 RELEASE_CANDIDATE="rc1" RELEASE_BRANCH=release-0.8 OLD_VERSION=0.8-SNAPSHOT USER_NAME=YOURAPACHEID GPG_PASSPHRASE=YOURGPGPASSPHRASE GPG_KEY=YOURGPGKEY ./create_release_files.sh

    Note: the ./tools/create_release_files.sh script needs to make sure that the "mvn deploy" call is done using Java 8 (to release the java8 module to mvn central as well), but the fat jar for the binary release needs to be created by Java6 (due to a bug in java6 jar opening mechanism).

  • Usually the create_release_files.sh script needs to be adopted a bit depending on the used linux distribution
  • Close the staging repository in repository.apache.org (DO NOT PRESS "RELEASE"!)
  • Check that the release files are located in your people.apache.org home directory
  • go to the ./tools/flink directory and push the release commit to release-x.y.z-rcn branch. (DO NOT COMMIT THE LOCAL CHANGES, the release commit has already been created.)
  • Send the VOTE mail to the dev@flink.a.o list, containing the release commit hash, the link to your people.apache.org and to the staging repository.

Releasing a Release Candidate

  • No labels