Author: stevel Date: Tue Jan 13 15:53:15 2015 New Revision: 1651392 URL: http://svn.apache.org/r1651392 Log: Fix up headers and other minor MD file corrections
Modified: incubator/slider/site/trunk/content/design/index.md incubator/slider/site/trunk/content/design/ssl_implementation.md incubator/slider/site/trunk/content/developing/index.md incubator/slider/site/trunk/content/developing/releasing.md incubator/slider/site/trunk/content/docs/high_availability.md incubator/slider/site/trunk/content/docs/index.md Modified: incubator/slider/site/trunk/content/design/index.md URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/design/index.md?rev=1651392&r1=1651391&r2=1651392&view=diff ============================================================================== --- incubator/slider/site/trunk/content/design/index.md (original) +++ incubator/slider/site/trunk/content/design/index.md Tue Jan 13 15:53:15 2015 @@ -17,7 +17,7 @@ # Apache Slider Architecture -* [Overview](/design/architecture.html) +* [Architecture](/design/architecture.html) * [Application Needs](/docs/slider_specs/application_needs.html) * [Specification](/design/specification/index.html) * [Service Registry](/design/registry/index.html) Modified: incubator/slider/site/trunk/content/design/ssl_implementation.md URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/design/ssl_implementation.md?rev=1651392&r1=1651391&r2=1651392&view=diff ============================================================================== --- incubator/slider/site/trunk/content/design/ssl_implementation.md (original) +++ incubator/slider/site/trunk/content/design/ssl_implementation.md Tue Jan 13 15:53:15 2015 @@ -1,3 +1,17 @@ +<!--- + Licensed 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. See accompanying LICENSE file. +--> + #Agent to Application Master SSL Communication Slider agents are configured to communicate with the Slider Application Master using SSL. By default, one-way SSL authentication is enabled (i.e., the agent verifies the identity of the application master). However, two-way SSL authentication can be enabled to further secure the communication channel. Modified: incubator/slider/site/trunk/content/developing/index.md URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/developing/index.md?rev=1651392&r1=1651391&r2=1651392&view=diff ============================================================================== --- incubator/slider/site/trunk/content/developing/index.md (original) +++ incubator/slider/site/trunk/content/developing/index.md Tue Jan 13 15:53:15 2015 @@ -29,7 +29,6 @@ Slider * [Functional Testing](functional_tests.html) * [Manual Testing](manual_testing.html) * [Releasing](releasing.html) -* [Releasing](releasing.html) * [Style Guide](style.html) * [Submitting Patches](submitting_patches.html) * [Windows Development and Testing](windows.html) Modified: incubator/slider/site/trunk/content/developing/releasing.md URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/developing/releasing.md?rev=1651392&r1=1651391&r2=1651392&view=diff ============================================================================== --- incubator/slider/site/trunk/content/developing/releasing.md (original) +++ incubator/slider/site/trunk/content/developing/releasing.md Tue Jan 13 15:53:15 2015 @@ -61,7 +61,9 @@ starting to make a release* *2.* Check out the latest version of `origin/master`. -*3.* If you are not building against a stable Hadoop release +*3.* Make sure there are no uncommitted files in your local repo. + +*4.* If you are not building against a stable Hadoop release 1. Check out the hadoop branch you intend to build and test against âand include in the redistributable artifacts. @@ -74,11 +76,17 @@ starting to make a release* The slider POMs offer different profiles of hadoop versions to build against. The instructions below do not choose one. If a profile is needed, append it to all the maven commands. -e.g. {{mvn clean install -DskipTests -Prelease-2.6}} +e.g. `mvn clean install -DskipTests -Prelease-2.6` ## <a name="phase1"></a>Phase - I +**Step #0:** Sync up with the ASF repo. You do not want to release the wrong +code. + + git checkout develop + git pull origin + git push origin **Step #1:** Create a JIRA for the release, estimate 3h (so you don't try to skip the tests) @@ -92,12 +100,14 @@ versions plugin](http://mojo.codehaus.or export SLIDER_RELEASE=0.60.0-incubating - + mvn versions:set -DnewVersion=$SLIDER_RELEASE **Step #5:** Commit the changed POM files + git status + git add --all git commit -m "$SLIDER_RELEASE_JIRA updating release POMs for $SLIDER_RELEASE" @@ -116,7 +126,7 @@ In the `slider` directory, run: (Make sure the build isn't trying to pull down its JARs from the Apache Staging repo) -Once everything is built- including .tar files, run the tests +Once everything is built- including `.tar` files, run the tests mvn test @@ -136,26 +146,29 @@ finalizing the release notes. **Step #7:** Build the release package -Run the `package` goal: +Run a clean install, followed by a site build and package goal: - mvn clean site:site site:stage package -DskipTests + mvn clean install -DskipTests + mvn site:site site:stage package -DskipTests -**Step #8:** Validate the tar file +**Step #8:** Validate the tarball Look in `slider-assembly/target` to find the `.tar.gz` file, and the expanded version of it. Inspect that expanded version to make sure that everything looks good -and that the versions of all the dependent artifacts look good too: there must be no `-SNAPSHOT` dependencies. [Exception, when the release is deliberately made against an unreleased version of Hadoop or other dependencies. -in that situation the unreleased dependency is expected to consist of `-SNAPSHORT` +in that situation the unreleased dependency is expected to consist of `-SNAPSHOT` artifacts] tip: the lib dir can be viewed with - ls -l slider-assembly/target/lib + ls -l slider-assembly/target/slider-$SLIDER_RELEASE-all/slider-$SLIDER_RELEASE/lib -Verify that there is a `slider-agent` `.tar.gz` file. +**Important** Verify that there is a `slider-agent` `.tar.gz` file. The two-phase +install/site build gets it in there, but doing a single build doesn't always seem +to. **Step #9:** Build the release notes @@ -215,11 +228,18 @@ Check out the develop branch and purge a *At this point you are ready for Apache release from master.* -## <a name="phase2"></a>Phase - II +## <a name="phase2"></a>Phase - II: publish to the ASF + +This phase of the process creates the artifacts for the ASF. +This is done in a separate directory to ensure that nothing accidentally gets in. + +Preamble: set up the RC Version + + export RELEASE_RC=rc0 **Step 1** -Get a clean enlistment. +Get a clean git clone in its own directory. mkdir release cd release @@ -244,7 +264,7 @@ Ensure the rat check is clean. Tag for the release. Start with RC0 and move to RC1, RC2 if you need to restart the release process for this version. - git tag -a release-$SLIDER_RELEASE-rc1 -m 'Slider $SLIDER_RELEASE-RC1' + git tag -a release-$SLIDER_RELEASE-$RELEASE_RC -m 'Slider $SLIDER_RELEASE-$RELEASE_RC' git push --tags origin **Step 5** @@ -257,11 +277,16 @@ You should find a `*.tar.gz` at target f Rename it with *incubator* in the name. cd target + rm rat.txt + rm .plxarc rm -rf archive-tmp + rm -rf maven-shared-archive-resources + **Step 6** +<!-- this is now automated Sign the tarball @@ -269,11 +294,14 @@ Sign the tarball gpg2 --armor --default-key $asf_u...@apache.org -v --output apache-slider-$SLIDER_RELEASE-source-release.tar.gz.asc --detach-sig apache-slider-$SLIDER_RELEASE-source-release.tar.gz gpg2 --armor --default-key $asf_u...@apache.org -v --output apache-slider-$SLIDER_RELEASE-source-release.zip.asc --detach-sig apache-slider-$SLIDER_RELEASE-source-release.zip +--> **Step 7** Generate MD5 checksums. *md5sum* and *sha1sum* or *gpg* are all capable of creating checksum files. +Either + openssl md5 apache-slider-$SLIDER_RELEASE-source-release.tar.gz > apache-slider-$SLIDER_RELEASE-source-release.tar.gz.md5 openssl sha1 apache-slider-$SLIDER_RELEASE-source-release.tar.gz > apache-slider-$SLIDER_RELEASE-source-release.tar.gz.sha openssl md5 apache-slider-$SLIDER_RELEASE-source-release.zip > apache-slider-$SLIDER_RELEASE-source-release.zip.md5 @@ -291,74 +319,79 @@ or Upload the artifacts to your apache home: -The artifacts then need to be copied over to ~/public_html/slider-release-$SLIDER_RELEASE-rc0 +The artifacts then need to be copied over to `~/public_html/slider-release-$SLIDER_RELEASE-rcX` cd .. - mv target slider-release-$SLIDER_RELEASE-rc1 + + mv target slider-release-$SLIDER_RELEASE-$RELEASE_RC - scp -r slider-release-$SLIDER_RELEASE-rc1 $asf_u...@people.apache.org:public_html/slider/ + scp -r slider-release-$SLIDER_RELEASE-$RELEASE_RC $asf_u...@people.apache.org:public_html/slider/ (if you don't get the authentication for the copy, go to https://id.apache.org/ and add your ssh keys to your profile) The entire directory should now be uploaded, check it: - echo http://people.apache.org/~$ASF_USER/slider + echo http://people.apache.org/~$ASF_USER/slider/slider-release-$SLIDER_RELEASE-$RELEASE_RC + + on OS/X, you can have it opened in your chosen browser + + open http://people.apache.org/~$ASF_USER/slider/slider-release-$SLIDER_RELEASE-$RELEASE_RC **Step 9** -Tell JIRA there's a new release. You must be registered as an admin for the -Slider project on JIRA. - -Go to the [Slider Versions page](https://issues.apache.org/jira/plugins/servlet/project-config/SLIDER/versions) - -Release the version you've done, carrying forward issues that haven't been done -yet. +(omitted) **Step 10** -Call for a release VOTE to the dev mailing list (d...@slider.incubator.apache.org). +Call for a release VOTE to the dev mailing list (`d...@slider.incubator.apache.org`). To build the URLs, echo them then verify in your browser that they are present - echo "artifacts at http://people.apache.org/~$ASF_USER/slider/slider-release-$SLIDER_RELEASE-rc1" + echo [VOTE] Apache Slider Incubating Release $SLIDER_RELEASE $RELEASE_RC + + echo "This is a call for a vote on Apache Slider $SLIDER_RELEASE release" + + echo "Artifacts at http://people.apache.org/~$ASF_USER/slider/slider-release-$SLIDER_RELEASE-$RELEASE_RC" - echo "source at https://git-wip-us.apache.org/repos/asf?p=incubator-slider.git;a=shortlog;h=refs/tags/release-$SLIDER_RELEASE-rc0" + echo "Git source tag: https://git-wip-us.apache.org/repos/asf?p=incubator-slider.git;a=shortlog;h=refs/tags/release-$SLIDER_RELEASE-$RELEASE_RC" echo "PGP keys at http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=$asf_u...@apache.org" - echo [VOTE] Apache Slider Incubating Release $SLIDER_RELEASE RC0 + Sample: +``` - Title: [VOTE] Apache Slider Incubating Release $SLIDER_RELEASE RC0 +Title: [VOTE] Apache Slider Incubating Release $SLIDER_RELEASE $RELEASE_RC - Hello folks, +Hello folks, - This is a call for a vote on Apache Slider $SLIDER_RELEASE release. - Thanks to everyone who have contributed to this release. +This is a call for a vote on Apache Slider $SLIDER_RELEASE release. +Thanks to everyone who have contributed to this release. - Git source tag: - https://git-wip-us.apache.org/repos/asf?p=incubator-slider.git;a=shortlog;h=refs/tags/release-$SLIDER_RELEASE-rc0 +Git source tag: +https://git-wip-us.apache.org/repos/asf?p=incubator-slider.git;a=shortlog;h=refs/tags/release-$SLIDER_RELEASE-$RELEASE_RC - Staging site: - http://people.apache.org/~$ASF_USER/slider-release-$SLIDER_RELEASE-rc0" +Staging site: +http://people.apache.org/~$ASF_USER/slider-release-$SLIDER_RELEASE-$RELEASE_RC" - PGP release keys (signed using $ASF_USER) - http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=$asf_u...@apache.org +PGP release keys (signed using $ASF_USER) +http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=$asf_u...@apache.org - The issues fixed in this release are listed at at: - https://issues.apache.org/jira/browse/SLIDER/fixforversion/<FIX VERSION OF THIS RELEASE> +The issues fixed in this release are listed at at: +https://issues.apache.org/jira/browse/SLIDER/fixforversion/<FIX VERSION OF THIS RELEASE> - Note that this is a source only release and we are voting on the source. +Note that this is a source only release and we are voting on the source. - Build instructions at: http://slider.incubator.apache.org/developing/building.html +Build instructions at: http://slider.incubator.apache.org/developing/building.html - Vote will be open for 72 hours +Vote will be open for 72 hours - [ ] +1 approve - [ ] +0 no opinion - [ ] -1 disapprove (and reason why) +[ ] +1 approve +[ ] +0 no opinion +[ ] -1 disapprove (and reason why) +``` * CHECK ALL THE URLS FIRST * @@ -370,7 +403,7 @@ If that VOTE passes with the IPMC send a Sample: - Title: [RESULT][VOTE] Apache Slider $SLIDER_RELEASE RC0 + Title: [RESULT][VOTE] Apache Slider $SLIDER_RELEASE $RELEASE_RC Thanks for the votes. The VOTE passes with 5, +1 votes from IPMC. @@ -407,7 +440,7 @@ Then... mkdir $SLIDER_RELEASE $SLIDER_RELEASE/src cd $SLIDER_RELEASE/src - scp ~/public_html/$SLIDER_RELEASE-rc0/* . + scp ~/public_html/$SLIDER_RELEASE-$RELEASE_RC/* . cd .. svn add $SLIDER_RELEASE svn commit -m "SLIDER_RELEASE_JIRA Committing Release $SLIDER_RELEASE" @@ -454,7 +487,17 @@ Sample: Regards, The Slider Team + +**Step 17** +Tell JIRA there's a new release. You must be registered as an admin for the +Slider project on JIRA. + +Go to the [Slider Versions page](https://issues.apache.org/jira/plugins/servlet/project-config/SLIDER/versions) + +Release the version you've done, carrying forward issues that haven't been done +yet. + ## Hotfixing a release @@ -533,7 +576,7 @@ See the [ASF release guidelines](http:// The (slider 0.60) app package versions mean the artifacts are not suitable for uploading; they generate files such as `slider-storm-app-package-${pkg.version}.pom` which don't contain a valid version number. -We have fixed this this by moving the app packages out of the slider project itself, so drive them off other version information. +We have fixed this this from Slider 0.61/0.70 by moving the app packages out of the slider project itself, so drive them off other version information. ## Dry run of release @@ -542,9 +585,38 @@ We have fixed this this by moving the ap ## Deploy - mvn deploy -DskipTests -Papache-release - + mvn deploy -DskipTests -Papache-release + +## uploading for a vote + + mvn release:clean + mvn release:prepare -DautoVersionSubmodules=true -Darguments="-DskipTests -DskipITs" -Dresume=false + mvn release:perform + ### Closing the release log in to [https://repository.apache.org/index.html](https://repository.apache.org/index.html) -with your ASF username & LDAP password \ No newline at end of file +with your ASF username & LDAP password + +# Notes on a changed process + +This is some working notes on the 0.61 release + +* see: [Publishing Maven Artifacts](http://www.apache.org/dev/publishing-maven-artifacts.html) +* see: [https://wiki.apache.org/commons/UsingNexus](https://wiki.apache.org/commons/UsingNexus) + +Key: the mvn release package is what should be doing the automation + + +you can log in to nexus at + +https://repository.apache.org/service/local/staging/deploy/maven2/org/apache/slider + +using your ASF username and LDAP passwd + +proposed + +1. mvn deploy of the snapshot +1. publish the src +1. vote on it +1. if people are happy issue a release with the same files, rebadged \ No newline at end of file Modified: incubator/slider/site/trunk/content/docs/high_availability.md URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/high_availability.md?rev=1651392&r1=1651391&r2=1651392&view=diff ============================================================================== --- incubator/slider/site/trunk/content/docs/high_availability.md (original) +++ incubator/slider/site/trunk/content/docs/high_availability.md Tue Jan 13 15:53:15 2015 @@ -1,20 +1,16 @@ -Title: -Notice: 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. +<!--- + Licensed 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. See accompanying LICENSE file. +--> # High Availability: ###Setup Resource Manager HA, Name Node HA, Work Preserving Resource Manager restart and Work Preserving Node Manager restart Modified: incubator/slider/site/trunk/content/docs/index.md URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/index.md?rev=1651392&r1=1651391&r2=1651392&view=diff ============================================================================== --- incubator/slider/site/trunk/content/docs/index.md (original) +++ incubator/slider/site/trunk/content/docs/index.md Tue Jan 13 15:53:15 2015 @@ -23,6 +23,7 @@ * [Client Configuration](client-configuration.html) * [Client Exit Codes](exitcodes.html) * [Security](security.html) +* [REST API](api/index.html) * [Agent to AM SSL](ssl.html) * [High Availability](high_availability.html) * [Troubleshooting](troubleshooting.html)