Added: release/karaf/documentation/cellar/3_x.html ============================================================================== --- release/karaf/documentation/cellar/3_x.html (added) +++ release/karaf/documentation/cellar/3_x.html Thu Dec 24 07:18:51 2015 @@ -0,0 +1,2423 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 1.5.2"> +<meta name="author" content="Apache Software Foundation"> +<title>Apache Karaf Cellar 3.x - Documentation</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";> +<style> +/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ +/* Remove the comments around the @import statement below when using this as a custom stylesheet */ +/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} +audio,canvas,video{display:inline-block} +audio:not([controls]){display:none;height:0} +[hidden],template{display:none} +script{display:none!important} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +body{margin:0} +a{background:transparent} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +dfn{font-style:italic} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} +input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +#map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +.antialiased,body{-webkit-font-smoothing:antialiased} +img{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:none} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ul.no-bullet{list-style:none} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite:before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7;font-weight:bold} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} +.clearfix:after,.float-group:after{clear:both} +*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} +pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} +.keyseq{color:rgba(51,51,51,.8)} +kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menu{color:rgba(0,0,0,.8)} +b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} +b.button:before{content:"[";padding:0 3px 0 2px} +b.button:after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} +#header:after,#content:after,#footnotes:after,#footer:after{clear:both} +#content{margin-top:1.25em} +#content:before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} +#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span:before{content:"\00a0\2013\00a0"} +#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark:before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber:after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +@media only screen and (min-width:768px){#toctitle{font-size:1.375em} +body.toc2{padding-left:15em;padding-right:0} +#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{width:20em} +#toc.toc2 #toctitle{font-size:1.375em} +#toc.toc2>ul{font-size:.95em} +#toc.toc2 ul ul{padding-left:1.25em} +body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +#content #toc>:first-child{margin-top:0} +#content #toc>:last-child{margin-bottom:0} +#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} +#footer-text{color:rgba(255,255,255,.8);line-height:1.44} +.sect1{padding-bottom:.625em} +@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} +.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} +.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.listingblock>.content{position:relative} +.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]:before{display:block} +.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} +table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} +table.pyhltable td.code{padding-left:.75em;padding-right:0} +pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} +pre.pygments .lineno{display:inline-block;margin-right:.25em} +table.pyhltable .linenodiv{background:none!important;padding-right:0!important} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} +.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} +.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} +.quoteblock .quoteblock blockquote:before{display:none} +.verseblock{margin:0 1em 1.25em 1em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} +.quoteblock.abstract{margin:0 0 1.25em 0;display:block} +.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} +.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} +table.tableblock{max-width:100%;border-collapse:separate} +table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} +table.spread{width:100%} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} +table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} +table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} +table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} +table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} +table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} +table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot{border-width:1px 0} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +td>div.verse{white-space:pre} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} +ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px} +ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} +ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} +ul.inline>li>*{display:block} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1{padding-right:.75em;font-weight:bold} +td.hdlist1,td.hdlist2{vertical-align:top} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} +.colist>table tr>td:last-of-type{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} +.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none} +span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} +span.footnote a,span.footnoteref a{text-decoration:none} +span.footnote a:active,span.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} +#footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background-color:#00fafa} +.black{color:#000} +.black-background{background-color:#000} +.blue{color:#0000bf} +.blue-background{background-color:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background-color:#fa00fa} +.gray{color:#606060} +.gray-background{background-color:#7d7d7d} +.green{color:#006000} +.green-background{background-color:#007d00} +.lime{color:#00bf00} +.lime-background{background-color:#00fa00} +.maroon{color:#600000} +.maroon-background{background-color:#7d0000} +.navy{color:#000060} +.navy-background{background-color:#00007d} +.olive{color:#606000} +.olive-background{background-color:#7d7d00} +.purple{color:#600060} +.purple-background{background-color:#7d007d} +.red{color:#bf0000} +.red-background{background-color:#fa0000} +.silver{color:#909090} +.silver-background{background-color:#bcbcbc} +.teal{color:#006060} +.teal-background{background-color:#007d7d} +.white{color:#bfbfbf} +.white-background{background-color:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background-color:#fafa00} +span.icon>.fa{cursor:default} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]:after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +h1,h2{letter-spacing:-.01em} +dt,th.tableblock,td.content{text-rendering:optimizeLegibility} +p,td.content{letter-spacing:-.01em} +p strong,td.content strong{letter-spacing:-.005em} +p,blockquote,dt,td.content{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} +.print-only{display:none!important} +@media print{@page{margin:1.25cm .75cm} +*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} +a{color:inherit!important;text-decoration:underline!important} +a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} +a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} +abbr[title]:after{content:" (" attr(title) ")"} +pre,blockquote,tr,img{page-break-inside:avoid} +thead{display:table-header-group} +img{max-width:100%!important} +p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} +h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} +#toc,.sidebarblock,.exampleblock>.content{background:none!important} +#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} +.sect1{padding-bottom:0!important} +.sect1+.sect1{border:0!important} +#header>h1:first-child{margin-top:1.25rem} +body.book #header{text-align:center} +body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} +body.book #header .details{border:0!important;display:block;padding:0!important} +body.book #header .details span:first-child{margin-left:0!important} +body.book #header .details br{display:block} +body.book #header .details br+span:before{content:none!important} +body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} +body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} +.listingblock code[data-lang]:before{display:block} +#footer{background:none!important;padding:0 .9375em} +#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} +.hide-on-print{display:none!important} +.print-only{display:block!important} +.hide-for-print{display:none!important} +.show-for-print{display:inherit!important}} +</style> +<style> +/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */ +/*pre.CodeRay {background-color:#f7f7f8;}*/ +.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em} +.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)} +.CodeRay .line-numbers strong{font-weight: normal} +table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none} +table.CodeRay td{vertical-align: top} +table.CodeRay td.line-numbers{text-align:right} +table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)} +table.CodeRay td.code{padding:0 0 0 .5em} +table.CodeRay td.code>pre{padding:0} +.CodeRay .debug{color:#fff !important;background:#000080 !important} +.CodeRay .annotation{color:#007} +.CodeRay .attribute-name{color:#000080} +.CodeRay .attribute-value{color:#700} +.CodeRay .binary{color:#509} +.CodeRay .comment{color:#998;font-style:italic} +.CodeRay .char{color:#04d} +.CodeRay .char .content{color:#04d} +.CodeRay .char .delimiter{color:#039} +.CodeRay .class{color:#458;font-weight:bold} +.CodeRay .complex{color:#a08} +.CodeRay .constant,.CodeRay .predefined-constant{color:#008080} +.CodeRay .color{color:#099} +.CodeRay .class-variable{color:#369} +.CodeRay .decorator{color:#b0b} +.CodeRay .definition{color:#099} +.CodeRay .delimiter{color:#000} +.CodeRay .doc{color:#970} +.CodeRay .doctype{color:#34b} +.CodeRay .doc-string{color:#d42} +.CodeRay .escape{color:#666} +.CodeRay .entity{color:#800} +.CodeRay .error{color:#808} +.CodeRay .exception{color:inherit} +.CodeRay .filename{color:#099} +.CodeRay .function{color:#900;font-weight:bold} +.CodeRay .global-variable{color:#008080} +.CodeRay .hex{color:#058} +.CodeRay .integer,.CodeRay .float{color:#099} +.CodeRay .include{color:#555} +.CodeRay .inline{color:#00} +.CodeRay .inline .inline{background:#ccc} +.CodeRay .inline .inline .inline{background:#bbb} +.CodeRay .inline .inline-delimiter{color:#d14} +.CodeRay .inline-delimiter{color:#d14} +.CodeRay .important{color:#555;font-weight:bold} +.CodeRay .interpreted{color:#b2b} +.CodeRay .instance-variable{color:#008080} +.CodeRay .label{color:#970} +.CodeRay .local-variable{color:#963} +.CodeRay .octal{color:#40e} +.CodeRay .predefined{color:#369} +.CodeRay .preprocessor{color:#579} +.CodeRay .pseudo-class{color:#555} +.CodeRay .directive{font-weight:bold} +.CodeRay .type{font-weight:bold} +.CodeRay .predefined-type{color:inherit} +.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold} +.CodeRay .key{color:#808} +.CodeRay .key .delimiter{color:#606} +.CodeRay .key .char{color:#80f} +.CodeRay .value{color:#088} +.CodeRay .regexp .delimiter{color:#808} +.CodeRay .regexp .content{color:#808} +.CodeRay .regexp .modifier{color:#808} +.CodeRay .regexp .char{color:#d14} +.CodeRay .regexp .function{color:#404;font-weight:bold} +.CodeRay .string{color:#d20} +.CodeRay .string .string .string{background:#ffd0d0} +.CodeRay .string .content{color:#d14} +.CodeRay .string .char{color:#d14} +.CodeRay .string .delimiter{color:#d14} +.CodeRay .shell{color:#d14} +.CodeRay .shell .delimiter{color:#d14} +.CodeRay .symbol{color:#990073} +.CodeRay .symbol .content{color:#a60} +.CodeRay .symbol .delimiter{color:#630} +.CodeRay .tag{color:#008080} +.CodeRay .tag-special{color:#d70} +.CodeRay .variable{color:#036} +.CodeRay .insert{background:#afa} +.CodeRay .delete{background:#faa} +.CodeRay .change{color:#aaf;background:#007} +.CodeRay .head{color:#f8f;background:#505} +.CodeRay .insert .insert{color:#080} +.CodeRay .delete .delete{color:#800} +.CodeRay .change .change{color:#66f} +.CodeRay .head .head{color:#f4f} +</style> +</head> +<body class="article toc2 toc-left"> +<div id="header"> +<h1>Apache Karaf Cellar 3.x - Documentation</h1> +<div class="details"> +<span id="author" class="author">Apache Software Foundation</span><br> +</div> +<div id="toc" class="toc2"> +<div id="toctitle">Apache Karaf Cellar 3.x - Documentation</div> +<ul class="sectlevel0"> +<li><a href="#_user_guide">User Guide</a> +<ul class="sectlevel1"> +<li><a href="#_introduction">1. Introduction</a> +<ul class="sectlevel2"> +<li><a href="#_karaf_cellar_use_cases">1.1. Karaf Cellar use cases</a></li> +<li><a href="#_cross_topology">1.2. Cross topology</a></li> +<li><a href="#_star_topology">1.3. Star topology</a></li> +</ul> +</li> +<li><a href="#_installation">2. Installation</a> +<ul class="sectlevel2"> +<li><a href="#_pre_installation_requirements">2.1. Pre-Installation Requirements</a></li> +<li><a href="#_building_from_sources">2.2. Building from Sources</a></li> +<li><a href="#_building_on_windows">2.3. Building on Windows</a></li> +<li><a href="#_building_on_unix">2.4. Building on Unix</a></li> +</ul> +</li> +<li><a href="#_deploy_cellar">3. Deploy Cellar</a> +<ul class="sectlevel2"> +<li><a href="#_registering_cellar_features">3.1. Registering Cellar features</a></li> +<li><a href="#_starting_cellar">3.2. Starting Cellar</a></li> +<li><a href="#_optional_features">3.3. Optional features</a></li> +</ul> +</li> +<li><a href="#_core_runtime_and_hazelcast">4. Core runtime and Hazelcast</a> +<ul class="sectlevel2"> +<li><a href="#_hazelcast_cluster_identification">4.1. Hazelcast cluster identification</a></li> +<li><a href="#_network">4.2. Network</a></li> +</ul> +</li> +<li><a href="#_cellar_nodes">5. Cellar nodes</a> +<ul class="sectlevel2"> +<li><a href="#_nodes_identification">5.1. Nodes identification</a></li> +<li><a href="#_testing_nodes">5.2. Testing nodes</a></li> +<li><a href="#_node_components_listener_producer_handler_consume_and_synchronizer">5.3. Node Components: listener, producer, handler, consume, and synchronizer</a></li> +<li><a href="#_synchronizers_and_sync_policy">5.4. Synchronizers and sync policy</a></li> +<li><a href="#_producer_consumer_and_handlers">5.5. Producer, consumer, and handlers</a></li> +<li><a href="#_listeners">5.6. Listeners</a></li> +</ul> +</li> +<li><a href="#_clustered_resources">6. Clustered resources</a></li> +<li><a href="#_cellar_groups">7. Cellar groups</a> +<ul class="sectlevel2"> +<li><a href="#_new_group">7.1. New group</a></li> +<li><a href="#_clustered_resources_and_cluster_groups">7.2. Clustered Resources and Cluster Groups</a> +<ul class="sectlevel3"> +<li><a href="#_features">7.2.1. Features</a></li> +<li><a href="#_bundles">7.2.2. Bundles</a></li> +<li><a href="#_configurations">7.2.3. Configurations</a></li> +<li><a href="#_obr_optional">7.2.4. OBR (optional)</a></li> +<li><a href="#_eventadmin_optional">7.2.5. EventAdmin (optional)</a></li> +</ul> +</li> +<li><a href="#_blocking_policy">7.3. Blocking policy</a></li> +</ul> +</li> +<li><a href="#_obr_support">8. OBR Support</a> +<ul class="sectlevel2"> +<li><a href="#_enable_obr_support">8.1. Enable OBR support</a></li> +<li><a href="#_register_repository_url_in_a_cluster">8.2. Register repository URL in a cluster</a></li> +<li><a href="#_deploying_bundles_using_the_cluster_obr">8.3. Deploying bundles using the cluster OBR</a></li> +</ul> +</li> +<li><a href="#_osgi_event_broadcasting_support_eventadmin">9. OSGi Event Broadcasting support (eventadmin)</a> +<ul class="sectlevel2"> +<li><a href="#_enable_osgi_event_broadcasting_support">9.1. Enable OSGi Event Broadcasting support</a></li> +<li><a href="#_osgi_event_broadcast_in_action">9.2. OSGi Event Broadcast in action</a></li> +</ul> +</li> +<li><a href="#_dosgi_and_transport">10. DOSGi and Transport</a></li> +<li><a href="#_discovery_services">11. Discovery Services</a> +<ul class="sectlevel2"> +<li><a href="#_jclouds">11.1. jClouds</a> +<ul class="sectlevel3"> +<li><a href="#_cloud_discovery_service">11.1.1. Cloud discovery service</a></li> +<li><a href="#_installing_cellar_cloud_discovery_service">11.1.2. Installing Cellar cloud discovery service</a></li> +<li><a href="#_kubernetes_docker_io">11.1.3. Kubernetes & docker.io</a></li> +<li><a href="#_kubernetes_discovery_service">11.1.4. Kubernetes discovery service</a></li> +<li><a href="#_installing_kubernetes_discovery_service">11.1.5. Installing Kubernetes discovery service</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li><a href="#_architecture_guide">Architecture Guide</a> +<ul class="sectlevel1"> +<li><a href="#_architecture_overview">1. Architecture Overview</a></li> +<li><a href="#_supported_events">2. Supported Events</a></li> +<li><a href="#_the_role_of_hazelcast">3. The role of Hazelcast</a></li> +<li><a href="#_design">4. Design</a></li> +<li><a href="#_broadcasting_commands">5. Broadcasting commands</a></li> +</ul> +</li> +</ul> +</div> +</div> +<div id="content"> +<h1 id="_user_guide" class="sect0">User Guide</h1> +<div class="sect1"> +<h2 id="_introduction">1. Introduction</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_karaf_cellar_use_cases">1.1. Karaf Cellar use cases</h3> +<div class="paragraph"> +<p>The first purpose of Cellar is to synchronize the state of several Karaf instances (named nodes).</p> +</div> +<div class="paragraph"> +<p>Cellar provides dedicated shell commands and MBeans to administrate the cluster, and manipulate the resources on the cluster.</p> +</div> +<div class="paragraph"> +<p>It’s also possible to enable local resources listeners: these listeners broadcast local resource changes as cluster events. +Please note that this behavior is disabled by default as it can have side effects (especially when a node is stopped). +Enabling listeners is at your own risk.</p> +</div> +<div class="paragraph"> +<p>The nodes list could be discovered (using unicast or multicast), or "staticly" defined (using a couple hostname or IP +and port list).</p> +</div> +<div class="paragraph"> +<p>Cellar is able to synchronize:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>bundles (remote, local, or from an OBR)</p> +</li> +<li> +<p>config</p> +</li> +<li> +<p>features</p> +</li> +<li> +<p>eventadmin</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>Optionally, Cellar also support synchronization of OSGi EventAdmin, OBR (URLs and bundles).</p> +</div> +<div class="paragraph"> +<p>The second purpose is to provide a Distributed OSGi runtime. It means that using Cellar, you are able to call an OSGi +service located on a remote instance. See the [Transport and DOSGi] section of the user guide.</p> +</div> +<div class="paragraph"> +<p>Finally, Cellar also provides "runtime clustering" by providing dedicated feature like:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>HTTP load balancing</p> +</li> +<li> +<p>HTTP sessions replication</p> +</li> +<li> +<p>log centralization</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>Please, see the sections dedicated to those features.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_cross_topology">1.2. Cross topology</h3> +<div class="imageblock"> +<div class="content"> +<img src="../resources/images/images/cross_topology.jpg" alt="cross topology"> +</div> +</div> +<div class="paragraph"> +<p>This is the default Cellar topology. Cellar is installed on every nodes, each node has the same function.</p> +</div> +<div class="paragraph"> +<p>It means that you can perform actions on any node, it will be broadcasted to all others nodes.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_star_topology">1.3. Star topology</h3> +<div class="imageblock"> +<div class="content"> +<img src="../resources/images/images/star_topology.jpg" alt="star topology"> +</div> +</div> +<div class="paragraph"> +<p>In this topology, if Cellar is installed on all nodes, you perform actions only on one specific node (the "manager").</p> +</div> +<div class="paragraph"> +<p>To do that, the "manager" is a standard Cellar node, and the event producing is disable on all others nodes +(<code>cluster:producer-stop</code> on all "managed" nodes).</p> +</div> +<div class="paragraph"> +<p>Like this, only the "manager" will send event to the nodes (which are able to consumer and handle), but no event can +be produced on the nodes.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_installation">2. Installation</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This chapter describes how to install Apache Karaf Cellar into your existing Karaf based installation.</p> +</div> +<div class="sect2"> +<h3 id="_pre_installation_requirements">2.1. Pre-Installation Requirements</h3> +<div class="paragraph"> +<p>Cellar is installed on running Karaf instances.</p> +</div> +<div class="paragraph"> +<p>Cellar is provided as a Karaf features descriptor. The easiest way to install is just to +have an internet connection from the Karaf running instance.</p> +</div> +<div class="paragraph"> +<p>See link::deploy to how to install and start Cellar.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_building_from_sources">2.2. Building from Sources</h3> +<div class="paragraph"> +<p>If you intend to build Karaf Cellar from the sources, the requirements are:</p> +</div> +<div class="paragraph"> +<p><strong>Hardware:</strong></p> +</div> +<div class="ulist"> +<ul> +<li> +<p>100MB of free disk space for the Apache Karaf Cellar x.y source distributions or SVN checkout, the Maven build and the dependencies that Maven downloads.</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p><strong>Environment:</strong></p> +</div> +<div class="ulist"> +<ul> +<li> +<p>Java SE Development Kit 1.7.x or greater ([<a href="http://www.oracle.com/technetwork/java/javase/"; class="bare">http://www.oracle.com/technetwork/java/javase/</a>]).</p> +</li> +<li> +<p>Apache Maven 3.0.3 ([<a href="http://maven.apache.org/download.html"; class="bare">http://maven.apache.org/download.html</a>]).</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p><strong>Note:</strong> Karaf Cellar requires Java 7 to compile, build and run.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_building_on_windows">2.3. Building on Windows</h3> +<div class="paragraph"> +<p>This procedure explains how to download and install the source distribution on a Windows system.</p> +</div> +<div class="olist arabic"> +<ol class="arabic"> +<li> +<p>From a browser, navigate to link::http://karaf.apache.org/sub-projects/cellar/download.html.</p> +</li> +<li> +<p>Select the desired distribution. +For a source distribution, the filename will be similar to: <code>apache-karaf-cellar-x.y-src.zip</code>.</p> +</li> +<li> +<p>Extract Karaf Cellar from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc.</p> +</li> +<li> +<p>Build Karaf Cellar using Maven 3.0.3 or greater and Java 6. +The recommended method of building Karaf Cellar is the following:</p> +</li> +</ol> +</div> +<div class="listingblock"> +<div class="content"> +<pre>cd [cellar_install_dir]\src</pre> +</div> +</div> +<div class="paragraph"> +<p>where <code>[cellar_install_dir]</code> is the directory in which Karaf Cellar was uncompressed.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>mvn</pre> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_building_on_unix">2.4. Building on Unix</h3> +<div class="paragraph"> +<p>This procedure explains how to download and install the source distribution on an Unix system.</p> +</div> +<div class="olist arabic"> +<ol class="arabic"> +<li> +<p>From a browser, navigate to link::http://karaf.apache.org/sub-projects/cellar/download.html.</p> +</li> +<li> +<p>Select the desired distribution. +For a source distribution, the filename will be similar to: <code>apache-karaf-cellar-x.y-src.tar.gz</code>.</p> +</li> +<li> +<p>Extract the files from the tarball file into a directory of your choice. For example:</p> +</li> +</ol> +</div> +<div class="listingblock"> +<div class="content"> +<pre>gunzip apache-karaf-cellar-x.y-src.tar.gz +tar xvf apache-karaf-cellar-x.y-src.tar</pre> +</div> +</div> +<div class="paragraph"> +<p>Please remember the restrictions concerning illegal characters in Java paths, e.g. \!, % etc. +4. Build Karaf using Maven: +The preferred method of building Karaf is the following:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>cd [karaf_install_dir]/src</pre> +</div> +</div> +<div class="paragraph"> +<p>where [karaf_install_dir] is the directory in which Karaf Cellar was uncompressed.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>mvn</pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_deploy_cellar">3. Deploy Cellar</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This chapter describes how to deploy and start Cellar into a running Apache Karaf instance. This chapter +assumes that you already know Apache Karaf basics, especially the notion of features and shell usage.</p> +</div> +<div class="sect2"> +<h3 id="_registering_cellar_features">3.1. Registering Cellar features</h3> +<div class="paragraph"> +<p>Karaf Cellar is provided as a Karaf features XML descriptor.</p> +</div> +<div class="paragraph"> +<p>Simply register the Cellar feature URL in your Karaf instance:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:repo-add mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.3/xml/features +Adding feature url mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.3/xml/features</pre> +</div> +</div> +<div class="paragraph"> +<p>Now you have Cellar features available in your Karaf instance:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:list |grep -i cellar +cellar-core | 3.0.3 | | karaf-cellar-3.0.3 | Karaf clustering core +hazelcast | 3.4.2 | | karaf-cellar-3.0.3 | In memory data grid +cellar-hazelcast | 3.0.3 | | karaf-cellar-3.0.3 | Cellar implementation based on Hazelcast +cellar-config | 3.0.3 | | karaf-cellar-3.0.3 | ConfigAdmin cluster support +cellar-features | 3.0.3 | | karaf-cellar-3.0.3 | Karaf features cluster support +cellar-bundle | 3.0.3 | | karaf-cellar-3.0.3 | Bundle cluster support +cellar-shell | 3.0.3 | | karaf-cellar-3.0.3 | Cellar shell support +cellar | 3.0.3 | | karaf-cellar-3.0.3 | Karaf clustering +cellar-dosgi | 3.0.3 | | karaf-cellar-3.0.3 | DOSGi support +cellar-obr | 3.0.3 | | karaf-cellar-3.0.3 | OBR cluster support +cellar-eventadmin | 3.0.3 | | karaf-cellar-3.0.3 | OSGi events broadcasting in clusters +cellar-cloud | 3.0.3 | | karaf-cellar-3.0.3 | Cloud blobstore support in clusters +cellar-webconsole | 3.0.3 | | karaf-cellar-3.0.3 | Cellar plugin for Karaf WebConsole</pre> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_starting_cellar">3.2. Starting Cellar</h3> +<div class="paragraph"> +<p>To start Cellar in your Karaf instance, you only need to install the Cellar feature:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:install cellar</pre> +</div> +</div> +<div class="paragraph"> +<p>You can now see the Cellar components (bundles) installed:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> la|grep -i cellar +80 | Active | 30 | 3.0.3 | Apache Karaf :: Cellar :: Core +81 | Active | 31 | 3.0.3 | Apache Karaf :: Cellar :: Utils +82 | Active | 33 | 3.0.3 | Apache Karaf :: Cellar :: Hazelcast +83 | Active | 40 | 3.0.3 | Apache Karaf :: Cellar :: Shell +84 | Active | 40 | 3.0.3 | Apache Karaf :: Cellar :: Config +85 | Active | 40 | 3.0.3 | Apache Karaf :: Cellar :: Bundle +86 | Active | 40 | 3.0.3 | Apache Karaf :: Cellar :: Features</pre> +</div> +</div> +<div class="paragraph"> +<p>And Cellar cluster commands are now available:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:<TAB></pre> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_optional_features">3.3. Optional features</h3> +<div class="paragraph"> +<p>Optionally, you can install additional features.</p> +</div> +<div class="paragraph"> +<p>The cellar-event feature adds support of OSGi EventAdmin on the cluster:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:install cellar-event</pre> +</div> +</div> +<div class="paragraph"> +<p>The cellar-obr feature adds support of OBR sync on the cluster:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:install cellar-obr</pre> +</div> +</div> +<div class="paragraph"> +<p>The cellar-dosgi feature adds support of DOSGi (Distributed OSGi):</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:install cellar-dosgi</pre> +</div> +</div> +<div class="paragraph"> +<p>The cellar-cloud feature adds support of cloud blobstore, allowing to use instances located on a cloud provider:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:install cellar-cloud</pre> +</div> +</div> +<div class="paragraph"> +<p>Please, see the sections dedicated to these features for details.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_core_runtime_and_hazelcast">4. Core runtime and Hazelcast</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Cellar uses Hazelcast as cluster engine.</p> +</div> +<div class="paragraph"> +<p>When you install the cellar feature, a hazelcast feature is automatically installed, providing the <code>etc/hazelcast.xml</code> +configuration file.</p> +</div> +<div class="paragraph"> +<p>The <code>etc/hazelcast.xml</code> configuration file contains all the core configuration, especially: +* the Hazelcast cluster identifiers (group name and password) +* network discovery and security configuration</p> +</div> +<div class="sect2"> +<h3 id="_hazelcast_cluster_identification">4.1. Hazelcast cluster identification</h3> +<div class="paragraph"> +<p>The <code><group/></code> element in the <code>etc/hazelcast.xml</code> defines the identification of the Hazelcast cluster:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <group> + <name>cellar</name> + <password>pass</password> + </group></pre> +</div> +</div> +<div class="paragraph"> +<p>All Cellar nodes have to use the same name and password (to be part of the same Hazelcast cluster).</p> +</div> +</div> +<div class="sect2"> +<h3 id="_network">4.2. Network</h3> +<div class="paragraph"> +<p>The <code><network/></code> element in the <code>etc/hazelcast.xml</code> contains all the network configuration.</p> +</div> +<div class="paragraph"> +<p>First, it defines the port numbers used by Hazelcast:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <port auto-increment="true" port-count="100">5701</port> + <outbound-ports> + <!-- + Allowed port range when connecting to other nodes. + 0 or * means use system provided port. + --> + <ports>0</ports> + </outbound-ports></pre> +</div> +</div> +<div class="paragraph"> +<p>Second, it defines the mechanism used to discover the Cellar nodes: it’s the <code><join/></code> element.</p> +</div> +<div class="paragraph"> +<p>By default, Hazelcast uses unicast.</p> +</div> +<div class="paragraph"> +<p>You can also use multicast (enabled by default in Cellar):</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <multicast enabled="true"> + <multicast-group>224.2.2.3</multicast-group> + <multicast-port>54327</multicast-port> + </multicast> + <tcp-ip enabled="false"/> + <aws enabled="false"/></pre> +</div> +</div> +<div class="paragraph"> +<p>Instead of using multicast, you can also explicitly define the host names (or IP addresses) of the different +Cellar nodes:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <multicast enabled="false"/> + <tcp-ip enabled="true"/> + <aws enabled="false"/></pre> +</div> +</div> +<div class="paragraph"> +<p>By default, it will bind to all interfaces on the node machine. It’s possible to specify a interface:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <multicast enabled="false"/> + <tcp-ip enabled="true"> + <interface>127.0.0.1</interface> + </tcp-ip> + <aws enabled="false"/></pre> +</div> +</div> +<div class="paragraph"> +<p>NB: in previous Hazelcast versions (especially the one used by Cellar 2.3.x), it was possible to have multicast and tcp-ip enabled in the same time. +In Hazelcast 3.3.x (the version currently used by Cellar 3.0.x), only one discover mechanism can be enabled at a time. Cellar uses multicast by default (tcp-ip is disabled). +If your network or network interface don’t support multicast, you have to enable tcp-ip and disable multicast.</p> +</div> +<div class="paragraph"> +<p>You can also discover nodes located on a Amazon instance:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <multicast enabled="false"/> + <tcp-ip enabled="false"/> + <aws enabled="true"> + <access-key>my-access-key</access-key> + <secret-key>my-secret-key</secret-key> + <!--optional, default is us-east-1 --> + <region>us-west-1</region> + <!--optional, default is ec2.amazonaws.com. If set, region shouldn't be set as it will override this property --> + <host-header>ec2.amazonaws.com</host-header> + <!-- optional, only instances belonging to this group will be discovered, default will try all running instances --> + <security-group-name>hazelcast-sg</security-group-name> + <tag-key>type</tag-key> + <tag-value>hz-nodes</tag-value> + </aws></pre> +</div> +</div> +<div class="paragraph"> +<p>Third, you can specific on which network interface the cluster is running (whatever the discovery mechanism used). By default, Hazelcast listens on all interfaces (0.0.0.0). +But you can specify an interface:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <interfaces enabled="true"> + <interface>10.10.1.*</interface> + </interfaces></pre> +</div> +</div> +<div class="paragraph"> +<p>Finally, you can also enable security transport on the cluster. +Two modes are supported: +* SSL:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <ssl enabled="true"/></pre> +</div> +</div> +<div class="ulist"> +<ul> +<li> +<p>Symmetric Encryption:</p> +</li> +</ul> +</div> +<div class="listingblock"> +<div class="content"> +<pre> <symmetric-encryption enabled="true"> + <!-- + encryption algorithm such as + DES/ECB/PKCS5Padding, + PBEWithMD5AndDES, + AES/CBC/PKCS5Padding, + Blowfish, + DESede + --> + <algorithm>PBEWithMD5AndDES</algorithm> + <!-- salt value to use when generating the secret key --> + <salt>thesalt</salt> + <!-- pass phrase to use when generating the secret key --> + <password>thepass</password> + <!-- iteration count to use when generating the secret key --> + <iteration-count>19</iteration-count> + </symmetric-encryption></pre> +</div> +</div> +<div class="paragraph"> +<p>Cellar provides additional discovery mechanisms, See <a href="cloud">Discovery Service (jclouds and kubernetes)</a> section for details.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_cellar_nodes">5. Cellar nodes</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This chapter describes the Cellar nodes manipulation commands.</p> +</div> +<div class="sect2"> +<h3 id="_nodes_identification">5.1. Nodes identification</h3> +<div class="paragraph"> +<p>When you installed the Cellar feature, your Karaf instance became automatically a Cellar cluster node, +and hence tries to discover the others Cellar nodes.</p> +</div> +<div class="paragraph"> +<p>You can list the known Cellar nodes using the list-nodes command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:node-list + | Id | Host Name | Port +------------------------------------- +x | node2:5702 | node2 | 5702 + | node1:5701 | node1 | 5701</pre> +</div> +</div> +<div class="paragraph"> +<p>The starting <em>x</em> indicates that it’s the Karaf instance on which you are logged on (the local node).</p> +</div> +<div class="paragraph"> +<p>NB: if you don’t see the other nodes there (whereas they should be there), it’s probably due to a network issue. By default, Cellar uses multicast to discover the nodes. +If your network or network interface don’t support multicast, you have to switch to tcp-ip instead of multicast. See [Core Configuration|hazelcast] for details.</p> +</div> +<div class="paragraph"> +<p>NB: in Cellar 2.3.x, Cellar used both multicast and tcp-ip by default. Due to a change in Hazelcast, it’s no more possible to have both. Now, in Cellar 3.0.x, the default +configuration is multicast enabled, tcp-ip disabled. See [Core Configuration|hazelcast] for details.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_testing_nodes">5.2. Testing nodes</h3> +<div class="paragraph"> +<p>You can ping a node to test it:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:node-ping node1:5701 +PING node1:5701 +from 1: req=node1:5701 time=11 ms +from 2: req=node1:5701 time=12 ms +from 3: req=node1:5701 time=13 ms +from 4: req=node1:5701 time=7 ms +from 5: req=node1:5701 time=12 ms</pre> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_node_components_listener_producer_handler_consume_and_synchronizer">5.3. Node Components: listener, producer, handler, consume, and synchronizer</h3> +<div class="paragraph"> +<p>A Cellar node is actually a set of components, each component is dedicated to a special purpose.</p> +</div> +<div class="paragraph"> +<p>The <code>etc/org.apache.karaf.cellar.node.cfg</code> configuration file is dedicated to the configuration of the local node. +It’s where you can control the status of the different components.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_synchronizers_and_sync_policy">5.4. Synchronizers and sync policy</h3> +<div class="paragraph"> +<p>A synchronizer is invoked when you:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>Cellar starts</p> +</li> +<li> +<p>a node joins a cluster group (see [groups] for details about cluster groups)</p> +</li> +<li> +<p>you explicitly call the cluster:sync command</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>We have a synchronizer per resource: feature, bundle, config, obr (optional).</p> +</div> +<div class="paragraph"> +<p>Cellar supports three sync policies:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>cluster (default): if the node is the first one in the cluster, it pushes its local state to the cluster, else if it’s +not the first node in the cluster, the node will update its local state with the cluster one (meaning that the cluster +is the master).</p> +</li> +<li> +<p>node: in this case, the node is the master, it means that the cluster state will be overwritten by the node state.</p> +</li> +<li> +<p>disabled: in this case, it means that the synchronizer is not used at all, meaning the node or the cluster are not +updated at all (at sync time).</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>You can configure the sync policy (for each resource, and each cluster group) in the etc/org.apache.karaf.cellar.groups.cfg +configuration file:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>default.bundle.sync = cluster +default.config.sync = cluster +default.feature.sync = cluster +default.obr.urls.sync = cluster</pre> +</div> +</div> +<div class="paragraph"> +<p>The <code>cluster:sync</code> command allows you to "force" the sync:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:sync +Synchronizing cluster group default + bundle: done + config: done + feature: done + obr.urls: No synchronizer found for obr.urls</pre> +</div> +</div> +<div class="paragraph"> +<p>It’s also possible to sync only a resource using:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>-b (--bundle) for bundle</p> +</li> +<li> +<p>-f (--feature) for feature</p> +</li> +<li> +<p>-c (--config) for configuration</p> +</li> +<li> +<p>-o (--obr) for OBR URLs</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>or a given cluster group using the -g (--group) option.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_producer_consumer_and_handlers">5.5. Producer, consumer, and handlers</h3> +<div class="paragraph"> +<p>To notify the other nodes in the cluster, Cellar produces a cluster event.</p> +</div> +<div class="paragraph"> +<p>For that, the local node uses a producer to create and send the cluster event. +You can see the current status of the local producer using the <code>cluster:producer-status</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:producer-status + | Node | Status +----------------------------- +x | 172.17.42.1:5701 | ON</pre> +</div> +</div> +<div class="paragraph"> +<p>The <code>cluster:producer-stop</code> and <code>cluster:producer-start</code> commands allow you to stop or start the local cluster event +producer:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:producer-stop + | Node | Status +----------------------------- +x | 172.17.42.1:5701 | OFF +karaf@node1()> cluster:producer-start + | Node | Status +----------------------------- +x | 172.17.42.1:5701 | ON</pre> +</div> +</div> +<div class="paragraph"> +<p>When the producer is off, it means that the node is "isolated" from the cluster as it doesn’t send "outbound" cluster events +to the other nodes.</p> +</div> +<div class="paragraph"> +<p>On the other hand, a node receives the cluster events on a consumer. Like for the producer, you can see and control the +consumer using dedicated command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:consumer-status + | Node | Status +--------------------------- +x | localhost:5701 | ON +karaf@node1()> cluster:consumer-stop + | Node | Status +--------------------------- +x | localhost:5701 | OFF +karaf@node1()> cluster:consumer-start + | Node | Status +--------------------------- +x | localhost:5701 | ON</pre> +</div> +</div> +<div class="paragraph"> +<p>When the consumer is off, it means that node is "isolated" from the cluster as it doesn’t receive "inbound" cluster events +from the other nodes.</p> +</div> +<div class="paragraph"> +<p>Different cluster events are involved. For instance, we have cluster event for feature, for bundle, for configuration, for OBR, etc. +When a consumer receives a cluster event, it delegates the handling of the cluster event to a specific handler, depending of the +type of the cluster event. +You can see the different handlers and their status using the cluster:handler-status command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:handler-status + | Node | Status | Event Handler +-------------------------------------------------------------------------------------- +x | localhost:5701 | ON | org.apache.karaf.cellar.config.ConfigurationEventHandler +x | localhost:5701 | ON | org.apache.karaf.cellar.bundle.BundleEventHandler +x | localhost:5701 | ON | org.apache.karaf.cellar.features.FeaturesEventHandler</pre> +</div> +</div> +<div class="paragraph"> +<p>You can stop or start a specific handler using the <code>cluster:handler-stop</code> and <code>cluster:handler-start</code> commands.</p> +</div> +<div class="paragraph"> +<p>When a handler is stopped, it means that the node will receive the cluster event, but will not update the local resources +dealt by the handler.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_listeners">5.6. Listeners</h3> +<div class="paragraph"> +<p>The listeners are listening for local resource change.</p> +</div> +<div class="paragraph"> +<p>For instance, when you install a feature (with <code>feature:install</code>), the feature listener traps the change and broadcast this +change as a cluster event to other nodes.</p> +</div> +<div class="paragraph"> +<p>To avoid some unexpected behaviors (especially when you stop a node), most of the listeners are switch off by default.</p> +</div> +<div class="paragraph"> +<p>The listeners status are configured in the <code>etc/org.apache.karaf.cellar.node.cfg</code> configuration file.</p> +</div> +<div class="paragraph"> +<p>NB: enabling listeners is at your own risk. We encourage you to use cluster dedicated commands and MBeans to manipulate +the resources on the cluster.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_clustered_resources">6. Clustered resources</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Cellar provides dedicated commands and MBeans for clustered resources.</p> +</div> +<div class="paragraph"> +<p>Please, go into the <a href=":groups">cluster groups</a> section for details.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_cellar_groups">7. Cellar groups</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>You can define groups in Cellar. A group allows you to define specific nodes and resources that are to be +working together. This permits some nodes (those outside the group) not to need to sync’ed with changes of +a node within a group.</p> +</div> +<div class="paragraph"> +<p>By default, the Cellar nodes go into the default group:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:group-list + | Group | Members +----------------------------------------------- +x | default | node2:5702 node1:5701(x)</pre> +</div> +</div> +<div class="paragraph"> +<p>The <em>x</em> indicates a local group. A local group is a group containing the local node (where we are connected).</p> +</div> +<div class="sect2"> +<h3 id="_new_group">7.1. New group</h3> +<div class="paragraph"> +<p>You can create a new group using the group-create command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:group-create test</pre> +</div> +</div> +<div class="paragraph"> +<p>For now, the test group hasn’t any nodes:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:group-list + | Group | Members +----------------------------------------------- +x | default | node2:5702 node1:5701(x) + | test |</pre> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_clustered_resources_and_cluster_groups">7.2. Clustered Resources and Cluster Groups</h3> +<div class="sect3"> +<h4 id="_features">7.2.1. Features</h4> +<div class="paragraph"> +<p>Cellar can manipulate features and features repositories on cluster groups.</p> +</div> +<div class="paragraph"> +<p>You can use <code>cluster:feature-*</code> commands or the corresponding MBean for that.</p> +</div> +<div class="paragraph"> +<p>You can list the features repositories on a given cluster group:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:feature-repo-list default +Repository | Located | URL +------------------------------------------------------------------------------------------------------------------------- +jclouds-1.8.1 | cluster/local | mvn:org.apache.jclouds.karaf/jclouds-karaf/1.8.1/xml/features +karaf-cellar-3.0.1-SNAPSHOT | cluster/local | mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.1-SNAPSHOT/xml/features +org.ops4j.pax.cdi-0.8.0 | cluster/local | mvn:org.ops4j.pax.cdi/pax-cdi-features/0.8.0/xml/features +spring-3.0.2 | cluster/local | mvn:org.apache.karaf.features/spring/3.0.2/xml/features +standard-3.0.2 | cluster/local | mvn:org.apache.karaf.features/standard/3.0.2/xml/features +enterprise-3.0.2 | cluster/local | mvn:org.apache.karaf.features/enterprise/3.0.2/xml/features +org.ops4j.pax.web-3.1.2 | cluster/local | mvn:org.ops4j.pax.web/pax-web-features/3.1.2/xml/features</pre> +</div> +</div> +<div class="paragraph"> +<p>You have the name of the repository, and the URL, like in the <code>feature:repo-list</code> command. However, the <code>cluster:feature-repo-list</code> command +provides the location of the features repository: +* cluster means that the repository is defined only on the cluster group +* local means that the repository is defined only on the local node (not on the cluster) +* cluster/local means that the repository is defined both on the local node, but also on the cluster group</p> +</div> +<div class="paragraph"> +<p>You can add a repository on a cluster group using the <code>cluster:feature-repo-add</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:feature-repo-add default mvn:org.apache.activemq/activemq-karaf/5.10.0/xml/features</pre> +</div> +</div> +<div class="paragraph"> +<p>You can remove a repository from a cluster group using the <code>cluster:feature-repo-remove</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:feature-repo-remove default mvn:org.apache.activemq/activemq-karaf/5.10.0/xml/features</pre> +</div> +</div> +<div class="paragraph"> +<p>You can list the features on a given cluster group:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:feature-list default |more +Name | Version | Installed | Located | Blocked +------------------------------------------------------------------------------------------------ +gemini-blueprint | 1.0.0.RELEASE | | cluster/local | +package | 3.0.2 | x | cluster/local | +jclouds-api-route53 | 1.8.1 | | cluster/local | +jclouds-rackspace-clouddns-uk | 1.8.1 | | cluster/local | +cellar-cloud | 3.0.1-SNAPSHOT | | local | in/out +webconsole | 3.0.2 | | cluster/local | +cellar-shell | 3.0.1-SNAPSHOT | x | local | in/out +jclouds-glesys | 1.8.1 | | cluster/local | +...</pre> +</div> +</div> +<div class="paragraph"> +<p>Like for the features repositories, you can note there the "Located" column containing where the feature is located (local +to the node, or on the cluster group). +You can also see the "Blocked" column indicating if the feature is blocked inbound or outbound (see the blocking policy).</p> +</div> +<div class="paragraph"> +<p>You can install a feature on a cluster group using the <code>cluster:feature-install</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:feature-install default eventadmin</pre> +</div> +</div> +<div class="paragraph"> +<p>You can uninstall a feature from a cluster group, using the <code>cluster:feature-uninstall</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:feature-uninstall default eventadmin</pre> +</div> +</div> +<div class="paragraph"> +<p>Cellar also provides a feature listener, disabled by default as you can see in <code>etc/org.apache.karaf.cellar.node.cfg</code> configuration +file:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>feature.listener = false</pre> +</div> +</div> +<div class="paragraph"> +<p>The listener listens for the following local feature changes:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>add features repository</p> +</li> +<li> +<p>remove features repository</p> +</li> +<li> +<p>install feature</p> +</li> +<li> +<p>uninstall feature</p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_bundles">7.2.2. Bundles</h4> +<div class="paragraph"> +<p>Cellar can manipulate bundles on cluster groups.</p> +</div> +<div class="paragraph"> +<p>You can use <code>cluster:bundle-*</code> commands or the corresponding MBean for that.</p> +</div> +<div class="paragraph"> +<p>You can list the bundles in a cluster group using the <code>cluster:bundle-list</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:bundle-list default |more +Bundles in cluster group default +ID | State | Located | Blocked | Version | Name +-------------------------------------------------------------------------------------------------------------------- + 0 | Active | cluster/local | | 2.2.0 | OPS4J Pax Url - aether: + 1 | Active | cluster/local | | 3.0.2 | Apache Karaf :: Deployer :: Blueprint + 2 | Active | cluster/local | | 2.2.0 | OPS4J Pax Url - wrap: + 3 | Active | cluster/local | | 1.8.0 | Apache Felix Configuration Admin Service + 4 | Active | cluster/local | | 3.0.2 | Apache Karaf :: Region :: Core + ...</pre> +</div> +</div> +<div class="paragraph"> +<p>Like for the features, you can see the "Located" and "Blocked" columns.</p> +</div> +<div class="paragraph"> +<p>You can install a bundle on a cluster group using the <code>cluster:bundle-install</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:bundle-install default mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.commons-lang/2.4_6</pre> +</div> +</div> +<div class="paragraph"> +<p>You can start a bundle in a cluster group using the <code>cluster:bundle-start command</code>:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:bundle-start default commons-lang</pre> +</div> +</div> +<div class="paragraph"> +<p>You can stop a bundle in a cluster group using the <code>cluster:bundle-stop</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:bundle-stop default commons-lang</pre> +</div> +</div> +<div class="paragraph"> +<p>You can uninstall a bundle from a cluster group using the <code>cluster:bundle-uninstall</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:bundle-uninstall default commons-lang</pre> +</div> +</div> +<div class="paragraph"> +<p>Like for the feature, Cellar provides a bundle listener disabled by default in <code>etc/org.apache.karaf.cellar.nodes.cfg</code>:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>bundle.listener = false</pre> +</div> +</div> +<div class="paragraph"> +<p>The bundle listener listens the following local bundle changes:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>install bundle</p> +</li> +<li> +<p>start bundle</p> +</li> +<li> +<p>stop bundle</p> +</li> +<li> +<p>uninstall bundle</p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_configurations">7.2.3. Configurations</h4> +<div class="paragraph"> +<p>Cellar can manipulate configurations on cluster groups.</p> +</div> +<div class="paragraph"> +<p>You can use <code>cluster:config-*</code> commands or the corresponding MBean for that.</p> +</div> +<div class="paragraph"> +<p>You can list the configurations on a cluster group using the <code>cluster:config-list</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:config-list default |more +---------------------------------------------------------------- +Pid: org.apache.karaf.command.acl.jaas +Located: cluster/local +Blocked: +Properties: + update = admin + service.pid = org.apache.karaf.command.acl.jaas +---------------------------------------------------------------- +...</pre> +</div> +</div> +<div class="paragraph"> +<p>You can note the "Blocked" and "Located" attributes, like for features and bundles.</p> +</div> +<div class="paragraph"> +<p>YOu can list properties in a config using the <code>cluster:config-property-list</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:config-property-list default org.apache.karaf.jaas +Property list for configuration PID org.apache.karaf.jaas for cluster group default + encryption.prefix = {CRYPT} + encryption.name = + encryption.enabled = false + encryption.suffix = {CRYPT} + encryption.encoding = hexadecimal + service.pid = org.apache.karaf.jaas + encryption.algorithm = MD5</pre> +</div> +</div> +<div class="paragraph"> +<p>You can set or append a value to a config property using the <code>cluster:config-property-set</code> or <code>cluster:config-property-append</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:config-property-set default my.config my.property my.value</pre> +</div> +</div> +<div class="paragraph"> +<p>You can delete a property in a config using the <code>cluster:config-property-delete</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:config-property-delete default my.config my.property</pre> +</div> +</div> +<div class="paragraph"> +<p>You can delete the whole config using the <code>cluster:config-delete</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:config-delete default my.config</pre> +</div> +</div> +<div class="paragraph"> +<p>Like for feature and bundle, Cellar provides a config listener disabled by default in <code>etc/org.apache.karaf.cellar.nodes.cfg</code>:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>config.listener = false</pre> +</div> +</div> +<div class="paragraph"> +<p>The config listener listens the following local config changes:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>create a config</p> +</li> +<li> +<p>add/delete/change a property</p> +</li> +<li> +<p>delete a config</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>As some properties may be local to a node, Cellar excludes some property by default. +You can see the current excluded properties using the <code>cluster:config-property-excluded</code> command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:config-property-excluded +service.factoryPid, felix.fileinstall.filename, felix.fileinstall.dir, felix.fileinstall.tmpdir, org.ops4j.pax.url.mvn.defaultRepositories</pre> +</div> +</div> +<div class="paragraph"> +<p>You can modify this list using the same command, or by editing the <code>etc/org.apache.karaf.cellar.node.cfg</code> configuration file:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre># +# Excluded config properties from the sync +#Â Some config properties can be considered as local to a node, and should not be sync on the cluster. +# +config.excluded.properties = service.factoryPid, felix.fileinstall.filename, felix.fileinstall.dir, felix.fileinstall.tmpdir, org.ops4j.pax.url.mvn.defaultRepositories</pre> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_obr_optional">7.2.4. OBR (optional)</h4> +<div class="paragraph"> +<p>See the <a href=":obr">OBR section</a> for details.</p> +</div> +</div> +<div class="sect3"> +<h4 id="_eventadmin_optional">7.2.5. EventAdmin (optional)</h4> +<div class="paragraph"> +<p>See the <a href=":event">EventAdmin section</a> for details.</p> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_blocking_policy">7.3. Blocking policy</h3> +<div class="paragraph"> +<p>You can define a policy to filter the cluster events exchanges by the nodes (inbound or outbound).</p> +</div> +<div class="paragraph"> +<p>It allows you to block or allow some resources on the cluster.</p> +</div> +<div class="paragraph"> +<p>By adding a resource id in a blacklist, you block the resource. +By adding a resource id in a whitelist, you allow the resource.</p> +</div> +<div class="paragraph"> +<p>For instance, for feature, you can use the <code>cluster:feature-block</code> command to display or modify the current blocking policy for features:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:feature-block default +INBOUND: + whitelist: [*] + blacklist: [config, cellar*, hazelcast, management] +OUTBOUND: + whitelist: [*] + blacklist: [config, cellar*, hazelcast, management]</pre> +</div> +</div> +<div class="paragraph"> +<p>NB: * is a wildcard.</p> +</div> +<div class="paragraph"> +<p>You have the equivalent command for bundle and config:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@node1()> cluster:bundle-block default +INBOUND: + whitelist: [*] + blacklist: [*.xml] +OUTBOUND: + whitelist: [*] + blacklist: [*.xml] +karaf@node1()> cluster:config-block default +INBOUND: + whitelist: [*] + blacklist: [org.apache.karaf.cellar*, org.apache.karaf.shell, org.ops4j.pax.logging, org.ops4j.pax.web, org.apache.felix.fileinstall*, org.apache.karaf.management, org.apache.aries.transaction] +OUTBOUND: + whitelist: [*] + blacklist: [org.apache.karaf.cellar*, org.apache.karaf.shell, org.ops4j.pax.logging, org.ops4j.pax.web, org.apache.felix.fileinstall*, org.apache.karaf.management, org.apache.aries.transaction]</pre> +</div> +</div> +<div class="paragraph"> +<p>Using those commands, you can also update the blacklist and whitelist for inbound or outbound cluster events.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_obr_support">8. OBR Support</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Apache Karaf Cellar is able to "broadcast" OBR actions between cluster nodes of the same group.</p> +</div> +<div class="sect2"> +<h3 id="_enable_obr_support">8.1. Enable OBR support</h3> +<div class="paragraph"> +<p>To enable Cellar OBR support, the cellar-obr feature must first be installed:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> feature:install cellar-obr</pre> +</div> +</div> +<div class="paragraph"> +<p>The Cellar OBR feature will install the Karaf OBR feature which provides the OBR service (RepositoryAdmin).</p> +</div> +</div> +<div class="sect2"> +<h3 id="_register_repository_url_in_a_cluster">8.2. Register repository URL in a cluster</h3> +<div class="paragraph"> +<p>The <code>cluster:obr-add-url</code> command registers an OBR repository URL (repository.xml) in a cluster group:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:obr-add-url group file:///path/to/repository.xml +karaf@root()> cluster:obr-add-url group http://karaf.cave.host:9090/cave/repo-repository.xml</pre> +</div> +</div> +<div class="paragraph"> +<p>The OBR repository URLs are stored in a cluster distributed set. It allows new nodes to register the distributed URLs:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:obr-list-url group +file://path/to/repository.xml +http://karaf.cave.host:9090/cave/repo-repository.xml</pre> +</div> +</div> +<div class="paragraph"> +<p>When a repository is registered in the distributed OBR, Cave maintains a distributed set of bundles available on the +OBR of a cluster group:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> cluster:obr-list group +Name | Symbolic Name | Version +------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +Apache Aries JMX Blueprint Core | org.apache.aries.jmx.blueprint.core | 1.1.1.SNAPSHOT +Apache Karaf :: JAAS :: Command | org.apache.karaf.jaas.command | 2.3.6.SNAPSHOT +Apache Aries Proxy Service | org.apache.aries.proxy.impl | 1.0.3.SNAPSHOT +Apache Karaf :: System :: Shell Commands | org.apache.karaf.system.command | 3.0.2.SNAPSHOT +Apache Karaf :: JDBC :: Core | org.apache.karaf.jdbc.core | 3.0.2.SNAPSHOT +Apache Aries Example SPI Provider Bundle 1 | org.apache.aries.spifly.examples.provider1.bundle | 1.0.1.SNAPSHOT +Apache Aries Transaction Manager | org.apache.aries.transaction.manager | 1.1.1.SNAPSHOT +Apache Karaf :: Features :: Management | org.apache.karaf.features.management | 2.3.6.SNAPSHOT +Apache Aries Blueprint Sample Fragment for Testing Annotation | org.apache.aries.blueprint.sample-fragment | 1.0.1.SNAPSHOT +Apache Karaf :: Management :: MBeans :: OBR | org.apache.karaf.management.mbeans.obr | 2.3.6.SNAPSHOT
[... 519 lines stripped ...]
