http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/assets/js/npm.js ---------------------------------------------------------------------- diff --git a/assets/js/npm.js b/assets/js/npm.js new file mode 100644 index 0000000..bf6aa80 --- /dev/null +++ b/assets/js/npm.js @@ -0,0 +1,13 @@ +// This file is autogenerated via the `commonjs` Grunt task. You can require() this file in a CommonJS environment. +require('../../js/transition.js') +require('../../js/alert.js') +require('../../js/button.js') +require('../../js/carousel.js') +require('../../js/collapse.js') +require('../../js/dropdown.js') +require('../../js/modal.js') +require('../../js/tooltip.js') +require('../../js/popover.js') +require('../../js/scrollspy.js') +require('../../js/tab.js') +require('../../js/affix.js') \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/assets/js/owl.carousel.min.js ---------------------------------------------------------------------- diff --git a/assets/js/owl.carousel.min.js b/assets/js/owl.carousel.min.js new file mode 100644 index 0000000..394505e --- /dev/null +++ b/assets/js/owl.carousel.min.js @@ -0,0 +1,47 @@ +"function"!==typeof Object.create&&(Object.create=function(f){function g(){}g.prototype=f;return new g}); +(function(f,g,k){var l={init:function(a,b){this.$elem=f(b);this.options=f.extend({},f.fn.owlCarousel.options,this.$elem.data(),a);this.userOptions=a;this.loadContent()},loadContent:function(){function a(a){var d,e="";if("function"===typeof b.options.jsonSuccess)b.options.jsonSuccess.apply(this,[a]);else{for(d in a.owl)a.owl.hasOwnProperty(d)&&(e+=a.owl[d].item);b.$elem.html(e)}b.logIn()}var b=this,e;"function"===typeof b.options.beforeInit&&b.options.beforeInit.apply(this,[b.$elem]);"string"===typeof b.options.jsonPath? +(e=b.options.jsonPath,f.getJSON(e,a)):b.logIn()},logIn:function(){this.$elem.data("owl-originalStyles",this.$elem.attr("style"));this.$elem.data("owl-originalClasses",this.$elem.attr("class"));this.$elem.css({opacity:0});this.orignalItems=this.options.items;this.checkBrowser();this.wrapperWidth=0;this.checkVisible=null;this.setVars()},setVars:function(){if(0===this.$elem.children().length)return!1;this.baseClass();this.eventTypes();this.$userItems=this.$elem.children();this.itemsAmount=this.$userItems.length; +this.wrapItems();this.$owlItems=this.$elem.find(".owl-item");this.$owlWrapper=this.$elem.find(".owl-wrapper");this.playDirection="next";this.prevItem=0;this.prevArr=[0];this.currentItem=0;this.customEvents();this.onStartup()},onStartup:function(){this.updateItems();this.calculateAll();this.buildControls();this.updateControls();this.response();this.moveEvents();this.stopOnHover();this.owlStatus();!1!==this.options.transitionStyle&&this.transitionTypes(this.options.transitionStyle);!0===this.options.autoPlay&& +(this.options.autoPlay=5E3);this.play();this.$elem.find(".owl-wrapper").css("display","block");this.$elem.is(":visible")?this.$elem.css("opacity",1):this.watchVisibility();this.onstartup=!1;this.eachMoveUpdate();"function"===typeof this.options.afterInit&&this.options.afterInit.apply(this,[this.$elem])},eachMoveUpdate:function(){!0===this.options.lazyLoad&&this.lazyLoad();!0===this.options.autoHeight&&this.autoHeight();this.onVisibleItems();"function"===typeof this.options.afterAction&&this.options.afterAction.apply(this, +[this.$elem])},updateVars:function(){"function"===typeof this.options.beforeUpdate&&this.options.beforeUpdate.apply(this,[this.$elem]);this.watchVisibility();this.updateItems();this.calculateAll();this.updatePosition();this.updateControls();this.eachMoveUpdate();"function"===typeof this.options.afterUpdate&&this.options.afterUpdate.apply(this,[this.$elem])},reload:function(){var a=this;g.setTimeout(function(){a.updateVars()},0)},watchVisibility:function(){var a=this;if(!1===a.$elem.is(":visible"))a.$elem.css({opacity:0}), +g.clearInterval(a.autoPlayInterval),g.clearInterval(a.checkVisible);else return!1;a.checkVisible=g.setInterval(function(){a.$elem.is(":visible")&&(a.reload(),a.$elem.animate({opacity:1},200),g.clearInterval(a.checkVisible))},500)},wrapItems:function(){this.$userItems.wrapAll('<div class="owl-wrapper">').wrap('<div class="owl-item"></div>');this.$elem.find(".owl-wrapper").wrap('<div class="owl-wrapper-outer">');this.wrapperOuter=this.$elem.find(".owl-wrapper-outer");this.$elem.css("display","block")}, +baseClass:function(){var a=this.$elem.hasClass(this.options.baseClass),b=this.$elem.hasClass(this.options.theme);a||this.$elem.addClass(this.options.baseClass);b||this.$elem.addClass(this.options.theme)},updateItems:function(){var a,b;if(!1===this.options.responsive)return!1;if(!0===this.options.singleItem)return this.options.items=this.orignalItems=1,this.options.itemsCustom=!1,this.options.itemsDesktop=!1,this.options.itemsDesktopSmall=!1,this.options.itemsTablet=!1,this.options.itemsTabletSmall= +!1,this.options.itemsMobile=!1;a=f(this.options.responsiveBaseWidth).width();a>(this.options.itemsDesktop[0]||this.orignalItems)&&(this.options.items=this.orignalItems);if(!1!==this.options.itemsCustom)for(this.options.itemsCustom.sort(function(a,b){return a[0]-b[0]}),b=0;b<this.options.itemsCustom.length;b+=1)this.options.itemsCustom[b][0]<=a&&(this.options.items=this.options.itemsCustom[b][1]);else a<=this.options.itemsDesktop[0]&&!1!==this.options.itemsDesktop&&(this.options.items=this.options.itemsDesktop[1]), +a<=this.options.itemsDesktopSmall[0]&&!1!==this.options.itemsDesktopSmall&&(this.options.items=this.options.itemsDesktopSmall[1]),a<=this.options.itemsTablet[0]&&!1!==this.options.itemsTablet&&(this.options.items=this.options.itemsTablet[1]),a<=this.options.itemsTabletSmall[0]&&!1!==this.options.itemsTabletSmall&&(this.options.items=this.options.itemsTabletSmall[1]),a<=this.options.itemsMobile[0]&&!1!==this.options.itemsMobile&&(this.options.items=this.options.itemsMobile[1]);this.options.items>this.itemsAmount&& +!0===this.options.itemsScaleUp&&(this.options.items=this.itemsAmount)},response:function(){var a=this,b,e;if(!0!==a.options.responsive)return!1;e=f(g).width();a.resizer=function(){f(g).width()!==e&&(!1!==a.options.autoPlay&&g.clearInterval(a.autoPlayInterval),g.clearTimeout(b),b=g.setTimeout(function(){e=f(g).width();a.updateVars()},a.options.responsiveRefreshRate))};f(g).resize(a.resizer)},updatePosition:function(){this.jumpTo(this.currentItem);!1!==this.options.autoPlay&&this.checkAp()},appendItemsSizes:function(){var a= +this,b=0,e=a.itemsAmount-a.options.items;a.$owlItems.each(function(c){var d=f(this);d.css({width:a.itemWidth}).data("owl-item",Number(c));if(0===c%a.options.items||c===e)c>e||(b+=1);d.data("owl-roundPages",b)})},appendWrapperSizes:function(){this.$owlWrapper.css({width:this.$owlItems.length*this.itemWidth*2,left:0});this.appendItemsSizes()},calculateAll:function(){this.calculateWidth();this.appendWrapperSizes();this.loops();this.max()},calculateWidth:function(){this.itemWidth=Math.round(this.$elem.width()/ +this.options.items)},max:function(){var a=-1*(this.itemsAmount*this.itemWidth-this.options.items*this.itemWidth);this.options.items>this.itemsAmount?this.maximumPixels=a=this.maximumItem=0:(this.maximumItem=this.itemsAmount-this.options.items,this.maximumPixels=a);return a},min:function(){return 0},loops:function(){var a=0,b=0,e,c;this.positionsInArray=[0];this.pagesInArray=[];for(e=0;e<this.itemsAmount;e+=1)b+=this.itemWidth,this.positionsInArray.push(-b),!0===this.options.scrollPerPage&&(c=f(this.$owlItems[e]), +c=c.data("owl-roundPages"),c!==a&&(this.pagesInArray[a]=this.positionsInArray[e],a=c))},buildControls:function(){if(!0===this.options.navigation||!0===this.options.pagination)this.owlControls=f('<div class="owl-controls"/>').toggleClass("clickable",!this.browser.isTouch).appendTo(this.$elem);!0===this.options.pagination&&this.buildPagination();!0===this.options.navigation&&this.buildButtons()},buildButtons:function(){var a=this,b=f('<div class="owl-buttons"/>');a.owlControls.append(b);a.buttonPrev= +f("<div/>",{"class":"owl-prev",html:a.options.navigationText[0]||""});a.buttonNext=f("<div/>",{"class":"owl-next",html:a.options.navigationText[1]||""});b.append(a.buttonPrev).append(a.buttonNext);b.on("touchstart.owlControls mousedown.owlControls",'div[class^="owl"]',function(a){a.preventDefault()});b.on("touchend.owlControls mouseup.owlControls",'div[class^="owl"]',function(b){b.preventDefault();f(this).hasClass("owl-next")?a.next():a.prev()})},buildPagination:function(){var a=this;a.paginationWrapper= +f('<div class="owl-pagination"/>');a.owlControls.append(a.paginationWrapper);a.paginationWrapper.on("touchend.owlControls mouseup.owlControls",".owl-page",function(b){b.preventDefault();Number(f(this).data("owl-page"))!==a.currentItem&&a.goTo(Number(f(this).data("owl-page")),!0)})},updatePagination:function(){var a,b,e,c,d,g;if(!1===this.options.pagination)return!1;this.paginationWrapper.html("");a=0;b=this.itemsAmount-this.itemsAmount%this.options.items;for(c=0;c<this.itemsAmount;c+=1)0===c%this.options.items&& +(a+=1,b===c&&(e=this.itemsAmount-this.options.items),d=f("<div/>",{"class":"owl-page"}),g=f("<span></span>",{text:!0===this.options.paginationNumbers?a:"","class":!0===this.options.paginationNumbers?"owl-numbers":""}),d.append(g),d.data("owl-page",b===c?e:c),d.data("owl-roundPages",a),this.paginationWrapper.append(d));this.checkPagination()},checkPagination:function(){var a=this;if(!1===a.options.pagination)return!1;a.paginationWrapper.find(".owl-page").each(function(){f(this).data("owl-roundPages")=== +f(a.$owlItems[a.currentItem]).data("owl-roundPages")&&(a.paginationWrapper.find(".owl-page").removeClass("active"),f(this).addClass("active"))})},checkNavigation:function(){if(!1===this.options.navigation)return!1;!1===this.options.rewindNav&&(0===this.currentItem&&0===this.maximumItem?(this.buttonPrev.addClass("disabled"),this.buttonNext.addClass("disabled")):0===this.currentItem&&0!==this.maximumItem?(this.buttonPrev.addClass("disabled"),this.buttonNext.removeClass("disabled")):this.currentItem=== +this.maximumItem?(this.buttonPrev.removeClass("disabled"),this.buttonNext.addClass("disabled")):0!==this.currentItem&&this.currentItem!==this.maximumItem&&(this.buttonPrev.removeClass("disabled"),this.buttonNext.removeClass("disabled")))},updateControls:function(){this.updatePagination();this.checkNavigation();this.owlControls&&(this.options.items>=this.itemsAmount?this.owlControls.hide():this.owlControls.show())},destroyControls:function(){this.owlControls&&this.owlControls.remove()},next:function(a){if(this.isTransition)return!1; +this.currentItem+=!0===this.options.scrollPerPage?this.options.items:1;if(this.currentItem>this.maximumItem+(!0===this.options.scrollPerPage?this.options.items-1:0))if(!0===this.options.rewindNav)this.currentItem=0,a="rewind";else return this.currentItem=this.maximumItem,!1;this.goTo(this.currentItem,a)},prev:function(a){if(this.isTransition)return!1;this.currentItem=!0===this.options.scrollPerPage&&0<this.currentItem&&this.currentItem<this.options.items?0:this.currentItem-(!0===this.options.scrollPerPage? +this.options.items:1);if(0>this.currentItem)if(!0===this.options.rewindNav)this.currentItem=this.maximumItem,a="rewind";else return this.currentItem=0,!1;this.goTo(this.currentItem,a)},goTo:function(a,b,e){var c=this;if(c.isTransition)return!1;"function"===typeof c.options.beforeMove&&c.options.beforeMove.apply(this,[c.$elem]);a>=c.maximumItem?a=c.maximumItem:0>=a&&(a=0);c.currentItem=c.owl.currentItem=a;if(!1!==c.options.transitionStyle&&"drag"!==e&&1===c.options.items&&!0===c.browser.support3d)return c.swapSpeed(0), +!0===c.browser.support3d?c.transition3d(c.positionsInArray[a]):c.css2slide(c.positionsInArray[a],1),c.afterGo(),c.singleItemTransition(),!1;a=c.positionsInArray[a];!0===c.browser.support3d?(c.isCss3Finish=!1,!0===b?(c.swapSpeed("paginationSpeed"),g.setTimeout(function(){c.isCss3Finish=!0},c.options.paginationSpeed)):"rewind"===b?(c.swapSpeed(c.options.rewindSpeed),g.setTimeout(function(){c.isCss3Finish=!0},c.options.rewindSpeed)):(c.swapSpeed("slideSpeed"),g.setTimeout(function(){c.isCss3Finish=!0}, +c.options.slideSpeed)),c.transition3d(a)):!0===b?c.css2slide(a,c.options.paginationSpeed):"rewind"===b?c.css2slide(a,c.options.rewindSpeed):c.css2slide(a,c.options.slideSpeed);c.afterGo()},jumpTo:function(a){"function"===typeof this.options.beforeMove&&this.options.beforeMove.apply(this,[this.$elem]);a>=this.maximumItem||-1===a?a=this.maximumItem:0>=a&&(a=0);this.swapSpeed(0);!0===this.browser.support3d?this.transition3d(this.positionsInArray[a]):this.css2slide(this.positionsInArray[a],1);this.currentItem= +this.owl.currentItem=a;this.afterGo()},afterGo:function(){this.prevArr.push(this.currentItem);this.prevItem=this.owl.prevItem=this.prevArr[this.prevArr.length-2];this.prevArr.shift(0);this.prevItem!==this.currentItem&&(this.checkPagination(),this.checkNavigation(),this.eachMoveUpdate(),!1!==this.options.autoPlay&&this.checkAp());"function"===typeof this.options.afterMove&&this.prevItem!==this.currentItem&&this.options.afterMove.apply(this,[this.$elem])},stop:function(){this.apStatus="stop";g.clearInterval(this.autoPlayInterval)}, +checkAp:function(){"stop"!==this.apStatus&&this.play()},play:function(){var a=this;a.apStatus="play";if(!1===a.options.autoPlay)return!1;g.clearInterval(a.autoPlayInterval);a.autoPlayInterval=g.setInterval(function(){a.next(!0)},a.options.autoPlay)},swapSpeed:function(a){"slideSpeed"===a?this.$owlWrapper.css(this.addCssSpeed(this.options.slideSpeed)):"paginationSpeed"===a?this.$owlWrapper.css(this.addCssSpeed(this.options.paginationSpeed)):"string"!==typeof a&&this.$owlWrapper.css(this.addCssSpeed(a))}, +addCssSpeed:function(a){return{"-webkit-transition":"all "+a+"ms ease","-moz-transition":"all "+a+"ms ease","-o-transition":"all "+a+"ms ease",transition:"all "+a+"ms ease"}},removeTransition:function(){return{"-webkit-transition":"","-moz-transition":"","-o-transition":"",transition:""}},doTranslate:function(a){return{"-webkit-transform":"translate3d("+a+"px, 0px, 0px)","-moz-transform":"translate3d("+a+"px, 0px, 0px)","-o-transform":"translate3d("+a+"px, 0px, 0px)","-ms-transform":"translate3d("+ +a+"px, 0px, 0px)",transform:"translate3d("+a+"px, 0px,0px)"}},transition3d:function(a){this.$owlWrapper.css(this.doTranslate(a))},css2move:function(a){this.$owlWrapper.css({left:a})},css2slide:function(a,b){var e=this;e.isCssFinish=!1;e.$owlWrapper.stop(!0,!0).animate({left:a},{duration:b||e.options.slideSpeed,complete:function(){e.isCssFinish=!0}})},checkBrowser:function(){var a=k.createElement("div");a.style.cssText=" -moz-transform:translate3d(0px, 0px, 0px); -ms-transform:translate3d(0px, 0px, 0px); -o-transform:translate3d(0px, 0px, 0px); -webkit-transform:translate3d(0px, 0px, 0px); transform:translate3d(0px, 0px, 0px)"; +a=a.style.cssText.match(/translate3d\(0px, 0px, 0px\)/g);this.browser={support3d:null!==a&&1===a.length,isTouch:"ontouchstart"in g||g.navigator.msMaxTouchPoints}},moveEvents:function(){if(!1!==this.options.mouseDrag||!1!==this.options.touchDrag)this.gestures(),this.disabledEvents()},eventTypes:function(){var a=["s","e","x"];this.ev_types={};!0===this.options.mouseDrag&&!0===this.options.touchDrag?a=["touchstart.owl mousedown.owl","touchmove.owl mousemove.owl","touchend.owl touchcancel.owl mouseup.owl"]: +!1===this.options.mouseDrag&&!0===this.options.touchDrag?a=["touchstart.owl","touchmove.owl","touchend.owl touchcancel.owl"]:!0===this.options.mouseDrag&&!1===this.options.touchDrag&&(a=["mousedown.owl","mousemove.owl","mouseup.owl"]);this.ev_types.start=a[0];this.ev_types.move=a[1];this.ev_types.end=a[2]},disabledEvents:function(){this.$elem.on("dragstart.owl",function(a){a.preventDefault()});this.$elem.on("mousedown.disableTextSelect",function(a){return f(a.target).is("input, textarea, select, option")})}, +gestures:function(){function a(a){if(void 0!==a.touches)return{x:a.touches[0].pageX,y:a.touches[0].pageY};if(void 0===a.touches){if(void 0!==a.pageX)return{x:a.pageX,y:a.pageY};if(void 0===a.pageX)return{x:a.clientX,y:a.clientY}}}function b(a){"on"===a?(f(k).on(d.ev_types.move,e),f(k).on(d.ev_types.end,c)):"off"===a&&(f(k).off(d.ev_types.move),f(k).off(d.ev_types.end))}function e(b){b=b.originalEvent||b||g.event;d.newPosX=a(b).x-h.offsetX;d.newPosY=a(b).y-h.offsetY;d.newRelativeX=d.newPosX-h.relativePos; +"function"===typeof d.options.startDragging&&!0!==h.dragging&&0!==d.newRelativeX&&(h.dragging=!0,d.options.startDragging.apply(d,[d.$elem]));(8<d.newRelativeX||-8>d.newRelativeX)&&!0===d.browser.isTouch&&(void 0!==b.preventDefault?b.preventDefault():b.returnValue=!1,h.sliding=!0);(10<d.newPosY||-10>d.newPosY)&&!1===h.sliding&&f(k).off("touchmove.owl");d.newPosX=Math.max(Math.min(d.newPosX,d.newRelativeX/5),d.maximumPixels+d.newRelativeX/5);!0===d.browser.support3d?d.transition3d(d.newPosX):d.css2move(d.newPosX)} +function c(a){a=a.originalEvent||a||g.event;var c;a.target=a.target||a.srcElement;h.dragging=!1;!0!==d.browser.isTouch&&d.$owlWrapper.removeClass("grabbing");d.dragDirection=0>d.newRelativeX?d.owl.dragDirection="left":d.owl.dragDirection="right";0!==d.newRelativeX&&(c=d.getNewPosition(),d.goTo(c,!1,"drag"),h.targetElement===a.target&&!0!==d.browser.isTouch&&(f(a.target).on("click.disable",function(a){a.stopImmediatePropagation();a.stopPropagation();a.preventDefault();f(a.target).off("click.disable")}), +a=f._data(a.target,"events").click,c=a.pop(),a.splice(0,0,c)));b("off")}var d=this,h={offsetX:0,offsetY:0,baseElWidth:0,relativePos:0,position:null,minSwipe:null,maxSwipe:null,sliding:null,dargging:null,targetElement:null};d.isCssFinish=!0;d.$elem.on(d.ev_types.start,".owl-wrapper",function(c){c=c.originalEvent||c||g.event;var e;if(3===c.which)return!1;if(!(d.itemsAmount<=d.options.items)){if(!1===d.isCssFinish&&!d.options.dragBeforeAnimFinish||!1===d.isCss3Finish&&!d.options.dragBeforeAnimFinish)return!1; +!1!==d.options.autoPlay&&g.clearInterval(d.autoPlayInterval);!0===d.browser.isTouch||d.$owlWrapper.hasClass("grabbing")||d.$owlWrapper.addClass("grabbing");d.newPosX=0;d.newRelativeX=0;f(this).css(d.removeTransition());e=f(this).position();h.relativePos=e.left;h.offsetX=a(c).x-e.left;h.offsetY=a(c).y-e.top;b("on");h.sliding=!1;h.targetElement=c.target||c.srcElement}})},getNewPosition:function(){var a=this.closestItem();a>this.maximumItem?a=this.currentItem=this.maximumItem:0<=this.newPosX&&(this.currentItem= +a=0);return a},closestItem:function(){var a=this,b=!0===a.options.scrollPerPage?a.pagesInArray:a.positionsInArray,e=a.newPosX,c=null;f.each(b,function(d,g){e-a.itemWidth/20>b[d+1]&&e-a.itemWidth/20<g&&"left"===a.moveDirection()?(c=g,a.currentItem=!0===a.options.scrollPerPage?f.inArray(c,a.positionsInArray):d):e+a.itemWidth/20<g&&e+a.itemWidth/20>(b[d+1]||b[d]-a.itemWidth)&&"right"===a.moveDirection()&&(!0===a.options.scrollPerPage?(c=b[d+1]||b[b.length-1],a.currentItem=f.inArray(c,a.positionsInArray)): +(c=b[d+1],a.currentItem=d+1))});return a.currentItem},moveDirection:function(){var a;0>this.newRelativeX?(a="right",this.playDirection="next"):(a="left",this.playDirection="prev");return a},customEvents:function(){var a=this;a.$elem.on("owl.next",function(){a.next()});a.$elem.on("owl.prev",function(){a.prev()});a.$elem.on("owl.play",function(b,e){a.options.autoPlay=e;a.play();a.hoverStatus="play"});a.$elem.on("owl.stop",function(){a.stop();a.hoverStatus="stop"});a.$elem.on("owl.goTo",function(b,e){a.goTo(e)}); +a.$elem.on("owl.jumpTo",function(b,e){a.jumpTo(e)})},stopOnHover:function(){var a=this;!0===a.options.stopOnHover&&!0!==a.browser.isTouch&&!1!==a.options.autoPlay&&(a.$elem.on("mouseover",function(){a.stop()}),a.$elem.on("mouseout",function(){"stop"!==a.hoverStatus&&a.play()}))},lazyLoad:function(){var a,b,e,c,d;if(!1===this.options.lazyLoad)return!1;for(a=0;a<this.itemsAmount;a+=1)b=f(this.$owlItems[a]),"loaded"!==b.data("owl-loaded")&&(e=b.data("owl-item"),c=b.find(".lazyOwl"),"string"!==typeof c.data("src")? +b.data("owl-loaded","loaded"):(void 0===b.data("owl-loaded")&&(c.hide(),b.addClass("loading").data("owl-loaded","checked")),(d=!0===this.options.lazyFollow?e>=this.currentItem:!0)&&e<this.currentItem+this.options.items&&c.length&&this.lazyPreload(b,c)))},lazyPreload:function(a,b){function e(){a.data("owl-loaded","loaded").removeClass("loading");b.removeAttr("data-src");"fade"===d.options.lazyEffect?b.fadeIn(400):b.show();"function"===typeof d.options.afterLazyLoad&&d.options.afterLazyLoad.apply(this, +[d.$elem])}function c(){f+=1;d.completeImg(b.get(0))||!0===k?e():100>=f?g.setTimeout(c,100):e()}var d=this,f=0,k;"DIV"===b.prop("tagName")?(b.css("background-image","url("+b.data("src")+")"),k=!0):b[0].src=b.data("src");c()},autoHeight:function(){function a(){var a=f(e.$owlItems[e.currentItem]).height();e.wrapperOuter.css("height",a+"px");e.wrapperOuter.hasClass("autoHeight")||g.setTimeout(function(){e.wrapperOuter.addClass("autoHeight")},0)}function b(){d+=1;e.completeImg(c.get(0))?a():100>=d?g.setTimeout(b, +100):e.wrapperOuter.css("height","")}var e=this,c=f(e.$owlItems[e.currentItem]).find("img"),d;void 0!==c.get(0)?(d=0,b()):a()},completeImg:function(a){return!a.complete||"undefined"!==typeof a.naturalWidth&&0===a.naturalWidth?!1:!0},onVisibleItems:function(){var a;!0===this.options.addClassActive&&this.$owlItems.removeClass("active");this.visibleItems=[];for(a=this.currentItem;a<this.currentItem+this.options.items;a+=1)this.visibleItems.push(a),!0===this.options.addClassActive&&f(this.$owlItems[a]).addClass("active"); +this.owl.visibleItems=this.visibleItems},transitionTypes:function(a){this.outClass="owl-"+a+"-out";this.inClass="owl-"+a+"-in"},singleItemTransition:function(){var a=this,b=a.outClass,e=a.inClass,c=a.$owlItems.eq(a.currentItem),d=a.$owlItems.eq(a.prevItem),f=Math.abs(a.positionsInArray[a.currentItem])+a.positionsInArray[a.prevItem],g=Math.abs(a.positionsInArray[a.currentItem])+a.itemWidth/2;a.isTransition=!0;a.$owlWrapper.addClass("owl-origin").css({"-webkit-transform-origin":g+"px","-moz-perspective-origin":g+ +"px","perspective-origin":g+"px"});d.css({position:"relative",left:f+"px"}).addClass(b).on("webkitAnimationEnd oAnimationEnd MSAnimationEnd animationend",function(){a.endPrev=!0;d.off("webkitAnimationEnd oAnimationEnd MSAnimationEnd animationend");a.clearTransStyle(d,b)});c.addClass(e).on("webkitAnimationEnd oAnimationEnd MSAnimationEnd animationend",function(){a.endCurrent=!0;c.off("webkitAnimationEnd oAnimationEnd MSAnimationEnd animationend");a.clearTransStyle(c,e)})},clearTransStyle:function(a, +b){a.css({position:"",left:""}).removeClass(b);this.endPrev&&this.endCurrent&&(this.$owlWrapper.removeClass("owl-origin"),this.isTransition=this.endCurrent=this.endPrev=!1)},owlStatus:function(){this.owl={userOptions:this.userOptions,baseElement:this.$elem,userItems:this.$userItems,owlItems:this.$owlItems,currentItem:this.currentItem,prevItem:this.prevItem,visibleItems:this.visibleItems,isTouch:this.browser.isTouch,browser:this.browser,dragDirection:this.dragDirection}},clearEvents:function(){this.$elem.off(".owl owl mousedown.disableTextSelect"); +f(k).off(".owl owl");f(g).off("resize",this.resizer)},unWrap:function(){0!==this.$elem.children().length&&(this.$owlWrapper.unwrap(),this.$userItems.unwrap().unwrap(),this.owlControls&&this.owlControls.remove());this.clearEvents();this.$elem.attr("style",this.$elem.data("owl-originalStyles")||"").attr("class",this.$elem.data("owl-originalClasses"))},destroy:function(){this.stop();g.clearInterval(this.checkVisible);this.unWrap();this.$elem.removeData()},reinit:function(a){a=f.extend({},this.userOptions, +a);this.unWrap();this.init(a,this.$elem)},addItem:function(a,b){var e;if(!a)return!1;if(0===this.$elem.children().length)return this.$elem.append(a),this.setVars(),!1;this.unWrap();e=void 0===b||-1===b?-1:b;e>=this.$userItems.length||-1===e?this.$userItems.eq(-1).after(a):this.$userItems.eq(e).before(a);this.setVars()},removeItem:function(a){if(0===this.$elem.children().length)return!1;a=void 0===a||-1===a?-1:a;this.unWrap();this.$userItems.eq(a).remove();this.setVars()}};f.fn.owlCarousel=function(a){return this.each(function(){if(!0=== +f(this).data("owl-init"))return!1;f(this).data("owl-init",!0);var b=Object.create(l);b.init(a,this);f.data(this,"owlCarousel",b)})};f.fn.owlCarousel.options={items:5,itemsCustom:!1,itemsDesktop:[1199,4],itemsDesktopSmall:[979,3],itemsTablet:[768,2],itemsTabletSmall:!1,itemsMobile:[479,1],singleItem:!1,itemsScaleUp:!1,slideSpeed:200,paginationSpeed:800,rewindSpeed:1E3,autoPlay:!1,stopOnHover:!1,navigation:!1,navigationText:["prev","next"],rewindNav:!0,scrollPerPage:!1,pagination:!0,paginationNumbers:!1, +responsive:!0,responsiveRefreshRate:200,responsiveBaseWidth:g,baseClass:"owl-carousel",theme:"owl-theme",lazyLoad:!1,lazyFollow:!0,lazyEffect:"fade",autoHeight:!1,jsonPath:!1,jsonSuccess:!1,dragBeforeAnimFinish:!0,mouseDrag:!0,touchDrag:!0,addClassActive:!1,transitionStyle:!1,beforeUpdate:!1,afterUpdate:!1,beforeInit:!1,afterInit:!1,beforeMove:!1,afterMove:!1,afterAction:!1,startDragging:!1,afterLazyLoad:!1}})(jQuery,window,document); \ No newline at end of file http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/assets/js/storm.js ---------------------------------------------------------------------- diff --git a/assets/js/storm.js b/assets/js/storm.js new file mode 100644 index 0000000..1aab7e1 --- /dev/null +++ b/assets/js/storm.js @@ -0,0 +1,67 @@ +$(document).ready(function() { + //Scroll to Top + $(".totop").hide(); + $(window).scroll(function(){ + if ($(this).scrollTop() > 300) { + $('.totop').fadeIn(); + } else { + $('.totop').fadeOut(); + } + }); + $(".totop a").click(function(e) { + e.preventDefault(); + $("html, body").animate({ scrollTop: 0 }, "slow"); + return false; + }); + + //Fixed Navigation + $('.navbar').affix({ + offset: { + top: $('header').height() + } + }); + + //Owl Carousel For CLient List + $("#owl-example").owlCarousel({ + items: 8 + }); + + $(".navbar li a").each(function() { + if(document.URL.indexOf(this.getAttribute('href'))>0) + { + $(".navbar li a").removeClass('current'); + $(this).addClass('current'); + } + if(document.URL.indexOf('/documentation/')>0) + { + $(".navbar li a").removeClass('current'); + $('#documentation').addClass('current'); + } + if(document.URL.indexOf('/contribute/')>0) + { + $(".navbar li a").removeClass('current'); + $('#contribute').addClass('current'); + } + + }); + $(".news li a").each(function() { + if(document.URL.indexOf(this.getAttribute('href'))>0 && !($("#news-list li a").hasClass('current'))){ + $("#news-list li a").removeClass('current'); + $(this).addClass('current'); + } + }); + +});; + +function isMobile() { + if (sessionStorage.desktop) + return false; + else if (localStorage.mobile) + $('#twitter_widget').hide(); + + var mobile = ['iphone','ipad','android','blackberry','nokia','opera mini','windows mobile','windows phone','iemobile']; + for (var i in mobile) + if (navigator.userAgent.toLowerCase().indexOf(mobile[i].toLowerCase()) > 0) + $('#twitter_widget').hide(); + return false; + }; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/contribute/BYLAWS.md ---------------------------------------------------------------------- diff --git a/contribute/BYLAWS.md b/contribute/BYLAWS.md new file mode 100644 index 0000000..f0725bf --- /dev/null +++ b/contribute/BYLAWS.md @@ -0,0 +1,98 @@ +--- +title: Project By-laws +layout: documentation +documentation: true +--- + +## Roles and Responsibilities + +Apache projects define a set of roles with associated rights and responsibilities. These roles govern what tasks an individual may perform within the project. The roles are defined in the following sections: + +### Users: + +The most important participants in the project are people who use our software. The majority of our developers start out as users and guide their development efforts from the user's perspective. + +Users contribute to the Apache projects by providing feedback to developers in the form of bug reports and feature suggestions. As well, users participate in the Apache community by helping other users on mailing lists and user support forums. + +### Contributors: + +Contributors are all of the volunteers who are contributing time, code, documentation, or resources to the Storm Project. A contributor that makes sustained, welcome contributions to the project may be invited to become a Committer, though the exact timing of such invitations depends on many factors. + +### Committers: + +The project's Committers are responsible for the project's technical management. Committers have access to all project source repositories. Committers may cast binding votes on any technical discussion regarding storm. + +Committer access is by invitation only and must be approved by lazy consensus of the active PMC members. A Committer is considered emeritus by their own declaration or by not contributing in any form to the project for over six months. An emeritus Committer may request reinstatement of commit access from the PMC. Such reinstatement is subject to lazy consensus approval of active PMC members. + +All Apache Committers are required to have a signed Contributor License Agreement (CLA) on file with the Apache Software Foundation. There is a [Committers' FAQ](https://www.apache.org/dev/committers.html) which provides more details on the requirements for Committers. + +A Committer who makes a sustained contribution to the project may be invited to become a member of the PMC. The form of contribution is not limited to code. It can also include code review, helping out users on the mailing lists, documentation, testing, etc. + +### Project Management Committee(PMC): + +The PMC is responsible to the board and the ASF for the management and oversight of the Apache Storm codebase. The responsibilities of the PMC include: + + * Deciding what is distributed as products of the Apache Storm project. In particular all releases must be approved by the PMC. + * Maintaining the project's shared resources, including the codebase repository, mailing lists, websites. + * Speaking on behalf of the project. + * Resolving license disputes regarding products of the project. + * Nominating new PMC members and Committers. + * Maintaining these bylaws and other guidelines of the project. + +Membership of the PMC is by invitation only and must be approved by a consensus approval of active PMC members. A PMC member is considered "emeritus" by their own declaration or by not contributing in any form to the project for over six months. An emeritus member may request reinstatement to the PMC. Such reinstatement is subject to consensus approval of the active PMC members. + +The chair of the PMC is appointed by the ASF board. The chair is an office holder of the Apache Software Foundation (Vice President, Apache Storm) and has primary responsibility to the board for the management of the projects within the scope of the Storm PMC. The chair reports to the board quarterly on developments within the Storm project. + +The chair of the PMC is rotated annually. When the chair is rotated or if the current chair of the PMC resigns, the PMC votes to recommend a new chair using Single Transferable Vote (STV) voting. See http://wiki.apache.org/general/BoardVoting for specifics. The decision must be ratified by the Apache board. + +## Voting + +Decisions regarding the project are made by votes on the primary project development mailing list ([email protected]). Where necessary, PMC voting may take place on the private Storm PMC mailing list. Votes are clearly indicated by subject line starting with [VOTE]. Votes may contain multiple items for approval and these should be clearly separated. Voting is carried out by replying to the vote mail. Voting may take four flavors: + +| Vote | Meaning | +|------|---------| +| +1 | 'Yes,' 'Agree,' or 'the action should be performed.' | +| +0 | Neutral about the proposed action. | +| -0 | Mildly negative, but not enough so to want to block it. | +| -1 |This is a negative vote. On issues where consensus is required, this vote counts as a veto. All vetoes must contain an explanation of why the veto is appropriate. Vetoes with no explanation are void. It may also be appropriate for a -1 vote to include an alternative course of action. | + +All participants in the Storm project are encouraged to show their agreement with or against a particular action by voting. For technical decisions, only the votes of active Committers are binding. Non-binding votes are still useful for those with binding votes to understand the perception of an action in the wider Storm community. For PMC decisions, only the votes of active PMC members are binding. + +Voting can also be applied to changes already made to the Storm codebase. These typically take the form of a veto (-1) in reply to the commit message sent when the commit is made. Note that this should be a rare occurrence. All efforts should be made to discuss issues when they are still patches before the code is committed. + +Only active (i.e. non-emeritus) Committers and PMC members have binding votes. + +## Approvals + +These are the types of approvals that can be sought. Different actions require different types of approvals + +| Approval Type | Criteria | +|---------------|----------| +| Consensus Approval | Consensus approval requires 3 binding +1 votes and no binding vetoes. | +| Majority Approval | Majority approval requires at least 3 binding +1 votes and more +1 votes than -1 votes. | +| Lazy Consensus | Lazy consensus requires no -1 votes ('silence gives assent'). | +| 2/3 Majority | 2/3 majority votes requires at least 3 votes and twice as many +1 votes as -1 votes. | + +### Vetoes + +A valid, binding veto cannot be overruled. If a veto is cast, it must be accompanied by a valid reason explaining the reasons for the veto. The validity of a veto, if challenged, can be confirmed by anyone who has a binding vote. This does not necessarily signify agreement with the veto - merely that the veto is valid. + +If you disagree with a valid veto, you must lobby the person casting the veto to withdraw their veto. If a veto is not withdrawn, any action that has been vetoed must be reversed in a timely manner. + +## Actions + +This section describes the various actions which are undertaken within the project, the corresponding approval required for that action and those who have binding votes over the action. + +| Actions | Description | Approval | Binding Votes | Minimum Length | Mailing List | +|---------|-------------|----------|---------------|----------------|--------------| +| Code Change | A change made to a source code of the project and committed by a Committer. | A minimum of one +1 from a Committer other than the one who authored the patch, and no -1s. The code can be committed after the first +1. If a -1 is received to the patch within 7 days after the patch was posted, it may be reverted immediately if it was already merged. | Active Committers | 1 day from initial patch (**Note:** Committers should consider allowing more time for review based on the complexity and/or impact of the patch in question.)|JIRA or Github pull ( with notification sent to [email protected]) | +| Non-Code Change | A change made to a repository of the project and committed by a Committer. This includes documentation, website content, etc., but not source code, unless only comments are being modified. | Lazy Consensus | Active Committers | At the discression of the Committer |JIRA or Github pull (with notification sent to [email protected]) | +| Product Release | A vote is required to accept a proposed release as an official release of the project. Any Committer may call for a release vote at any point in time. | Majority Approval | Active PMC members | 3 days | [email protected] | +| Adoption of New Codebase | When the codebase for an existing, released product is to be replaced with an alternative codebase. If such a vote fails to gain approval, the existing code base will continue. This also covers the creation of new sub-projects and submodules within the project as well as merging of feature branches. | 2/3 Majority | Active PMC members | 6 days | [email protected] | +| New Committer | When a new Committer is proposed for the project. | Consensus Approval | Active PMC members | 3 days | [email protected] | +| New PMC Member | When a member is proposed for the PMC. | Consensus Approval | Active PMC members | 3 days | [email protected] | +| Emeritus PMC Member re-instatement | When an emeritus PMC member requests to be re-instated as an active PMC member. | Consensus Approval | Active PMC members | 6 days | [email protected] | +| Emeritus Committer re-instatement | When an emeritus Committer requests to be re-instated as an active Committer. | Consensus Approval | Active PMC members | 6 days | [email protected] | +| Committer Removal | When removal of commit privileges is sought. Note: Such actions will also be referred to the ASF board by the PMC chair. | 2/3 Majority | Active PMC members (excluding the Committer in question if a member of the PMC). | 6 Days | [email protected] | +| PMC Member Removal | When removal of a PMC member is sought. Note: Such actions will also be referred to the ASF board by the PMC chair. | 2/3 Majority | Active PMC members (excluding the member in question). | 6 Days | [email protected] | +| Modifying Bylaws | Modifying this document. | 2/3 Majority | Active PMC members | 6 Days | [email protected] | http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/contribute/Contributing-to-Storm.md ---------------------------------------------------------------------- diff --git a/contribute/Contributing-to-Storm.md b/contribute/Contributing-to-Storm.md new file mode 100644 index 0000000..310214b --- /dev/null +++ b/contribute/Contributing-to-Storm.md @@ -0,0 +1,33 @@ +--- +title: Contributing +layout: documentation +documentation: true +--- + +### Getting started with contributing + +Some of the issues on the [issue tracker](https://issues.apache.org/jira/browse/STORM) are marked with the "Newbie" label. If you're interesting in contributing to Storm but don't know where to begin, these are good issues to start with. These issues are a great way to get your feet wet with learning the codebase because they require learning about only an isolated portion of the codebase and are a relatively small amount of work. + +### Learning the codebase + +The [Implementation docs](/documentation/Implementation-docs.html) section of the wiki gives detailed walkthroughs of the codebase. Reading through these docs is highly recommended to understand the codebase. + +### Contribution process + +Contributions to the Storm codebase should be sent as [GitHub](https://github.com/apache/storm) pull requests. If there's any problems to the pull request we can iterate on it using GitHub's commenting features. + +For small patches, feel free to submit pull requests directly for them. For larger contributions, please use the following process. The idea behind this process is to prevent any wasted work and catch design issues early on: + +1. Open an issue on the [issue tracker](https://issues.apache.org/jira/browse/STORM) if one doesn't exist already +2. Comment on the issue with your plan for implementing the issue. Explain what pieces of the codebase you're going to touch and how everything is going to fit together. +3. Storm committers will iterate with you on the design to make sure you're on the right track +4. Implement your issue, submit a pull request, and iterate from there. + +### Modules built on top of Storm + +Modules built on top of Storm (like spouts, bolts, etc) that aren't appropriate for Storm core can be done as your own project or as part of [@stormprocessor](https://github.com/stormprocessor). To be part of @stormprocessor put your project on your own Github and then send an email to the mailing list proposing to make it part of @stormprocessor. Then the community can discuss whether it's useful enough to be part of @stormprocessor. Then you'll be added to the @stormprocessor organization and can maintain your project there. The advantage of hosting your module in @stormprocessor is that it will be easier for potential users to find your project. + +### Contributing documentation + +Documentation contributions are very welcome! The best way to send contributions is as emails through the mailing list. + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/css/main.scss ---------------------------------------------------------------------- diff --git a/css/main.scss b/css/main.scss new file mode 100755 index 0000000..352e13a --- /dev/null +++ b/css/main.scss @@ -0,0 +1,48 @@ +--- +# Only the main Sass file needs front matter (the dashes are enough) +--- +@charset "utf-8"; + + +$spacing-unit: 30px; + +@import + "syntax-highlighting" +; + +#sidebar { + float: left; + background: #F6F9FB; + border: 1px solid #E1E1E1; + padding: 0px 10px 10px 0px; + margin-left: 0px; + +} + +#sidebar a.current { + color: #E00000; +} + +#sidebar ul { + list-style: none; + font-size: 0.83em; + padding-left: 20px; +} + +#sidebar ul li { + margin-top: 3px; +} + + +#aboutcontent { + width: 70%; + margin-top:0px; + margin-left: 220px; +} + +#footer { + //margin: 100px; + //padding: 0; + font-size: 0.7em; +} + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/css/style.css ---------------------------------------------------------------------- diff --git a/css/style.css b/css/style.css new file mode 100644 index 0000000..0302cb7 --- /dev/null +++ b/css/style.css @@ -0,0 +1,553 @@ +/* + Theme: Apache Storm +*/ + +/* Fonts */ +@import url(http://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic,700italic); +@import url(http://fonts.googleapis.com/css?family=Oswald:400,300); + +/* Generic */ +body { + font-family: "Lato", sans-serif; + font-weight: 400; + font-size: 14px; +} +header { + background: #fdfbfb url(../images/header-bg.png); + border-top: 3px #328fbf solid; +} +footer { + background: #222 url(../images/footer-bg.png); + padding-top: 10px; + color: #ddd; + border-top: 3px #328fbf solid; + font-size: 12px; +} +p { + line-height: 24px; +} +h1, h2, h3, h4, h5, h6{ + font-family: "Oswald", sans-serif; + font-weight: 400; +} + +/* Bootstrap Extended */ +.col-xs-1, .col-sm-1, .col-md-1, .col-lg-1, .col-xs-2, .col-sm-2, .col-md-2, .col-lg-2, .col-xs-3, .col-sm-3, .col-md-3, .col-lg-3, .col-xs-4, .col-sm-4, .col-md-4, .col-lg-4, .col-xs-5, .col-sm-5, .col-md-5, .col-lg-5, .col-xs-6, .col-sm-6, .col-md-6, .col-lg-6, .col-xs-7, .col-sm-7, .col-md-7, .col-lg-7, .col-xs-8, .col-sm-8, .col-md-8, .col-lg-8, .col-xs-9, .col-sm-9, .col-md-9, .col-lg-9, .col-xs-10, .col-sm-10, .col-md-10, .col-lg-10, .col-xs-11, .col-sm-11, .col-md-11, .col-lg-11, .col-xs-12, .col-sm-12, .col-md-12, .col-lg-12 { + padding-top: 15px; + padding-bottom: 15px; +} +.navbar{ + background: #328fbf; + border-top:1px solid #235693; + border-bottom:1px solid #235693; + border-radius:0; + margin-bottom:10px; +} +.navbar.affix { + position: fixed; + top: 0; + width: 100%; + z-index:10; +} +.nav .open>a, .nav .open>a:hover, .nav .open>a:focus { + border-color: #235693; +} +.navbar button{ + background:#29a1c4; +} +.navbar button:hover{ + background:#29a1c4; +} +.navbar-toggle .icon-bar { + background: #fff; +} +.navbar .nav{ + border-right:1px solid #235693; +} +.navbar .nav > li > a{ + color: #ffffff; + background: #328fbf !important; + border-left:1px solid #235693; + font-weight: 400; + + -webkit-transition:background 1s ease; + -moz-transition:background 1s ease; + -o-transition:background 1s ease; + transition:background 1s ease; +} +.navbar .nav > li > a:hover, .navbar .nav > li > a.current { + background:#235693 !important; +} +.navbar .nav .active > a, +.navbar .nav .active > a:hover, +.navbar .nav .active > a:focus { + background: #235693; +} +.dropdown-toggle{ + background: #328fbf; +} +.dropdown-menu{ + padding:0px; + background:#328fbf; + border:1px solid #235693; +} +.dropdown-menu a{ + padding: 8px 10px !important; + color:#ffffff !important; + background:#328fbf; + border-bottom:1px solid #235693; + + -webkit-transition:background 1s ease; + -moz-transition:background 1s ease; + -o-transition:background 1s ease; + transition:background 1s ease; +} +.dropdown-menu a:hover,.dropdown-menu a:focus{ + background:#235693 !important; +} + +/* Theme Style */ +.row-margin-bottom { + margin-bottom: 25px; +} +.remove-custom-padding { + padding-top: 0px; + padding-bottom: 0px; +} +.no-margin-top { + margin-top: 0px; +} +.logo { + margin-top: 20px; + margin-bottom: 20px; +} +.page-title { + margin-top: 0; + margin-bottom: 20px; + padding-bottom: 5px; + color: #235693; + border-bottom: 2px solid #e99941; + font-weight: 300; +} +.page-title span { + font-family: "Lato", sans-serif; + font-weight: 400; + font-size: 14px; + color: #328fbf; + margin-top: 5px; +} +.btn-std { + background-color: #328fbf; + border-bottom: 2px solid #235693; + color: #ffffff; + padding: 4px 12px; + font-size: 12px; + text-align: center; + border-radius: 5px; +} +.btn-std:hover { + background-color: #235693; + color: #ffffff; + text-decoration: none; +} +.btn-download { + background-color: #32bf61; + border-bottom: 2px solid #239329; + font-size: 16px; + font-weight: 700; + margin-top: 35px; + margin-bottom: 35px; + padding: 12px 36px; +} +.btn-download:hover { + background-color: #239329; +} +.box-primary { + padding: 8px 10px; + background: #fbfbfb; + border: 1px solid #ccc; + border-bottom: 3px solid #ccc; + border-radius: 10px; +} +.box-primary h4 { + border-bottom: 1px solid #ccc; + padding-bottom: 10px; +} +.box-warning { + padding: 8px 10px; + background: #FFFAF3; + border: 1px solid #EB9A35; + border-bottom: 3px solid #EB9A35; + border-radius: 10px; +} +.box-warning h4 { + border-bottom: 1px solid #EB9A35; + padding-bottom: 10px; +} +.box-info { + padding: 8px 10px; + background: #F8FFFF; + border: 1px solid #328fbf; + border-bottom: 3px solid #328fbf; + /*border-radius: 10px;*/ +} +.box-info h4 { + border-bottom: 1px solid #328fbf; + padding-bottom: 10px; +} + +/* Footer */ +footer hr { + margin: 0; + border-top: 1px solid #555; + border-bottom: 1px solid #111; +} +.footer-widget h5 { + padding-bottom: 10px; + border-bottom: 1px solid #555; + margin-bottom: 10px; +} +.footer-list { + list-style: none; + padding-left: 20px; +} +.footer-list li { + line-height: 32px; +} +.footer-list li:before { + content: "\f105"; + font-family: 'FontAwesome'; + margin-right: 10px; +} +.footer-list li a { + color: #ddd; +} + +.tweet {margin-bottom: 10px;} + +.social a, .social a:visited, .social a:hover{ + color:#fff; + text-decoration:none; +} +.social i{ + display:inline-block; + height:30px; + width:30px; + font-size:15px; + text-align:center; + line-height:30px; + -webkit-transition:background 1s ease; + -moz-transition:background 1s ease; + -o-transition:background 1s ease; + transition:background 1s ease; + border-radius:30px; + margin-right:5px; +} +.social i:hover{ + -webkit-transition:background 1s ease; + -moz-transition:background 1s ease; + -o-transition:background 1s ease; + transition:background 1s ease; +} +.facebook { background: #1e78ae !important; } +.twitter { background: #1ba1e2 !important; } +.google-plus { background: #f22d0c !important; } +.linkedin { background: #2d93cf !important; } +.pinterest { background: #dd1617 !important; } + +.facebook:hover, .twitter:hover, .google-plus:hover, .linkedin:hover, .pinterest:hover { background: #666 !important; } + +/* Scroll to top */ +.totop { + position: fixed; + bottom: 10px; + right: 10px; + z-index: 104400; +} +.totop a i{ + display: block; + width: 40px; + height: 40px; + line-height: 40px; + text-align: center; + font-size: 25px; + background: rgba(60,60,60,0.7); +} +.totop a:hover i { background: rgba(60,60,60,1); } +.totop a, .totop a:visited{ + color: #fff; +} +.totop a:hover { + color: #eee; + text-decoration: none; +} + +/* Page Specific - Home */ +.latest-news { + list-style: none; + padding-left: 20px; +} +.latest-news li { + line-height: 28px; +} +.latest-news li:before { + content: "\f101"; + font-family: 'FontAwesome'; + margin-right: 10px; +} +.latest-news li span.small { + font-size:10px; +} + +/* Page Specific - Download */ +.download-block { + margin-bottom: 15px; + border-bottom: 1px solid #eee; +} +.download-block h5 { + background: #328fbf; + color: #fff; + padding: 10px; +} +.download-info { + padding; +} +.arrow-list { + list-style: none; + padding-left: 20px; +} +.arrow-list li { + line-height: 28px; +} +.arrow-list li:before { + content: "\f105"; + font-family: 'FontAwesome'; + margin-right: 10px; +} + +/* Page Specific - News */ +.news { + list-style: none; + padding-left: 0px; +} +.news li a { + display: block; + padding: 7px; + margin-bottom: 2px; + font-family: "Oswald", sans-serif; + letter-spacing: 1px; + color: #328fbf; + border: 1px #328fbf solid; + -webkit-transition:background 1s ease; + -moz-transition:background 1s ease; + -o-transition:background 1s ease; + transition:background 1s ease; +} +.news li a:hover, .news li a.current { + text-decoration: none; + border: 1px #235693 solid; + background-color: #328fbf; + color:white; +} +.news-title { + color: #235693; + margin-top: 0; +} +.news-meta { + padding: 5px 0; + margin-bottom: 20px; + border-top: 1px #328fbf solid; + border-bottom: 1px #328fbf solid; + color: #235693; + font-weight: 400; +} +.news-meta .fa-user { + margin-left: 25px; +} + +/* Page Specific - FAQ */ +.faq .nav-tabs { + border-bottom: 1px solid #328fbf; +} +.faq .nav-tabs > li > a { + margin-right: 2px; + font-family: "Oswald", sans-serif; + font-size: 18px; + letter-spacing: 1px; + border: none; + border-radius: 0; +} +.faq .nav-tabs > li > a:hover { + border-bottom-color: #328fbf; + background-color: #FFF0DF; +} +.faq .nav-tabs > li.active > a, +.faq .nav-tabs > li.active > a:hover, +.faq .nav-tabs > li.active > a:focus { + color: #235693; + cursor: default; + background-color: #fff; + border: 1px solid #328fbf; + border-bottom-color: transparent; +} +.faq .tab-content { + padding: 15px; + border: 1px #328fbf solid; + border-top: none; +} + +/* Syntax Highlighting Styles */ +.highlight {background: #fff;} +.highlight .c {color: #998; font-style: italic;} +.highlight .err {color: #a61717; background-color: #e3d2d2;} +.highlight .k {font-weight: bold;} +.highlight .o {font-weight: bold;} +.highlight .cm {color: #998; font-style: italic;} +.highlight .cp {color: #999; font-weight: bold;} +.highlight .c1 {color: #998; font-style: italic;} +.highlight .cs {color: #999; font-weight: bold; font-style: italic;} +.highlight .gd {color: #000; background-color: #fdd;} +.highlight .gd .x {color: #000; background-color: #faa;} +.highlight .ge {font-style: italic;} +.highlight .gr {color: #a00;} +.highlight .gh {color: #999;} +.highlight .gi {color: #000; background-color: #dfd;} +.highlight .gi .x {color: #000; background-color: #afa;} +.highlight .go {color: #888;} +.highlight .gp {color: #555;} +.highlight .gs {font-weight: bold;} +.highlight .gu {color: #aaa;} +.highlight .gt {color: #a00;} +.highlight .kc {font-weight: bold;} +.highlight .kd {font-weight: bold;} +.highlight .kp {font-weight: bold;} +.highlight .kr {font-weight: bold;} +.highlight .kt {color: #458; font-weight: bold;} +.highlight .m {color: #099;} +.highlight .s {color: #d14;} +.highlight .na {color: #008080;} +.highlight .nb {color: #0086B3;} +.highlight .nc {color: #458; font-weight: bold;} +.highlight .no {color: #008080;} +.highlight .ni {color: #800080;} +.highlight .ne {color: #900; font-weight: bold;} +.highlight .nf {color: #900; font-weight: bold;} +.highlight .nn {color: #555;} +.highlight .nt {color: #000080;} +.highlight .nv {color: #008080;} +.highlight .ow {font-weight: bold;} +.highlight .w {color: #bbb;} +.highlight .mf {color: #099;} +.highlight .mh {color: #099;} +.highlight .mi {color: #099;} +.highlight .mo {color: #099;} +.highlight .sb {color: #d14;} +.highlight .sc {color: #d14;} +.highlight .sd {color: #d14;} +.highlight .s2 {color: #d14;} +.highlight .se {color: #d14;} +.highlight .sh {color: #d14;} +.highlight .si {color: #d14;} +.highlight .sx {color: #d14;} +.highlight .sr {color: #009926;} +.highlight .s1 {color: #d14;} +.highlight .ss {color: #990073;} +.highlight .bp {color: #999;} +.highlight .vc {color: #008080;} +.highlight .vg {color: #008080;} +.highlight .vi {color: #008080;} +.highlight .il {color: #099;} + +/* Page Specific - Documentation Index */ +.documentation-list { + list-style: none; + padding-left: 0px; +} +.documentation-list li { + line-height: 28px; +} +.documentation-list li:before { + content: "\f101"; + font-family: 'FontAwesome'; + margin-right: 5px; + color: #337ab7; +} + + +/* Responsive */ +@media screen and (max-width: 992px) { + .logo, .btn-download {margin-top:0; margin-bottom:0;} +} + +.brick{ + width: 370px; + border: solid 1px #CCCCCC; + margin: 20px; +} + +.brick h3{ + border-bottom: 1px solid #CCCCCC + margin-bottom: 20px; +} +.brickSS { + border: solid 1px #CCCCCC; + margin: 20px; +} + +.brickSS .row{ + padding: 15px; +} + +.brickSS iframe{ + margin: 15px; +} + +.resources .nav-tabs { + border-bottom: 1px solid #328fbf; +} +.resources .nav-tabs > li > a { + margin-right: 2px; + font-family: "Oswald", sans-serif; + font-size: 18px; + letter-spacing: 1px; + border: none; + border-radius: 0; +} +.resources .nav-tabs > li > a:hover { + border-bottom-color: #328fbf; + background-color: #FFF0DF; +} +.resources .nav-tabs > li.active > a, +.resources .nav-tabs > li.active > a:hover, +.resources .nav-tabs > li.active > a:focus { + color: #235693; + cursor: default; + background-color: #fff; + border: 1px solid #328fbf; + border-bottom-color: transparent; +} +.resources .tab-content { + padding: 15px; + border: 1px #328fbf solid; + border-top: none; +} + + + + + + + + + + + + + + + + + + + + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/doc-index.html ---------------------------------------------------------------------- diff --git a/doc-index.html b/doc-index.html new file mode 100644 index 0000000..beb20ad --- /dev/null +++ b/doc-index.html @@ -0,0 +1,12 @@ +--- +layout: default +title: Documentation index +--- + +<ul> +{% for page in site.pages %} +{% if page.documentation == true %} +<li><a href="{{ page.url }}">{{ page.title }}</a></li> +{% endif %} <!-- resource-p --> +{% endfor %} <!-- page --> +</ul> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/documentation.html ---------------------------------------------------------------------- diff --git a/documentation.html b/documentation.html new file mode 100644 index 0000000..cbe145e --- /dev/null +++ b/documentation.html @@ -0,0 +1,78 @@ +--- +layout: default +title: Documentation +--- +<!--Content Begin--> +<div class="content"> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-12"> + <div class="faq"> + <ul class="nav nav-tabs" role="tablist"> + <li role="presentation" class="active"><a href="#basic" aria-controls="basic" role="tab" data-toggle="tab">Basics of Storm</a></li> + <li role="presentation"><a href="#trident" aria-controls="trident" role="tab" data-toggle="tab">Trident</a></li> + <li role="presentation"><a href="#setup" aria-controls="setup" role="tab" data-toggle="tab">Setup and deploying</a></li> + <li role="presentation"><a href="#intermediate" aria-controls="intermediate" role="tab" data-toggle="tab">Intermediate</a></li> + <li role="presentation"><a href="#advance" aria-controls="advance" role="tab" data-toggle="tab">Advanced</a></li> + </ul> + <div class="tab-content"> + <div role="tabpanel" class="tab-pane active" id="basic"> + <ul> + <li><a href="https://storm.apache.org/javadoc/apidocs/index.html"; target="_blank">Javadoc</a></li> + <li><a href="/tutorial.html">Tutorial</a></li> + <li><a href="/documentation/Concepts.html">Concepts</a></li> + <li><a href="/documentation/Configuration.html">Configuration</a></li> + <li><a href="/documentation/Guaranteeing-message-processing.html">Guaranteeing message processing</a></li> + <li><a href="/documentation/Fault-tolerance.html">Fault-tolerance</a></li> + <li><a href="/documentation/Command-line-client.html">Command line client</a></li> + <li><a href="/documentation/Understanding-the-parallelism-of-a-Storm-topology.html">Understanding the parallelism of a Storm topology</a></li> + <li><a href="/documentation/FAQ.html">FAQ</a></li> + </ul> + </div> + <div role="tabpanel" class="tab-pane" id="trident"> + <p>Trident is an alternative interface to Storm. It provides exactly-once processing, "transactional" datastore persistence, and a set of common stream analytics operations.</p> + <ul> + <li><a href="documentation/Trident-tutorial.html">Trident Tutorial</a> -- basic concepts and walkthrough</li> + <li><a href="documentation/Trident-API-Overview.html">Trident API Overview</a> -- operations for transforming and orchestrating data</li> + <li><a href="documentation/Trident-state.html">Trident State</a> -- exactly-once processing and fast, persistent aggregation</li> + <li><a href="documentation/Trident-spouts.html">Trident spouts</a> -- transactional and non-transactional data intake</li> + </ul> + </div> + <div role="tabpanel" class="tab-pane" id="setup"> + <ul> + <li><a href="documentation/Setting-up-a-Storm-cluster.html">Setting up a Storm cluster</a></li> + <li><a href="documentation/Local-mode.html">Local mode</a></li> + <li><a href="documentation/Troubleshooting.html">Troubleshooting</a></li> + <li><a href="documentation/Running-topologies-on-a-production-cluster.html">Running topologies on a production cluster</a></li> + <li><a href="documentation/Maven.html">Building Storm</a> with Maven</li> + </ul> + </div> + <div role="tabpanel" class="tab-pane" id="intermediate"> + <ul> + <li><a href="documentation/Serialization.html">Serialization</a></li> + <li><a href="documentation/Common-patterns.html">Common patterns</a></li> + <li><a href="documentation/Clojure-DSL.html">Clojure DSL</a></li> + <li><a href="documentation/Using-non-JVM-languages-with-Storm.html">Using non-JVM languages with Storm</a></li> + <li><a href="documentation/Distributed-RPC.html">Distributed RPC</a></li> + <li><a href="documentation/Transactional-topologies.html">Transactional topologies</a></li> + <li><a href="documentation/Kestrel-and-Storm.html">Kestrel and Storm</a></li> + <!--<li><a href="javascript:void(0);">Direct groupings</a></li>--> + <li><a href="documentation/Hooks.html">Hooks</a></li> + <li><a href="documentation/Metrics.html">Metrics</a></li> + <li><a href="documentation/Lifecycle-of-a-topology.html">Lifecycle of a trident tuple</a></li> + </ul> + </div> + <div role="tabpanel" class="tab-pane" id="advance"> + <ul> + <li><a href="documentation/Defining-a-non-jvm-language-dsl-for-storm.html">Defining a non-JVM language DSL for Storm</a></li> + <li><a href="documentation/Multilang-protocol.html">Multilang protocol</a> (how to provide support for another language)</li> + <li><a href="documentation/Implementation-docs.html">Implementation docs</a></li> + </ul> + </div> + </div> + </div> + </div> + </div> + </div> +</div> +<!--Content End--> http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/documentation/Acking-framework-implementation.md ---------------------------------------------------------------------- diff --git a/documentation/Acking-framework-implementation.md b/documentation/Acking-framework-implementation.md new file mode 100644 index 0000000..4099219 --- /dev/null +++ b/documentation/Acking-framework-implementation.md @@ -0,0 +1,38 @@ +--- +title: Acking Framework Implementation +layout: documentation +documentation: true +--- +[Storm's acker](https://github.com/apache/storm/blob/46c3ba7/storm-core/src/clj/backtype/storm/daemon/acker.clj#L28) tracks completion of each tupletree with a checksum hash: each time a tuple is sent, its value is XORed into the checksum, and each time a tuple is acked its value is XORed in again. If all tuples have been successfully acked, the checksum will be zero (the odds that the checksum will be zero otherwise are vanishingly small). + +You can read a bit more about the [reliability mechanism](Guaranteeing-message-processing.html#what-is-storms-reliability-api) elsewhere on the wiki -- this explains the internal details. + +### acker `execute()` + +The acker is actually a regular bolt, with its [execute method](https://github.com/apache/storm/blob/46c3ba7/storm-core/src/clj/backtype/storm/daemon/acker.clj#L36) defined withing `mk-acker-bolt`. When a new tupletree is born, the spout sends the XORed edge-ids of each tuple recipient, which the acker records in its `pending` ledger. Every time an executor acks a tuple, the acker receives a partial checksum that is the XOR of the tuple's own edge-id (clearing it from the ledger) and the edge-id of each downstream tuple the executor emitted (thus entering them into the ledger). + +This is accomplished as follows. + +On a tick tuple, just advance pending tupletree checksums towards death and return. Otherwise, update or create the record for this tupletree: + +* on init: initialize with the given checksum value, and record the spout's id for later. +* on ack: xor the partial checksum into the existing checksum value +* on fail: just mark it as failed + +Next, [put the record](https://github.com/apache/storm/blob/46c3ba7/storm-core/src/clj/backtype/storm/daemon/acker.clj#L50)), into the RotatingMap (thus resetting is countdown to expiry) and take action: + +* if the total checksum is zero, the tupletree is complete: remove it from the pending collection and notify the spout of success +* if the tupletree has failed, it is also complete: remove it from the pending collection and notify the spout of failure + +Finally, pass on an ack of our own. + +### Pending tuples and the `RotatingMap` + +The acker stores pending tuples in a [`RotatingMap`](https://github.com/apache/storm/blob/master/storm-core/src/jvm/backtype/storm/utils/RotatingMap.java#L19), a simple device used in several places within Storm to efficiently time-expire a process. + +The RotatingMap behaves as a HashMap, and offers the same O(1) access guarantees. + +Internally, it holds several HashMaps ('buckets') of its own, each holding a cohort of records that will expire at the same time. Let's call the longest-lived bucket death row, and the most recent the nursery. Whenever a value is `.put()` to the RotatingMap, it is relocated to the nursery -- and removed from any other bucket it might have been in (effectively resetting its death clock). + +Whenever its owner calls `.rotate()`, the RotatingMap advances each cohort one step further towards expiration. (Typically, Storm objects call rotate on every receipt of a system tick stream tuple.) If there are any key-value pairs in the former death row bucket, the RotatingMap invokes a callback (given in the constructor) for each key-value pair, letting its owner take appropriate action (eg, failing a tuple. + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/documentation/Clojure-DSL.md ---------------------------------------------------------------------- diff --git a/documentation/Clojure-DSL.md b/documentation/Clojure-DSL.md new file mode 100644 index 0000000..fcbbce4 --- /dev/null +++ b/documentation/Clojure-DSL.md @@ -0,0 +1,266 @@ +--- +title: Clojure DSL +layout: documentation +documentation: true +--- +Storm comes with a Clojure DSL for defining spouts, bolts, and topologies. The Clojure DSL has access to everything the Java API exposes, so if you're a Clojure user you can code Storm topologies without touching Java at all. The Clojure DSL is defined in the source in the [backtype.storm.clojure](https://github.com/apache/storm/blob/0.5.3/src/clj/backtype/storm/clojure.clj) namespace. + +This page outlines all the pieces of the Clojure DSL, including: + +1. Defining topologies +2. `defbolt` +3. `defspout` +4. Running topologies in local mode or on a cluster +5. Testing topologies + +### Defining topologies + +To define a topology, use the `topology` function. `topology` takes in two arguments: a map of "spout specs" and a map of "bolt specs". Each spout and bolt spec wires the code for the component into the topology by specifying things like inputs and parallelism. + +Let's take a look at an example topology definition [from the storm-starter project](https://github.com/apache/storm/blob/master/examples/storm-starter/src/clj/storm/starter/clj/word_count.clj): + +```clojure +(topology + {"1" (spout-spec sentence-spout) + "2" (spout-spec (sentence-spout-parameterized + ["the cat jumped over the door" + "greetings from a faraway land"]) + :p 2)} + {"3" (bolt-spec {"1" :shuffle "2" :shuffle} + split-sentence + :p 5) + "4" (bolt-spec {"3" ["word"]} + word-count + :p 6)}) +``` + +The maps of spout and bolt specs are maps from the component id to the corresponding spec. The component ids must be unique across the maps. Just like defining topologies in Java, component ids are used when declaring inputs for bolts in the topology. + +#### spout-spec + +`spout-spec` takes as arguments the spout implementation (an object that implements [IRichSpout](/javadoc/apidocs/backtype/storm/topology/IRichSpout.html)) and optional keyword arguments. The only option that exists currently is the `:p` option, which specifies the parallelism for the spout. If you omit `:p`, the spout will execute as a single task. + +#### bolt-spec + +`bolt-spec` takes as arguments the input declaration for the bolt, the bolt implementation (an object that implements [IRichBolt](/javadoc/apidocs/backtype/storm/topology/IRichBolt.html)), and optional keyword arguments. + +The input declaration is a map from stream ids to stream groupings. A stream id can have one of two forms: + +1. `[==component id== ==stream id==]`: Subscribes to a specific stream on a component +2. `==component id==`: Subscribes to the default stream on a component + +A stream grouping can be one of the following: + +1. `:shuffle`: subscribes with a shuffle grouping +2. Vector of field names, like `["id" "name"]`: subscribes with a fields grouping on the specified fields +3. `:global`: subscribes with a global grouping +4. `:all`: subscribes with an all grouping +5. `:direct`: subscribes with a direct grouping + +See [Concepts](Concepts.html) for more info on stream groupings. Here's an example input declaration showcasing the various ways to declare inputs: + +```clojure +{["2" "1"] :shuffle + "3" ["field1" "field2"] + ["4" "2"] :global} +``` + +This input declaration subscribes to three streams total. It subscribes to stream "1" on component "2" with a shuffle grouping, subscribes to the default stream on component "3" with a fields grouping on the fields "field1" and "field2", and subscribes to stream "2" on component "4" with a global grouping. + +Like `spout-spec`, the only current supported keyword argument for `bolt-spec` is `:p` which specifies the parallelism for the bolt. + +#### shell-bolt-spec + +`shell-bolt-spec` is used for defining bolts that are implemented in a non-JVM language. It takes as arguments the input declaration, the command line program to run, the name of the file implementing the bolt, an output specification, and then the same keyword arguments that `bolt-spec` accepts. + +Here's an example `shell-bolt-spec`: + +```clojure +(shell-bolt-spec {"1" :shuffle "2" ["id"]} + "python" + "mybolt.py" + ["outfield1" "outfield2"] + :p 25) +``` + +The syntax of output declarations is described in more detail in the `defbolt` section below. See [Using non JVM languages with Storm](Using-non-JVM-languages-with-Storm.html) for more details on how multilang works within Storm. + +### defbolt + +`defbolt` is used for defining bolts in Clojure. Bolts have the constraint that they must be serializable, and this is why you can't just reify `IRichBolt` to implement a bolt (closures aren't serializable). `defbolt` works around this restriction and provides a nicer syntax for defining bolts than just implementing a Java interface. + +At its fullest expressiveness, `defbolt` supports parameterized bolts and maintaining state in a closure around the bolt implementation. It also provides shortcuts for defining bolts that don't need this extra functionality. The signature for `defbolt` looks like the following: + +(defbolt _name_ _output-declaration_ *_option-map_ & _impl_) + +Omitting the option map is equivalent to having an option map of `{:prepare false}`. + +#### Simple bolts + +Let's start with the simplest form of `defbolt`. Here's an example bolt that splits a tuple containing a sentence into a tuple for each word: + +```clojure +(defbolt split-sentence ["word"] [tuple collector] + (let [words (.split (.getString tuple 0) " ")] + (doseq [w words] + (emit-bolt! collector [w] :anchor tuple)) + (ack! collector tuple) + )) +``` + +Since the option map is omitted, this is a non-prepared bolt. The DSL simply expects an implementation for the `execute` method of `IRichBolt`. The implementation takes two parameters, the tuple and the `OutputCollector`, and is followed by the body of the `execute` function. The DSL automatically type-hints the parameters for you so you don't need to worry about reflection if you use Java interop. + +This implementation binds `split-sentence` to an actual `IRichBolt` object that you can use in topologies, like so: + +```clojure +(bolt-spec {"1" :shuffle} + split-sentence + :p 5) +``` + + +#### Parameterized bolts + +Many times you want to parameterize your bolts with other arguments. For example, let's say you wanted to have a bolt that appends a suffix to every input string it receives, and you want that suffix to be set at runtime. You do this with `defbolt` by including a `:params` option in the option map, like so: + +```clojure +(defbolt suffix-appender ["word"] {:params [suffix]} + [tuple collector] + (emit-bolt! collector [(str (.getString tuple 0) suffix)] :anchor tuple) + ) +``` + +Unlike the previous example, `suffix-appender` will be bound to a function that returns an `IRichBolt` rather than be an `IRichBolt` object directly. This is caused by specifying `:params` in its option map. So to use `suffix-appender` in a topology, you would do something like: + +```clojure +(bolt-spec {"1" :shuffle} + (suffix-appender "-suffix") + :p 10) +``` + +#### Prepared bolts + +To do more complex bolts, such as ones that do joins and streaming aggregations, the bolt needs to store state. You can do this by creating a prepared bolt which is specified by including `{:prepare true}` in the option map. Consider, for example, this bolt that implements word counting: + +```clojure +(defbolt word-count ["word" "count"] {:prepare true} + [conf context collector] + (let [counts (atom {})] + (bolt + (execute [tuple] + (let [word (.getString tuple 0)] + (swap! counts (partial merge-with +) {word 1}) + (emit-bolt! collector [word (@counts word)] :anchor tuple) + (ack! collector tuple) + ))))) +``` + +The implementation for a prepared bolt is a function that takes as input the topology config, `TopologyContext`, and `OutputCollector`, and returns an implementation of the `IBolt` interface. This design allows you to have a closure around the implementation of `execute` and `cleanup`. + +In this example, the word counts are stored in the closure in a map called `counts`. The `bolt` macro is used to create the `IBolt` implementation. The `bolt` macro is a more concise way to implement the interface than reifying, and it automatically type-hints all of the method parameters. This bolt implements the execute method which updates the count in the map and emits the new word count. + +Note that the `execute` method in prepared bolts only takes as input the tuple since the `OutputCollector` is already in the closure of the function (for simple bolts the collector is a second parameter to the `execute` function). + +Prepared bolts can be parameterized just like simple bolts. + +#### Output declarations + +The Clojure DSL has a concise syntax for declaring the outputs of a bolt. The most general way to declare the outputs is as a map from stream id a stream spec. For example: + +```clojure +{"1" ["field1" "field2"] + "2" (direct-stream ["f1" "f2" "f3"]) + "3" ["f1"]} +``` + +The stream id is a string, while the stream spec is either a vector of fields or a vector of fields wrapped by `direct-stream`. `direct stream` marks the stream as a direct stream (See [Concepts](Concepts.html) and [Direct groupings]() for more details on direct streams). + +If the bolt only has one output stream, you can define the default stream of the bolt by using a vector instead of a map for the output declaration. For example: + +```clojure +["word" "count"] +``` +This declares the output of the bolt as the fields ["word" "count"] on the default stream id. + +#### Emitting, acking, and failing + +Rather than use the Java methods on `OutputCollector` directly, the DSL provides a nicer set of functions for using `OutputCollector`: `emit-bolt!`, `emit-direct-bolt!`, `ack!`, and `fail!`. + +1. `emit-bolt!`: takes as parameters the `OutputCollector`, the values to emit (a Clojure sequence), and keyword arguments for `:anchor` and `:stream`. `:anchor` can be a single tuple or a list of tuples, and `:stream` is the id of the stream to emit to. Omitting the keyword arguments emits an unanchored tuple to the default stream. +2. `emit-direct-bolt!`: takes as parameters the `OutputCollector`, the task id to send the tuple to, the values to emit, and keyword arguments for `:anchor` and `:stream`. This function can only emit to streams declared as direct streams. +2. `ack!`: takes as parameters the `OutputCollector` and the tuple to ack. +3. `fail!`: takes as parameters the `OutputCollector` and the tuple to fail. + +See [Guaranteeing message processing](Guaranteeing-message-processing.html) for more info on acking and anchoring. + +### defspout + +`defspout` is used for defining spouts in Clojure. Like bolts, spouts must be serializable so you can't just reify `IRichSpout` to do spout implementations in Clojure. `defspout` works around this restriction and provides a nicer syntax for defining spouts than just implementing a Java interface. + +The signature for `defspout` looks like the following: + +(defspout _name_ _output-declaration_ *_option-map_ & _impl_) + +If you leave out the option map, it defaults to {:prepare true}. The output declaration for `defspout` has the same syntax as `defbolt`. + +Here's an example `defspout` implementation from [storm-starter](https://github.com/apache/storm/blob/master/examples/storm-starter/src/clj/storm/starter/clj/word_count.clj): + +```clojure +(defspout sentence-spout ["sentence"] + [conf context collector] + (let [sentences ["a little brown dog" + "the man petted the dog" + "four score and seven years ago" + "an apple a day keeps the doctor away"]] + (spout + (nextTuple [] + (Thread/sleep 100) + (emit-spout! collector [(rand-nth sentences)]) + ) + (ack [id] + ;; You only need to define this method for reliable spouts + ;; (such as one that reads off of a queue like Kestrel) + ;; This is an unreliable spout, so it does nothing here + )))) +``` + +The implementation takes in as input the topology config, `TopologyContext`, and `SpoutOutputCollector`. The implementation returns an `ISpout` object. Here, the `nextTuple` function emits a random sentence from `sentences`. + +This spout isn't reliable, so the `ack` and `fail` methods will never be called. A reliable spout will add a message id when emitting tuples, and then `ack` or `fail` will be called when the tuple is completed or failed respectively. See [Guaranteeing message processing](Guaranteeing-message-processing.html) for more info on how reliability works within Storm. + +`emit-spout!` takes in as parameters the `SpoutOutputCollector` and the new tuple to be emitted, and accepts as keyword arguments `:stream` and `:id`. `:stream` specifies the stream to emit to, and `:id` specifies a message id for the tuple (used in the `ack` and `fail` callbacks). Omitting these arguments emits an unanchored tuple to the default output stream. + +There is also a `emit-direct-spout!` function that emits a tuple to a direct stream and takes an additional argument as the second parameter of the task id to send the tuple to. + +Spouts can be parameterized just like bolts, in which case the symbol is bound to a function returning `IRichSpout` instead of the `IRichSpout` itself. You can also declare an unprepared spout which only defines the `nextTuple` method. Here is an example of an unprepared spout that emits random sentences parameterized at runtime: + +```clojure +(defspout sentence-spout-parameterized ["word"] {:params [sentences] :prepare false} + [collector] + (Thread/sleep 500) + (emit-spout! collector [(rand-nth sentences)])) +``` + +The following example illustrates how to use this spout in a `spout-spec`: + +```clojure +(spout-spec (sentence-spout-parameterized + ["the cat jumped over the door" + "greetings from a faraway land"]) + :p 2) +``` + +### Running topologies in local mode or on a cluster + +That's all there is to the Clojure DSL. To submit topologies in remote mode or local mode, just use the `StormSubmitter` or `LocalCluster` classes just like you would from Java. + +To create topology configs, it's easiest to use the `backtype.storm.config` namespace which defines constants for all of the possible configs. The constants are the same as the static constants in the `Config` class, except with dashes instead of underscores. For example, here's a topology config that sets the number of workers to 15 and configures the topology in debug mode: + +```clojure +{TOPOLOGY-DEBUG true + TOPOLOGY-WORKERS 15} +``` + +### Testing topologies + +[This blog post](http://www.pixelmachine.org/2011/12/17/Testing-Storm-Topologies.html) and its [follow-up](http://www.pixelmachine.org/2011/12/21/Testing-Storm-Topologies-Part-2.html) give a good overview of Storm's powerful built-in facilities for testing topologies in Clojure. http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/documentation/Command-line-client.md ---------------------------------------------------------------------- diff --git a/documentation/Command-line-client.md b/documentation/Command-line-client.md new file mode 100644 index 0000000..2800411 --- /dev/null +++ b/documentation/Command-line-client.md @@ -0,0 +1,102 @@ +--- +title: Command Line Client +layout: documentation +documentation: true +--- +This page describes all the commands that are possible with the "storm" command line client. To learn how to set up your "storm" client to talk to a remote cluster, follow the instructions in [Setting up development environment](Setting-up-development-environment.html). + +These commands are: + +1. jar +1. kill +1. activate +1. deactivate +1. rebalance +1. repl +1. classpath +1. localconfvalue +1. remoteconfvalue +1. nimbus +1. supervisor +1. ui +1. drpc + +### jar + +Syntax: `storm jar topology-jar-path class ...` + +Runs the main method of `class` with the specified arguments. The storm jars and configs in `~/.storm` are put on the classpath. The process is configured so that [StormSubmitter](/javadoc/apidocs/backtype/storm/StormSubmitter.html) will upload the jar at `topology-jar-path` when the topology is submitted. + +### kill + +Syntax: `storm kill topology-name [-w wait-time-secs]` + +Kills the topology with the name `topology-name`. Storm will first deactivate the topology's spouts for the duration of the topology's message timeout to allow all messages currently being processed to finish processing. Storm will then shutdown the workers and clean up their state. You can override the length of time Storm waits between deactivation and shutdown with the -w flag. + +### activate + +Syntax: `storm activate topology-name` + +Activates the specified topology's spouts. + +### deactivate + +Syntax: `storm deactivate topology-name` + +Deactivates the specified topology's spouts. + +### rebalance + +Syntax: `storm rebalance topology-name [-w wait-time-secs]` + +Sometimes you may wish to spread out where the workers for a topology are running. For example, let's say you have a 10 node cluster running 4 workers per node, and then let's say you add another 10 nodes to the cluster. You may wish to have Storm spread out the workers for the running topology so that each node runs 2 workers. One way to do this is to kill the topology and resubmit it, but Storm provides a "rebalance" command that provides an easier way to do this. + +Rebalance will first deactivate the topology for the duration of the message timeout (overridable with the -w flag) and then redistribute the workers evenly around the cluster. The topology will then return to its previous state of activation (so a deactivated topology will still be deactivated and an activated topology will go back to being activated). + +### repl + +Syntax: `storm repl` + +Opens up a Clojure REPL with the storm jars and configuration on the classpath. Useful for debugging. + +### classpath + +Syntax: `storm classpath` + +Prints the classpath used by the storm client when running commands. + +### localconfvalue + +Syntax: `storm localconfvalue conf-name` + +Prints out the value for `conf-name` in the local Storm configs. The local Storm configs are the ones in `~/.storm/storm.yaml` merged in with the configs in `defaults.yaml`. + +### remoteconfvalue + +Syntax: `storm remoteconfvalue conf-name` + +Prints out the value for `conf-name` in the cluster's Storm configs. The cluster's Storm configs are the ones in `$STORM-PATH/conf/storm.yaml` merged in with the configs in `defaults.yaml`. This command must be run on a cluster machine. + +### nimbus + +Syntax: `storm nimbus` + +Launches the nimbus daemon. This command should be run under supervision with a tool like [daemontools](http://cr.yp.to/daemontools.html) or [monit](http://mmonit.com/monit/). See [Setting up a Storm cluster](Setting-up-a-Storm-cluster.html) for more information. + +### supervisor + +Syntax: `storm supervisor` + +Launches the supervisor daemon. This command should be run under supervision with a tool like [daemontools](http://cr.yp.to/daemontools.html) or [monit](http://mmonit.com/monit/). See [Setting up a Storm cluster](Setting-up-a-Storm-cluster.html) for more information. + +### ui + +Syntax: `storm ui` + +Launches the UI daemon. The UI provides a web interface for a Storm cluster and shows detailed stats about running topologies. This command should be run under supervision with a tool like [daemontools](http://cr.yp.to/daemontools.html) or [monit](http://mmonit.com/monit/). See [Setting up a Storm cluster](Setting-up-a-Storm-cluster.html) for more information. + +### drpc + +Syntax: `storm drpc` + +Launches a DRPC daemon. This command should be run under supervision with a tool like [daemontools](http://cr.yp.to/daemontools.html) or [monit](http://mmonit.com/monit/). See [Distributed RPC](Distributed-RPC.html) for more information.
