Merge pull request #411 from hashicorp/sethvargo/more_website_updates
SEO and latest middleman goodness
This commit is contained in:
Seth Vargo
commit
9c12b95cb7
|
|
@ -1,6 +1,6 @@
|
||||||
GIT
|
GIT
|
||||||
remote: git://github.com/hashicorp/middleman-hashicorp.git
|
remote: git://github.com/hashicorp/middleman-hashicorp.git
|
||||||
revision: fe7d5bb4b04c408857dbe94345341cafcbc02de4
|
revision: dc9f2d6b986842622796a569bf9358f6f3e3f634
|
||||||
specs:
|
specs:
|
||||||
middleman-hashicorp (0.1.0)
|
middleman-hashicorp (0.1.0)
|
||||||
bootstrap-sass (~> 3.2)
|
bootstrap-sass (~> 3.2)
|
||||||
|
|
@ -29,7 +29,7 @@ GEM
|
||||||
builder (3.2.2)
|
builder (3.2.2)
|
||||||
celluloid (0.16.0)
|
celluloid (0.16.0)
|
||||||
timers (~> 4.0.0)
|
timers (~> 4.0.0)
|
||||||
chunky_png (1.3.1)
|
chunky_png (1.3.2)
|
||||||
coffee-script (2.3.0)
|
coffee-script (2.3.0)
|
||||||
coffee-script-source
|
coffee-script-source
|
||||||
execjs
|
execjs
|
||||||
|
|
@ -53,8 +53,8 @@ GEM
|
||||||
http_parser.rb (~> 0.6.0)
|
http_parser.rb (~> 0.6.0)
|
||||||
erubis (2.7.0)
|
erubis (2.7.0)
|
||||||
eventmachine (1.0.3)
|
eventmachine (1.0.3)
|
||||||
execjs (2.2.1)
|
execjs (2.2.2)
|
||||||
ffi (1.9.5)
|
ffi (1.9.6)
|
||||||
haml (4.0.5)
|
haml (4.0.5)
|
||||||
tilt
|
tilt
|
||||||
hike (1.2.3)
|
hike (1.2.3)
|
||||||
|
|
@ -113,11 +113,11 @@ GEM
|
||||||
rouge (~> 1.0)
|
rouge (~> 1.0)
|
||||||
minitest (5.4.2)
|
minitest (5.4.2)
|
||||||
multi_json (1.10.1)
|
multi_json (1.10.1)
|
||||||
padrino-helpers (0.12.3)
|
padrino-helpers (0.12.4)
|
||||||
i18n (~> 0.6, >= 0.6.7)
|
i18n (~> 0.6, >= 0.6.7)
|
||||||
padrino-support (= 0.12.3)
|
padrino-support (= 0.12.4)
|
||||||
tilt (~> 1.4.1)
|
tilt (~> 1.4.1)
|
||||||
padrino-support (0.12.3)
|
padrino-support (0.12.4)
|
||||||
activesupport (>= 3.1)
|
activesupport (>= 3.1)
|
||||||
rack (1.5.2)
|
rack (1.5.2)
|
||||||
rack-contrib (1.1.0)
|
rack-contrib (1.1.0)
|
||||||
|
|
@ -129,10 +129,10 @@ GEM
|
||||||
rb-fsevent (0.9.4)
|
rb-fsevent (0.9.4)
|
||||||
rb-inotify (0.9.5)
|
rb-inotify (0.9.5)
|
||||||
ffi (>= 0.5.0)
|
ffi (>= 0.5.0)
|
||||||
redcarpet (3.1.2)
|
redcarpet (3.2.0)
|
||||||
ref (1.0.5)
|
ref (1.0.5)
|
||||||
rouge (1.7.2)
|
rouge (1.7.2)
|
||||||
sass (3.4.5)
|
sass (3.4.6)
|
||||||
sprockets (2.12.2)
|
sprockets (2.12.2)
|
||||||
hike (~> 1.2)
|
hike (~> 1.2)
|
||||||
multi_json (~> 1.0)
|
multi_json (~> 1.0)
|
||||||
|
|
@ -157,7 +157,7 @@ GEM
|
||||||
hitimes
|
hitimes
|
||||||
tzinfo (1.2.2)
|
tzinfo (1.2.2)
|
||||||
thread_safe (~> 0.1)
|
thread_safe (~> 0.1)
|
||||||
uber (0.0.8)
|
uber (0.0.9)
|
||||||
uglifier (2.5.3)
|
uglifier (2.5.3)
|
||||||
execjs (>= 0.3.0)
|
execjs (>= 0.3.0)
|
||||||
json (>= 1.8.0)
|
json (>= 1.8.0)
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
# Configure Middleman
|
# Configure Middleman
|
||||||
#-------------------------------------------------------------------------
|
#-------------------------------------------------------------------------
|
||||||
|
|
||||||
|
set :base_url, "https://www.consul.io/"
|
||||||
|
|
||||||
activate :hashicorp do |h|
|
activate :hashicorp do |h|
|
||||||
h.version = '0.4.0'
|
h.version = '0.4.0'
|
||||||
h.bintray_repo = 'mitchellh/consul'
|
h.bintray_repo = 'mitchellh/consul'
|
||||||
|
|
|
||||||
|
|
@ -1 +1,5 @@
|
||||||
|
---
|
||||||
|
noindex: true
|
||||||
|
---
|
||||||
|
|
||||||
<h2>Page Not Found</h2>
|
<h2>Page Not Found</h2>
|
||||||
|
|
|
||||||
BIN
website/source/assets/fonts/league_gothic-webfont.eot (Stored with Git LFS)
BIN
website/source/assets/fonts/league_gothic-webfont.eot (Stored with Git LFS)
Binary file not shown.
|
|
@ -1,230 +0,0 @@
|
||||||
<?xml version="1.0" standalone="no"?>
|
|
||||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
|
|
||||||
<svg xmlns="http://www.w3.org/2000/svg">
|
|
||||||
<metadata></metadata>
|
|
||||||
<defs>
|
|
||||||
<font id="LeagueGothicRegular" horiz-adv-x="724" >
|
|
||||||
<font-face units-per-em="2048" ascent="1505" descent="-543" />
|
|
||||||
<missing-glyph horiz-adv-x="315" />
|
|
||||||
<glyph horiz-adv-x="0" />
|
|
||||||
<glyph horiz-adv-x="2048" />
|
|
||||||
<glyph unicode="
" horiz-adv-x="682" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="315" />
|
|
||||||
<glyph unicode="	" horiz-adv-x="315" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="315" />
|
|
||||||
<glyph unicode="!" horiz-adv-x="387" d="M74 1505h239l-55 -1099h-129zM86 0v227h215v-227h-215z" />
|
|
||||||
<glyph unicode=""" horiz-adv-x="329" d="M57 1505h215l-30 -551h-154z" />
|
|
||||||
<glyph unicode="#" horiz-adv-x="1232" d="M49 438l27 195h198l37 258h-196l26 194h197l57 420h197l-57 -420h260l57 420h197l-58 -420h193l-27 -194h-192l-37 -258h190l-26 -195h-191l-59 -438h-197l60 438h-261l-59 -438h-197l60 438h-199zM471 633h260l37 258h-260z" />
|
|
||||||
<glyph unicode="$" horiz-adv-x="692" d="M37 358l192 13q12 -186 129 -187q88 0 93 185q0 74 -61 175q-21 36 -34 53l-40 55q-28 38 -65.5 90t-70.5 101.5t-70.5 141.5t-37.5 170q4 293 215 342v131h123v-125q201 -23 235 -282l-192 -25q-14 129 -93 125q-80 -2 -84 -162q0 -102 94 -227l41 -59q30 -42 37 -52 t33 -48l37 -52q41 -57 68 -109l26 -55q43 -94 43 -186q-4 -338 -245 -369v-217h-123v221q-236 41 -250 352z" />
|
|
||||||
<glyph unicode="%" horiz-adv-x="1001" d="M55 911v437q0 110 82 156q33 18 90.5 18t97.5 -44t44 -87l4 -43v-437q0 -107 -81 -157q-32 -19 -77 -19q-129 0 -156 135zM158 0l553 1505h131l-547 -1505h-137zM178 911q-4 -55 37 -55q16 0 25.5 14.5t9.5 26.5v451q2 55 -35 55q-18 0 -27.5 -13.5t-9.5 -27.5v-451z M631 158v436q0 108 81 156q33 20 79 20q125 0 153 -135l4 -41v-436q0 -110 -80 -156q-32 -18 -90.5 -18t-98.5 43t-44 88zM754 158q-4 -57 37 -58q37 0 34 58v436q2 55 -34 55q-18 0 -27.5 -13t-9.5 -28v-450z" />
|
|
||||||
<glyph unicode="&" horiz-adv-x="854" d="M49 304q0 126 44 225.5t126 222.5q-106 225 -106 442v18q0 94 47 180q70 130 223 130q203 0 252 -215q14 -61 12 -113q0 -162 -205 -434q76 -174 148 -285q33 96 47 211l176 -33q-16 -213 -92 -358q55 -63 92 -76v-235q-23 0 -86 37.5t-123 101.5q-123 -139 -252 -139 t-216 97t-87 223zM263 325.5q1 -65.5 28.5 -107.5t78.5 -42t117 86q-88 139 -174 295q-18 -30 -34.5 -98t-15.5 -133.5zM305 1194q0 -111 55 -246q101 156 101 252q-2 2 0 15.5t-2 36t-11 42.5q-19 52 -61.5 52t-62 -38t-19.5 -75v-39z" />
|
|
||||||
<glyph unicode="'" horiz-adv-x="309" d="M45 1012l72 266h-72v227h215v-227l-113 -266h-102z" />
|
|
||||||
<glyph unicode="(" horiz-adv-x="561" d="M66 645q0 143 29.5 292.5t73.5 261.5q92 235 159 343l30 47l162 -84q-38 -53 -86.5 -148t-82.5 -189.5t-61.5 -238t-27.5 -284.5t26.5 -282.5t64.5 -240.5q80 -207 141 -296l26 -39l-162 -84q-41 61 -96 173t-94 217.5t-70.5 257t-31.5 294.5z" />
|
|
||||||
<glyph unicode=")" horiz-adv-x="561" d="M41 -213q36 50 85.5 147t83.5 190t61.5 236.5t27.5 284.5t-26.5 282.5t-64.5 240.5q-78 205 -140 298l-27 39l162 84q41 -61 96 -173.5t94 -217t71 -257.5t32 -296t-30 -292.5t-74 -260.5q-92 -233 -159 -342l-30 -47z" />
|
|
||||||
<glyph unicode="*" horiz-adv-x="677" d="M74 1251l43 148l164 -70l-19 176h154l-19 -176l164 70l43 -148l-172 -34l115 -138l-131 -80l-78 152l-76 -152l-131 80l115 138z" />
|
|
||||||
<glyph unicode="+" horiz-adv-x="1060" d="M74 649v172h370v346h172v-346h371v-172h-371v-346h-172v346h-370z" />
|
|
||||||
<glyph unicode="," horiz-adv-x="309" d="M45 0v227h215v-227l-113 -266h-102l72 266h-72z" />
|
|
||||||
<glyph unicode="-" horiz-adv-x="444" d="M74 455v194h297v-194h-297z" />
|
|
||||||
<glyph unicode="." horiz-adv-x="321" d="M53 0v227h215v-227h-215z" />
|
|
||||||
<glyph unicode="/" horiz-adv-x="720" d="M8 -147l543 1652h162l-537 -1652h-168z" />
|
|
||||||
<glyph unicode="0" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5l2 26v887q0 46 -19.5 78.5 t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887z" />
|
|
||||||
<glyph unicode="1" horiz-adv-x="475" d="M25 1180v141q129 25 205 130q16 21 30 54h133v-1505h-221v1180h-147z" />
|
|
||||||
<glyph unicode="2" horiz-adv-x="731" d="M55 0v219l39 62q25 39 88.5 152.5t112.5 220t91 241.5t44 238q0 184 -73.5 184t-73.5 -184v-105h-222v105q0 389 295 389t295 -375q0 -336 -346 -928h350v-219h-600z" />
|
|
||||||
<glyph unicode="3" horiz-adv-x="686" d="M45 1071q0 249 63 343q29 42 84.5 75t134.5 33t136 -31t84.5 -71t44.5 -92q22 -71 22 -130q0 -291 -108 -399q127 -100 127 -414q0 -68 -19.5 -145.5t-47 -128t-85 -89t-136.5 -38.5t-135 31.5t-86 75.5t-48 113q-23 91 -23 230h217q2 -150 17.5 -203t59.5 -53t56.5 50.5 t12.5 104.5t1 102t0 63q-6 82 -14 95l-18 33q-12 22 -29 29q-55 22 -108 25h-19v184q133 7 156 73q12 34 12 91v105q0 146 -29 177q-16 17 -40 17q-41 0 -52.5 -49t-13.5 -207h-217z" />
|
|
||||||
<glyph unicode="4" horiz-adv-x="684" d="M25 328v194l323 983h221v-983h103v-194h-103v-328h-202v328h-342zM213 522h154v516h-13z" />
|
|
||||||
<glyph unicode="5" horiz-adv-x="704" d="M74 438h221v-59q0 -115 14.5 -159t52 -44t53 45t15.5 156v336q0 111 -70 110q-33 0 -59.5 -40t-26.5 -70h-186v792h535v-219h-344v-313q74 55 127 51q78 0 133 -40t77 -100q35 -98 35 -171v-336q0 -393 -289 -393q-78 0 -133 29.5t-84.5 71.5t-46.5 109q-24 98 -24 244z " />
|
|
||||||
<glyph unicode="6" horiz-adv-x="700" d="M66 309v856q0 356 288.5 356.5t288.5 -356.5v-94h-221q0 162 -11.5 210t-53.5 48t-56 -37t-14 -127v-268q59 37 124.5 37t119 -36t75.5 -93q37 -92 37 -189v-307q0 -90 -42 -187q-26 -61 -89 -99.5t-157.5 -38.5t-158 38.5t-88.5 99.5q-42 98 -42 187zM287 244 q0 -20 17.5 -44t49 -24t50 24.5t18.5 43.5v450q0 18 -18.5 43t-49 25t-48 -20.5t-19.5 -41.5v-456z" />
|
|
||||||
<glyph unicode="7" horiz-adv-x="589" d="M8 1286v219h557v-221l-221 -1284h-229l225 1286h-332z" />
|
|
||||||
<glyph unicode="8" horiz-adv-x="696" d="M53 322v176q0 188 115 297q-102 102 -102 276v127q0 213 147 293q57 31 135 31t135.5 -31t84 -71t42.5 -93q21 -66 21 -129v-127q0 -174 -103 -276q115 -109 115 -297v-176q0 -222 -153 -306q-60 -32 -142 -32t-141.5 32.5t-88 73.5t-44.5 96q-21 69 -21 136zM269 422 q1 -139 16.5 -187.5t57.5 -48.5t59.5 30t21.5 71t4 158t-13.5 174t-66.5 57t-66.5 -57.5t-12.5 -196.5zM284 1116q-1 -123 11 -173t53 -50t53.5 50t12.5 170t-12.5 167t-51.5 47t-52 -44t-14 -167z" />
|
|
||||||
<glyph unicode="9" horiz-adv-x="700" d="M57 340v94h222q0 -162 11 -210t53 -48t56.5 37t14.5 127v283q-59 -37 -125 -37t-119 35.5t-76 92.5q-37 96 -37 189v293q0 87 43 188q25 60 88.5 99t157.5 39t157.5 -39t88.5 -99q43 -101 43 -188v-856q0 -356 -289 -356t-289 356zM279 825q0 -18 18 -42.5t49 -24.5 t48.5 20.5t19.5 40.5v443q0 20 -17.5 43.5t-49.5 23.5t-50 -24.5t-18 -42.5v-437z" />
|
|
||||||
<glyph unicode=":" horiz-adv-x="362" d="M74 0v227h215v-227h-215zM74 893v227h215v-227h-215z" />
|
|
||||||
<glyph unicode=";" horiz-adv-x="362" d="M74 0v227h215v-227l-113 -266h-102l71 266h-71zM74 893v227h215v-227h-215z" />
|
|
||||||
<glyph unicode="<" horiz-adv-x="1058" d="M74 649v160l911 475v-199l-698 -356l698 -356v-199z" />
|
|
||||||
<glyph unicode="=" horiz-adv-x="1058" d="M74 477v172h911v-172h-911zM74 864v172h911v-172h-911z" />
|
|
||||||
<glyph unicode=">" horiz-adv-x="1058" d="M74 174v199l698 356l-698 356v199l911 -475v-160z" />
|
|
||||||
<glyph unicode="?" horiz-adv-x="645" d="M25 1260q24 67 78 131q105 128 235 122q82 -2 138 -33.5t82 -81.5q46 -88 46 -170.5t-80 -219.5l-57 -96q-18 -32 -42 -106.5t-24 -143.5v-256h-190v256q0 102 24.5 195t48 140t65.5 118t50 105t-9 67.5t-60 34.5t-78 -48t-49 -98zM199 0h215v227h-215v-227z" />
|
|
||||||
<glyph unicode="@" horiz-adv-x="872" d="M66 303v889q0 97 73 200q39 56 117 93t184.5 37t184 -37t116.5 -93q74 -105 74 -200v-793h-164l-20 56q-14 -28 -46 -48t-67 -20q-145 0 -145 172v485q0 170 145 170q71 0 113 -67v45q0 51 -45 104.5t-145.5 53.5t-145.5 -53.5t-45 -104.5v-889q0 -53 44 -103t153.5 -50 t160.5 63l152 -86q-109 -143 -320 -143q-106 0 -184 35.5t-117 90.5q-73 102 -73 193zM535 573q0 -53 48 -53t48 53v455q0 53 -48 53t-48 -53v-455z" />
|
|
||||||
<glyph unicode="A" horiz-adv-x="765" d="M20 0l228 1505h270l227 -1505h-215l-41 307h-213l-40 -307h-216zM307 541h152l-64 475l-6 39h-12z" />
|
|
||||||
<glyph unicode="B" horiz-adv-x="745" d="M82 0v1505h194q205 0 304.5 -91t99.5 -308q0 -106 -29.5 -175t-107.5 -136q14 -5 47 -38.5t54 -71.5q52 -97 52 -259q0 -414 -342 -426h-272zM303 219q74 0 109 31q55 56 55 211t-63 195q-42 26 -93 26h-8v-463zM303 885q87 0 119 39q45 55 45 138t-14.5 124t-30.5 60.5 t-45 28.5q-35 11 -74 11v-401z" />
|
|
||||||
<glyph unicode="C" horiz-adv-x="708" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-207h-206v207q-2 0 0 11.5t-3.5 27.5t-12.5 33q-17 39 -68 39q-70 -10 -78 -111v-887q0 -43 21.5 -76.5t59.5 -33.5t59.5 27.5t21.5 56.5v233h206v-207q0 -42 -17 -106t-45 -107 t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175z" />
|
|
||||||
<glyph unicode="D" horiz-adv-x="761" d="M82 0v1505h174q270 0 346 -113q31 -46 50.5 -95.5t28.5 -139.5t12 -177t3 -228.5t-3 -228.5t-12 -176t-28.5 -138t-50.5 -95t-80 -68q-106 -46 -266 -46h-174zM303 221q117 0 140.5 78t23.5 399v111q0 322 -23.5 398.5t-140.5 76.5v-1063z" />
|
|
||||||
<glyph unicode="E" horiz-adv-x="628" d="M82 0v1505h506v-227h-285v-395h205v-242h-205v-414h285v-227h-506z" />
|
|
||||||
<glyph unicode="F" horiz-adv-x="616" d="M82 0v1505h526v-227h-305v-395h205v-228h-205v-655h-221z" />
|
|
||||||
<glyph unicode="G" horiz-adv-x="737" d="M67 271.5q0 26.5 1 37.5v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-231h-221v231q0 46 -19.5 78.5t-54 32.5t-53 -28t-18.5 -54l-2 -29v-905q0 -46 19.5 -78.5t54 -32.5t53 28t18.5 54l2 29v272h-88v187h309v-750h-131l-26 72 q-70 -88 -172 -88q-203 0 -250 213q-11 48 -11 74.5z" />
|
|
||||||
<glyph unicode="H" horiz-adv-x="778" d="M82 0v1505h221v-622h172v622h221v-1505h-221v655h-172v-655h-221z" />
|
|
||||||
<glyph unicode="I" horiz-adv-x="385" d="M82 0v1505h221v-1505h-221z" />
|
|
||||||
<glyph unicode="J" horiz-adv-x="423" d="M12 -14v217q4 0 12.5 -1t29 2t35.5 12t28.5 34.5t13.5 62.5v1192h221v-1226q0 -137 -74 -216q-74 -78 -223 -78h-4q-19 0 -39 1z" />
|
|
||||||
<glyph unicode="K" horiz-adv-x="768" d="M82 0v1505h221v-526h8l195 526h215l-203 -495l230 -1010h-216l-153 655l-6 31h-6l-64 -154v-532h-221z" />
|
|
||||||
<glyph unicode="L" horiz-adv-x="604" d="M82 0v1505h221v-1300h293v-205h-514z" />
|
|
||||||
<glyph unicode="M" horiz-adv-x="991" d="M82 0v1505h270l131 -688l11 -80h4l10 80l131 688h270v-1505h-204v1010h-13l-149 -1010h-94l-142 946l-8 64h-12v-1010h-205z" />
|
|
||||||
<glyph unicode="N" horiz-adv-x="808" d="M82 0v1505h197l215 -784l18 -70h12v854h203v-1505h-197l-215 784l-18 70h-12v-854h-203z" />
|
|
||||||
<glyph unicode="O" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5l2 26v887q0 46 -19.5 78.5 t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887z" />
|
|
||||||
<glyph unicode="P" horiz-adv-x="720" d="M82 0v1505h221q166 0 277.5 -105.5t111.5 -345t-111.5 -346t-277.5 -106.5v-602h-221zM303 827q102 0 134 45.5t32 175.5t-33 181t-133 51v-453z" />
|
|
||||||
<glyph unicode="Q" horiz-adv-x="729" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -94 -45 -182q33 -43 88 -53v-189q-160 0 -227 117q-55 -18 -125 -18t-130 33.5t-88 81.5q-55 94 -60 175zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5l2 26v887 q0 46 -19.5 78.5t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887z" />
|
|
||||||
<glyph unicode="R" horiz-adv-x="739" d="M82 0v1505h221q377 0 377 -434q0 -258 -123 -342l141 -729h-221l-115 635h-59v-635h-221zM303 840q117 0 149 98q15 49 15 125t-15.5 125t-45.5 68q-44 30 -103 30v-446z" />
|
|
||||||
<glyph unicode="S" horiz-adv-x="702" d="M37 422l217 20q0 -256 104 -256q90 0 91 166q0 59 -32 117.5t-45 79.5l-54 79q-40 58 -77 113t-73.5 117t-68 148.5t-31.5 162.5q0 139 71.5 245t216.5 108h10q88 0 152 -36t94 -100q54 -120 54 -264l-217 -20q0 217 -89 217q-75 -2 -75 -146q0 -59 23 -105 q32 -66 58 -104l197 -296q31 -49 67 -139.5t36 -166.5q0 -378 -306 -378h-2q-229 0 -290 188q-31 99 -31 250z" />
|
|
||||||
<glyph unicode="T" horiz-adv-x="647" d="M4 1278v227h639v-227h-209v-1278h-221v1278h-209z" />
|
|
||||||
<glyph unicode="U" horiz-adv-x="749" d="M80 309v1196h221v-1196q0 -46 19.5 -78t54.5 -32t53 27.5t18 56.5l3 26v1196h221v-1196q0 -42 -17.5 -106t-45 -107t-88 -77.5t-144.5 -34.5t-144.5 33.5t-88.5 81.5q-55 97 -60 175z" />
|
|
||||||
<glyph unicode="V" horiz-adv-x="716" d="M18 1505h215l111 -827l8 -64h13l118 891h215l-229 -1505h-221z" />
|
|
||||||
<glyph unicode="W" horiz-adv-x="1036" d="M25 1505h204l88 -782l5 -49h16l100 831h160l100 -831h17l92 831h205l-203 -1505h-172l-115 801h-8l-115 -801h-172z" />
|
|
||||||
<glyph unicode="X" horiz-adv-x="737" d="M16 0l244 791l-240 714h218l120 -381l7 -18h8l127 399h217l-240 -714l244 -791h-217l-127 449l-4 18h-8l-132 -467h-217z" />
|
|
||||||
<glyph unicode="Y" horiz-adv-x="700" d="M14 1505h217l111 -481l6 -14h4l6 14l111 481h217l-225 -864v-641h-221v641z" />
|
|
||||||
<glyph unicode="Z" horiz-adv-x="626" d="M20 0v238l347 1048h-297v219h536v-219l-352 -1067h352v-219h-586z" />
|
|
||||||
<glyph unicode="[" horiz-adv-x="538" d="M82 -213v1718h399v-196h-202v-1325h202v-197h-399z" />
|
|
||||||
<glyph unicode="\" horiz-adv-x="792" d="M8 1692h162l614 -1872h-168z" />
|
|
||||||
<glyph unicode="]" horiz-adv-x="538" d="M57 -16h203v1325h-203v196h400v-1718h-400v197z" />
|
|
||||||
<glyph unicode="^" horiz-adv-x="1101" d="M53 809l381 696h234l381 -696h-199l-299 543l-299 -543h-199z" />
|
|
||||||
<glyph unicode="_" horiz-adv-x="1210" d="M74 -154h1063v-172h-1063v172z" />
|
|
||||||
<glyph unicode="`" horiz-adv-x="1024" d="M293 1489h215l106 -184h-159z" />
|
|
||||||
<glyph unicode="a" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM252 291 q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250z" />
|
|
||||||
<glyph unicode="b" horiz-adv-x="686" d="M82 0v1505h207v-458q88 90 165 90t117.5 -69t40.5 -150v-715q0 -82 -41 -150.5t-118 -68.5q-33 0 -74 22.5t-66 44.5l-24 23v-74h-207zM289 246q0 -29 19.5 -48.5t42 -19.5t39 19.5t16.5 48.5v628q0 29 -16.5 48.5t-39 19.5t-42 -21.5t-19.5 -46.5v-628z" />
|
|
||||||
<glyph unicode="c" horiz-adv-x="645" d="M66 315v490q0 332 264 332q137 0 201.5 -71t64.5 -251v-88h-207v135q0 51 -12 70.5t-47 19.5q-58 0 -58 -90v-604q0 -90 58 -90q35 0 47 19.5t12 70.5v156h207v-109q0 -180 -64.5 -250.5t-201.5 -70.5q-264 0 -264 331z" />
|
|
||||||
<glyph unicode="d" horiz-adv-x="686" d="M74 203v715q0 82 41 150.5t118 68.5q33 0 74 -22.5t66 -45.5l24 -22v458h207v-1505h-207v74q-88 -90 -165 -90t-117.5 68.5t-40.5 150.5zM281 246q0 -29 16 -48.5t38.5 -19.5t42 19.5t19.5 48.5v628q0 25 -19.5 46.5t-42 21.5t-38.5 -19.5t-16 -48.5v-628z" />
|
|
||||||
<glyph unicode="e" horiz-adv-x="659" d="M66 279v563q0 36 16 94.5t42 97.5t81 71t129 32q199 0 252 -197q14 -51 14 -92v-326h-342v-256q0 -59 39 -88q16 -12 37 -12q70 10 74 113v122h192v-129q0 -37 -16.5 -93t-41 -95t-79.5 -69.5t-130 -30.5t-130.5 30.5t-80.5 73.5q-49 87 -54 160zM258 684h150v158 q0 48 -19.5 81t-53.5 33t-53.5 -28.5t-21.5 -57.5l-2 -28v-158z" />
|
|
||||||
<glyph unicode="f" horiz-adv-x="475" d="M20 934v186h105v31q0 190 51 270q23 35 71 63.5t115 28.5l97 -14v-178q-27 8 -62 8q-65 0 -65 -175v-5v-29h104v-186h-104v-934h-207v934h-105z" />
|
|
||||||
<glyph unicode="g" horiz-adv-x="700" d="M12 -184q0 94 162 170q-125 35 -125 149q0 45 40 93t89 75q-51 35 -80.5 95.5t-34.5 105.5l-4 43v305q0 35 16.5 91t41 94t79 69t126.5 31q135 0 206 -103q102 102 170 103v-185q-72 0 -120 -24l10 -70v-317q0 -37 -17.5 -90.5t-42 -90t-79 -66.5t-104.5 -30t-62 2 q-29 -25 -29 -46t11 -33.5t42 -20.5t45.5 -10t65.5 -10.5t95 -21.5t89 -41q96 -60 96 -205t-103 -212q-100 -65 -250 -65h-9q-156 2 -240 50t-84 165zM213 -150q0 -77 132 -77h3q59 0 108.5 19t49.5 54t-20.5 52.5t-90.5 29.5l-106 21q-76 -43 -76 -99zM262 509 q0 -17 15.5 -45t44.5 -28q63 6 63 101v307q-2 0 0 10q1 3 1 7q0 8 -3 19q-4 15 -9 30q-11 36 -46 36t-50.5 -25.5t-15.5 -52.5v-359z" />
|
|
||||||
<glyph unicode="h" horiz-adv-x="690" d="M82 0v1505h207v-479l32 32q79 79 145.5 79t106 -69t39.5 -150v-918h-206v887q-1 49 -50 49q-41 0 -67 -53v-883h-207z" />
|
|
||||||
<glyph unicode="i" horiz-adv-x="370" d="M82 0v1120h207v-1120h-207zM82 1298v207h207v-207h-207z" />
|
|
||||||
<glyph unicode="j" horiz-adv-x="364" d="M-45 -182q29 -8 57 -8q64 0 64 142v1168h207v-1149q0 -186 -51 -266q-23 -35 -71 -62.5t-115 -27.5t-91 12v191zM76 1298v207h207v-207h-207z" />
|
|
||||||
<glyph unicode="k" horiz-adv-x="641" d="M82 0v1505h207v-714h10l113 329h186l-149 -364l188 -756h-199l-102 453l-4 16h-10l-33 -82v-387h-207z" />
|
|
||||||
<glyph unicode="l" horiz-adv-x="370" d="M82 0v1505h207v-1505h-207z" />
|
|
||||||
<glyph unicode="m" horiz-adv-x="1021" d="M82 0v1120h207v-94q2 0 33 30q80 81 139 81q100 0 139 -125q125 125 194.5 125t109.5 -69t40 -150v-918h-194v887q-1 49 -56 49q-41 0 -78 -53v-883h-194v887q0 49 -55 49q-41 0 -78 -53v-883h-207z" />
|
|
||||||
<glyph unicode="n" horiz-adv-x="690" d="M82 0v1120h207v-94l32 32q79 79 145.5 79t106 -69t39.5 -150v-918h-206v887q-1 49 -50 49q-41 0 -67 -53v-883h-207z" />
|
|
||||||
<glyph unicode="o" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t129.5 32q199 0 252 -197q14 -51 14 -92v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-129 -30.5t-130 30.5t-80.5 73.5q-52 92 -52 160zM257 259q0 -17 9 -44q18 -49 62 -49q70 10 71 113v563l1 19q0 19 -10 45q-18 50 -62 50 q-68 -10 -70 -114v-563q1 -1 1 -4z" />
|
|
||||||
<glyph unicode="p" horiz-adv-x="686" d="M82 -385v1505h207v-73q88 90 165 90t117.5 -69t40.5 -150v-715q0 -82 -41 -150.5t-118 -68.5q-33 0 -74 22.5t-66 44.5l-24 23v-459h-207zM289 246q0 -25 19.5 -46.5t42 -21.5t39 19.5t16.5 48.5v628q0 29 -16.5 48.5t-39 19.5t-42 -19.5t-19.5 -48.5v-628z" />
|
|
||||||
<glyph unicode="q" horiz-adv-x="686" d="M74 203v715q0 82 41 150.5t118 68.5q33 0 74 -22.5t66 -45.5l24 -22v73h207v-1505h-207v459q-88 -90 -165 -90t-117.5 68.5t-40.5 150.5zM281 246q0 -29 16 -48.5t38.5 -19.5t42 21.5t19.5 46.5v628q0 29 -19.5 48.5t-42 19.5t-38.5 -19.5t-16 -48.5v-628z" />
|
|
||||||
<glyph unicode="r" horiz-adv-x="503" d="M82 0v1120h207v-125q8 41 58.5 91.5t148.5 50.5v-230q-34 11 -77 11t-86.5 -39t-43.5 -101v-778h-207z" />
|
|
||||||
<glyph unicode="s" horiz-adv-x="630" d="M37 326h192q0 -170 97 -170q71 0 71 131q0 78 -129 202q-68 66 -98.5 99t-64 101.5t-33.5 134t12 114.5t39 95q59 100 201 104h11q161 0 211 -105q42 -86 42 -198h-193q0 131 -67 131q-63 -2 -64 -131q0 -33 23.5 -73t45 -62.5t66.5 -65.5q190 -182 191 -342 q0 -123 -64.5 -215t-199.5 -92q-197 0 -260 170q-29 76 -29 172z" />
|
|
||||||
<glyph unicode="t" horiz-adv-x="501" d="M20 934v186h105v277h207v-277h141v-186h-141v-557q0 -184 65 -184l76 8v-203q-45 -14 -112 -14t-114.5 28.5t-70 64.5t-34.5 96q-17 79 -17 187v574h-105z" />
|
|
||||||
<glyph unicode="u" horiz-adv-x="690" d="M78 203v917h207v-887q0 -49 49 -49q41 0 67 54v882h207v-1120h-207v94l-31 -32q-78 -78 -145.5 -78t-107 68.5t-39.5 150.5z" />
|
|
||||||
<glyph unicode="v" horiz-adv-x="602" d="M16 1120h201l68 -649l8 -72h16l76 721h201l-183 -1120h-204z" />
|
|
||||||
<glyph unicode="w" horiz-adv-x="905" d="M20 1120h189l65 -585l9 -64h12l96 649h123l86 -585l10 -64h13l73 649h189l-166 -1120h-172l-80 535l-10 63h-8l-91 -598h-172z" />
|
|
||||||
<glyph unicode="x" horiz-adv-x="618" d="M16 0l193 578l-176 542h194l74 -262l6 -31h4l6 31l74 262h195l-176 -542l192 -578h-201l-84 283l-6 30h-4l-6 -30l-84 -283h-201z" />
|
|
||||||
<glyph unicode="y" horiz-adv-x="634" d="M25 1120h202l82 -688l4 -57h9l4 57l82 688h202l-198 -1204q-16 -127 -94 -222t-193 -95l-92 4v184q16 -4 49 -4q61 6 97 61.5t36 122.5z" />
|
|
||||||
<glyph unicode="z" horiz-adv-x="532" d="M12 0v168l285 764h-240v188h459v-168l-285 -764h285v-188h-504z" />
|
|
||||||
<glyph unicode="{" horiz-adv-x="688" d="M61 453v163q72 0 102 49.5t30 90.5v397q0 223 96 298t342 71v-172q-135 2 -188.5 -38t-53.5 -159v-397q0 -143 -127 -221q127 -82 127 -222v-397q0 -119 53.5 -159t188.5 -38v-172q-246 -4 -342 71t-96 298v397q0 57 -41 97.5t-91 42.5z" />
|
|
||||||
<glyph unicode="|" horiz-adv-x="356" d="M82 -512v2204h192v-2204h-192z" />
|
|
||||||
<glyph unicode="}" horiz-adv-x="688" d="M57 -281q135 -2 188.5 38t53.5 159v397q0 139 127 222q-127 78 -127 221v397q0 119 -53 159t-189 38v172q246 4 342.5 -71t96.5 -298v-397q0 -63 41 -101.5t90 -38.5v-163q-72 -4 -101.5 -52.5t-29.5 -87.5v-397q0 -223 -96.5 -298t-342.5 -71v172z" />
|
|
||||||
<glyph unicode="~" horiz-adv-x="1280" d="M113 1352q35 106 115 200q34 41 94.5 74t121 33t116.5 -18.5t82 -33t83 -51.5q106 -72 174 -71q109 0 178 153l13 29l135 -57q-63 -189 -206 -276q-56 -34 -120 -34q-121 0 -272 101q-115 74 -178.5 74t-113.5 -45.5t-69 -90.5l-18 -45z" />
|
|
||||||
<glyph unicode="¡" horiz-adv-x="387" d="M74 -385l55 1100h129l55 -1100h-239zM86 893v227h215v-227h-215z" />
|
|
||||||
<glyph unicode="¢" horiz-adv-x="636" d="M66 508v489q0 297 208 328v242h123v-244q98 -16 144.5 -88t46.5 -227v-88h-189v135q0 90 -72.5 90t-72.5 -90v-604q0 -90 72 -91q74 0 73 91v155h189v-108q0 -156 -46 -228.5t-145 -89.5v-303h-123v301q-209 31 -208 330z" />
|
|
||||||
<glyph unicode="£" horiz-adv-x="817" d="M4 63q8 20 23.5 53.5t70 91.5t117.5 68q37 111 37 189t-31 184h-188v137h147l-6 21q-78 254 -78 333t15.5 140t48.5 116q72 122 231 126q190 4 267 -126q65 -108 65 -276h-213q0 201 -115 197q-47 -2 -68.5 -51t-21.5 -139.5t70 -315.5l6 -25h211v-137h-174 q25 -100 24.5 -189t-57.5 -204q16 -8 44 -24q59 -35 89 -35q74 4 82 190l188 -22q-12 -182 -81.5 -281.5t-169.5 -99.5q-51 0 -143.5 51t-127.5 51t-63.5 -25.5t-40.5 -52.5l-12 -24z" />
|
|
||||||
<glyph unicode="¥" horiz-adv-x="720" d="M25 1505h217l110 -481l6 -14h4l7 14l110 481h217l-196 -753h147v-138h-176v-137h176v-137h-176v-340h-221v340h-176v137h176v137h-176v138h147z" />
|
|
||||||
<glyph unicode="¨" horiz-adv-x="1024" d="M272 1305v200h191v-200h-191zM561 1305v200h191v-200h-191z" />
|
|
||||||
<glyph unicode="©" horiz-adv-x="1644" d="M53 751.5q0 317.5 225.5 544t543 226.5t543.5 -226.5t226 -544t-226 -542.5t-543.5 -225t-543 225t-225.5 542.5zM172 751.5q0 -266.5 191.5 -458t457.5 -191.5t459 191.5t193 459t-191.5 459t-459 191.5t-459 -192.5t-191.5 -459zM627 487v531q0 122 97 174q40 22 95 22 q147 0 182 -147l7 -49v-125h-138v142q0 11 -12 28.5t-37 17.5q-47 -2 -49 -63v-531q0 -63 49 -63q53 2 49 63v125h138v-125q0 -68 -40 -127q-18 -26 -57 -47.5t-108.5 -21.5t-117.5 49t-54 98z" />
|
|
||||||
<glyph unicode="ª" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM252 291 q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250z" />
|
|
||||||
<glyph unicode="­" horiz-adv-x="444" d="M74 455v194h297v-194h-297z" />
|
|
||||||
<glyph unicode="®" horiz-adv-x="1644" d="M53 751.5q0 317.5 225.5 544t543 226.5t543.5 -226.5t226 -544t-226 -542.5t-543.5 -225t-543 225t-225.5 542.5zM172 751.5q0 -266.5 191.5 -458t457.5 -191.5t459 191.5t193 459t-191.5 459t-459 191.5t-459 -192.5t-191.5 -459zM625 313v879h196q231 0 232 -258 q0 -76 -16.5 -125t-71.5 -96l106 -400h-151l-95 365h-55v-365h-145zM770 805h45q43 0 65.5 21.5t27.5 45t5 61.5t-5 62.5t-27.5 46t-65.5 21.5h-45v-258z" />
|
|
||||||
<glyph unicode="¯" horiz-adv-x="1024" d="M313 1315v162h398v-162h-398z" />
|
|
||||||
<glyph unicode="²" horiz-adv-x="731" d="M55 0v219l39 62q25 39 88.5 152.5t112.5 220t91 241.5t44 238q0 184 -73.5 184t-73.5 -184v-105h-222v105q0 389 295 389t295 -375q0 -336 -346 -928h350v-219h-600z" />
|
|
||||||
<glyph unicode="³" horiz-adv-x="686" d="M45 1071q0 249 63 343q29 42 84.5 75t134.5 33t136 -31t84.5 -71t44.5 -92q22 -71 22 -130q0 -291 -108 -399q127 -100 127 -414q0 -68 -19.5 -145.5t-47 -128t-85 -89t-136.5 -38.5t-135 31.5t-86 75.5t-48 113q-23 91 -23 230h217q2 -150 17.5 -203t59.5 -53t56.5 50.5 t12.5 104.5t1 102t0 63q-6 82 -14 95l-18 33q-12 22 -29 29q-55 22 -108 25h-19v184q133 7 156 73q12 34 12 91v105q0 146 -29 177q-16 17 -40 17q-41 0 -52.5 -49t-13.5 -207h-217z" />
|
|
||||||
<glyph unicode="´" horiz-adv-x="1024" d="M410 1305l106 184h215l-162 -184h-159z" />
|
|
||||||
<glyph unicode="·" horiz-adv-x="215" d="M0 649v228h215v-228h-215z" />
|
|
||||||
<glyph unicode="¸" horiz-adv-x="1024" d="M426 -111h172v-141l-45 -133h-104l40 133h-63v141z" />
|
|
||||||
<glyph unicode="¹" horiz-adv-x="475" d="M25 1180v141q129 25 205 130q16 21 30 54h133v-1505h-221v1180h-147z" />
|
|
||||||
<glyph unicode="º" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t129.5 32q199 0 252 -197q14 -51 14 -92v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-129 -30.5t-130 30.5t-80.5 73.5q-52 92 -52 160zM257 259q0 -17 9 -44q18 -49 62 -49q70 10 71 113v563l1 19q0 19 -10 45q-18 50 -62 50 q-68 -10 -70 -114v-563q1 -1 1 -4z" />
|
|
||||||
<glyph unicode="¿" horiz-adv-x="645" d="M41 -106q0 82 80 219l57 95q18 32 42 106.5t24 144.5v256h190v-256q0 -102 -24.5 -195.5t-48 -140.5t-65.5 -118t-50 -104.5t9 -67.5t60 -35t78 48.5t49 98.5l179 -84q-24 -66 -78 -132q-104 -126 -236 -122q-163 4 -220 115q-46 90 -46 172zM231 893v227h215v-227h-215z " />
|
|
||||||
<glyph unicode="À" horiz-adv-x="765" d="M20 0l228 1505h270l227 -1505h-215l-41 307h-213l-40 -307h-216zM141 1823h215l107 -185h-160zM307 541h152l-64 475l-6 39h-12z" />
|
|
||||||
<glyph unicode="Á" horiz-adv-x="765" d="M20 0l228 1505h270l227 -1505h-215l-41 307h-213l-40 -307h-216zM293 1638l106 185h215l-161 -185h-160zM307 541h152l-64 475l-6 39h-12z" />
|
|
||||||
<glyph unicode="Â" horiz-adv-x="765" d="M20 0l228 1505h270l227 -1505h-215l-41 307h-213l-40 -307h-216zM133 1638l141 185h220l141 -185h-189l-63 72l-61 -72h-189zM307 541h152l-64 475l-6 39h-12z" />
|
|
||||||
<glyph unicode="Ã" horiz-adv-x="765" d="M20 0l228 1505h270l227 -1505h-215l-41 307h-213l-40 -307h-216zM184 1632v152q49 39 95.5 39t104.5 -18.5t100.5 -19.5t97.5 32v-152q-51 -39 -95.5 -39t-102.5 19.5t-98 19.5t-102 -33zM307 541h152l-64 475l-6 39h-12z" />
|
|
||||||
<glyph unicode="Ä" horiz-adv-x="765" d="M20 0l228 1505h270l227 -1505h-215l-41 307h-213l-40 -307h-216zM143 1638v201h191v-201h-191zM307 541h152l-64 475l-6 39h-12zM432 1638v201h191v-201h-191z" />
|
|
||||||
<glyph unicode="Å" horiz-adv-x="765" d="M20 0l228 1505h270l227 -1505h-215l-41 307h-213l-40 -307h-216zM231 1761.5q0 61.5 45.5 102.5t109 41t107.5 -41t44 -102.5t-44 -102.5t-107.5 -41t-109 41t-45.5 102.5zM307 541h152l-64 475l-6 39h-12zM309 1761.5q0 -28.5 23.5 -50t52.5 -21.5t52.5 21.5t23.5 50 t-23.5 50t-52.5 21.5t-52.5 -21.5t-23.5 -50z" />
|
|
||||||
<glyph unicode="Æ" horiz-adv-x="1099" d="M16 0l420 1505h623v-227h-285v-395h205v-242h-205v-414h285v-227h-506v307h-227l-90 -307h-220zM393 541h160v514h-10z" />
|
|
||||||
<glyph unicode="Ç" horiz-adv-x="708" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-207h-206v207q-2 0 0 11.5t-3.5 27.5t-12.5 33q-17 39 -68 39q-70 -10 -78 -111v-887q0 -43 21.5 -76.5t59.5 -33.5t59.5 27.5t21.5 56.5v233h206v-207q0 -42 -17 -106t-45 -107 t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM268 -111v-141h64l-41 -133h104l45 133v141h-172z" />
|
|
||||||
<glyph unicode="È" horiz-adv-x="628" d="M82 0v1505h506v-227h-285v-395h205v-242h-205v-414h285v-227h-506zM111 1823h215l106 -185h-160z" />
|
|
||||||
<glyph unicode="É" horiz-adv-x="628" d="M82 0v1505h506v-227h-285v-395h205v-242h-205v-414h285v-227h-506zM236 1638l106 185h215l-162 -185h-159z" />
|
|
||||||
<glyph unicode="Ê" horiz-adv-x="628" d="M82 0v1505h506v-227h-285v-395h205v-242h-205v-414h285v-227h-506zM84 1638l141 185h219l142 -185h-189l-63 72l-62 -72h-188z" />
|
|
||||||
<glyph unicode="Ë" horiz-adv-x="628" d="M82 0v1505h506v-227h-285v-395h205v-242h-205v-414h285v-227h-506zM94 1638v201h191v-201h-191zM383 1638v201h190v-201h-190z" />
|
|
||||||
<glyph unicode="Ì" horiz-adv-x="401" d="M-6 1823h215l106 -185h-159zM98 0v1505h221v-1505h-221z" />
|
|
||||||
<glyph unicode="Í" horiz-adv-x="401" d="M82 0v1505h221v-1505h-221zM86 1638l107 185h215l-162 -185h-160z" />
|
|
||||||
<glyph unicode="Î" horiz-adv-x="370" d="M-66 1638l142 185h219l141 -185h-188l-64 72l-61 -72h-189zM74 0v1505h221v-1505h-221z" />
|
|
||||||
<glyph unicode="Ï" horiz-adv-x="372" d="M-53 1638v201h190v-201h-190zM76 0v1505h221v-1505h-221zM236 1638v201h190v-201h-190z" />
|
|
||||||
<glyph unicode="Ð" horiz-adv-x="761" d="M20 655v228h62v622h174q270 0 346 -113q31 -46 50.5 -95.5t28.5 -139.5t12 -177t3 -228.5t-3 -228.5t-12 -176t-28.5 -138t-50.5 -95t-80 -68q-106 -46 -266 -46h-174v655h-62zM303 221q117 0 141.5 81t22.5 452q2 371 -22.5 450.5t-141.5 79.5v-401h84v-228h-84v-434z " />
|
|
||||||
<glyph unicode="Ñ" horiz-adv-x="808" d="M82 0v1505h197l215 -784l18 -70h12v854h203v-1505h-197l-215 784l-18 70h-12v-854h-203zM207 1632v152q49 39 95 39t104.5 -18.5t102.5 -19.5t95 32v-152q-51 -39 -95 -39t-102.5 19.5t-100 19.5t-99.5 -33z" />
|
|
||||||
<glyph unicode="Ò" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM121 1823h215l106 -185h-159zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5 l2 26v887q0 46 -19.5 78.5t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887z" />
|
|
||||||
<glyph unicode="Ó" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM285 1638l106 185h215l-162 -185h-159zM289 309q0 -46 19.5 -78t54 -32t53 27.5 t18.5 56.5l2 26v887q0 46 -19.5 78.5t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887z" />
|
|
||||||
<glyph unicode="Ô" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM113 1638l141 185h219l141 -185h-188l-64 72l-61 -72h-188zM289 309q0 -46 19.5 -78 t54 -32t53 27.5t18.5 56.5l2 26v887q0 46 -19.5 78.5t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887z" />
|
|
||||||
<glyph unicode="Õ" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM164 1632v152q49 39 95 39t104.5 -18.5t102.5 -19.5t95 32v-152q-51 -39 -95 -39 t-102.5 19.5t-100 19.5t-99.5 -33zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5l2 26v887q0 46 -19.5 78.5t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887z" />
|
|
||||||
<glyph unicode="Ö" d="M68 309v887q0 42 17 106t45 107t88.5 78t144 35t144 -34t88.5 -81q55 -93 60 -178l2 -33v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-144 -34.5t-144 33.5t-88.5 81.5q-55 94 -60 175zM123 1638v201h190v-201h-190zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5 l2 26v887q0 46 -19.5 78.5t-54 32.5t-53 -28t-18.5 -54l-2 -29v-887zM412 1638v201h190v-201h-190z" />
|
|
||||||
<glyph unicode="Ø" d="M59 -20l47 157q-36 74 -36 148l-2 24v887q0 42 17 106t45 107t88.5 78t148 35t153.5 -43l15 47h122l-45 -150q43 -84 43 -155l2 -25v-887q0 -42 -17 -106t-45 -107t-88.5 -77.5t-150.5 -34.5t-153 43l-15 -47h-129zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5 l2 26v488zM289 727l147 479q-8 100 -74 101q-35 0 -53 -28t-18 -54l-2 -29v-469z" />
|
|
||||||
<glyph unicode="Ù" horiz-adv-x="749" d="M80 309q0 -42 17.5 -106t45 -107t88 -77.5t144.5 -34.5t144.5 33.5t88.5 81.5q55 97 60 175l2 35v1196h-221v-1196q0 -44 -19.5 -77t-54.5 -33t-53.5 27.5t-18.5 56.5l-2 26v1196h-221v-1196zM145 1823h215l107 -185h-160z" />
|
|
||||||
<glyph unicode="Ú" horiz-adv-x="749" d="M80 309q0 -42 17.5 -106t45 -107t88 -77.5t144.5 -34.5t144.5 33.5t88.5 81.5q55 97 60 175l2 35v1196h-221v-1196q0 -44 -19.5 -77t-54.5 -33t-53.5 27.5t-18.5 56.5l-2 26v1196h-221v-1196zM307 1638l107 185h215l-162 -185h-160z" />
|
|
||||||
<glyph unicode="Û" horiz-adv-x="749" d="M80 309q0 -42 17.5 -106t45 -107t88 -77.5t144.5 -34.5t144.5 33.5t88.5 81.5q55 97 60 175l2 35v1196h-221v-1196q0 -44 -19.5 -77t-54.5 -33t-53.5 27.5t-18.5 56.5l-2 26v1196h-221v-1196zM125 1638l141 185h219l142 -185h-189l-63 72l-62 -72h-188z" />
|
|
||||||
<glyph unicode="Ü" horiz-adv-x="749" d="M80 309v1196h221v-1196q0 -46 19.5 -78t54.5 -32t53 27.5t18 56.5l3 26v1196h221v-1196q0 -42 -17.5 -106t-45 -107t-88 -77.5t-144.5 -34.5t-144.5 33.5t-88.5 81.5q-55 97 -60 175zM135 1638v201h191v-201h-191zM424 1638v201h190v-201h-190z" />
|
|
||||||
<glyph unicode="Ý" horiz-adv-x="704" d="M16 1505l226 -864v-641h221v641l225 864h-217l-111 -481l-6 -14h-4l-6 14l-111 481h-217zM254 1638l106 185h215l-161 -185h-160z" />
|
|
||||||
<glyph unicode="Þ" d="M82 0v1505h219v-241h2q166 0 277.5 -105.5t111.5 -345.5t-111.5 -346.5t-277.5 -106.5v-360h-221zM303 586q102 0 134 45t32 175t-33 181t-133 51v-452z" />
|
|
||||||
<glyph unicode="ß" horiz-adv-x="733" d="M66 0v1235q0 123 70.5 205t206.5 82t204.5 -81t68.5 -197t-88 -181q152 -88 152 -488q0 -362 -87 -475q-46 -59 -102.5 -79.5t-144.5 -20.5v193q45 0 70 25q57 57 57 357q0 316 -57 377q-25 27 -70 27v141q35 0 60.5 33t25.5 84q0 100 -86 100q-74 0 -74 -102v-1235h-206 z" />
|
|
||||||
<glyph unicode="à" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM102 1489h215 l107 -184h-160zM252 291q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250z" />
|
|
||||||
<glyph unicode="á" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM252 291 q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250zM264 1305l107 184h215l-162 -184h-160z" />
|
|
||||||
<glyph unicode="â" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM90 1305 l141 184h220l141 -184h-189l-63 71l-61 -71h-189zM252 291q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250z" />
|
|
||||||
<glyph unicode="ã" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM143 1305v151 q49 39 95.5 39t104.5 -18.5t97 -19.5t101 32v-152q-51 -39 -95.5 -39t-102.5 19.5t-99 19.5t-101 -32zM252 291q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250z" />
|
|
||||||
<glyph unicode="ä" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM102 1305v200 h191v-200h-191zM252 291q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250zM391 1305v200h191v-200h-191z" />
|
|
||||||
<glyph unicode="å" horiz-adv-x="681" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t190 88t184.5 -74t75 -180v-688q0 -109 14 -195h-202q-18 20 -19 90h-14q-20 -37 -65.5 -71.5t-102.5 -34.5t-110.5 60t-53.5 191zM188 1421.5 q0 61.5 45.5 102.5t109 41t107.5 -41t44 -102.5t-44 -102.5t-107.5 -41t-109 41t-45.5 102.5zM252 291q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250zM266 1421.5q0 -28.5 23.5 -50t52.5 -21.5t52.5 21.5t23.5 50t-23.5 50t-52.5 21.5t-52.5 -21.5 t-23.5 -50z" />
|
|
||||||
<glyph unicode="æ" horiz-adv-x="989" d="M49 235q0 131 34 212t83 124t98 73t88 50.5t43 36.5v123q0 102 -57 102q-41 0 -50 -42t-9 -84v-39h-207v47q0 123 80.5 211t197.5 88q84 0 152 -52q66 51 162 52q199 0 251 -197q14 -51 15 -92v-326h-342v-256q0 -60 38 -88q17 -12 38 -12q70 10 73 113v122h193v-129 q0 -37 -16.5 -93t-41 -95t-80 -69.5t-130.5 -30.5q-158 0 -226 131q-102 -131 -221 -131q-59 0 -112.5 60t-53.5 191zM252 291q0 -104 57 -105q35 0 60.5 19.5t25.5 48.5v287q-143 -62 -143 -250zM588 684h149v158q0 48 -19.5 81t-53 33t-53 -28.5t-21.5 -57.5l-2 -28v-158z " />
|
|
||||||
<glyph unicode="ç" horiz-adv-x="645" d="M66 315v490q0 332 264 332q137 0 201.5 -71t64.5 -251v-88h-207v135q0 51 -12 70.5t-47 19.5q-58 0 -58 -90v-604q0 -90 58 -90q35 0 47 19.5t12 70.5v156h207v-109q0 -180 -64.5 -250.5t-201.5 -70.5q-264 0 -264 331zM238 -111v-141h63l-41 -133h105l45 133v141h-172z " />
|
|
||||||
<glyph unicode="è" horiz-adv-x="659" d="M66 279v563q0 36 16 94.5t42 97.5t81 71t129 32q199 0 252 -197q14 -51 14 -92v-326h-342v-256q0 -59 39 -88q16 -12 37 -12q70 10 74 113v122h192v-129q0 -37 -16.5 -93t-41 -95t-79.5 -69.5t-130 -30.5t-130.5 30.5t-80.5 73.5q-49 87 -54 160zM102 1489h215l107 -184 h-160zM258 684h150v158q0 48 -19.5 81t-53.5 33t-53.5 -28.5t-21.5 -57.5l-2 -28v-158z" />
|
|
||||||
<glyph unicode="é" horiz-adv-x="659" d="M66 279v563q0 36 16 94.5t42 97.5t81 71t129 32q199 0 252 -197q14 -51 14 -92v-326h-342v-256q0 -59 39 -88q16 -12 37 -12q70 10 74 113v122h192v-129q0 -37 -16.5 -93t-41 -95t-79.5 -69.5t-130 -30.5t-130.5 30.5t-80.5 73.5q-49 87 -54 160zM258 684h150v158 q0 48 -19.5 81t-53.5 33t-53.5 -28.5t-21.5 -57.5l-2 -28v-158zM264 1305l107 184h215l-162 -184h-160z" />
|
|
||||||
<glyph unicode="ê" horiz-adv-x="659" d="M66 279v563q0 36 16 94.5t42 97.5t81 71t129 32q199 0 252 -197q14 -51 14 -92v-326h-342v-256q0 -59 39 -88q16 -12 37 -12q70 10 74 113v122h192v-129q0 -37 -16.5 -93t-41 -95t-79.5 -69.5t-130 -30.5t-130.5 30.5t-80.5 73.5q-49 87 -54 160zM80 1305l141 184h219 l142 -184h-189l-63 71l-62 -71h-188zM258 684h150v158q0 48 -19.5 81t-53.5 33t-53.5 -28.5t-21.5 -57.5l-2 -28v-158z" />
|
|
||||||
<glyph unicode="ë" horiz-adv-x="659" d="M66 279v563q0 36 16 94.5t42 97.5t81 71t129 32q199 0 252 -197q14 -51 14 -92v-326h-342v-256q0 -59 39 -88q16 -12 37 -12q70 10 74 113v122h192v-129q0 -37 -16.5 -93t-41 -95t-79.5 -69.5t-130 -30.5t-130.5 30.5t-80.5 73.5q-49 87 -54 160zM90 1305v200h191v-200 h-191zM258 684h150v158q0 48 -19.5 81t-53.5 33t-53.5 -28.5t-21.5 -57.5l-2 -28v-158zM379 1305v200h190v-200h-190z" />
|
|
||||||
<glyph unicode="ì" horiz-adv-x="370" d="M-33 1489h215l107 -184h-160zM82 0h207v1120h-207v-1120z" />
|
|
||||||
<glyph unicode="í" horiz-adv-x="370" d="M82 0h207v1120h-207v-1120zM82 1305l106 184h215l-161 -184h-160z" />
|
|
||||||
<glyph unicode="î" horiz-adv-x="370" d="M-66 1305l142 184h219l141 -184h-188l-64 71l-61 -71h-189zM82 0h207v1120h-207v-1120z" />
|
|
||||||
<glyph unicode="ï" horiz-adv-x="372" d="M-53 1305v200h190v-200h-190zM82 0v1120h207v-1120h-207zM236 1305v200h190v-200h-190z" />
|
|
||||||
<glyph unicode="ð" horiz-adv-x="673" d="M76 279v579q0 279 172 279q63 0 155 -78q-12 109 -51 203l-82 -72l-55 63l100 88l-45 66l109 100q25 -27 53 -61l94 82l56 -66l-101 -88q125 -201 125 -446v-656q0 -102 -56 -188q-26 -39 -80 -69.5t-129 -30.5t-130 30.5t-80 73.5q-53 91 -53 160zM270 267.5 q-2 -11.5 2 -29t10 -34.5q16 -38 58 -38q70 10 72 113v563q-2 0 0 11t-2 28.5t-10 34.5q-16 40 -60 40q-68 -10 -70 -114v-563q2 0 0 -11.5z" />
|
|
||||||
<glyph unicode="ñ" horiz-adv-x="690" d="M82 0v1120h207v-94l32 32q79 79 145.5 79t106 -69t39.5 -150v-918h-206v887q-1 49 -50 49q-41 0 -67 -53v-883h-207zM147 1305v151q49 39 95.5 39t105 -18.5t97 -19.5t100.5 32v-152q-51 -39 -95.5 -39t-102.5 19.5t-99 19.5t-101 -32z" />
|
|
||||||
<glyph unicode="ò" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t129.5 32q199 0 252 -197q14 -51 14 -92v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-129 -30.5t-130 30.5t-80.5 73.5q-52 92 -52 160zM98 1489h215l107 -184h-160zM258 267.5q-2 -11.5 2 -29t10 -34.5q14 -38 58 -38 q70 10 71 113v563q-2 0 0 11t-2 28.5t-10 34.5q-15 40 -59 40q-68 -10 -70 -114v-563q2 0 0 -11.5z" />
|
|
||||||
<glyph unicode="ó" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t129.5 32q199 0 252 -197q14 -51 14 -92v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-129 -30.5t-130 30.5t-80.5 73.5q-52 92 -52 160zM258 267.5q-2 -11.5 2 -29t10 -34.5q14 -38 58 -38q70 10 71 113v563q-2 0 0 11t-2 28.5 t-10 34.5q-15 40 -59 40q-68 -10 -70 -114v-563q2 0 0 -11.5zM260 1305l107 184h215l-162 -184h-160z" />
|
|
||||||
<glyph unicode="ô" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t129.5 32q199 0 252 -197q14 -51 14 -92v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-129 -30.5t-130 30.5t-80.5 73.5q-52 92 -52 160zM78 1305l141 184h219l142 -184h-189l-63 71l-62 -71h-188zM258 267.5q-2 -11.5 2 -29 t10 -34.5q14 -38 58 -38q70 10 71 113v563q-2 0 0 11t-2 28.5t-10 34.5q-15 40 -59 40q-68 -10 -70 -114v-563q2 0 0 -11.5z" />
|
|
||||||
<glyph unicode="õ" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t129.5 32q199 0 252 -197q14 -51 14 -92v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-129 -30.5t-130 30.5t-80.5 73.5q-52 92 -52 160zM131 1305v151q49 39 95.5 39t104.5 -18.5t98.5 -19.5t98.5 32v-152q-51 -39 -95 -39 t-102 19.5t-101 19.5t-99 -32zM258 267.5q-2 -11.5 2 -29t10 -34.5q14 -38 58 -38q70 10 71 113v563q-2 0 0 11t-2 28.5t-10 34.5q-15 40 -59 40q-68 -10 -70 -114v-563q2 0 0 -11.5z" />
|
|
||||||
<glyph unicode="ö" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t129.5 32q199 0 252 -197q14 -51 14 -92v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-129 -30.5t-130 30.5t-80.5 73.5q-52 92 -52 160zM90 1305v200h191v-200h-191zM258 267.5q-2 -11.5 2 -29t10 -34.5q14 -38 58 -38 q70 10 71 113v563q-2 0 0 11t-2 28.5t-10 34.5q-15 40 -59 40q-68 -10 -70 -114v-563q2 0 0 -11.5zM379 1305v200h190v-200h-190z" />
|
|
||||||
<glyph unicode="ø" horiz-adv-x="657" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t118 32t117.5 -19l21 80h75l-30 -121q88 -84 94 -229v-576q0 -102 -56 -188q-26 -39 -80.5 -69.5t-120.5 -30.5t-112 16l-20 -78h-80l31 121q-41 39 -64.5 97.5t-25.5 97.5zM258 436l125 486q-18 35 -55 34q-68 -10 -70 -114 v-406zM274 197q17 -31 54 -31q70 10 71 113v403z" />
|
|
||||||
<glyph unicode="ù" horiz-adv-x="690" d="M78 203v917h207v-887q0 -49 49 -49q41 0 67 54v882h207v-1120h-207v94l-31 -32q-78 -78 -145.5 -78t-107 68.5t-39.5 150.5zM113 1489h215l106 -184h-160z" />
|
|
||||||
<glyph unicode="ú" horiz-adv-x="690" d="M78 203v917h207v-887q0 -49 49 -49q41 0 67 54v882h207v-1120h-207v94l-31 -32q-78 -78 -145.5 -78t-107 68.5t-39.5 150.5zM274 1305l107 184h215l-162 -184h-160z" />
|
|
||||||
<glyph unicode="û" horiz-adv-x="690" d="M78 203v917h207v-887q0 -49 49 -49q41 0 67 54v882h207v-1120h-207v94l-31 -32q-78 -78 -145.5 -78t-107 68.5t-39.5 150.5zM94 1305l142 184h219l141 -184h-188l-64 71l-61 -71h-189z" />
|
|
||||||
<glyph unicode="ü" horiz-adv-x="690" d="M78 203v917h207v-887q0 -49 49 -49q41 0 67 54v882h207v-1120h-207v94l-31 -32q-78 -78 -145.5 -78t-107 68.5t-39.5 150.5zM106 1305v200h191v-200h-191zM395 1305v200h191v-200h-191z" />
|
|
||||||
<glyph unicode="ý" horiz-adv-x="634" d="M25 1120l190 -1153q0 -68 -36 -123t-97 -61l-49 4v-184q70 -4 92 -4q115 0 192.5 95t94.5 222l198 1204h-202l-82 -688l-4 -57h-9l-4 57l-82 688h-202zM231 1305l107 184h215l-162 -184h-160z" />
|
|
||||||
<glyph unicode="þ" horiz-adv-x="686" d="M82 -385v1890h207v-458q88 90 165 90t117.5 -69t40.5 -150v-715q0 -82 -41 -150.5t-118 -68.5q-33 0 -74 22.5t-66 44.5l-24 23v-459h-207zM289 246q0 -25 19.5 -46.5t42 -21.5t39 19.5t16.5 48.5v628q0 29 -16.5 48.5t-39 19.5t-42 -19.5t-19.5 -48.5v-628z" />
|
|
||||||
<glyph unicode="ÿ" horiz-adv-x="634" d="M25 1120h202l82 -688l4 -57h9l4 57l82 688h202l-198 -1204q-16 -127 -94 -222t-193 -95l-92 4v184q16 -4 49 -4q61 6 97 61.5t36 122.5zM78 1305v200h190v-200h-190zM367 1305v200h190v-200h-190z" />
|
|
||||||
<glyph unicode="Œ" horiz-adv-x="983" d="M68 309v887q0 41 17 101.5t45 100.5t88.5 73.5t143.5 33.5h580v-227h-285v-395h205v-242h-205v-414h285v-227h-580q-84 0 -144 31.5t-88 78.5q-55 91 -60 169zM289 309q0 -46 19.5 -78t54 -32t53 27.5t18.5 56.5l2 26v901q-6 96 -74 97q-35 0 -53 -28t-18 -54l-2 -29 v-887z" />
|
|
||||||
<glyph unicode="œ" horiz-adv-x="995" d="M63 279v563q0 40 15.5 96.5t40 95.5t80 71t145.5 32t156 -60q66 59 170 60q199 0 252 -197q14 -51 14 -92v-326h-342v-250q0 -46 22.5 -76t53.5 -30q70 10 73 113v122h193v-129q0 -37 -16.5 -93t-41 -95t-80 -69.5t-146 -30.5t-154.5 57q-68 -57 -156 -57t-143.5 30.5 t-80.5 73.5q-52 92 -52 160zM258 267.5q-2 -11.5 2 -29t10 -34.5q14 -38 58 -38q70 10 71 113v563q-2 0 0 11t-2 28.5t-10 34.5q-15 40 -59 40q-68 -10 -70 -114v-563q2 0 0 -11.5zM594 684h149v158q0 48 -19 81t-58 33t-55.5 -37.5t-16.5 -70.5v-164z" />
|
|
||||||
<glyph unicode="Ÿ" horiz-adv-x="704" d="M16 1505h217l111 -481l6 -14h4l6 14l111 481h217l-225 -864v-641h-221v641zM113 1638v201h190v-201h-190zM401 1638v201h191v-201h-191z" />
|
|
||||||
<glyph unicode="ˆ" horiz-adv-x="1021" d="M260 1305l141 184h220l141 -184h-189l-63 71l-61 -71h-189z" />
|
|
||||||
<glyph unicode="˜" horiz-adv-x="1024" d="M313 1305v151q49 39 95.5 39t104.5 -18.5t97 -19.5t101 32v-152q-51 -39 -95.5 -39t-102.5 19.5t-99 19.5t-101 -32z" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="952" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="1905" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="952" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="1905" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="635" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="476" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="317" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="317" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="238" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="381" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="105" />
|
|
||||||
<glyph unicode="‐" horiz-adv-x="444" d="M74 455v194h297v-194h-297z" />
|
|
||||||
<glyph unicode="‑" horiz-adv-x="444" d="M74 455v194h297v-194h-297z" />
|
|
||||||
<glyph unicode="‒" horiz-adv-x="444" d="M74 455v194h297v-194h-297z" />
|
|
||||||
<glyph unicode="–" horiz-adv-x="806" d="M74 649v195h659v-195h-659z" />
|
|
||||||
<glyph unicode="—" horiz-adv-x="972" d="M74 649v195h825v-195h-825z" />
|
|
||||||
<glyph unicode="‘" horiz-adv-x="309" d="M49 1012v227l113 266h102l-71 -266h71v-227h-215z" />
|
|
||||||
<glyph unicode="’" horiz-adv-x="309" d="M45 1012l72 266h-72v227h215v-227l-113 -266h-102z" />
|
|
||||||
<glyph unicode="‚" horiz-adv-x="309" d="M45 0v227h215v-227l-113 -266h-102l72 266h-72z" />
|
|
||||||
<glyph unicode="“" horiz-adv-x="624" d="M53 1012v227l113 266h102l-71 -266h71v-227h-215zM356 1012v227l113 266h102l-71 -266h71v-227h-215z" />
|
|
||||||
<glyph unicode="”" horiz-adv-x="624" d="M53 1012l72 266h-72v227h215v-227l-112 -266h-103zM356 1012l72 266h-72v227h215v-227l-112 -266h-103z" />
|
|
||||||
<glyph unicode="„" horiz-adv-x="624" d="M53 0v227h215v-227l-112 -266h-103l72 266h-72zM356 0v227h215v-227l-112 -266h-103l72 266h-72z" />
|
|
||||||
<glyph unicode="•" horiz-adv-x="663" d="M82 815q0 104 72.5 177t177 73t177.5 -72.5t73 -177t-73 -177.5t-177 -73t-177 73t-73 177z" />
|
|
||||||
<glyph unicode="…" horiz-adv-x="964" d="M53 0v227h215v-227h-215zM375 0v227h215v-227h-215zM696 0v227h215v-227h-215z" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="381" />
|
|
||||||
<glyph unicode="‹" horiz-adv-x="1058" d="M74 649v160l911 475v-199l-698 -356l698 -356v-199z" />
|
|
||||||
<glyph unicode="›" horiz-adv-x="1058" d="M74 174v199l698 356l-698 356v199l911 -475v-160z" />
|
|
||||||
<glyph unicode=" " horiz-adv-x="476" />
|
|
||||||
<glyph unicode="€" horiz-adv-x="813" d="M53 547v137h107v137h-107v137h107v238q0 42 17.5 106t45 107t88 78t144.5 35t144 -34t88 -81q53 -90 61 -178l2 -33v-84h-207v84q-2 0 0 11.5t-3 27.5t-12 33q-18 39 -69 39q-70 -10 -78 -111v-238h233v-137h-233v-137h233v-137h-233v-238q0 -43 21.5 -76.5t59.5 -33.5 t58.5 27.5t20.5 56.5l2 26v84h207v-84q0 -38 -17.5 -104t-45.5 -109t-88 -77.5t-144 -34.5t-144.5 33.5t-88.5 81.5q-55 97 -60 175l-2 35v238h-107z" />
|
|
||||||
<glyph unicode="™" horiz-adv-x="937" d="M74 1401v104h321v-104h-104v-580h-113v580h-104zM440 821v684h138l67 -319h6l68 319h137v-684h-104v449l-78 -449h-51l-80 449v-449h-103z" />
|
|
||||||
<glyph unicode="" horiz-adv-x="1120" d="M0 0v1120h1120v-1120h-1120z" />
|
|
||||||
<glyph unicode="fi" horiz-adv-x="772" d="M20 934v186h105v31q0 172 31 231q16 31 42 67q53 71 181 71q59 0 127 -13l20 -2v-184q-41 12 -91 12t-69.5 -18.5t-25.5 -58.5q-8 -52 -8 -107v-29h358v-1120h-207v934h-151v-934h-207v934h-105z" />
|
|
||||||
<glyph unicode="fl" horiz-adv-x="772" d="M20 934v186h105v31q0 172 31 231q16 31 42 67q53 71 181 71q59 0 127 -13l20 -2h164v-1505h-207v1329q-37 4 -67.5 4t-50 -18.5t-25.5 -58.5q-8 -52 -8 -107v-29h104v-186h-104v-934h-207v934h-105z" />
|
|
||||||
<glyph unicode="ffi" horiz-adv-x="1320" d="M20 934v186h105v31q0 190 51 270q23 35 71 63.5t115 28.5l97 -14v-178q-27 8 -62 8q-66 0 -65 -180v-29h104v-186h-104v-934h-207v934h-105zM495 934v186h105v31q0 190 51 270q23 35 71 63.5t115 28.5l97 -14v-178q-27 8 -62 8q-66 0 -65 -180v-29h104v-186h-104v-934 h-207v934h-105zM1032 0v1120h207v-1120h-207zM1032 1298v207h207v-207h-207z" />
|
|
||||||
<glyph unicode="ffl" horiz-adv-x="1320" d="M20 934v186h105v31q0 190 51 270q23 35 71 63.5t115 28.5l97 -14v-178q-27 8 -62 8q-66 0 -65 -180v-29h104v-186h-104v-934h-207v934h-105zM495 934v186h105v31q0 190 51 270q23 35 71 63.5t115 28.5l97 -14v-178q-27 8 -62 8q-66 0 -65 -180v-29h104v-186h-104v-934 h-207v934h-105zM1032 0v1505h207v-1505h-207z" />
|
|
||||||
</font>
|
|
||||||
</defs></svg>
|
|
||||||
|
Before Width: | Height: | Size: 46 KiB |
BIN
website/source/assets/fonts/league_gothic-webfont.ttf (Stored with Git LFS)
BIN
website/source/assets/fonts/league_gothic-webfont.ttf (Stored with Git LFS)
Binary file not shown.
BIN
website/source/assets/fonts/league_gothic-webfont.woff (Stored with Git LFS)
BIN
website/source/assets/fonts/league_gothic-webfont.woff (Stored with Git LFS)
Binary file not shown.
|
|
@ -1,58 +0,0 @@
|
||||||
// Copyright (C) 2010 Google Inc.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
//
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @fileoverview
|
|
||||||
* Registers a language handler for the Go language..
|
|
||||||
* <p>
|
|
||||||
* Based on the lexical grammar at
|
|
||||||
* http://golang.org/doc/go_spec.html#Lexical_elements
|
|
||||||
* <p>
|
|
||||||
* Go uses a minimal style for highlighting so the below does not distinguish
|
|
||||||
* strings, keywords, literals, etc. by design.
|
|
||||||
* From a discussion with the Go designers:
|
|
||||||
* <pre>
|
|
||||||
* On Thursday, July 22, 2010, Mike Samuel <...> wrote:
|
|
||||||
* > On Thu, Jul 22, 2010, Rob 'Commander' Pike <...> wrote:
|
|
||||||
* >> Personally, I would vote for the subdued style godoc presents at http://golang.org
|
|
||||||
* >>
|
|
||||||
* >> Not as fancy as some like, but a case can be made it's the official style.
|
|
||||||
* >> If people want more colors, I wouldn't fight too hard, in the interest of
|
|
||||||
* >> encouragement through familiarity, but even then I would ask to shy away
|
|
||||||
* >> from technicolor starbursts.
|
|
||||||
* >
|
|
||||||
* > Like http://golang.org/pkg/go/scanner/ where comments are blue and all
|
|
||||||
* > other content is black? I can do that.
|
|
||||||
* </pre>
|
|
||||||
*
|
|
||||||
* @author mikesamuel@gmail.com
|
|
||||||
*/
|
|
||||||
|
|
||||||
PR['registerLangHandler'](
|
|
||||||
PR['createSimpleLexer'](
|
|
||||||
[
|
|
||||||
// Whitespace is made up of spaces, tabs and newline characters.
|
|
||||||
[PR['PR_PLAIN'], /^[\t\n\r \xA0]+/, null, '\t\n\r \xA0'],
|
|
||||||
// Not escaped as a string. See note on minimalism above.
|
|
||||||
[PR['PR_PLAIN'], /^(?:\"(?:[^\"\\]|\\[\s\S])*(?:\"|$)|\'(?:[^\'\\]|\\[\s\S])+(?:\'|$)|`[^`]*(?:`|$))/, null, '"\'']
|
|
||||||
],
|
|
||||||
[
|
|
||||||
// Block comments are delimited by /* and */.
|
|
||||||
// Single-line comments begin with // and extend to the end of a line.
|
|
||||||
[PR['PR_COMMENT'], /^(?:\/\/[^\r\n]*|\/\*[\s\S]*?\*\/)/],
|
|
||||||
[PR['PR_PLAIN'], /^(?:[^\/\"\'`]|\/(?![\/\*]))+/i]
|
|
||||||
]),
|
|
||||||
['go']);
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
!function(){var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
|
|
||||||
(function(){function S(a){function d(e){var b=e.charCodeAt(0);if(b!==92)return b;var a=e.charAt(1);return(b=r[a])?b:"0"<=a&&a<="7"?parseInt(e.substring(1),8):a==="u"||a==="x"?parseInt(e.substring(2),16):e.charCodeAt(1)}function g(e){if(e<32)return(e<16?"\\x0":"\\x")+e.toString(16);e=String.fromCharCode(e);return e==="\\"||e==="-"||e==="]"||e==="^"?"\\"+e:e}function b(e){var b=e.substring(1,e.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),e=[],a=
|
|
||||||
b[0]==="^",c=["["];a&&c.push("^");for(var a=a?1:0,f=b.length;a<f;++a){var h=b[a];if(/\\[bdsw]/i.test(h))c.push(h);else{var h=d(h),l;a+2<f&&"-"===b[a+1]?(l=d(b[a+2]),a+=2):l=h;e.push([h,l]);l<65||h>122||(l<65||h>90||e.push([Math.max(65,h)|32,Math.min(l,90)|32]),l<97||h>122||e.push([Math.max(97,h)&-33,Math.min(l,122)&-33]))}}e.sort(function(e,a){return e[0]-a[0]||a[1]-e[1]});b=[];f=[];for(a=0;a<e.length;++a)h=e[a],h[0]<=f[1]+1?f[1]=Math.max(f[1],h[1]):b.push(f=h);for(a=0;a<b.length;++a)h=b[a],c.push(g(h[0])),
|
|
||||||
h[1]>h[0]&&(h[1]+1>h[0]&&c.push("-"),c.push(g(h[1])));c.push("]");return c.join("")}function s(e){for(var a=e.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),c=a.length,d=[],f=0,h=0;f<c;++f){var l=a[f];l==="("?++h:"\\"===l.charAt(0)&&(l=+l.substring(1))&&(l<=h?d[l]=-1:a[f]=g(l))}for(f=1;f<d.length;++f)-1===d[f]&&(d[f]=++x);for(h=f=0;f<c;++f)l=a[f],l==="("?(++h,d[h]||(a[f]="(?:")):"\\"===l.charAt(0)&&(l=+l.substring(1))&&l<=h&&
|
|
||||||
(a[f]="\\"+d[l]);for(f=0;f<c;++f)"^"===a[f]&&"^"!==a[f+1]&&(a[f]="");if(e.ignoreCase&&m)for(f=0;f<c;++f)l=a[f],e=l.charAt(0),l.length>=2&&e==="["?a[f]=b(l):e!=="\\"&&(a[f]=l.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return a.join("")}for(var x=0,m=!1,j=!1,k=0,c=a.length;k<c;++k){var i=a[k];if(i.ignoreCase)j=!0;else if(/[a-z]/i.test(i.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){m=!0;j=!1;break}}for(var r={b:8,t:9,n:10,v:11,
|
|
||||||
f:12,r:13},n=[],k=0,c=a.length;k<c;++k){i=a[k];if(i.global||i.multiline)throw Error(""+i);n.push("(?:"+s(i)+")")}return RegExp(n.join("|"),j?"gi":"g")}function T(a,d){function g(a){var c=a.nodeType;if(c==1){if(!b.test(a.className)){for(c=a.firstChild;c;c=c.nextSibling)g(c);c=a.nodeName.toLowerCase();if("br"===c||"li"===c)s[j]="\n",m[j<<1]=x++,m[j++<<1|1]=a}}else if(c==3||c==4)c=a.nodeValue,c.length&&(c=d?c.replace(/\r\n?/g,"\n"):c.replace(/[\t\n\r ]+/g," "),s[j]=c,m[j<<1]=x,x+=c.length,m[j++<<1|1]=
|
|
||||||
a)}var b=/(?:^|\s)nocode(?:\s|$)/,s=[],x=0,m=[],j=0;g(a);return{a:s.join("").replace(/\n$/,""),d:m}}function H(a,d,g,b){d&&(a={a:d,e:a},g(a),b.push.apply(b,a.g))}function U(a){for(var d=void 0,g=a.firstChild;g;g=g.nextSibling)var b=g.nodeType,d=b===1?d?a:g:b===3?V.test(g.nodeValue)?a:d:d;return d===a?void 0:d}function C(a,d){function g(a){for(var j=a.e,k=[j,"pln"],c=0,i=a.a.match(s)||[],r={},n=0,e=i.length;n<e;++n){var z=i[n],w=r[z],t=void 0,f;if(typeof w==="string")f=!1;else{var h=b[z.charAt(0)];
|
|
||||||
if(h)t=z.match(h[1]),w=h[0];else{for(f=0;f<x;++f)if(h=d[f],t=z.match(h[1])){w=h[0];break}t||(w="pln")}if((f=w.length>=5&&"lang-"===w.substring(0,5))&&!(t&&typeof t[1]==="string"))f=!1,w="src";f||(r[z]=w)}h=c;c+=z.length;if(f){f=t[1];var l=z.indexOf(f),B=l+f.length;t[2]&&(B=z.length-t[2].length,l=B-f.length);w=w.substring(5);H(j+h,z.substring(0,l),g,k);H(j+h+l,f,I(w,f),k);H(j+h+B,z.substring(B),g,k)}else k.push(j+h,w)}a.g=k}var b={},s;(function(){for(var g=a.concat(d),j=[],k={},c=0,i=g.length;c<i;++c){var r=
|
|
||||||
g[c],n=r[3];if(n)for(var e=n.length;--e>=0;)b[n.charAt(e)]=r;r=r[1];n=""+r;k.hasOwnProperty(n)||(j.push(r),k[n]=q)}j.push(/[\S\s]/);s=S(j)})();var x=d.length;return g}function v(a){var d=[],g=[];a.tripleQuotedStrings?d.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?d.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
|
|
||||||
q,"'\"`"]):d.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&g.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var b=a.hashComments;b&&(a.cStyleComments?(b>1?d.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):d.push(["com",/^#(?:(?:define|e(?:l|nd)if|else|error|ifn?def|include|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),g.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h(?:h|pp|\+\+)?|[a-z]\w*)>/,q])):d.push(["com",
|
|
||||||
/^#[^\n\r]*/,q,"#"]));a.cStyleComments&&(g.push(["com",/^\/\/[^\n\r]*/,q]),g.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));if(b=a.regexLiterals){var s=(b=b>1?"":"\n\r")?".":"[\\S\\s]";g.push(["lang-regex",RegExp("^(?:^^\\.?|[+-]|[!=]=?=?|\\#|%=?|&&?=?|\\(|\\*=?|[+\\-]=|->|\\/=?|::?|<<?=?|>>?>?=?|,|;|\\?|@|\\[|~|{|\\^\\^?=?|\\|\\|?=?|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\\s*("+("/(?=[^/*"+b+"])(?:[^/\\x5B\\x5C"+b+"]|\\x5C"+s+"|\\x5B(?:[^\\x5C\\x5D"+b+"]|\\x5C"+
|
|
||||||
s+")*(?:\\x5D|$))+/")+")")])}(b=a.types)&&g.push(["typ",b]);b=(""+a.keywords).replace(/^ | $/g,"");b.length&&g.push(["kwd",RegExp("^(?:"+b.replace(/[\s,]+/g,"|")+")\\b"),q]);d.push(["pln",/^\s+/,q," \r\n\t\u00a0"]);b="^.[^\\s\\w.$@'\"`/\\\\]*";a.regexLiterals&&(b+="(?!s*/)");g.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,
|
|
||||||
q],["pun",RegExp(b),q]);return C(d,g)}function J(a,d,g){function b(a){var c=a.nodeType;if(c==1&&!x.test(a.className))if("br"===a.nodeName)s(a),a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)b(a);else if((c==3||c==4)&&g){var d=a.nodeValue,i=d.match(m);if(i)c=d.substring(0,i.index),a.nodeValue=c,(d=d.substring(i.index+i[0].length))&&a.parentNode.insertBefore(j.createTextNode(d),a.nextSibling),s(a),c||a.parentNode.removeChild(a)}}function s(a){function b(a,c){var d=
|
|
||||||
c?a.cloneNode(!1):a,e=a.parentNode;if(e){var e=b(e,1),g=a.nextSibling;e.appendChild(d);for(var i=g;i;i=g)g=i.nextSibling,e.appendChild(i)}return d}for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),d;(d=a.parentNode)&&d.nodeType===1;)a=d;c.push(a)}for(var x=/(?:^|\s)nocode(?:\s|$)/,m=/\r\n?|\n/,j=a.ownerDocument,k=j.createElement("li");a.firstChild;)k.appendChild(a.firstChild);for(var c=[k],i=0;i<c.length;++i)b(c[i]);d===(d|0)&&c[0].setAttribute("value",d);var r=j.createElement("ol");
|
|
||||||
r.className="linenums";for(var d=Math.max(0,d-1|0)||0,i=0,n=c.length;i<n;++i)k=c[i],k.className="L"+(i+d)%10,k.firstChild||k.appendChild(j.createTextNode("\u00a0")),r.appendChild(k);a.appendChild(r)}function p(a,d){for(var g=d.length;--g>=0;){var b=d[g];F.hasOwnProperty(b)?D.console&&console.warn("cannot override language handler %s",b):F[b]=a}}function I(a,d){if(!a||!F.hasOwnProperty(a))a=/^\s*</.test(d)?"default-markup":"default-code";return F[a]}function K(a){var d=a.h;try{var g=T(a.c,a.i),b=g.a;
|
|
||||||
a.a=b;a.d=g.d;a.e=0;I(d,b)(a);var s=/\bMSIE\s(\d+)/.exec(navigator.userAgent),s=s&&+s[1]<=8,d=/\n/g,x=a.a,m=x.length,g=0,j=a.d,k=j.length,b=0,c=a.g,i=c.length,r=0;c[i]=m;var n,e;for(e=n=0;e<i;)c[e]!==c[e+2]?(c[n++]=c[e++],c[n++]=c[e++]):e+=2;i=n;for(e=n=0;e<i;){for(var p=c[e],w=c[e+1],t=e+2;t+2<=i&&c[t+1]===w;)t+=2;c[n++]=p;c[n++]=w;e=t}c.length=n;var f=a.c,h;if(f)h=f.style.display,f.style.display="none";try{for(;b<k;){var l=j[b+2]||m,B=c[r+2]||m,t=Math.min(l,B),A=j[b+1],G;if(A.nodeType!==1&&(G=x.substring(g,
|
|
||||||
t))){s&&(G=G.replace(d,"\r"));A.nodeValue=G;var L=A.ownerDocument,o=L.createElement("span");o.className=c[r+1];var v=A.parentNode;v.replaceChild(o,A);o.appendChild(A);g<l&&(j[b+1]=A=L.createTextNode(x.substring(t,l)),v.insertBefore(A,o.nextSibling))}g=t;g>=l&&(b+=2);g>=B&&(r+=2)}}finally{if(f)f.style.display=h}}catch(u){D.console&&console.log(u&&u.stack||u)}}var D=window,y=["break,continue,do,else,for,if,return,while"],E=[[y,"auto,case,char,const,default,double,enum,extern,float,goto,inline,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
|
|
||||||
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],M=[E,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,delegate,dynamic_cast,explicit,export,friend,generic,late_check,mutable,namespace,nullptr,property,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],N=[E,"abstract,assert,boolean,byte,extends,final,finally,implements,import,instanceof,interface,null,native,package,strictfp,super,synchronized,throws,transient"],
|
|
||||||
O=[N,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,internal,into,is,let,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var,virtual,where"],E=[E,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],P=[y,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
|
|
||||||
Q=[y,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],W=[y,"as,assert,const,copy,drop,enum,extern,fail,false,fn,impl,let,log,loop,match,mod,move,mut,priv,pub,pure,ref,self,static,struct,true,trait,type,unsafe,use"],y=[y,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],R=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)\b/,
|
|
||||||
V=/\S/,X=v({keywords:[M,O,E,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",P,Q,y],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),F={};p(X,["default-code"]);p(C([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",
|
|
||||||
/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),["default-markup","htm","html","mxml","xhtml","xml","xsl"]);p(C([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],
|
|
||||||
["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);p(C([],[["atv",/^[\S\s]+/]]),["uq.val"]);p(v({keywords:M,hashComments:!0,cStyleComments:!0,types:R}),["c","cc","cpp","cxx","cyc","m"]);p(v({keywords:"null,true,false"}),["json"]);p(v({keywords:O,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:R}),
|
|
||||||
["cs"]);p(v({keywords:N,cStyleComments:!0}),["java"]);p(v({keywords:y,hashComments:!0,multiLineStrings:!0}),["bash","bsh","csh","sh"]);p(v({keywords:P,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),["cv","py","python"]);p(v({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:2}),["perl","pl","pm"]);p(v({keywords:Q,
|
|
||||||
hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb","ruby"]);p(v({keywords:E,cStyleComments:!0,regexLiterals:!0}),["javascript","js"]);p(v({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,throw,true,try,unless,until,when,while,yes",hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);p(v({keywords:W,cStyleComments:!0,multilineStrings:!0}),["rc","rs","rust"]);
|
|
||||||
p(C([],[["str",/^[\S\s]+/]]),["regex"]);var Y=D.PR={createSimpleLexer:C,registerLangHandler:p,sourceDecorator:v,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ",prettyPrintOne:D.prettyPrintOne=function(a,d,g){var b=document.createElement("div");b.innerHTML="<pre>"+a+"</pre>";b=b.firstChild;g&&J(b,g,!0);K({h:d,j:g,c:b,i:1});
|
|
||||||
return b.innerHTML},prettyPrint:D.prettyPrint=function(a,d){function g(){for(var b=D.PR_SHOULD_USE_CONTINUATION?c.now()+250:Infinity;i<p.length&&c.now()<b;i++){for(var d=p[i],j=h,k=d;k=k.previousSibling;){var m=k.nodeType,o=(m===7||m===8)&&k.nodeValue;if(o?!/^\??prettify\b/.test(o):m!==3||/\S/.test(k.nodeValue))break;if(o){j={};o.replace(/\b(\w+)=([\w%+\-.:]+)/g,function(a,b,c){j[b]=c});break}}k=d.className;if((j!==h||e.test(k))&&!v.test(k)){m=!1;for(o=d.parentNode;o;o=o.parentNode)if(f.test(o.tagName)&&
|
|
||||||
o.className&&e.test(o.className)){m=!0;break}if(!m){d.className+=" prettyprinted";m=j.lang;if(!m){var m=k.match(n),y;if(!m&&(y=U(d))&&t.test(y.tagName))m=y.className.match(n);m&&(m=m[1])}if(w.test(d.tagName))o=1;else var o=d.currentStyle,u=s.defaultView,o=(o=o?o.whiteSpace:u&&u.getComputedStyle?u.getComputedStyle(d,q).getPropertyValue("white-space"):0)&&"pre"===o.substring(0,3);u=j.linenums;if(!(u=u==="true"||+u))u=(u=k.match(/\blinenums\b(?::(\d+))?/))?u[1]&&u[1].length?+u[1]:!0:!1;u&&J(d,u,o);r=
|
|
||||||
{h:m,c:d,j:u,i:o};K(r)}}}i<p.length?setTimeout(g,250):"function"===typeof a&&a()}for(var b=d||document.body,s=b.ownerDocument||document,b=[b.getElementsByTagName("pre"),b.getElementsByTagName("code"),b.getElementsByTagName("xmp")],p=[],m=0;m<b.length;++m)for(var j=0,k=b[m].length;j<k;++j)p.push(b[m][j]);var b=q,c=Date;c.now||(c={now:function(){return+new Date}});var i=0,r,n=/\blang(?:uage)?-([\w.]+)(?!\S)/,e=/\bprettyprint\b/,v=/\bprettyprinted\b/,w=/pre|xmp/i,t=/^code$/i,f=/^(?:pre|code|xmp)$/i,
|
|
||||||
h={};g()}};typeof define==="function"&&define.amd&&define("google-code-prettify",[],function(){return Y})})();}()
|
|
||||||
|
|
@ -159,6 +159,15 @@ body.layout-intro{
|
||||||
-webkit-font-smoothing: antialiased;
|
-webkit-font-smoothing: antialiased;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
li p a, li a {
|
||||||
|
text-decoration: none;
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
cursor: default;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pre{
|
pre{
|
||||||
margin: 0 0 18px;
|
margin: 0 0 18px;
|
||||||
}
|
}
|
||||||
|
|
@ -192,6 +201,10 @@ body.layout-intro{
|
||||||
#graph {
|
#graph {
|
||||||
margin-top: 30px;
|
margin-top: 30px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.alert p {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,9 @@
|
||||||
@import "bootstrap-sprockets";
|
@import "bootstrap-sprockets";
|
||||||
@import "bootstrap";
|
@import "bootstrap";
|
||||||
|
|
||||||
|
// Remote fonts
|
||||||
|
@import url("http://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700");
|
||||||
|
|
||||||
// Core variables and mixins
|
// Core variables and mixins
|
||||||
@import "_variables";
|
@import "_variables";
|
||||||
@import "_mixins";
|
@import "_mixins";
|
||||||
|
|
@ -25,6 +28,3 @@
|
||||||
@import "_community";
|
@import "_community";
|
||||||
@import "_docs";
|
@import "_docs";
|
||||||
@import "_downloads";
|
@import "_downloads";
|
||||||
|
|
||||||
// Components w/ JavaScript
|
|
||||||
/*@import "modals.less";*/
|
|
||||||
|
|
|
||||||
|
|
@ -1,160 +0,0 @@
|
||||||
/* Hemisu Dark */
|
|
||||||
/* Original theme - http://noahfrederick.com/vim-color-scheme-hemisu/ */
|
|
||||||
/* Pretty printing styles. Used with prettify.js. */
|
|
||||||
/* SPAN elements with the classes below are added by prettyprint. */
|
|
||||||
/* plain text */
|
|
||||||
.pln {
|
|
||||||
color: #eeeeee;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media screen {
|
|
||||||
/* string content */
|
|
||||||
.str {
|
|
||||||
color: #b1d631;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a keyword */
|
|
||||||
.kwd {
|
|
||||||
color: #b1d631;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a comment */
|
|
||||||
.com {
|
|
||||||
color: #777777;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a type name */
|
|
||||||
.typ {
|
|
||||||
color: #bbffaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a literal value */
|
|
||||||
.lit {
|
|
||||||
color: #9fd3e6;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* punctuation */
|
|
||||||
.pun {
|
|
||||||
color: #eeeeee;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* lisp open bracket */
|
|
||||||
.opn {
|
|
||||||
color: #eeeeee;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* lisp close bracket */
|
|
||||||
.clo {
|
|
||||||
color: #eeeeee;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a markup tag name */
|
|
||||||
.tag {
|
|
||||||
color: #eeeeee;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a markup attribute name */
|
|
||||||
.atn {
|
|
||||||
color: #b1d631;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a markup attribute value */
|
|
||||||
.atv {
|
|
||||||
color: #bbffaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a declaration */
|
|
||||||
.dec {
|
|
||||||
color: #eeeeee;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a variable name */
|
|
||||||
.var {
|
|
||||||
color: #eeeeee;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* a function name */
|
|
||||||
.fun {
|
|
||||||
color: #9fd3e6;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/* Use higher contrast and text-weight for printable form. */
|
|
||||||
@media print, projection {
|
|
||||||
.str {
|
|
||||||
color: #006600;
|
|
||||||
}
|
|
||||||
|
|
||||||
.kwd {
|
|
||||||
color: #006;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.com {
|
|
||||||
color: #600;
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
.typ {
|
|
||||||
color: #404;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.lit {
|
|
||||||
color: #004444;
|
|
||||||
}
|
|
||||||
|
|
||||||
.pun, .opn, .clo {
|
|
||||||
color: #444400;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tag {
|
|
||||||
color: #006;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.atn {
|
|
||||||
color: #440044;
|
|
||||||
}
|
|
||||||
|
|
||||||
.atv {
|
|
||||||
color: #006600;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/* Style */
|
|
||||||
pre.prettyprint {
|
|
||||||
background: black;
|
|
||||||
font-family: Menlo, "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Monaco, Consolas, monospace;
|
|
||||||
font-size: 12px;
|
|
||||||
line-height: 1.5;
|
|
||||||
border: 1px solid #cccccc;
|
|
||||||
padding: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Specify class=linenums on a pre to get line numbering */
|
|
||||||
ol.linenums {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* IE indents via margin-left */
|
|
||||||
li.L0,
|
|
||||||
li.L1,
|
|
||||||
li.L2,
|
|
||||||
li.L3,
|
|
||||||
li.L4,
|
|
||||||
li.L5,
|
|
||||||
li.L6,
|
|
||||||
li.L7,
|
|
||||||
li.L8,
|
|
||||||
li.L9 {
|
|
||||||
/* */
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Alternate shading for lines */
|
|
||||||
li.L1,
|
|
||||||
li.L3,
|
|
||||||
li.L5,
|
|
||||||
li.L7,
|
|
||||||
li.L9 {
|
|
||||||
/* */
|
|
||||||
}
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
---
|
---
|
||||||
page_title: "Community"
|
page_title: "Community"
|
||||||
|
description: |-
|
||||||
|
Consul is a new project with a growing community. Despite this, there are active, dedicated users willing to help you through various mediums.
|
||||||
---
|
---
|
||||||
|
|
||||||
<div class="container">
|
<div class="container">
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Agent"
|
page_title: "Agent"
|
||||||
sidebar_current: "docs-agent-running"
|
sidebar_current: "docs-agent-running"
|
||||||
|
description: |-
|
||||||
|
The Consul agent is the core process of Consul. The agent maintains membership information, registers services, runs checks, responds to queries and more. The agent must run on every node that is part of a Consul cluster.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Agent
|
# Consul Agent
|
||||||
|
|
@ -25,7 +27,7 @@ running forever or until told to quit. The agent command takes a variety
|
||||||
of configuration options but the defaults are usually good enough. When
|
of configuration options but the defaults are usually good enough. When
|
||||||
running `consul agent`, you should see output similar to that below:
|
running `consul agent`, you should see output similar to that below:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul agent -data-dir=/tmp/consul
|
$ consul agent -data-dir=/tmp/consul
|
||||||
==> Starting Consul agent...
|
==> Starting Consul agent...
|
||||||
==> Starting Consul agent RPC...
|
==> Starting Consul agent RPC...
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Check Definition"
|
page_title: "Check Definition"
|
||||||
sidebar_current: "docs-agent-checks"
|
sidebar_current: "docs-agent-checks"
|
||||||
|
description: |-
|
||||||
|
One of the primary roles of the agent is the management of system and application level health checks. A health check is considered to be application level if it associated with a service. A check is defined in a configuration file, or added at runtime over the HTTP interface.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Checks
|
# Checks
|
||||||
|
|
@ -30,6 +32,7 @@ There are two different kinds of checks:
|
||||||
|
|
||||||
A check definition that is a script looks like:
|
A check definition that is a script looks like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"check": {
|
"check": {
|
||||||
"id": "mem-util",
|
"id": "mem-util",
|
||||||
|
|
@ -38,9 +41,11 @@ A check definition that is a script looks like:
|
||||||
"interval": "10s"
|
"interval": "10s"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
A TTL based check is very similar:
|
A TTL based check is very similar:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"check": {
|
"check": {
|
||||||
"id": "web-app",
|
"id": "web-app",
|
||||||
|
|
@ -49,6 +54,7 @@ A TTL based check is very similar:
|
||||||
"ttl": "30s"
|
"ttl": "30s"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Both types of definitions must include a `name`, and may optionally
|
Both types of definitions must include a `name`, and may optionally
|
||||||
provide an `id` and `notes` field. The `id` is set to the `name` if not
|
provide an `id` and `notes` field. The `id` is set to the `name` if not
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "DNS Interface"
|
page_title: "DNS Interface"
|
||||||
sidebar_current: "docs-agent-dns"
|
sidebar_current: "docs-agent-dns"
|
||||||
|
description: |-
|
||||||
|
One of the primary query interfaces for Consul is using DNS. The DNS interface allows applications to make use of service discovery without any high-touch integration with Consul.
|
||||||
---
|
---
|
||||||
|
|
||||||
# DNS Interface
|
# DNS Interface
|
||||||
|
|
@ -50,6 +52,7 @@ DNS lookup for nodes in other datacenters, with no additional effort.
|
||||||
For a node lookup, the only records returned are A records with the IP address of
|
For a node lookup, the only records returned are A records with the IP address of
|
||||||
the node.
|
the node.
|
||||||
|
|
||||||
|
```text
|
||||||
$ dig @127.0.0.1 -p 8600 foobar.node.consul ANY
|
$ dig @127.0.0.1 -p 8600 foobar.node.consul ANY
|
||||||
|
|
||||||
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 foobar.node.consul ANY
|
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 foobar.node.consul ANY
|
||||||
|
|
@ -68,7 +71,7 @@ the node.
|
||||||
|
|
||||||
;; AUTHORITY SECTION:
|
;; AUTHORITY SECTION:
|
||||||
consul. 0 IN SOA ns.consul. postmaster.consul. 1392836399 3600 600 86400 0
|
consul. 0 IN SOA ns.consul. postmaster.consul. 1392836399 3600 600 86400 0
|
||||||
|
```
|
||||||
|
|
||||||
## Service Lookups
|
## Service Lookups
|
||||||
|
|
||||||
|
|
@ -100,6 +103,7 @@ provide the port that a service is registered on, enabling services to avoid rel
|
||||||
on well-known ports. SRV records are only served if the client specifically requests
|
on well-known ports. SRV records are only served if the client specifically requests
|
||||||
SRV records.
|
SRV records.
|
||||||
|
|
||||||
|
```text
|
||||||
$ dig @127.0.0.1 -p 8600 consul.service.consul SRV
|
$ dig @127.0.0.1 -p 8600 consul.service.consul SRV
|
||||||
|
|
||||||
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 consul.service.consul ANY
|
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 consul.service.consul ANY
|
||||||
|
|
@ -118,6 +122,7 @@ SRV records.
|
||||||
|
|
||||||
;; ADDITIONAL SECTION:
|
;; ADDITIONAL SECTION:
|
||||||
foobar.node.dc1.consul. 0 IN A 10.1.10.12
|
foobar.node.dc1.consul. 0 IN A 10.1.10.12
|
||||||
|
```
|
||||||
|
|
||||||
### RFC-2782 Style Lookup
|
### RFC-2782 Style Lookup
|
||||||
|
|
||||||
|
|
@ -138,6 +143,7 @@ Using the RCF style lookup, If you registered the service "rabbitmq" on port
|
||||||
5672 and tagged it with "amqp" you would query the SRV record as
|
5672 and tagged it with "amqp" you would query the SRV record as
|
||||||
"_rabbitmq._amqp.service.consul" as illustrated in the example below:
|
"_rabbitmq._amqp.service.consul" as illustrated in the example below:
|
||||||
|
|
||||||
|
```text
|
||||||
$ dig @127.0.0.1 -p 8600 _rabbitmq._amqp.service.consul SRV
|
$ dig @127.0.0.1 -p 8600 _rabbitmq._amqp.service.consul SRV
|
||||||
|
|
||||||
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 _rabbitmq._amqp.service.consul ANY
|
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 _rabbitmq._amqp.service.consul ANY
|
||||||
|
|
@ -156,6 +162,7 @@ Using the RCF style lookup, If you registered the service "rabbitmq" on port
|
||||||
|
|
||||||
;; ADDITIONAL SECTION:
|
;; ADDITIONAL SECTION:
|
||||||
rabbitmq.node1.dc1.consul. 0 IN A 10.1.11.20
|
rabbitmq.node1.dc1.consul. 0 IN A 10.1.11.20
|
||||||
|
```
|
||||||
|
|
||||||
### UDP Based DNS Queries
|
### UDP Based DNS Queries
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Encryption"
|
page_title: "Encryption"
|
||||||
sidebar_current: "docs-agent-encryption"
|
sidebar_current: "docs-agent-encryption"
|
||||||
|
description: |-
|
||||||
|
The Consul agent supports encrypting all of its network traffic. The exact method of this encryption is described on the encryption internals page. There are two seperate systems, one for gossip traffic and one for RPC.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Encryption
|
# Encryption
|
||||||
|
|
@ -19,7 +21,7 @@ in a configuration file for the agent. The key must be 16-bytes that are base64
|
||||||
encoded. The easiest method to obtain a cryptographically suitable key is by
|
encoded. The easiest method to obtain a cryptographically suitable key is by
|
||||||
using `consul keygen`.
|
using `consul keygen`.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul keygen
|
$ consul keygen
|
||||||
cg8StVXbQJ0gPvMd9o7yrg==
|
cg8StVXbQJ0gPvMd9o7yrg==
|
||||||
```
|
```
|
||||||
|
|
@ -27,7 +29,7 @@ cg8StVXbQJ0gPvMd9o7yrg==
|
||||||
With that key, you can enable encryption on the agent. You can verify
|
With that key, you can enable encryption on the agent. You can verify
|
||||||
encryption is enabled because the output will include "Encrypted: true".
|
encryption is enabled because the output will include "Encrypted: true".
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ cat encrypt.json
|
$ cat encrypt.json
|
||||||
{"encrypt": "cg8StVXbQJ0gPvMd9o7yrg=="}
|
{"encrypt": "cg8StVXbQJ0gPvMd9o7yrg=="}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "HTTP API"
|
page_title: "HTTP API"
|
||||||
sidebar_current: "docs-agent-http"
|
sidebar_current: "docs-agent-http"
|
||||||
|
description: |-
|
||||||
|
The main interface to Consul is a RESTful HTTP API. The API can be used for CRUD for nodes, services, checks, and configuration. The endpoints are versioned to enable changes without breaking backwards compatibility.
|
||||||
---
|
---
|
||||||
|
|
||||||
# HTTP API
|
# HTTP API
|
||||||
|
|
@ -120,6 +122,7 @@ all keys with the given prefix.
|
||||||
|
|
||||||
Each object will look like:
|
Each object will look like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"CreateIndex": 100,
|
"CreateIndex": 100,
|
||||||
|
|
@ -131,6 +134,7 @@ Each object will look like:
|
||||||
"Session": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
|
"Session": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
The `CreateIndex` is the internal index value that represents
|
The `CreateIndex` is the internal index value that represents
|
||||||
when the entry was created. The `ModifyIndex` is the last index
|
when the entry was created. The `ModifyIndex` is the last index
|
||||||
|
|
@ -153,11 +157,13 @@ can be used to list only up to a given separator.
|
||||||
|
|
||||||
For example, listing "/web/" with a "/" seperator may return:
|
For example, listing "/web/" with a "/" seperator may return:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
"/web/bar",
|
"/web/bar",
|
||||||
"/web/foo",
|
"/web/foo",
|
||||||
"/web/subdir/"
|
"/web/subdir/"
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
Using the key listing method may be suitable when you do not need
|
Using the key listing method may be suitable when you do not need
|
||||||
the values or flags, or want to implement a key-space explorer.
|
the values or flags, or want to implement a key-space explorer.
|
||||||
|
|
@ -242,6 +248,7 @@ anti-entropy, so in most situations everything will be in sync within a few seco
|
||||||
|
|
||||||
This endpoint is hit with a GET and returns a JSON body like this:
|
This endpoint is hit with a GET and returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"service:redis": {
|
"service:redis": {
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -254,6 +261,7 @@ This endpoint is hit with a GET and returns a JSON body like this:
|
||||||
"ServiceName": "redis"
|
"ServiceName": "redis"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### /v1/agent/services
|
### /v1/agent/services
|
||||||
|
|
||||||
|
|
@ -266,6 +274,7 @@ anti-entropy, so in most situations everything will be in sync within a few seco
|
||||||
|
|
||||||
This endpoint is hit with a GET and returns a JSON body like this:
|
This endpoint is hit with a GET and returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"redis": {
|
"redis": {
|
||||||
"ID": "redis",
|
"ID": "redis",
|
||||||
|
|
@ -274,6 +283,7 @@ This endpoint is hit with a GET and returns a JSON body like this:
|
||||||
"Port": 8000
|
"Port": 8000
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### /v1/agent/members
|
### /v1/agent/members
|
||||||
|
|
||||||
|
|
@ -287,6 +297,7 @@ the list of WAN members instead of the LAN members which is default.
|
||||||
|
|
||||||
This endpoint returns a JSON body like:
|
This endpoint returns a JSON body like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Name": "foobar",
|
"Name": "foobar",
|
||||||
|
|
@ -307,6 +318,7 @@ This endpoint returns a JSON body like:
|
||||||
"DelegateCur": 3
|
"DelegateCur": 3
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
### /v1/agent/self
|
### /v1/agent/self
|
||||||
|
|
||||||
|
|
@ -314,6 +326,7 @@ This endpoint is used to return configuration of the local agent and member info
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Config": {
|
"Config": {
|
||||||
"Bootstrap": true,
|
"Bootstrap": true,
|
||||||
|
|
@ -373,6 +386,7 @@ It returns a JSON body like this:
|
||||||
"DelegateCur": 4
|
"DelegateCur": 4
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### /v1/agent/join/\<address\>
|
### /v1/agent/join/\<address\>
|
||||||
|
|
||||||
|
|
@ -401,6 +415,7 @@ the status of the check and keeping the Catalog in sync.
|
||||||
The register endpoint expects a JSON request body to be PUT. The request
|
The register endpoint expects a JSON request body to be PUT. The request
|
||||||
body must look like:
|
body must look like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"ID": "mem",
|
"ID": "mem",
|
||||||
"Name": "Memory utilization",
|
"Name": "Memory utilization",
|
||||||
|
|
@ -409,6 +424,7 @@ body must look like:
|
||||||
"Interval": "10s",
|
"Interval": "10s",
|
||||||
"TTL": "15s"
|
"TTL": "15s"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
The `Name` field is mandatory, as is either `Script` and `Interval`
|
The `Name` field is mandatory, as is either `Script` and `Interval`
|
||||||
or `TTL`. Only one of `Script` and `Interval` or `TTL` should be provided.
|
or `TTL`. Only one of `Script` and `Interval` or `TTL` should be provided.
|
||||||
|
|
@ -474,6 +490,7 @@ the status of the check and keeping the Catalog in sync.
|
||||||
The register endpoint expects a JSON request body to be PUT. The request
|
The register endpoint expects a JSON request body to be PUT. The request
|
||||||
body must look like:
|
body must look like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"ID": "redis1",
|
"ID": "redis1",
|
||||||
"Name": "redis",
|
"Name": "redis",
|
||||||
|
|
@ -488,6 +505,7 @@ body must look like:
|
||||||
"TTL": "15s"
|
"TTL": "15s"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
The `Name` field is mandatory, If an `ID` is not provided, it is set to `Name`.
|
The `Name` field is mandatory, If an `ID` is not provided, it is set to `Name`.
|
||||||
You cannot have duplicate `ID` entries per agent, so it may be necessary to provide an ID.
|
You cannot have duplicate `ID` entries per agent, so it may be necessary to provide an ID.
|
||||||
|
|
@ -534,6 +552,7 @@ the agent local endpoints, as they are simpler and perform anti-entropy.
|
||||||
The register endpoint expects a JSON request body to be PUT. The request
|
The register endpoint expects a JSON request body to be PUT. The request
|
||||||
body must look like:
|
body must look like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Datacenter": "dc1",
|
"Datacenter": "dc1",
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -556,6 +575,7 @@ body must look like:
|
||||||
"ServiceID": "redis1"
|
"ServiceID": "redis1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
The behavior of the endpoint depends on what keys are provided. The endpoint
|
The behavior of the endpoint depends on what keys are provided. The endpoint
|
||||||
requires `Node` and `Address` to be provided, while `Datacenter` will be defaulted
|
requires `Node` and `Address` to be provided, while `Datacenter` will be defaulted
|
||||||
|
|
@ -593,22 +613,28 @@ endpoints, as they are simpler and perform anti-entropy.
|
||||||
The deregister endpoint expects a JSON request body to be PUT. The request
|
The deregister endpoint expects a JSON request body to be PUT. The request
|
||||||
body must look like one of the following:
|
body must look like one of the following:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Datacenter": "dc1",
|
"Datacenter": "dc1",
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Datacenter": "dc1",
|
"Datacenter": "dc1",
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
"CheckID": "service:redis1"
|
"CheckID": "service:redis1"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Datacenter": "dc1",
|
"Datacenter": "dc1",
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
"ServiceID": "redis1",
|
"ServiceID": "redis1",
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
The behavior of the endpoint depends on what keys are provided. The endpoint
|
The behavior of the endpoint depends on what keys are provided. The endpoint
|
||||||
requires `Node` to be provided, while `Datacenter` will be defaulted
|
requires `Node` to be provided, while `Datacenter` will be defaulted
|
||||||
|
|
@ -627,7 +653,9 @@ datacenters that are known by the Consul server.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
["dc1", "dc2"]
|
["dc1", "dc2"]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint does not require a cluster leader, and as such
|
This endpoint does not require a cluster leader, and as such
|
||||||
will succeed even during an availability outage. It can thus be
|
will succeed even during an availability outage. It can thus be
|
||||||
|
|
@ -641,6 +669,7 @@ however the dc can be provided using the "?dc=" query parameter.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": "baz",
|
"Node": "baz",
|
||||||
|
|
@ -651,6 +680,7 @@ It returns a JSON body like this:
|
||||||
"Address": "10.1.10.12"
|
"Address": "10.1.10.12"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -662,6 +692,7 @@ however the dc can be provided using the "?dc=" query parameter.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"consul": [],
|
"consul": [],
|
||||||
"redis": [],
|
"redis": [],
|
||||||
|
|
@ -670,6 +701,7 @@ It returns a JSON body like this:
|
||||||
"slave"
|
"slave"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
The main object keys are the service names, while the array
|
The main object keys are the service names, while the array
|
||||||
provides all the known tags for a given service.
|
provides all the known tags for a given service.
|
||||||
|
|
@ -688,6 +720,7 @@ by tag using the "?tag=" query parameter.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -698,6 +731,7 @@ It returns a JSON body like this:
|
||||||
"ServicePort": 8000
|
"ServicePort": 8000
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -710,6 +744,7 @@ The node being queried must be provided after the slash.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Node": {
|
"Node": {
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -732,6 +767,7 @@ It returns a JSON body like this:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -759,6 +795,7 @@ The node being queried must be provided after the slash.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -781,6 +818,7 @@ It returns a JSON body like this:
|
||||||
"ServiceName": "redis"
|
"ServiceName": "redis"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
In this case, we can see there is a system level check (no associated
|
In this case, we can see there is a system level check (no associated
|
||||||
`ServiceID`, as well as a service check for Redis). The "serfHealth" check
|
`ServiceID`, as well as a service check for Redis). The "serfHealth" check
|
||||||
|
|
@ -801,6 +839,7 @@ The service being queried must be provided after the slash.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -813,6 +852,7 @@ It returns a JSON body like this:
|
||||||
"ServiceName": "redis"
|
"ServiceName": "redis"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -841,6 +881,7 @@ by incorporating the use of health checks.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": {
|
"Node": {
|
||||||
|
|
@ -877,6 +918,7 @@ It returns a JSON body like this:
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -892,6 +934,7 @@ a wildcard that can be used to return all the checks.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -914,6 +957,7 @@ It returns a JSON body like this:
|
||||||
"ServiceName": "redis"
|
"ServiceName": "redis"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -945,12 +989,14 @@ to use cross-region sessions.
|
||||||
The create endpoint expects a JSON request body to be PUT. The request
|
The create endpoint expects a JSON request body to be PUT. The request
|
||||||
body must look like:
|
body must look like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"LockDelay": "15s",
|
"LockDelay": "15s",
|
||||||
"Name": "my-service-lock",
|
"Name": "my-service-lock",
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
"Checks": ["a", "b", "c"]
|
"Checks": ["a", "b", "c"]
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
None of the fields are mandatory, and in fact no body needs to be PUT
|
None of the fields are mandatory, and in fact no body needs to be PUT
|
||||||
if the defaults are to be used. The `LockDelay` field can be specified
|
if the defaults are to be used. The `LockDelay` field can be specified
|
||||||
|
|
@ -966,7 +1012,11 @@ It is highly recommended that if you override this list, you include that check.
|
||||||
|
|
||||||
The return code is 200 on success, along with a body like:
|
The return code is 200 on success, along with a body like:
|
||||||
|
|
||||||
{"ID":"adf4238a-882b-9ddc-4a9d-5b6758e4159e"}
|
```javascript
|
||||||
|
{
|
||||||
|
"ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
This is used to provide the ID of the newly created session.
|
This is used to provide the ID of the newly created session.
|
||||||
|
|
||||||
|
|
@ -988,6 +1038,7 @@ The session being queried must be provided after the slash.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"LockDelay": 1.5e+10,
|
"LockDelay": 1.5e+10,
|
||||||
|
|
@ -999,6 +1050,7 @@ It returns a JSON body like this:
|
||||||
"CreateIndex": 1086449
|
"CreateIndex": 1086449
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
If the session is not found, null is returned instead of a JSON list.
|
If the session is not found, null is returned instead of a JSON list.
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
@ -1012,6 +1064,7 @@ The node being queried must be provided after the slash.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"LockDelay": 1.5e+10,
|
"LockDelay": 1.5e+10,
|
||||||
|
|
@ -1024,6 +1077,7 @@ It returns a JSON body like this:
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -1035,6 +1089,7 @@ however the dc can be provided using the "?dc=" query parameter.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"LockDelay": 1.5e+10,
|
"LockDelay": 1.5e+10,
|
||||||
|
|
@ -1047,6 +1102,7 @@ It returns a JSON body like this:
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
This endpoint supports blocking queries and all consistency modes.
|
This endpoint supports blocking queries and all consistency modes.
|
||||||
|
|
||||||
|
|
@ -1080,11 +1136,13 @@ of the agent that the request is made to.
|
||||||
The create endpoint expects a JSON request body to be PUT. The request
|
The create endpoint expects a JSON request body to be PUT. The request
|
||||||
body must look like:
|
body must look like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Name": "my-app-token",
|
"Name": "my-app-token",
|
||||||
"Type": "client",
|
"Type": "client",
|
||||||
"Rules": ""
|
"Rules": ""
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
None of the fields are mandatory, and in fact no body needs to be PUT
|
None of the fields are mandatory, and in fact no body needs to be PUT
|
||||||
if the defaults are to be used. The `Name` and `Rules` default to being
|
if the defaults are to be used. The `Name` and `Rules` default to being
|
||||||
|
|
@ -1093,7 +1151,11 @@ blank, and the `Type` defaults to "client". The format of `Rules` is
|
||||||
|
|
||||||
The return code is 200 on success, along with a body like:
|
The return code is 200 on success, along with a body like:
|
||||||
|
|
||||||
{"ID":"adf4238a-882b-9ddc-4a9d-5b6758e4159e"}
|
```javascript
|
||||||
|
{
|
||||||
|
"ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
This is used to provide the ID of the newly created ACL token.
|
This is used to provide the ID of the newly created ACL token.
|
||||||
|
|
||||||
|
|
@ -1112,12 +1174,14 @@ of the agent that the request is made to.
|
||||||
The update endpoint expects a JSON request body to be PUT. The request
|
The update endpoint expects a JSON request body to be PUT. The request
|
||||||
body must look like:
|
body must look like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
|
"ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
|
||||||
"Name": "my-app-token-updated",
|
"Name": "my-app-token-updated",
|
||||||
"Type": "client",
|
"Type": "client",
|
||||||
"Rules": "# New Rules",
|
"Rules": "# New Rules",
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Only the `ID` field is mandatory, the other fields provide defaults.
|
Only the `ID` field is mandatory, the other fields provide defaults.
|
||||||
The `Name` and `Rules` default to being blank, and the `Type` defaults to "client".
|
The `Name` and `Rules` default to being blank, and the `Type` defaults to "client".
|
||||||
|
|
@ -1142,6 +1206,7 @@ The token being queried must be provided after the slash.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"CreateIndex": 3,
|
"CreateIndex": 3,
|
||||||
|
|
@ -1152,6 +1217,7 @@ It returns a JSON body like this:
|
||||||
"Rules": "..."
|
"Rules": "..."
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
If the session is not found, null is returned instead of a JSON list.
|
If the session is not found, null is returned instead of a JSON list.
|
||||||
|
|
||||||
|
|
@ -1165,7 +1231,11 @@ after the slash. Requests to this endpoint require a management token.
|
||||||
|
|
||||||
The return code is 200 on success, along with a body like:
|
The return code is 200 on success, along with a body like:
|
||||||
|
|
||||||
{"ID":"adf4238a-882b-9ddc-4a9d-5b6758e4159e"}
|
```javascript
|
||||||
|
{
|
||||||
|
"ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
This is used to provide the ID of the newly created ACL token.
|
This is used to provide the ID of the newly created ACL token.
|
||||||
|
|
||||||
|
|
@ -1177,6 +1247,7 @@ management token.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"CreateIndex": 3,
|
"CreateIndex": 3,
|
||||||
|
|
@ -1188,6 +1259,7 @@ It returns a JSON body like this:
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
## Event
|
## Event
|
||||||
|
|
||||||
|
|
@ -1218,6 +1290,7 @@ by node name, service, and service tags.
|
||||||
|
|
||||||
The return code is 200 on success, along with a body like:
|
The return code is 200 on success, along with a body like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"ID": "b54fe110-7af5-cafc-d1fb-afc8ba432b1c",
|
"ID": "b54fe110-7af5-cafc-d1fb-afc8ba432b1c",
|
||||||
"Name": "deploy",
|
"Name": "deploy",
|
||||||
|
|
@ -1228,6 +1301,7 @@ The return code is 200 on success, along with a body like:
|
||||||
"Version": 1,
|
"Version": 1,
|
||||||
"LTime": 0
|
"LTime": 0
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
This is used to provide the ID of the newly fired event.
|
This is used to provide the ID of the newly fired event.
|
||||||
|
|
||||||
|
|
@ -1267,11 +1341,12 @@ enough for most clients and watches.
|
||||||
|
|
||||||
It returns a JSON body like this:
|
It returns a JSON body like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"ID": "b54fe110-7af5-cafc-d1fb-afc8ba432b1c",
|
"ID": "b54fe110-7af5-cafc-d1fb-afc8ba432b1c",
|
||||||
"Name": "deploy",
|
"Name": "deploy",
|
||||||
"Payload": "MTYwOTAzMA=="",
|
"Payload": "MTYwOTAzMA==",
|
||||||
"NodeFilter": "",
|
"NodeFilter": "",
|
||||||
"ServiceFilter": "",
|
"ServiceFilter": "",
|
||||||
"TagFilter": "",
|
"TagFilter": "",
|
||||||
|
|
@ -1280,6 +1355,7 @@ It returns a JSON body like this:
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
|
|
@ -1297,11 +1373,19 @@ The following endpoints are supported:
|
||||||
This endpoint is used to get the Raft leader for the datacenter
|
This endpoint is used to get the Raft leader for the datacenter
|
||||||
the agent is running in. It returns only an address like:
|
the agent is running in. It returns only an address like:
|
||||||
|
|
||||||
|
```text
|
||||||
"10.1.10.12:8300"
|
"10.1.10.12:8300"
|
||||||
|
```
|
||||||
|
|
||||||
### /v1/status/peers
|
### /v1/status/peers
|
||||||
|
|
||||||
This endpoint is used to get the Raft peers for the datacenter
|
This endpoint is used to get the Raft peers for the datacenter
|
||||||
the agent is running in. It returns a list of addresses like:
|
the agent is running in. It returns a list of addresses like:
|
||||||
|
|
||||||
["10.1.10.12:8300", "10.1.10.11:8300", "10.1.10.10:8300"]
|
```javascript
|
||||||
|
[
|
||||||
|
"10.1.10.12:8300",
|
||||||
|
"10.1.10.11:8300",
|
||||||
|
"10.1.10.10:8300"
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Logging"
|
page_title: "Logging"
|
||||||
sidebar_current: "docs-agent"
|
sidebar_current: "docs-agent"
|
||||||
|
description: |-
|
||||||
|
TODO
|
||||||
---
|
---
|
||||||
|
|
||||||
# Logging
|
# Logging
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Configuration"
|
page_title: "Configuration"
|
||||||
sidebar_current: "docs-agent-config"
|
sidebar_current: "docs-agent-config"
|
||||||
|
description: |-
|
||||||
|
The agent has various configuration options that can be specified via the command-line or via configuration files. All of the configuration options are completely optional and their defaults will be specified with their descriptions.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
@ -156,7 +158,7 @@ definitions support being updated during a reload.
|
||||||
|
|
||||||
#### Example Configuration File
|
#### Example Configuration File
|
||||||
|
|
||||||
<pre class="prettyprint lang-json">
|
```javascript
|
||||||
{
|
{
|
||||||
"datacenter": "east-aws",
|
"datacenter": "east-aws",
|
||||||
"data_dir": "/opt/consul",
|
"data_dir": "/opt/consul",
|
||||||
|
|
@ -170,7 +172,7 @@ definitions support being updated during a reload.
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
</pre>
|
```
|
||||||
|
|
||||||
#### Configuration Key Reference
|
#### Configuration Key Reference
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "RPC"
|
page_title: "RPC"
|
||||||
sidebar_current: "docs-agent-rpc"
|
sidebar_current: "docs-agent-rpc"
|
||||||
|
description: |-
|
||||||
|
The Consul agent provides a complete RPC mechanism that can be used to control the agent programmatically. This RPC mechanism is the same one used by the CLI, but can be used by other applications to easily leverage the power of Consul without directly embedding.
|
||||||
---
|
---
|
||||||
|
|
||||||
# RPC Protocol
|
# RPC Protocol
|
||||||
|
|
@ -24,15 +26,21 @@ that is broadly available across languages.
|
||||||
All RPC requests have a request header, and some requests have
|
All RPC requests have a request header, and some requests have
|
||||||
a request body. The request header looks like:
|
a request body. The request header looks like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Command": "Handshake", "Seq": 0}
|
{
|
||||||
|
"Command": "Handshake",
|
||||||
|
"Seq": 0
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
All responses have a response header, and some may contain
|
All responses have a response header, and some may contain
|
||||||
a response body. The response header looks like:
|
a response body. The response header looks like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Seq": 0, "Error": ""}
|
{
|
||||||
|
"Seq": 0,
|
||||||
|
"Error": ""
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `Command` is used to specify what command the server should
|
The `Command` is used to specify what command the server should
|
||||||
|
|
@ -65,8 +73,10 @@ the server which version the client is using.
|
||||||
|
|
||||||
The request header must be followed with a handshake body, like:
|
The request header must be followed with a handshake body, like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Version": 1}
|
{
|
||||||
|
"Version": 1
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The body specifies the IPC version being used, however only version
|
The body specifies the IPC version being used, however only version
|
||||||
|
|
@ -81,8 +91,10 @@ response and check for an error.
|
||||||
This command is used to remove failed nodes from a cluster. It takes
|
This command is used to remove failed nodes from a cluster. It takes
|
||||||
the following body:
|
the following body:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Node": "failed-node-name"}
|
{
|
||||||
|
"Node": "failed-node-name"
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
There is no special response body.
|
There is no special response body.
|
||||||
|
|
@ -92,8 +104,14 @@ There is no special response body.
|
||||||
This command is used to join an existing cluster using a known node.
|
This command is used to join an existing cluster using a known node.
|
||||||
It takes the following body:
|
It takes the following body:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Existing": ["192.168.0.1:6000", "192.168.0.2:6000"], "WAN": false}
|
{
|
||||||
|
"Existing": [
|
||||||
|
"192.168.0.1:6000",
|
||||||
|
"192.168.0.2:6000"
|
||||||
|
],
|
||||||
|
"WAN": false
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `Existing` nodes are each contacted, and `WAN` controls if we are adding a
|
The `Existing` nodes are each contacted, and `WAN` controls if we are adding a
|
||||||
|
|
@ -105,8 +123,10 @@ WAN.
|
||||||
|
|
||||||
The response body in addition to the header is returned. The body looks like:
|
The response body in addition to the header is returned. The body looks like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Num": 2}
|
{
|
||||||
|
"Num": 2
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The body returns the number of nodes successfully joined.
|
The body returns the number of nodes successfully joined.
|
||||||
|
|
@ -118,8 +138,9 @@ information. All agents will respond to this command.
|
||||||
|
|
||||||
There is no request body, but the response looks like:
|
There is no request body, but the response looks like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Members": [
|
{
|
||||||
|
"Members": [
|
||||||
{
|
{
|
||||||
"Name": "TestNode"
|
"Name": "TestNode"
|
||||||
"Addr": [127, 0, 0, 1],
|
"Addr": [127, 0, 0, 1],
|
||||||
|
|
@ -135,7 +156,8 @@ There is no request body, but the response looks like:
|
||||||
"DelegateMax": 1,
|
"DelegateMax": 1,
|
||||||
"DelegateCur": 1,
|
"DelegateCur": 1,
|
||||||
},
|
},
|
||||||
...]
|
...
|
||||||
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -152,8 +174,10 @@ The monitor command subscribes the channel to log messages from the Agent.
|
||||||
|
|
||||||
The request is like:
|
The request is like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"LogLevel": "DEBUG"}
|
{
|
||||||
|
"LogLevel": "DEBUG"
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
This subscribes the client to all messages of at least DEBUG level.
|
This subscribes the client to all messages of at least DEBUG level.
|
||||||
|
|
@ -165,9 +189,15 @@ the same `Seq` as the monitor command that matches.
|
||||||
Assume we issued the previous monitor command with Seq `50`,
|
Assume we issued the previous monitor command with Seq `50`,
|
||||||
we may start getting messages like:
|
we may start getting messages like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Seq": 50, "Error": ""}
|
{
|
||||||
{"Log": "2013/12/03 13:06:53 [INFO] agent: Received event: member-join"}
|
"Seq": 50,
|
||||||
|
"Error": ""
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
"Log": "2013/12/03 13:06:53 [INFO] agent: Received event: member-join"
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
It is important to realize that these messages are sent asynchronously,
|
It is important to realize that these messages are sent asynchronously,
|
||||||
|
|
@ -184,8 +214,10 @@ To stop streaming, the `stop` command is used.
|
||||||
The stop command is used to stop a monitor.
|
The stop command is used to stop a monitor.
|
||||||
The request looks like:
|
The request looks like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{"Stop": 50}
|
{
|
||||||
|
"Stop": 50
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
This unsubscribes the client from the monitor with `Seq` value of 50.
|
This unsubscribes the client from the monitor with `Seq` value of 50.
|
||||||
|
|
@ -202,7 +234,7 @@ There is no request body, or special response body.
|
||||||
The stats command is used to provide operator information for debugging.
|
The stats command is used to provide operator information for debugging.
|
||||||
There is no request body, the response body looks like:
|
There is no request body, the response body looks like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{
|
{
|
||||||
"agent": {
|
"agent": {
|
||||||
"check_monitors": 0,
|
"check_monitors": 0,
|
||||||
|
|
@ -220,4 +252,3 @@ There is no request body, the response body looks like:
|
||||||
|
|
||||||
The reload command is used trigger a reload of configurations.
|
The reload command is used trigger a reload of configurations.
|
||||||
There is no request body, or special response body.
|
There is no request body, or special response body.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Service Definition"
|
page_title: "Service Definition"
|
||||||
sidebar_current: "docs-agent-services"
|
sidebar_current: "docs-agent-services"
|
||||||
|
description: |-
|
||||||
|
One of the main goals of service discovery is to provide a catalog of available services. To that end, the agent provides a simple service definition format to declare the availability of a service, and to potentially associate it with a health check. A health check is considered to be application level if it associated with a service. A service is defined in a configuration file, or added at runtime over the HTTP interface.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Services
|
# Services
|
||||||
|
|
@ -17,6 +19,7 @@ or added at runtime over the HTTP interface.
|
||||||
|
|
||||||
A service definition that is a script looks like:
|
A service definition that is a script looks like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"service": {
|
"service": {
|
||||||
"name": "redis",
|
"name": "redis",
|
||||||
|
|
@ -28,6 +31,7 @@ A service definition that is a script looks like:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
A service definition must include a `name`, and may optionally provide
|
A service definition must include a `name`, and may optionally provide
|
||||||
an `id`, `tags`, `port`, and `check`. The `id` is set to the `name` if not
|
an `id`, `tags`, `port`, and `check`. The `id` is set to the `name` if not
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Telemetry"
|
page_title: "Telemetry"
|
||||||
sidebar_current: "docs-agent-telemetry"
|
sidebar_current: "docs-agent-telemetry"
|
||||||
|
description: |-
|
||||||
|
The Consul agent collects various metrics data at runtime about the performance of different libraries and sub-systems. These metrics are aggregated on a ten second interval and are retained for one minute.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Telemetry
|
# Telemetry
|
||||||
|
|
@ -25,7 +27,7 @@ aggregate and flushed to Graphite or any other metrics store.
|
||||||
|
|
||||||
Below is an example output:
|
Below is an example output:
|
||||||
|
|
||||||
```
|
```text
|
||||||
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.num_goroutines': 19.000
|
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.num_goroutines': 19.000
|
||||||
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.alloc_bytes': 755960.000
|
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.alloc_bytes': 755960.000
|
||||||
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.malloc_count': 7550.000
|
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.malloc_count': 7550.000
|
||||||
|
|
@ -42,4 +44,3 @@ Below is an example output:
|
||||||
[2014-01-29 10:56:50 -0800 PST][S] 'consul-agent.serf.queue.Intent': Count: 10 Sum: 0.000
|
[2014-01-29 10:56:50 -0800 PST][S] 'consul-agent.serf.queue.Intent': Count: 10 Sum: 0.000
|
||||||
[2014-01-29 10:56:50 -0800 PST][S] 'consul-agent.serf.queue.Event': Count: 10 Min: 0.000 Mean: 2.500 Max: 5.000 Stddev: 2.121 Sum: 25.000
|
[2014-01-29 10:56:50 -0800 PST][S] 'consul-agent.serf.queue.Event': Count: 10 Min: 0.000 Mean: 2.500 Max: 5.000 Stddev: 2.121 Sum: 25.000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Watches"
|
page_title: "Watches"
|
||||||
sidebar_current: "docs-agent-watches"
|
sidebar_current: "docs-agent-watches"
|
||||||
|
description: |-
|
||||||
|
Watches are a way of specifying a view of data (list of nodes, KV pairs, health checks, etc) which is monitored for any updates. When an update is detected, an external handler is invoked. A handler can be any executable. As an example, you could watch the status of health checks and notify an external system when a check is critical.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Watches
|
# Watches
|
||||||
|
|
@ -74,11 +76,13 @@ This maps to the `/v1/kv/` API internally.
|
||||||
|
|
||||||
Here is an example configuration:
|
Here is an example configuration:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"type": "key",
|
"type": "key",
|
||||||
"key": "foo/bar/baz",
|
"key": "foo/bar/baz",
|
||||||
"handler": "/usr/bin/my-key-handler.sh"
|
"handler": "/usr/bin/my-key-handler.sh"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Or, using the watch command:
|
Or, using the watch command:
|
||||||
|
|
||||||
|
|
@ -86,6 +90,7 @@ Or, using the watch command:
|
||||||
|
|
||||||
An example of the output of this command:
|
An example of the output of this command:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"Key": "foo/bar/baz",
|
"Key": "foo/bar/baz",
|
||||||
"CreateIndex": 1793,
|
"CreateIndex": 1793,
|
||||||
|
|
@ -95,6 +100,7 @@ An example of the output of this command:
|
||||||
"Value": "aGV5",
|
"Value": "aGV5",
|
||||||
"Session": ""
|
"Session": ""
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Type: keyprefix
|
### Type: keyprefix
|
||||||
|
|
||||||
|
|
@ -105,11 +111,13 @@ This maps to the `/v1/kv/` API internally.
|
||||||
|
|
||||||
Here is an example configuration:
|
Here is an example configuration:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"type": "keyprefix",
|
"type": "keyprefix",
|
||||||
"prefix": "foo/",
|
"prefix": "foo/",
|
||||||
"handler": "/usr/bin/my-prefix-handler.sh"
|
"handler": "/usr/bin/my-prefix-handler.sh"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Or, using the watch command:
|
Or, using the watch command:
|
||||||
|
|
||||||
|
|
@ -117,6 +125,7 @@ Or, using the watch command:
|
||||||
|
|
||||||
An example of the output of this command:
|
An example of the output of this command:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Key": "foo/bar",
|
"Key": "foo/bar",
|
||||||
|
|
@ -146,7 +155,7 @@ An example of the output of this command:
|
||||||
"Session": ""
|
"Session": ""
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
### Type: services
|
### Type: services
|
||||||
|
|
||||||
|
|
@ -157,11 +166,13 @@ This maps to the `/v1/catalog/services` API internally.
|
||||||
|
|
||||||
An example of the output of this command:
|
An example of the output of this command:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"consul": [],
|
"consul": [],
|
||||||
"redis": [],
|
"redis": [],
|
||||||
"web": []
|
"web": []
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Type: nodes
|
### Type: nodes
|
||||||
|
|
||||||
|
|
@ -172,6 +183,7 @@ This maps to the `/v1/catalog/nodes` API internally.
|
||||||
|
|
||||||
An example of the output of this command:
|
An example of the output of this command:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": "nyc1-consul-1",
|
"Node": "nyc1-consul-1",
|
||||||
|
|
@ -198,6 +210,7 @@ An example of the output of this command:
|
||||||
"Address": "162.243.162.229"
|
"Address": "162.243.162.229"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
### Type: service
|
### Type: service
|
||||||
|
|
||||||
|
|
@ -211,11 +224,13 @@ This maps to the `/v1/health/service` API internally.
|
||||||
|
|
||||||
Here is an example configuration:
|
Here is an example configuration:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"type": "service",
|
"type": "service",
|
||||||
"service": "redis",
|
"key": "redis",
|
||||||
"handler": "/usr/bin/my-service-handler.sh"
|
"handler": "/usr/bin/my-service-handler.sh"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Or, using the watch command:
|
Or, using the watch command:
|
||||||
|
|
||||||
|
|
@ -223,6 +238,7 @@ Or, using the watch command:
|
||||||
|
|
||||||
An example of the output of this command:
|
An example of the output of this command:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": {
|
"Node": {
|
||||||
|
|
@ -259,6 +275,7 @@ An example of the output of this command:
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
### Type: checks
|
### Type: checks
|
||||||
|
|
||||||
|
|
@ -272,6 +289,7 @@ or `/v1/health/checks/` if monitoring by service.
|
||||||
|
|
||||||
An example of the output of this command:
|
An example of the output of this command:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Node": "foobar",
|
"Node": "foobar",
|
||||||
|
|
@ -284,7 +302,7 @@ An example of the output of this command:
|
||||||
"ServiceName": "redis"
|
"ServiceName": "redis"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
### Type: event
|
### Type: event
|
||||||
|
|
||||||
|
|
@ -297,11 +315,13 @@ This maps to the `v1/event/list` API internally.
|
||||||
|
|
||||||
Here is an example configuration:
|
Here is an example configuration:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"type": "event",
|
"type": "event",
|
||||||
"name": "web-deploy",
|
"name": "web-deploy",
|
||||||
"handler": "/usr/bin/my-deploy-handler.sh"
|
"handler": "/usr/bin/my-deploy-handler.sh"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Or, using the watch command:
|
Or, using the watch command:
|
||||||
|
|
||||||
|
|
@ -309,6 +329,7 @@ Or, using the watch command:
|
||||||
|
|
||||||
An example of the output of this command:
|
An example of the output of this command:
|
||||||
|
|
||||||
|
```javascript
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"ID": "f07f3fcc-4b7d-3a7c-6d1e-cf414039fcee",
|
"ID": "f07f3fcc-4b7d-3a7c-6d1e-cf414039fcee",
|
||||||
|
|
@ -322,8 +343,8 @@ An example of the output of this command:
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
]
|
]
|
||||||
|
```
|
||||||
|
|
||||||
To fire a new `web-deploy` event the following could be used:
|
To fire a new `web-deploy` event the following could be used:
|
||||||
|
|
||||||
$ consul event -name web-deploy 1609030
|
$ consul event -name web-deploy 1609030
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Agent"
|
page_title: "Commands: Agent"
|
||||||
sidebar_current: "docs-commands-agent"
|
sidebar_current: "docs-commands-agent"
|
||||||
|
description: |-
|
||||||
|
The `consul agent` command is the heart of Consul: it runs the agent that performs the important task of maintaining membership information, running checks, announcing services, handling queries, etc.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Agent
|
# Consul Agent
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Event"
|
page_title: "Commands: Event"
|
||||||
sidebar_current: "docs-commands-event"
|
sidebar_current: "docs-commands-event"
|
||||||
|
description: |-
|
||||||
|
The event command provides a mechanism to fire a custom user event to an entire datacenter. These events are opaque to Consul, but they can be used to build scripting infrastructure to do automated deploys, restart services, or perform any other orchestration action. Events can be handled by using a watch.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Event
|
# Consul Event
|
||||||
|
|
||||||
Command: `consul event`
|
Command: `consul event`
|
||||||
|
|
||||||
The event command provides a mechanism to fire a custom user event to an
|
The `event` command provides a mechanism to fire a custom user event to an
|
||||||
entire datacenter. These events are opaque to Consul, but they can be used
|
entire datacenter. These events are opaque to Consul, but they can be used
|
||||||
to build scripting infrastructure to do automated deploys, restart services,
|
to build scripting infrastructure to do automated deploys, restart services,
|
||||||
or perform any other orchestration action. Events can be handled by
|
or perform any other orchestration action. Events can be handled by
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Exec"
|
page_title: "Commands: Exec"
|
||||||
sidebar_current: "docs-commands-exec"
|
sidebar_current: "docs-commands-exec"
|
||||||
|
description: |-
|
||||||
|
The exec command provides a mechanism for remote execution. For example, this can be used to run the `uptime` command across all machines providing the `web` service.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Exec
|
# Consul Exec
|
||||||
|
|
||||||
Command: `consul exec`
|
Command: `consul exec`
|
||||||
|
|
||||||
The exec command provides a mechanism for remote execution. For example,
|
The `exec` command provides a mechanism for remote execution. For example,
|
||||||
this can be used to run the `uptime` command across all machines providing
|
this can be used to run the `uptime` command across all machines providing
|
||||||
the `web` service.
|
the `web` service.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Force Leave"
|
page_title: "Commands: Force Leave"
|
||||||
sidebar_current: "docs-commands-forceleave"
|
sidebar_current: "docs-commands-forceleave"
|
||||||
|
description: |-
|
||||||
|
The `force-leave` command forces a member of a Consul cluster to enter the left state. Note that if the member is still actually alive, it will eventually rejoin the cluster. The true purpose of this method is to force remove failed nodes.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Force Leave
|
# Consul Force Leave
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands"
|
page_title: "Commands"
|
||||||
sidebar_current: "docs-commands"
|
sidebar_current: "docs-commands"
|
||||||
|
description: |-
|
||||||
|
Consul is controlled via a very easy to use command-line interface (CLI). Consul is only a single command-line application: `consul`. This application then takes a subcommand such as agent or members. The complete list of subcommands is in the navigation to the left.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Commands (CLI)
|
# Consul Commands (CLI)
|
||||||
|
|
@ -19,7 +21,7 @@ as you'd most likely expect. And some commands that expect input accept
|
||||||
To view a list of the available commands at any time, just run `consul` with
|
To view a list of the available commands at any time, just run `consul` with
|
||||||
no arguments:
|
no arguments:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul
|
$ consul
|
||||||
usage: consul [--version] [--help] <command> [<args>]
|
usage: consul [--version] [--help] <command> [<args>]
|
||||||
|
|
||||||
|
|
@ -42,7 +44,7 @@ Available commands are:
|
||||||
To get help for any specific command, pass the `-h` flag to the relevant
|
To get help for any specific command, pass the `-h` flag to the relevant
|
||||||
subcommand. For example, to see help about the `join` subcommand:
|
subcommand. For example, to see help about the `join` subcommand:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul join -h
|
$ consul join -h
|
||||||
Usage: consul join [options] address ...
|
Usage: consul join [options] address ...
|
||||||
|
|
||||||
|
|
@ -53,5 +55,4 @@ Options:
|
||||||
|
|
||||||
-rpc-addr=127.0.0.1:8400 RPC address of the Consul agent.
|
-rpc-addr=127.0.0.1:8400 RPC address of the Consul agent.
|
||||||
-wan Joins a server to another server in the WAN pool
|
-wan Joins a server to another server in the WAN pool
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Info"
|
page_title: "Commands: Info"
|
||||||
sidebar_current: "docs-commands-info"
|
sidebar_current: "docs-commands-info"
|
||||||
|
description: |-
|
||||||
|
The `info` command provides various debugging information that can be useful to operators. Depending on if the agent is a client or server, information about different sub-systems will be returned.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Info
|
# Consul Info
|
||||||
|
|
||||||
Command: `consul info`
|
Command: `consul info`
|
||||||
|
|
||||||
The info command provides various debugging information that can be
|
The `info` command provides various debugging information that can be
|
||||||
useful to operators. Depending on if the agent is a client or server,
|
useful to operators. Depending on if the agent is a client or server,
|
||||||
information about different sub-systems will be returned.
|
information about different sub-systems will be returned.
|
||||||
|
|
||||||
|
|
@ -22,6 +24,7 @@ There are currently the top-level keys for:
|
||||||
|
|
||||||
Here is an example output:
|
Here is an example output:
|
||||||
|
|
||||||
|
```text
|
||||||
agent:
|
agent:
|
||||||
check_monitors = 0
|
check_monitors = 0
|
||||||
check_ttls = 0
|
check_ttls = 0
|
||||||
|
|
@ -63,6 +66,7 @@ Here is an example output:
|
||||||
members = 1
|
members = 1
|
||||||
query_queue = 0
|
query_queue = 0
|
||||||
query_time = 1
|
query_time = 1
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Join"
|
page_title: "Commands: Join"
|
||||||
sidebar_current: "docs-commands-join"
|
sidebar_current: "docs-commands-join"
|
||||||
|
description: |-
|
||||||
|
The `join` command tells a Consul agent to join an existing cluster. A new Consul agent must join with at least one existing member of a cluster in order to join an existing cluster. After joining that one member, the gossip layer takes over, propagating the updated membership state across the cluster.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Join
|
# Consul Join
|
||||||
|
|
||||||
Command: `consul join`
|
Command: `consul join`
|
||||||
|
|
||||||
The `consul join` command tells a Consul agent to join an existing cluster.
|
The `join` command tells a Consul agent to join an existing cluster.
|
||||||
A new Consul agent must join with at least one existing member of a cluster
|
A new Consul agent must join with at least one existing member of a cluster
|
||||||
in order to join an existing cluster. After joining that one member,
|
in order to join an existing cluster. After joining that one member,
|
||||||
the gossip layer takes over, propagating the updated membership state across
|
the gossip layer takes over, propagating the updated membership state across
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,16 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Keygen"
|
page_title: "Commands: Keygen"
|
||||||
sidebar_current: "docs-commands-keygen"
|
sidebar_current: "docs-commands-keygen"
|
||||||
|
description: |-
|
||||||
|
The `keygen` command generates an encryption key that can be used for Consul agent traffic encryption. The keygen command uses a cryptographically strong pseudo-random number generator to generate the key.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Keygen
|
# Consul Keygen
|
||||||
|
|
||||||
Command: `consul keygen`
|
Command: `consul keygen`
|
||||||
|
|
||||||
The `consul keygen` command generates an encryption key that can be used for
|
The `keygen` command generates an encryption key that can be used for
|
||||||
[Consul agent traffic encryption](/docs/agent/encryption.html).
|
[Consul agent traffic encryption](/docs/agent/encryption.html).
|
||||||
The keygen command uses a cryptographically
|
The keygen command uses a cryptographically
|
||||||
strong pseudo-random number generator to generate the key.
|
strong pseudo-random number generator to generate the key.
|
||||||
|
|
|
||||||
|
|
@ -2,15 +2,16 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Leave"
|
page_title: "Commands: Leave"
|
||||||
sidebar_current: "docs-commands-leave"
|
sidebar_current: "docs-commands-leave"
|
||||||
|
description: |-
|
||||||
|
The `leave` command triggers a graceful leave and shutdown of the agent. It is used to ensure other nodes see the agent as left instead of failed. Nodes that leave will not attempt to re-join the cluster on restarting with a snapshot.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Leave
|
# Consul Leave
|
||||||
|
|
||||||
Command: `consul leave`
|
Command: `consul leave`
|
||||||
|
|
||||||
The leave command triggers a graceful leave and shutdown of the agent.
|
The `leave` command triggers a graceful leave and shutdown of the agent.
|
||||||
|
It is used to ensure other nodes see the agent as "left" instead of
|
||||||
This is used to ensure other nodes see the agent as "left" instead of
|
|
||||||
"failed". Nodes that leave will not attempt to re-join the cluster
|
"failed". Nodes that leave will not attempt to re-join the cluster
|
||||||
on restarting with a snapshot.
|
on restarting with a snapshot.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Members"
|
page_title: "Commands: Members"
|
||||||
sidebar_current: "docs-commands-members"
|
sidebar_current: "docs-commands-members"
|
||||||
|
description: |-
|
||||||
|
The `members` command outputs the current list of members that a Consul agent knows about, along with their state. The state of a node can only be alive, left, or failed.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Members
|
# Consul Members
|
||||||
|
|
||||||
Command: `consul members`
|
Command: `consul members`
|
||||||
|
|
||||||
The members command outputs the current list of members that a Consul
|
The `members` command outputs the current list of members that a Consul
|
||||||
agent knows about, along with their state. The state of a node can only
|
agent knows about, along with their state. The state of a node can only
|
||||||
be "alive", "left", or "failed".
|
be "alive", "left", or "failed".
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Monitor"
|
page_title: "Commands: Monitor"
|
||||||
sidebar_current: "docs-commands-monitor"
|
sidebar_current: "docs-commands-monitor"
|
||||||
|
description: |-
|
||||||
|
The `monitor` command is used to connect and follow the logs of a running Consul agent. Monitor will show the recent logs and then continue to follow the logs, not exiting until interrupted or until the remote agent quits.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Monitor
|
# Consul Monitor
|
||||||
|
|
||||||
Command: `consul monitor`
|
Command: `consul monitor`
|
||||||
|
|
||||||
The monitor command is used to connect and follow the logs of a running
|
The `monitor` command is used to connect and follow the logs of a running
|
||||||
Consul agent. Monitor will show the recent logs and then continue to follow
|
Consul agent. Monitor will show the recent logs and then continue to follow
|
||||||
the logs, not exiting until interrupted or until the remote agent quits.
|
the logs, not exiting until interrupted or until the remote agent quits.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Reload"
|
page_title: "Commands: Reload"
|
||||||
sidebar_current: "docs-commands-reload"
|
sidebar_current: "docs-commands-reload"
|
||||||
|
description: |-
|
||||||
|
The `reload` command triggers a reload of configuration files for the agent.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Reload
|
# Consul Reload
|
||||||
|
|
||||||
Command: `consul reload`
|
Command: `consul reload`
|
||||||
|
|
||||||
The reload command triggers a reload of configuration files for the agent.
|
The `reload` command triggers a reload of configuration files for the agent.
|
||||||
|
|
||||||
The `SIGHUP` signal is usually used to trigger a reload of configurations,
|
The `SIGHUP` signal is usually used to trigger a reload of configurations,
|
||||||
but in some cases it may be more convenient to trigger the CLI instead.
|
but in some cases it may be more convenient to trigger the CLI instead.
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,15 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Commands: Watch"
|
page_title: "Commands: Watch"
|
||||||
sidebar_current: "docs-commands-watch"
|
sidebar_current: "docs-commands-watch"
|
||||||
|
description: |-
|
||||||
|
The `watch` command provides a mechanism to watch for changes in a particular data view (list of nodes, service members, key value, etc) and to invoke a process with the latest values of the view. If no process is specified, the current values are dumped to stdout which can be a useful way to inspect data in Consul.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Watch
|
# Consul Watch
|
||||||
|
|
||||||
Command: `consul watch`
|
Command: `consul watch`
|
||||||
|
|
||||||
The watch command provides a mechanism to watch for changes in a particular
|
The `watch` command provides a mechanism to watch for changes in a particular
|
||||||
data view (list of nodes, service members, key value, etc) and to invoke
|
data view (list of nodes, service members, key value, etc) and to invoke
|
||||||
a process with the latest values of the view. If no process is specified,
|
a process with the latest values of the view. If no process is specified,
|
||||||
the current values are dumped to stdout which can be a useful way to inspect
|
the current values are dumped to stdout which can be a useful way to inspect
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Consul Protocol Compatibility Promise"
|
page_title: "Consul Protocol Compatibility Promise"
|
||||||
sidebar_current: "docs-upgrading-compatibility"
|
sidebar_current: "docs-upgrading-compatibility"
|
||||||
|
description: |-
|
||||||
|
We expect Consul to run in large clusters as long-running agents. Because upgrading agents in this sort of environment relies heavily on protocol compatibility, this page makes it clear on our promise to keeping different Consul versions compatible with each other.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Protocol Compatibility Promise
|
# Protocol Compatibility Promise
|
||||||
|
|
@ -49,4 +51,3 @@ upgrading, see the [upgrading page](/docs/upgrading.html).
|
||||||
<td>1, 2</td>
|
<td>1, 2</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Bootstrapping"
|
page_title: "Bootstrapping"
|
||||||
sidebar_current: "docs-guides-bootstrapping"
|
sidebar_current: "docs-guides-bootstrapping"
|
||||||
|
description: |-
|
||||||
|
Before a Consul cluster can begin to service requests, it is necessary for a server node to be elected leader. For this reason, the first nodes that are started are generally the server nodes. Remember that an agent can run in both client and server mode. Server nodes are responsible for running the consensus protocol, and storing the cluster state. The client nodes are mostly stateless and rely on the server nodes, so they can be started easily.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Bootstrapping a Datacenter
|
# Bootstrapping a Datacenter
|
||||||
|
|
@ -26,22 +28,28 @@ discouraged as data loss is inevitable in a failure scenario.
|
||||||
Suppose we are starting a 3 server cluster, we can start `Node A`, `Node B` and `Node C` providing
|
Suppose we are starting a 3 server cluster, we can start `Node A`, `Node B` and `Node C` providing
|
||||||
the `-bootstrap-expect 3` flag. Once the nodes are started, you should see a message to the effect of:
|
the `-bootstrap-expect 3` flag. Once the nodes are started, you should see a message to the effect of:
|
||||||
|
|
||||||
|
```text
|
||||||
[WARN] raft: EnableSingleNode disabled, and no known peers. Aborting election.
|
[WARN] raft: EnableSingleNode disabled, and no known peers. Aborting election.
|
||||||
|
```
|
||||||
|
|
||||||
This indicates that the nodes are expecting 2 peers, but none are known yet. The servers will not elect
|
This indicates that the nodes are expecting 2 peers, but none are known yet. The servers will not elect
|
||||||
themselves leader to prevent a split-brain. We can now join these machines together. Since a join operation
|
themselves leader to prevent a split-brain. We can now join these machines together. Since a join operation
|
||||||
is symmetric it does not matter which node initiates it. From any node you can do the following:
|
is symmetric it does not matter which node initiates it. From any node you can do the following:
|
||||||
|
|
||||||
|
```text
|
||||||
$ consul join <Node A Address> <Node B Address> <Node C Address>
|
$ consul join <Node A Address> <Node B Address> <Node C Address>
|
||||||
Successfully joined cluster by contacting 3 nodes.
|
Successfully joined cluster by contacting 3 nodes.
|
||||||
|
```
|
||||||
|
|
||||||
Once the join is successful, one of the nodes will output something like:
|
Once the join is successful, one of the nodes will output something like:
|
||||||
|
|
||||||
|
```text
|
||||||
[INFO] consul: adding server foo (Addr: 127.0.0.2:8300) (DC: dc1)
|
[INFO] consul: adding server foo (Addr: 127.0.0.2:8300) (DC: dc1)
|
||||||
[INFO] consul: adding server bar (Addr: 127.0.0.1:8300) (DC: dc1)
|
[INFO] consul: adding server bar (Addr: 127.0.0.1:8300) (DC: dc1)
|
||||||
[INFO] consul: Attempting bootstrap with nodes: [127.0.0.3:8300 127.0.0.2:8300 127.0.0.1:8300]
|
[INFO] consul: Attempting bootstrap with nodes: [127.0.0.3:8300 127.0.0.2:8300 127.0.0.1:8300]
|
||||||
...
|
...
|
||||||
[INFO] consul: cluster leadership acquired
|
[INFO] consul: cluster leadership acquired
|
||||||
|
```
|
||||||
|
|
||||||
As a sanity check, the `consul info` command is a useful tool. It can be used to
|
As a sanity check, the `consul info` command is a useful tool. It can be used to
|
||||||
verify `raft.num_peers` is now 2, and you can view the latest log index under `raft.last_log_index`.
|
verify `raft.num_peers` is now 2, and you can view the latest log index under `raft.last_log_index`.
|
||||||
|
|
@ -64,4 +72,3 @@ In versions of Consul previous to 0.4, bootstrapping was a more manual process.
|
||||||
For a guide on using the `-bootstrap` flag directly, see the [manual bootstrapping guide](/docs/guides/manual-bootstrap.html).
|
For a guide on using the `-bootstrap` flag directly, see the [manual bootstrapping guide](/docs/guides/manual-bootstrap.html).
|
||||||
|
|
||||||
This is not recommended, as it is more error prone than automatic bootstrapping.
|
This is not recommended, as it is more error prone than automatic bootstrapping.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Multiple Datacenters"
|
page_title: "Multiple Datacenters"
|
||||||
sidebar_current: "docs-guides-datacenters"
|
sidebar_current: "docs-guides-datacenters"
|
||||||
|
description: |-
|
||||||
|
One of the key features of Consul is its support for multiple datacenters. The architecture of Consul is designed to promote a low-coupling of datacenters, so that connectivity issues or failure of any datacenter does not impact the availability of Consul in other regions. This means each datacenter runs independently, with a dedicated group of servers and a private LAN gossip pool.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Multi-Datacenter Deploys
|
# Multi-Datacenter Deploys
|
||||||
|
|
@ -20,7 +22,7 @@ we can refer to as `dc1` and `dc2`, although the names are opaque to Consul.
|
||||||
The next step is to ensure that all the server nodes join the WAN gossip pool.
|
The next step is to ensure that all the server nodes join the WAN gossip pool.
|
||||||
To query the known WAN nodes, we use the `members` command:
|
To query the known WAN nodes, we use the `members` command:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul members -wan
|
$ consul members -wan
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
@ -31,7 +33,7 @@ to a datacenter-local server, which then forwards the request to a server in the
|
||||||
|
|
||||||
The next step is to simply join all the servers in the WAN pool:
|
The next step is to simply join all the servers in the WAN pool:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul join -wan <server 1> <server 2> ...
|
$ consul join -wan <server 1> <server 2> ...
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
@ -46,14 +48,14 @@ Once this is done the `members` command can be used to verify that
|
||||||
all server nodes are known about. We can also verify that both datacenters
|
all server nodes are known about. We can also verify that both datacenters
|
||||||
are known using the HTTP API:
|
are known using the HTTP API:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl http://localhost:8500/v1/catalog/datacenters
|
$ curl http://localhost:8500/v1/catalog/datacenters
|
||||||
["dc1", "dc2"]
|
["dc1", "dc2"]
|
||||||
```
|
```
|
||||||
|
|
||||||
As a simple test, you can try to query the nodes in each datacenter:
|
As a simple test, you can try to query the nodes in each datacenter:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl http://localhost:8500/v1/catalog/nodes?dc=dc1
|
$ curl http://localhost:8500/v1/catalog/nodes?dc=dc1
|
||||||
...
|
...
|
||||||
$ curl http://localhost:8500/v1/catalog/nodes?dc=dc2
|
$ curl http://localhost:8500/v1/catalog/nodes?dc=dc2
|
||||||
|
|
@ -67,4 +69,3 @@ is to be used across datacenters, then the network must be able to route traffic
|
||||||
between IP addresses across regions as well. Usually, this means that all datacenters
|
between IP addresses across regions as well. Usually, this means that all datacenters
|
||||||
must be connected using a VPN or other tunneling mechanism. Consul does not handle
|
must be connected using a VPN or other tunneling mechanism. Consul does not handle
|
||||||
VPN, address rewriting, or NAT traversal for you.
|
VPN, address rewriting, or NAT traversal for you.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "DNS Caching"
|
page_title: "DNS Caching"
|
||||||
sidebar_current: "docs-guides-dns-cache"
|
sidebar_current: "docs-guides-dns-cache"
|
||||||
|
description: |-
|
||||||
|
One of the main interfaces to Consul is DNS. Using DNS is a simple way integrate Consul into an existing infrastructure without any high-touch integration.
|
||||||
---
|
---
|
||||||
|
|
||||||
# DNS Caching
|
# DNS Caching
|
||||||
|
|
@ -57,7 +59,7 @@ that matches if there is no specific service TTL provided.
|
||||||
This is specified using the `dns_config.service_ttl` map. The "*" service
|
This is specified using the `dns_config.service_ttl` map. The "*" service
|
||||||
is the wildcard service. For example, if we specify:
|
is the wildcard service. For example, if we specify:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
{
|
{
|
||||||
"dns_config": {
|
"dns_config": {
|
||||||
"service_ttl": {
|
"service_ttl": {
|
||||||
|
|
@ -71,4 +73,3 @@ is the wildcard service. For example, if we specify:
|
||||||
This sets all lookups to "web.service.consul" to use a 30 second TTL,
|
This sets all lookups to "web.service.consul" to use a 30 second TTL,
|
||||||
while lookups to "db.service.consul" or "api.service.consul" will use the
|
while lookups to "db.service.consul" or "api.service.consul" will use the
|
||||||
5 second TTL from the wildcard.
|
5 second TTL from the wildcard.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "External Services"
|
page_title: "External Services"
|
||||||
sidebar_current: "docs-guides-external"
|
sidebar_current: "docs-guides-external"
|
||||||
|
description: |-
|
||||||
|
Very few infrastructures are entirely self-contained, and often rely on a multitude of external service providers. Most services are registered in Consul through the use of a service definition, however that registers the local node as the service provider. In the case of external services, we want to register a service as being provided by an external provider.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Registering an External Service
|
# Registering an External Service
|
||||||
|
|
@ -21,11 +23,14 @@ also appear in standard queries against the API.
|
||||||
Let us suppose we want to register a "search" service that is provided by
|
Let us suppose we want to register a "search" service that is provided by
|
||||||
"www.google.com", we could do the following:
|
"www.google.com", we could do the following:
|
||||||
|
|
||||||
|
```text
|
||||||
$ curl -X PUT -d '{"Datacenter": "dc1", "Node": "google", "Address": "www.google.com",
|
$ curl -X PUT -d '{"Datacenter": "dc1", "Node": "google", "Address": "www.google.com",
|
||||||
"Service": {"Service": "search", "Port": 80}}' http://127.0.0.1:8500/v1/catalog/register
|
"Service": {"Service": "search", "Port": 80}}' http://127.0.0.1:8500/v1/catalog/register
|
||||||
|
```
|
||||||
|
|
||||||
If we do a DNS lookup now, we can see the new search service:
|
If we do a DNS lookup now, we can see the new search service:
|
||||||
|
|
||||||
|
```text
|
||||||
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 search.service.consul.
|
; <<>> DiG 9.8.3-P1 <<>> @127.0.0.1 -p 8600 search.service.consul.
|
||||||
; (1 server found)
|
; (1 server found)
|
||||||
;; global options: +cmd
|
;; global options: +cmd
|
||||||
|
|
@ -46,11 +51,13 @@ If we do a DNS lookup now, we can see the new search service:
|
||||||
;; SERVER: 127.0.0.1#8600(127.0.0.1)
|
;; SERVER: 127.0.0.1#8600(127.0.0.1)
|
||||||
;; WHEN: Tue Feb 25 17:45:12 2014
|
;; WHEN: Tue Feb 25 17:45:12 2014
|
||||||
;; MSG SIZE rcvd: 178
|
;; MSG SIZE rcvd: 178
|
||||||
|
```
|
||||||
|
|
||||||
If at any time we want to deregister the service, we can simply do:
|
If at any time we want to deregister the service, we can simply do:
|
||||||
|
|
||||||
|
```text
|
||||||
$ curl -X PUT -d '{"Datacenter": "dc1", "Node": "google"}' http://127.0.0.1:8500/v1/catalog/deregister
|
$ curl -X PUT -d '{"Datacenter": "dc1", "Node": "google"}' http://127.0.0.1:8500/v1/catalog/deregister
|
||||||
|
```
|
||||||
|
|
||||||
This will deregister the `google` node, along with all services it provides.
|
This will deregister the `google` node, along with all services it provides.
|
||||||
To learn more, read about the [HTTP API](/docs/agent/http.html).
|
To learn more, read about the [HTTP API](/docs/agent/http.html).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Forwarding"
|
page_title: "Forwarding"
|
||||||
sidebar_current: "docs-guides-forwarding"
|
sidebar_current: "docs-guides-forwarding"
|
||||||
|
description: |-
|
||||||
|
By default, DNS is served from port 53 which requires root privileges. Instead of running Consul as root, it is possible to instead run Bind and forward queries to Consul as appropriate.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Forwarding DNS
|
# Forwarding DNS
|
||||||
|
|
@ -18,6 +20,7 @@ simplicity but this is not required.
|
||||||
First, you have to disable DNSSEC so that Consul and Bind can communicate.
|
First, you have to disable DNSSEC so that Consul and Bind can communicate.
|
||||||
This is an example configuration:
|
This is an example configuration:
|
||||||
|
|
||||||
|
```text
|
||||||
options {
|
options {
|
||||||
listen-on port 53 { 127.0.0.1; };
|
listen-on port 53 { 127.0.0.1; };
|
||||||
listen-on-v6 port 53 { ::1; };
|
listen-on-v6 port 53 { ::1; };
|
||||||
|
|
@ -38,16 +41,19 @@ This is an example configuration:
|
||||||
};
|
};
|
||||||
|
|
||||||
include "/etc/named/consul.conf";
|
include "/etc/named/consul.conf";
|
||||||
|
```
|
||||||
|
|
||||||
### Zone File
|
### Zone File
|
||||||
|
|
||||||
Then we set up a zone for our Consul managed records in consul.conf:
|
Then we set up a zone for our Consul managed records in consul.conf:
|
||||||
|
|
||||||
|
```text
|
||||||
zone "consul" IN {
|
zone "consul" IN {
|
||||||
type forward;
|
type forward;
|
||||||
forward only;
|
forward only;
|
||||||
forwarders { 127.0.0.1 port 8600; };
|
forwarders { 127.0.0.1 port 8600; };
|
||||||
};
|
};
|
||||||
|
```
|
||||||
|
|
||||||
Here we assume Consul is running with default settings, and is serving
|
Here we assume Consul is running with default settings, and is serving
|
||||||
DNS on port 8600.
|
DNS on port 8600.
|
||||||
|
|
@ -56,6 +62,7 @@ DNS on port 8600.
|
||||||
|
|
||||||
First, perform a DNS query against Consul directly to be sure that the record exists:
|
First, perform a DNS query against Consul directly to be sure that the record exists:
|
||||||
|
|
||||||
|
```text
|
||||||
[root@localhost ~]# dig @localhost -p 8600 master.redis.service.dc-1.consul. A
|
[root@localhost ~]# dig @localhost -p 8600 master.redis.service.dc-1.consul. A
|
||||||
|
|
||||||
; <<>> DiG 9.8.2rc1-RedHat-9.8.2-0.23.rc1.32.amzn1 <<>> @localhost master.redis.service.dc-1.consul. A
|
; <<>> DiG 9.8.2rc1-RedHat-9.8.2-0.23.rc1.32.amzn1 <<>> @localhost master.redis.service.dc-1.consul. A
|
||||||
|
|
@ -75,9 +82,11 @@ First, perform a DNS query against Consul directly to be sure that the record ex
|
||||||
;; SERVER: 127.0.0.1#53(127.0.0.1)
|
;; SERVER: 127.0.0.1#53(127.0.0.1)
|
||||||
;; WHEN: Wed Apr 9 17:36:12 2014
|
;; WHEN: Wed Apr 9 17:36:12 2014
|
||||||
;; MSG SIZE rcvd: 76
|
;; MSG SIZE rcvd: 76
|
||||||
|
```
|
||||||
|
|
||||||
Then run the same query against your Bind instance and make sure you get a result:
|
Then run the same query against your Bind instance and make sure you get a result:
|
||||||
|
|
||||||
|
```text
|
||||||
[root@localhost ~]# dig @localhost -p 53 master.redis.service.dc-1.consul. A
|
[root@localhost ~]# dig @localhost -p 53 master.redis.service.dc-1.consul. A
|
||||||
|
|
||||||
; <<>> DiG 9.8.2rc1-RedHat-9.8.2-0.23.rc1.32.amzn1 <<>> @localhost master.redis.service.dc-1.consul. A
|
; <<>> DiG 9.8.2rc1-RedHat-9.8.2-0.23.rc1.32.amzn1 <<>> @localhost master.redis.service.dc-1.consul. A
|
||||||
|
|
@ -97,19 +106,24 @@ Then run the same query against your Bind instance and make sure you get a resul
|
||||||
;; SERVER: 127.0.0.1#53(127.0.0.1)
|
;; SERVER: 127.0.0.1#53(127.0.0.1)
|
||||||
;; WHEN: Wed Apr 9 17:36:12 2014
|
;; WHEN: Wed Apr 9 17:36:12 2014
|
||||||
;; MSG SIZE rcvd: 76
|
;; MSG SIZE rcvd: 76
|
||||||
|
```
|
||||||
|
|
||||||
### Troubleshooting
|
### Troubleshooting
|
||||||
|
|
||||||
If you don't get an answer from Bind but you do get an answer from Consul then your
|
If you don't get an answer from Bind but you do get an answer from Consul then your
|
||||||
best bet is to turn on the query log to see what's going on:
|
best bet is to turn on the query log to see what's going on:
|
||||||
|
|
||||||
|
```text
|
||||||
[root@localhost ~]# rndc querylog
|
[root@localhost ~]# rndc querylog
|
||||||
[root@localhost ~]# tail -f /var/log/messages
|
[root@localhost ~]# tail -f /var/log/messages
|
||||||
|
```
|
||||||
|
|
||||||
In there if you see errors like this:
|
In there if you see errors like this:
|
||||||
|
|
||||||
|
```text
|
||||||
error (no valid RRSIG) resolving
|
error (no valid RRSIG) resolving
|
||||||
error (no valid DS) resolving
|
error (no valid DS) resolving
|
||||||
|
```
|
||||||
|
|
||||||
Then DNSSEC is not disabled properly. If you see errors about network connections
|
Then DNSSEC is not disabled properly. If you see errors about network connections
|
||||||
then verify that there are no firewall or routing problems between the servers
|
then verify that there are no firewall or routing problems between the servers
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Guides"
|
page_title: "Guides"
|
||||||
sidebar_current: "docs-guides"
|
sidebar_current: "docs-guides"
|
||||||
|
description: |-
|
||||||
|
This section provides various guides for common actions. Due to the nature of Consul, some of these procedures can be complex, so our goal is to provide guidance to do them safely.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Guides
|
# Consul Guides
|
||||||
|
|
@ -12,21 +14,14 @@ guidance to do them safely.
|
||||||
|
|
||||||
The following guides are available:
|
The following guides are available:
|
||||||
|
|
||||||
* [Adding/Removing Servers](/docs/guides/servers.html) - This guide covers how to safely add
|
* [Adding/Removing Servers](/docs/guides/servers.html) - This guide covers how to safely add and remove Consul servers from the cluster. This should be done carefully to avoid availability outages.
|
||||||
and remove Consul servers from the cluster. This should be done carefully to avoid availability
|
|
||||||
outages.
|
|
||||||
|
|
||||||
* [Bootstrapping](/docs/guides/bootstrapping.html) - This guide covers bootstrapping a new
|
* [Bootstrapping](/docs/guides/bootstrapping.html) - This guide covers bootstrapping a new datacenter. This covers safely adding the initial Consul servers.
|
||||||
datacenter. This covers safely adding the initial Consul servers.
|
|
||||||
|
|
||||||
* [DNS Forwarding](/docs/guides/forwarding.html) - Forward DNS queries from Bind to Consul
|
* [DNS Forwarding](/docs/guides/forwarding.html) - Forward DNS queries from Bind to Consul
|
||||||
|
|
||||||
* [External Services](/docs/guides/external.html) - This guide covers registering
|
* [External Services](/docs/guides/external.html) - This guide covers registering an external service. This allows using 3rd party services within the Consul framework.
|
||||||
an external service. This allows using 3rd party services within the Consul framework.
|
|
||||||
|
|
||||||
* [Multiple Datacenters](/docs/guides/datacenters.html) - Configuring Consul to support multiple
|
* [Multiple Datacenters](/docs/guides/datacenters.html) - Configuring Consul to support multiple datacenters.
|
||||||
datacenters.
|
|
||||||
|
|
||||||
* [Outage Recovery](/docs/guides/outage.html) - This guide covers recovering a cluster
|
|
||||||
that has become unavailable due to server failures.
|
|
||||||
|
|
||||||
|
* [Outage Recovery](/docs/guides/outage.html) - This guide covers recovering a cluster that has become unavailable due to server failures.
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Leader Election"
|
page_title: "Leader Election"
|
||||||
sidebar_current: "docs-guides-leader"
|
sidebar_current: "docs-guides-leader"
|
||||||
|
description: |-
|
||||||
|
The goal of this guide is to cover how to build client-side leader election using Consul. If you are interested in the leader election used internally to Consul, you want to read about the consensus protocol instead.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Leader Election
|
# Leader Election
|
||||||
|
|
@ -21,7 +23,9 @@ The first flow we cover is for nodes who are attempting to acquire leadership
|
||||||
for a given service. All nodes that are participating should agree on a given
|
for a given service. All nodes that are participating should agree on a given
|
||||||
key being used to coordinate. A good choice is simply:
|
key being used to coordinate. A good choice is simply:
|
||||||
|
|
||||||
|
```text
|
||||||
service/<service name>/leader
|
service/<service name>/leader
|
||||||
|
```
|
||||||
|
|
||||||
We will refer to this as just `key` for simplicity.
|
We will refer to this as just `key` for simplicity.
|
||||||
|
|
||||||
|
|
@ -35,7 +39,9 @@ that may be needed.
|
||||||
|
|
||||||
Attempt to `acquire` the `key` by doing a `PUT`. This is something like:
|
Attempt to `acquire` the `key` by doing a `PUT`. This is something like:
|
||||||
|
|
||||||
|
```text
|
||||||
curl -X PUT -d body http://localhost:8500/v1/kv/key?acquire=session
|
curl -X PUT -d body http://localhost:8500/v1/kv/key?acquire=session
|
||||||
|
```
|
||||||
|
|
||||||
This will either return `true` or `false`. If `true` is returned, the lock
|
This will either return `true` or `false`. If `true` is returned, the lock
|
||||||
has been acquired and the local node is now the leader. If `false` is returned,
|
has been acquired and the local node is now the leader. If `false` is returned,
|
||||||
|
|
@ -54,7 +60,9 @@ wait. This is because Consul may be enforcing a [`lock-delay`](/docs/internals/s
|
||||||
If the leader ever wishes to step down voluntarily, this should be done by simply
|
If the leader ever wishes to step down voluntarily, this should be done by simply
|
||||||
releasing the lock:
|
releasing the lock:
|
||||||
|
|
||||||
|
```text
|
||||||
curl -X PUT http://localhost:8500/v1/kv/key?release=session
|
curl -X PUT http://localhost:8500/v1/kv/key?release=session
|
||||||
|
```
|
||||||
|
|
||||||
## Discovering a Leader
|
## Discovering a Leader
|
||||||
|
|
||||||
|
|
@ -70,4 +78,3 @@ the value of the key will provide all the application-dependent information requ
|
||||||
Clients should also watch the key using a blocking query for any changes. If the leader
|
Clients should also watch the key using a blocking query for any changes. If the leader
|
||||||
steps down, or fails, then the `Session` associated with the key will be cleared. When
|
steps down, or fails, then the `Session` associated with the key will be cleared. When
|
||||||
a new leader is elected, the key value will also be updated.
|
a new leader is elected, the key value will also be updated.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,82 +2,100 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Manual Bootstrapping"
|
page_title: "Manual Bootstrapping"
|
||||||
sidebar_current: "docs-guides-bootstrapping"
|
sidebar_current: "docs-guides-bootstrapping"
|
||||||
|
description: |-
|
||||||
|
When deploying Consul to a datacenter for the first time, there is an initial bootstrapping that must be done. As of Consul 0.4, an automatic bootstrapping is available and is the recommended approach. However, older versions only support a manual bootstrap that is documented here.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Manually Bootstrapping a Datacenter
|
# Manually Bootstrapping a Datacenter
|
||||||
|
|
||||||
When deploying Consul to a datacenter for the first time, there is an initial bootstrapping that
|
When deploying Consul to a datacenter for the first time, there is an initial
|
||||||
must be done. As of Consul 0.4, an [automatic bootstrapping](/docs/guides/bootstrapping.html) is
|
bootstrapping that must be done. As of Consul 0.4, an
|
||||||
available and is the recommended approach. However, older versions only support a manual bootstrap
|
[automatic bootstrapping](/docs/guides/bootstrapping.html) is available and is
|
||||||
that is documented here.
|
the recommended approach. However, older versions only support a manual
|
||||||
|
bootstrap that is documented here.
|
||||||
|
|
||||||
Generally, the first nodes that are started are the server nodes. Remember that an
|
Generally, the first nodes that are started are the server nodes. Remember that
|
||||||
agent can run in both client and server mode. Server nodes are responsible for running
|
an agent can run in both client and server mode. Server nodes are responsible
|
||||||
the [consensus protocol](/docs/internals/consensus.html), and storing the cluster state.
|
for running the [consensus protocol](/docs/internals/consensus.html), and
|
||||||
The client nodes are mostly stateless and rely on the server nodes, so they can be started easily.
|
storing the cluster state. The client nodes are mostly stateless and rely on the
|
||||||
|
server nodes, so they can be started easily.
|
||||||
|
|
||||||
Manual bootstrapping requires that the first server that is deployed in a new datacenter provide
|
Manual bootstrapping requires that the first server that is deployed in a new
|
||||||
the `-bootstrap` [configuration option](/docs/agent/options.html). This option allows the server to
|
datacenter provide the `-bootstrap`
|
||||||
assert leadership of the cluster without agreement from any other server. This is necessary because
|
[configuration option](/docs/agent/options.html). This option allows the server
|
||||||
at this point, there are no other servers running in the datacenter! Lets call this first server `Node A`.
|
to assert leadership of the cluster without agreement from any other server.
|
||||||
When starting `Node A` something like the following will be logged:
|
This is necessary because at this point, there are no other servers running in
|
||||||
|
the datacenter! Lets call this first server `Node A`. When starting `Node A`
|
||||||
|
something like the following will be logged:
|
||||||
|
|
||||||
|
```text
|
||||||
2014/02/22 19:23:32 [INFO] consul: cluster leadership acquired
|
2014/02/22 19:23:32 [INFO] consul: cluster leadership acquired
|
||||||
|
```
|
||||||
|
|
||||||
Once `Node A` is running, we can start the next set of servers. There is a [deployment table](/docs/internals/consensus.html#toc_4)
|
Once `Node A` is running, we can start the next set of servers. There is a
|
||||||
that covers various options, but it is recommended to have 3 or 5 total servers per data center.
|
[deployment table](/docs/internals/consensus.html#toc_4) that covers various
|
||||||
A single server deployment is _**highly**_ discouraged as data loss is inevitable in a failure scenario.
|
options, but it is recommended to have 3 or 5 total servers per data center. A
|
||||||
We start the next servers **without** specifying `-bootstrap`. This is critical, since only one server
|
single server deployment is _**highly**_ discouraged as data loss is inevitable
|
||||||
should ever be running in bootstrap mode*. Once `Node B` and `Node C` are started, you should see a
|
in a failure scenario. We start the next servers **without** specifying
|
||||||
|
`-bootstrap`. This is critical, since only one server should ever be running in
|
||||||
|
bootstrap mode*. Once `Node B` and `Node C` are started, you should see a
|
||||||
message to the effect of:
|
message to the effect of:
|
||||||
|
|
||||||
|
```text
|
||||||
[WARN] raft: EnableSingleNode disabled, and no known peers. Aborting election.
|
[WARN] raft: EnableSingleNode disabled, and no known peers. Aborting election.
|
||||||
|
```
|
||||||
|
|
||||||
This indicates that the node is not in bootstrap mode, and it will not elect itself as leader.
|
This indicates that the node is not in bootstrap mode, and it will not elect
|
||||||
We can now join these machines together. Since a join operation is symmetric it does not matter
|
itself as leader. We can now join these machines together. Since a join
|
||||||
which node initiates it. From `Node B` and `Node C` you can do the following:
|
operation is symmetric it does not matter which node initiates it. From
|
||||||
|
`Node B` and `Node C` you can do the following:
|
||||||
|
|
||||||
|
```text
|
||||||
$ consul join <Node A Address>
|
$ consul join <Node A Address>
|
||||||
Successfully joined cluster by contacting 1 nodes.
|
Successfully joined cluster by contacting 1 nodes.
|
||||||
|
```
|
||||||
|
|
||||||
Alternatively, from `Node A` you can do the following:
|
Alternatively, from `Node A` you can do the following:
|
||||||
|
|
||||||
|
```text
|
||||||
$ consul join <Node B Address> <Node C Address>
|
$ consul join <Node B Address> <Node C Address>
|
||||||
Successfully joined cluster by contacting 2 nodes.
|
Successfully joined cluster by contacting 2 nodes.
|
||||||
|
```
|
||||||
|
|
||||||
Once the join is successful, `Node A` should output something like:
|
Once the join is successful, `Node A` should output something like:
|
||||||
|
|
||||||
|
```text
|
||||||
[INFO] raft: Added peer 127.0.0.2:8300, starting replication
|
[INFO] raft: Added peer 127.0.0.2:8300, starting replication
|
||||||
....
|
....
|
||||||
[INFO] raft: Added peer 127.0.0.3:8300, starting replication
|
[INFO] raft: Added peer 127.0.0.3:8300, starting replication
|
||||||
|
```
|
||||||
|
|
||||||
As a sanity check, the `consul info` command is a useful tool. It can be used to
|
As a sanity check, the `consul info` command is a useful tool. It can be used to
|
||||||
verify `raft.num_peers` is now 2, and you can view the latest log index under `raft.last_log_index`.
|
verify `raft.num_peers` is now 2, and you can view the latest log index under
|
||||||
When running `consul info` on the followers, you should see `raft.last_log_index`
|
`raft.last_log_index`. When running `consul info` on the followers, you should
|
||||||
converge to the same value as the leader begins replication. That value represents the last
|
see `raft.last_log_index` converge to the same value as the leader begins
|
||||||
log entry that has been stored on disk.
|
replication. That value represents the last log entry that has been stored on
|
||||||
|
disk.
|
||||||
|
|
||||||
This indicates that `Node B` and `Node C` have been added as peers. At this point,
|
This indicates that `Node B` and `Node C` have been added as peers. At this
|
||||||
all three nodes see each other as peers, `Node A` is the leader, and replication
|
point, all three nodes see each other as peers, `Node A` is the leader, and
|
||||||
should be working.
|
replication should be working.
|
||||||
|
|
||||||
The final step is to remove the `-bootstrap` flag. This is important since we don't
|
The final step is to remove the `-bootstrap` flag. This is important since we
|
||||||
want the node to be able to make unilateral decisions in the case of a failure of the
|
don't want the node to be able to make unilateral decisions in the case of a
|
||||||
other two nodes. To do this, we send a `SIGINT` to `Node A` to allow it to perform
|
failure of the other two nodes. To do this, we send a `SIGINT` to `Node A` to
|
||||||
a graceful leave. Then we remove the `-bootstrap` flag and restart the node. The node
|
allow it to perform a graceful leave. Then we remove the `-bootstrap` flag and
|
||||||
will need to rejoin the cluster, since the graceful exit leaves the cluster. Any transactions
|
restart the node. The node will need to rejoin the cluster, since the graceful
|
||||||
that took place while `Node A` was offline will be replicated and the node will catch up.
|
exit leaves the cluster. Any transactions that took place while `Node A` was
|
||||||
|
offline will be replicated and the node will catch up.
|
||||||
|
|
||||||
Now that the servers are all started and replicating to each other, all the remaining
|
Now that the servers are all started and replicating to each other, all the
|
||||||
clients can be joined. Clients are much easier, as they can be started and perform
|
remaining clients can be joined. Clients are much easier, as they can be started
|
||||||
a `join` against any existing node. All nodes participate in a gossip protocol to
|
and perform a `join` against any existing node. All nodes participate in a
|
||||||
perform basic discovery, so clients will automatically find the servers and register
|
gossip protocol to perform basic discovery, so clients will automatically find
|
||||||
themselves.
|
the servers and register themselves.
|
||||||
|
|
||||||
<div class="alert alert-block alert-info">
|
-> If you accidentally start another server with the flag set, do not fret.
|
||||||
* If you accidentally start another server with the flag set, do not fret.
|
Shutdown the node, and remove the `raft/` folder from the data directory. This
|
||||||
Shutdown the node, and remove the `raft/` folder from the data directory. This will
|
will remove the bad state caused by being in `-bootstrap` mode. Then restart the
|
||||||
remove the bad state caused by being in `-bootstrap` mode. Then restart the
|
|
||||||
node and join the cluster normally.
|
node and join the cluster normally.
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Outage Recovery"
|
page_title: "Outage Recovery"
|
||||||
sidebar_current: "docs-guides-outage"
|
sidebar_current: "docs-guides-outage"
|
||||||
|
description: |-
|
||||||
|
Do not panic! This is a critical first step. Depending on your deployment configuration, it may take only a single server failure for cluster unavailability. Recovery requires an operator to intervene, but is straightforward.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Outage Recovery
|
# Outage Recovery
|
||||||
|
|
@ -11,15 +13,14 @@ Do not panic! This is a critical first step. Depending on your
|
||||||
take only a single server failure for cluster unavailability. Recovery
|
take only a single server failure for cluster unavailability. Recovery
|
||||||
requires an operator to intervene, but is straightforward.
|
requires an operator to intervene, but is straightforward.
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> This page covers recovery from Consul becoming unavailable due to a majority
|
||||||
This page covers recovery from Consul becoming unavailable due to a majority
|
|
||||||
of server nodes in a datacenter being lost. If you are just looking to
|
of server nodes in a datacenter being lost. If you are just looking to
|
||||||
add or remove a server <a href="/docs/guides/servers.html">see this page</a>.
|
add or remove a server [see this page](/docs/guides/servers.html).
|
||||||
</div>
|
|
||||||
|
|
||||||
If you had only a single server and it has failed, simply restart it.
|
If you had only a single server and it has failed, simply restart it.
|
||||||
Note that a single server configuration requires the `-bootstrap` or `-bootstrap-expect 1` flag.
|
Note that a single server configuration requires the `-bootstrap` or
|
||||||
If that server cannot be recovered, you need to bring up a new server.
|
`-bootstrap-expect 1` flag. If that server cannot be recovered, you need to
|
||||||
|
bring up a new server.
|
||||||
See the [bootstrapping guide](/docs/guides/bootstrapping.html). Data loss
|
See the [bootstrapping guide](/docs/guides/bootstrapping.html). Data loss
|
||||||
is inevitable, since data was not replicated to any other servers. This
|
is inevitable, since data was not replicated to any other servers. This
|
||||||
is why a single server deploy is never recommended. Any services registered
|
is why a single server deploy is never recommended. Any services registered
|
||||||
|
|
@ -35,8 +36,12 @@ The next step is to go to the `-data-dir` of each Consul server. Inside
|
||||||
that directory, there will be a `raft/` sub-directory. We need to edit
|
that directory, there will be a `raft/` sub-directory. We need to edit
|
||||||
the `raft/peers.json` file. It should be something like:
|
the `raft/peers.json` file. It should be something like:
|
||||||
|
|
||||||
```
|
```javascript
|
||||||
["10.0.1.8:8300","10.0.1.6:8300","10.0.1.7:8300"]
|
[
|
||||||
|
"10.0.1.8:8300",
|
||||||
|
"10.0.1.6:8300",
|
||||||
|
"10.0.1.7:8300"
|
||||||
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
Simply delete the entries for all the failed servers. You must confirm
|
Simply delete the entries for all the failed servers. You must confirm
|
||||||
|
|
@ -47,7 +52,7 @@ At this point, you can restart all the remaining servers. If any servers
|
||||||
managed to perform a graceful leave, you may need to have then rejoin
|
managed to perform a graceful leave, you may need to have then rejoin
|
||||||
the cluster using the `join` command:
|
the cluster using the `join` command:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul join <Node Address>
|
$ consul join <Node Address>
|
||||||
Successfully joined cluster by contacting 1 nodes.
|
Successfully joined cluster by contacting 1 nodes.
|
||||||
```
|
```
|
||||||
|
|
@ -58,13 +63,13 @@ as the gossip protocol will take care of discovering the server nodes.
|
||||||
At this point the cluster should be in an operable state again. One of the
|
At this point the cluster should be in an operable state again. One of the
|
||||||
nodes should claim leadership and emit a log like:
|
nodes should claim leadership and emit a log like:
|
||||||
|
|
||||||
```
|
```text
|
||||||
[INFO] consul: cluster leadership acquired
|
[INFO] consul: cluster leadership acquired
|
||||||
```
|
```
|
||||||
|
|
||||||
Additional, the `info` command can be a useful debugging tool:
|
Additional, the `info` command can be a useful debugging tool:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul info
|
$ consul info
|
||||||
...
|
...
|
||||||
raft:
|
raft:
|
||||||
|
|
@ -85,4 +90,3 @@ You should verify that one server claims to be the `Leader`, and all the
|
||||||
others should be in the `Follower` state. All the nodes should agree on the
|
others should be in the `Follower` state. All the nodes should agree on the
|
||||||
peer count as well. This count is (N-1), since a server does not count itself
|
peer count as well. This count is (N-1), since a server does not count itself
|
||||||
as a peer.
|
as a peer.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Adding/Removing Servers"
|
page_title: "Adding/Removing Servers"
|
||||||
sidebar_current: "docs-guides-servers"
|
sidebar_current: "docs-guides-servers"
|
||||||
|
description: |-
|
||||||
|
Consul is designed to require minimal operator involvement, however any changes to the set of Consul servers must be handled carefully. To better understand why, reading about the consensus protocol will be useful. In short, the Consul servers perform leader election and replication. For changes to be processed, a minimum quorum of servers (N/2)+1 must be available. That means if there are 3 server nodes, at least 2 must be available.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Adding/Removing Servers
|
# Adding/Removing Servers
|
||||||
|
|
@ -22,26 +24,32 @@ Adding new servers is generally straightforward. Simply start the new
|
||||||
server with the `-server` flag. At this point, the server will not be a member of
|
server with the `-server` flag. At this point, the server will not be a member of
|
||||||
any cluster, and should emit something like:
|
any cluster, and should emit something like:
|
||||||
|
|
||||||
|
```text
|
||||||
[WARN] raft: EnableSingleNode disabled, and no known peers. Aborting election.
|
[WARN] raft: EnableSingleNode disabled, and no known peers. Aborting election.
|
||||||
|
```
|
||||||
|
|
||||||
This means that it does not know about any peers and is not configured to elect itself.
|
This means that it does not know about any peers and is not configured to elect itself.
|
||||||
This is expected, and we can now add this node to the existing cluster using `join`.
|
This is expected, and we can now add this node to the existing cluster using `join`.
|
||||||
From the new server, we can join any member of the existing cluster:
|
From the new server, we can join any member of the existing cluster:
|
||||||
|
|
||||||
|
```text
|
||||||
$ consul join <Node Address>
|
$ consul join <Node Address>
|
||||||
Successfully joined cluster by contacting 1 nodes.
|
Successfully joined cluster by contacting 1 nodes.
|
||||||
|
```
|
||||||
|
|
||||||
It is important to note that any node, including a non-server may be specified for
|
It is important to note that any node, including a non-server may be specified for
|
||||||
join. The gossip protocol is used to properly discover all the nodes in the cluster.
|
join. The gossip protocol is used to properly discover all the nodes in the cluster.
|
||||||
Once the node has joined, the existing cluster leader should log something like:
|
Once the node has joined, the existing cluster leader should log something like:
|
||||||
|
|
||||||
|
```text
|
||||||
[INFO] raft: Added peer 127.0.0.2:8300, starting replication
|
[INFO] raft: Added peer 127.0.0.2:8300, starting replication
|
||||||
|
```
|
||||||
|
|
||||||
This means that raft, the underlying consensus protocol, has added the peer and begun
|
This means that raft, the underlying consensus protocol, has added the peer and begun
|
||||||
replicating state. Since the existing cluster may be very far ahead, it can take some
|
replicating state. Since the existing cluster may be very far ahead, it can take some
|
||||||
time for the new node to catch up. To check on this, run `info` on the leader:
|
time for the new node to catch up. To check on this, run `info` on the leader:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul info
|
$ consul info
|
||||||
...
|
...
|
||||||
raft:
|
raft:
|
||||||
|
|
@ -86,18 +94,22 @@ can handle a node leaving, the actual process is simple. You simply issue a
|
||||||
|
|
||||||
The server leaving should contain logs like:
|
The server leaving should contain logs like:
|
||||||
|
|
||||||
|
```text
|
||||||
...
|
...
|
||||||
[INFO] consul: server starting leave
|
[INFO] consul: server starting leave
|
||||||
...
|
...
|
||||||
[INFO] raft: Removed ourself, transitioning to follower
|
[INFO] raft: Removed ourself, transitioning to follower
|
||||||
...
|
...
|
||||||
|
```
|
||||||
|
|
||||||
The leader should also emit various logs including:
|
The leader should also emit various logs including:
|
||||||
|
|
||||||
|
```text
|
||||||
...
|
...
|
||||||
[INFO] consul: member 'node-10-0-1-8' left, deregistering
|
[INFO] consul: member 'node-10-0-1-8' left, deregistering
|
||||||
[INFO] raft: Removed peer 10.0.1.8:8300, stopping replication
|
[INFO] raft: Removed peer 10.0.1.8:8300, stopping replication
|
||||||
...
|
...
|
||||||
|
```
|
||||||
|
|
||||||
At this point the node has been gracefully removed from the cluster, and
|
At this point the node has been gracefully removed from the cluster, and
|
||||||
will shut down.
|
will shut down.
|
||||||
|
|
@ -113,6 +125,4 @@ leave the cluster. However, if this is not a possibility, then the `force-leave`
|
||||||
can be used to force removal of a server.
|
can be used to force removal of a server.
|
||||||
|
|
||||||
This is done by invoking that command with the name of the failed node. At this point,
|
This is done by invoking that command with the name of the failed node. At this point,
|
||||||
the cluster leader will mark the node as having left the cluster and it will stop attempting
|
the cluster leader will mark the node as having left the cluster and it will stop attempting to replicate.
|
||||||
to replicate.
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Documentation"
|
page_title: "Documentation"
|
||||||
sidebar_current: "docs-home"
|
sidebar_current: "docs-home"
|
||||||
|
description: |-
|
||||||
|
Welcome to the Consul documentation! This documentation is more of a reference guide for all available features and options of Consul. If you're just getting started with Consul, please start with the introduction and getting started guide instead.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Documentation
|
# Consul Documentation
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "ACL System"
|
page_title: "ACL System"
|
||||||
sidebar_current: "docs-internals-acl"
|
sidebar_current: "docs-internals-acl"
|
||||||
|
description: |-
|
||||||
|
Consul provides an optional Access Control List (ACL) system which can be used to control access to data and APIs. The ACL system is a Capability-based system that relies on tokens which can have fine grained rules applied to them. It is very similar to AWS IAM in many ways.
|
||||||
---
|
---
|
||||||
|
|
||||||
# ACL System
|
# ACL System
|
||||||
|
|
@ -76,6 +78,7 @@ with JSON making it easy to machine generate.
|
||||||
As of Consul 0.4, it is only possible to specify policies for the
|
As of Consul 0.4, it is only possible to specify policies for the
|
||||||
KV store. Specification in the HCL format looks like:
|
KV store. Specification in the HCL format looks like:
|
||||||
|
|
||||||
|
```javascript
|
||||||
# Default all keys to read-only
|
# Default all keys to read-only
|
||||||
key "" {
|
key "" {
|
||||||
policy = "read"
|
policy = "read"
|
||||||
|
|
@ -87,9 +90,11 @@ KV store. Specification in the HCL format looks like:
|
||||||
# Deny access to the private dir
|
# Deny access to the private dir
|
||||||
policy = "deny"
|
policy = "deny"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
This is equivalent to the following JSON input:
|
This is equivalent to the following JSON input:
|
||||||
|
|
||||||
|
```javascript
|
||||||
{
|
{
|
||||||
"key": {
|
"key": {
|
||||||
"": {
|
"": {
|
||||||
|
|
@ -103,10 +108,10 @@ This is equivalent to the following JSON input:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Key policies provide both a prefix and a policy. The rules are enforced
|
Key policies provide both a prefix and a policy. The rules are enforced
|
||||||
using a longest-prefix match policy. This means we pick the most specific
|
using a longest-prefix match policy. This means we pick the most specific
|
||||||
policy possible. The policy is either "read", "write" or "deny". A "write"
|
policy possible. The policy is either "read", "write" or "deny". A "write"
|
||||||
policy implies "read", and there is no way to specify write-only. If there
|
policy implies "read", and there is no way to specify write-only. If there
|
||||||
is no applicable rule, the `acl_default_policy` is applied.
|
is no applicable rule, the `acl_default_policy` is applied.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Consul Architecture"
|
page_title: "Consul Architecture"
|
||||||
sidebar_current: "docs-internals-architecture"
|
sidebar_current: "docs-internals-architecture"
|
||||||
|
description: |-
|
||||||
|
Consul is a complex system that has many different moving parts. To help users and developers of Consul form a mental model of how it works, this page documents the system architecture.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Architecture
|
# Consul Architecture
|
||||||
|
|
@ -10,12 +12,10 @@ Consul is a complex system that has many different moving parts. To help
|
||||||
users and developers of Consul form a mental model of how it works, this
|
users and developers of Consul form a mental model of how it works, this
|
||||||
page documents the system architecture.
|
page documents the system architecture.
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> **Advanced Topic!** This page covers technical details of
|
||||||
<strong>Advanced Topic!</strong> This page covers technical details of
|
|
||||||
the internals of Consul. You don't need to know these details to effectively
|
the internals of Consul. You don't need to know these details to effectively
|
||||||
operate and use Consul. These details are documented here for those who wish
|
operate and use Consul. These details are documented here for those who wish
|
||||||
to learn about them without having to go spelunking through the source code.
|
to learn about them without having to go spelunking through the source code.
|
||||||
</div>
|
|
||||||
|
|
||||||
## Glossary
|
## Glossary
|
||||||
|
|
||||||
|
|
@ -70,7 +70,7 @@ allowing a client to make a request from a server.
|
||||||
From a 10,000 foot altitude the architecture of Consul looks like this:
|
From a 10,000 foot altitude the architecture of Consul looks like this:
|
||||||
|
|
||||||
<div class="center">
|
<div class="center">
|
||||||
<%= link_to image_tag('consul-arch.png', alt: 'Consul Architecture'), image_path('consul-arch.png') %>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Lets break down this image and describe each piece. First of all we can see
|
Lets break down this image and describe each piece. First of all we can see
|
||||||
|
|
@ -116,4 +116,3 @@ documented in detail, as is the [gossip protocol](/docs/internals/gossip.html).
|
||||||
for the security model and protocols used are also available.
|
for the security model and protocols used are also available.
|
||||||
|
|
||||||
For other details, either consult the code, ask in IRC or reach out to the mailing list.
|
For other details, either consult the code, ask in IRC or reach out to the mailing list.
|
||||||
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Consensus Protocol"
|
page_title: "Consensus Protocol"
|
||||||
sidebar_current: "docs-internals-consensus"
|
sidebar_current: "docs-internals-consensus"
|
||||||
|
description: |-
|
||||||
|
Consul uses a consensus protocol to provide Consistency as defined by CAP. This page documents the details of this internal protocol. The consensus protocol is based on Raft: In search of an Understandable Consensus Algorithm. For a visual explanation of Raft, see the The Secret Lives of Data.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consensus Protocol
|
# Consensus Protocol
|
||||||
|
|
@ -11,12 +13,10 @@ to provide [Consistency](http://en.wikipedia.org/wiki/CAP_theorem) as defined by
|
||||||
This page documents the details of this internal protocol. The consensus protocol is based on
|
This page documents the details of this internal protocol. The consensus protocol is based on
|
||||||
["Raft: In search of an Understandable Consensus Algorithm"](https://ramcloud.stanford.edu/wiki/download/attachments/11370504/raft.pdf). For a visual explanation of Raft, see the [The Secret Lives of Data](http://thesecretlivesofdata.com/raft).
|
["Raft: In search of an Understandable Consensus Algorithm"](https://ramcloud.stanford.edu/wiki/download/attachments/11370504/raft.pdf). For a visual explanation of Raft, see the [The Secret Lives of Data](http://thesecretlivesofdata.com/raft).
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> **Advanced Topic!** This page covers technical details of
|
||||||
<strong>Advanced Topic!</strong> This page covers technical details of
|
|
||||||
the internals of Consul. You don't need to know these details to effectively
|
the internals of Consul. You don't need to know these details to effectively
|
||||||
operate and use Consul. These details are documented here for those who wish
|
operate and use Consul. These details are documented here for those who wish
|
||||||
to learn about them without having to go spelunking through the source code.
|
to learn about them without having to go spelunking through the source code.
|
||||||
</div>
|
|
||||||
|
|
||||||
## Raft Protocol Overview
|
## Raft Protocol Overview
|
||||||
|
|
||||||
|
|
@ -139,7 +139,7 @@ supports 3 different consistency modes for reads.
|
||||||
|
|
||||||
The three read modes are:
|
The three read modes are:
|
||||||
|
|
||||||
* default - Raft makes use of leader leasing, providing a time window
|
* `default` - Raft makes use of leader leasing, providing a time window
|
||||||
in which the leader assumes its role is stable. However, if a leader
|
in which the leader assumes its role is stable. However, if a leader
|
||||||
is partitioned from the remaining peers, a new leader may be elected
|
is partitioned from the remaining peers, a new leader may be elected
|
||||||
while the old leader is holding the lease. This means there are 2 leader
|
while the old leader is holding the lease. This means there are 2 leader
|
||||||
|
|
@ -151,12 +151,12 @@ The three read modes are:
|
||||||
only stale in a hard to trigger situation. The time window of stale reads
|
only stale in a hard to trigger situation. The time window of stale reads
|
||||||
is also bounded, since the leader will step down due to the partition.
|
is also bounded, since the leader will step down due to the partition.
|
||||||
|
|
||||||
* consistent - This mode is strongly consistent without caveats. It requires
|
* `consistent` - This mode is strongly consistent without caveats. It requires
|
||||||
that a leader verify with a quorum of peers that it is still leader. This
|
that a leader verify with a quorum of peers that it is still leader. This
|
||||||
introduces an additional round-trip to all server nodes. The trade off is
|
introduces an additional round-trip to all server nodes. The trade off is
|
||||||
always consistent reads, but increased latency due to an extra round trip.
|
always consistent reads, but increased latency due to an extra round trip.
|
||||||
|
|
||||||
* stale - This mode allows any server to service the read, regardless of if
|
* `stale` - This mode allows any server to service the read, regardless of if
|
||||||
it is the leader. This means reads can be arbitrarily stale, but are generally
|
it is the leader. This means reads can be arbitrarily stale, but are generally
|
||||||
within 50 milliseconds of the leader. The trade off is very fast and scalable
|
within 50 milliseconds of the leader. The trade off is very fast and scalable
|
||||||
reads but values will be stale. This mode allows reads without a leader, meaning
|
reads but values will be stale. This mode allows reads without a leader, meaning
|
||||||
|
|
@ -213,4 +213,3 @@ is _**highly**_ discouraged as data loss is inevitable in a failure scenario.
|
||||||
<td>3</td>
|
<td>3</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Gossip Protocol"
|
page_title: "Gossip Protocol"
|
||||||
sidebar_current: "docs-internals-gossip"
|
sidebar_current: "docs-internals-gossip"
|
||||||
|
description: |-
|
||||||
|
Consul uses a gossip protocol to manage membership and broadcast messages to the cluster. All of this is provided through the use of the Serf library. The gossip protocol used by Serf is based on SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol, with a few minor adaptations.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Gossip Protocol
|
# Gossip Protocol
|
||||||
|
|
@ -13,12 +15,10 @@ used by Serf is based on
|
||||||
["SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol"](http://www.cs.cornell.edu/~asdas/research/dsn02-swim.pdf),
|
["SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol"](http://www.cs.cornell.edu/~asdas/research/dsn02-swim.pdf),
|
||||||
with a few minor adaptations. There are more details about [Serf's protocol here](http://www.serfdom.io/docs/internals/gossip.html).
|
with a few minor adaptations. There are more details about [Serf's protocol here](http://www.serfdom.io/docs/internals/gossip.html).
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> **Advanced Topic!** This page covers technical details of
|
||||||
<strong>Advanced Topic!</strong> This page covers technical details of
|
|
||||||
the internals of Consul. You don't need to know these details to effectively
|
the internals of Consul. You don't need to know these details to effectively
|
||||||
operate and use Consul. These details are documented here for those who wish
|
operate and use Consul. These details are documented here for those who wish
|
||||||
to learn about them without having to go spelunking through the source code.
|
to learn about them without having to go spelunking through the source code.
|
||||||
</div>
|
|
||||||
|
|
||||||
## Gossip in Consul
|
## Gossip in Consul
|
||||||
|
|
||||||
|
|
@ -41,4 +41,3 @@ All of these features are provided by leveraging [Serf](http://www.serfdom.io/).
|
||||||
is used as an embedded library to provide these features. From a user perspective,
|
is used as an embedded library to provide these features. From a user perspective,
|
||||||
this is not important, since the abstraction should be masked by Consul. It can be useful
|
this is not important, since the abstraction should be masked by Consul. It can be useful
|
||||||
however as a developer to understand how this library is leveraged.
|
however as a developer to understand how this library is leveraged.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Internals"
|
page_title: "Internals"
|
||||||
sidebar_current: "docs-internals"
|
sidebar_current: "docs-internals"
|
||||||
|
description: |-
|
||||||
|
This section goes over some of the internals of Consul, such as the architecture, consensus and gossip protocol, security model, etc.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Internals
|
# Consul Internals
|
||||||
|
|
@ -9,8 +11,6 @@ sidebar_current: "docs-internals"
|
||||||
This section goes over some of the internals of Consul, such as the architecture,
|
This section goes over some of the internals of Consul, such as the architecture,
|
||||||
consensus and gossip protocol, security model, etc.
|
consensus and gossip protocol, security model, etc.
|
||||||
|
|
||||||
<div class="alert alert-block alert-info">
|
-> **Note:** Knowing about the internals of Consul is not necessary to successfully
|
||||||
Note that knowing about the internals of Consul is not necessary to
|
use it, but we document it here to be completely transparent about how Consul
|
||||||
successfully use it, but we document it here to be completely transparent
|
works.
|
||||||
about how Consul works.
|
|
||||||
</div>
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Jepsen Testing"
|
page_title: "Jepsen Testing"
|
||||||
sidebar_current: "docs-internals-jepsen"
|
sidebar_current: "docs-internals-jepsen"
|
||||||
|
description: |-
|
||||||
|
Jepsen is a tool written by Kyle Kingsbury that is designed to test the partition tolerance of distributed systems. It creates network partitions while fuzzing the system with random operations. The results are analyzed to see if the system violates any of the consistency properties it claims to have.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Jepsen Testing
|
# Jepsen Testing
|
||||||
|
|
@ -30,7 +32,7 @@ Below is the output captured from Jepsen. We ran Jepsen multiple times,
|
||||||
and it passed each time. This output is only representative of a single
|
and it passed each time. This output is only representative of a single
|
||||||
run.
|
run.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ lein test :only jepsen.system.consul-test
|
$ lein test :only jepsen.system.consul-test
|
||||||
|
|
||||||
lein test jepsen.system.consul-test
|
lein test jepsen.system.consul-test
|
||||||
|
|
@ -4018,4 +4020,3 @@ INFO jepsen.system.consul - :n5 consul nuked
|
||||||
Ran 1 tests containing 1 assertions.
|
Ran 1 tests containing 1 assertions.
|
||||||
0 failures, 0 errors.
|
0 failures, 0 errors.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Security Model"
|
page_title: "Security Model"
|
||||||
sidebar_current: "docs-internals-security"
|
sidebar_current: "docs-internals-security"
|
||||||
|
description: |-
|
||||||
|
Consul relies on both a lightweight gossip mechanism and an RPC system to provide various features. Both of the systems have different security mechanisms that stem from their designs. However, the goals of Consuls security are to provide confidentiality, integrity and authentication.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Security Model
|
# Security Model
|
||||||
|
|
@ -23,12 +25,10 @@ This means Consul communication is protected against eavesdropping, tampering,
|
||||||
or spoofing. This makes it possible to run Consul over untrusted networks such
|
or spoofing. This makes it possible to run Consul over untrusted networks such
|
||||||
as EC2 and other shared hosting providers.
|
as EC2 and other shared hosting providers.
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> **Advanced Topic!** This page covers the technical details of
|
||||||
<strong>Advanced Topic!</strong> This page covers the technical details of
|
|
||||||
the security model of Consul. You don't need to know these details to
|
the security model of Consul. You don't need to know these details to
|
||||||
operate and use Consul. These details are documented here for those who wish
|
operate and use Consul. These details are documented here for those who wish
|
||||||
to learn about them without having to go spelunking through the source code.
|
to learn about them without having to go spelunking through the source code.
|
||||||
</div>
|
|
||||||
|
|
||||||
## Threat Model
|
## Threat Model
|
||||||
|
|
||||||
|
|
@ -50,4 +50,3 @@ When designing security into a system you design it to fit the threat model.
|
||||||
Our goal is not to protect top secret data but to provide a "reasonable"
|
Our goal is not to protect top secret data but to provide a "reasonable"
|
||||||
level of security that would require an attacker to commit a considerable
|
level of security that would require an attacker to commit a considerable
|
||||||
amount of resources to defeat.
|
amount of resources to defeat.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Sessions"
|
page_title: "Sessions"
|
||||||
sidebar_current: "docs-internals-sessions"
|
sidebar_current: "docs-internals-sessions"
|
||||||
|
description: |-
|
||||||
|
Consul provides a session mechansim which can be used to build distributed locks. Sessions act as a binding layer between nodes, health checks, and key/value data. They are designed to provide granular locking, and are heavily inspired by The Chubby Lock Service for Loosely-Coupled Distributed Systems.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sessions
|
# Sessions
|
||||||
|
|
@ -11,12 +13,10 @@ Sessions act as a binding layer between nodes, health checks, and key/value data
|
||||||
They are designed to provide granular locking, and are heavily inspired
|
They are designed to provide granular locking, and are heavily inspired
|
||||||
by [The Chubby Lock Service for Loosely-Coupled Distributed Systems](http://research.google.com/archive/chubby.html).
|
by [The Chubby Lock Service for Loosely-Coupled Distributed Systems](http://research.google.com/archive/chubby.html).
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> **Advanced Topic!** This page covers technical details of
|
||||||
<strong>Advanced Topic!</strong> This page covers technical details of
|
|
||||||
the internals of Consul. You don't need to know these details to effectively
|
the internals of Consul. You don't need to know these details to effectively
|
||||||
operate and use Consul. These details are documented here for those who wish
|
operate and use Consul. These details are documented here for those who wish
|
||||||
to learn about them without having to go spelunking through the source code.
|
to learn about them without having to go spelunking through the source code.
|
||||||
</div>
|
|
||||||
|
|
||||||
## Session Design
|
## Session Design
|
||||||
|
|
||||||
|
|
@ -28,7 +28,7 @@ store to acquire locks, which are advisory mechanisms for mutual exclusion.
|
||||||
Below is a diagram showing the relationship between these components:
|
Below is a diagram showing the relationship between these components:
|
||||||
|
|
||||||
<div class="center">
|
<div class="center">
|
||||||
<%= link_to image_tag('consul-sessions.png'), image_path('consul-sessions.png') %>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
The contract that Consul provides is that under any of the folllowing
|
The contract that Consul provides is that under any of the folllowing
|
||||||
|
|
@ -113,4 +113,3 @@ the goal of Consul to protect against misbehaving clients.
|
||||||
The primitives provided by sessions and the locking mechanisms of the KV
|
The primitives provided by sessions and the locking mechanisms of the KV
|
||||||
store can be used to build client-side leader election algorithms.
|
store can be used to build client-side leader election algorithms.
|
||||||
These are covered in more detail in the [Leader Election guide](/docs/guides/leader-election.html).
|
These are covered in more detail in the [Leader Election guide](/docs/guides/leader-election.html).
|
||||||
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "docs"
|
layout: "docs"
|
||||||
page_title: "Upgrading Consul"
|
page_title: "Upgrading Consul"
|
||||||
sidebar_current: "docs-upgrading-upgrading"
|
sidebar_current: "docs-upgrading-upgrading"
|
||||||
|
description: |-
|
||||||
|
Consul is meant to be a long-running agent on any nodes participating in a Consul cluster. These nodes consistently communicate with each other. As such, protocol level compatibility and ease of upgrades is an important thing to keep in mind when using Consul.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Upgrading Consul
|
# Upgrading Consul
|
||||||
|
|
@ -85,9 +87,7 @@ only specifies the protocol version to _speak_. Every Consul agent can
|
||||||
always understand the entire range of protocol versions it claims to
|
always understand the entire range of protocol versions it claims to
|
||||||
on `consul -v`.
|
on `consul -v`.
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> **By running a previous protocol version**, some features
|
||||||
<strong>By running a previous protocol version</strong>, some features
|
|
||||||
of Consul, especially newer features, may not be available. If this is the
|
of Consul, especially newer features, may not be available. If this is the
|
||||||
case, Consul will typically warn you. In general, you should always upgrade
|
case, Consul will typically warn you. In general, you should always upgrade
|
||||||
your cluster so that you can run the latest protocol version.
|
your cluster so that you can run the latest protocol version.
|
||||||
</div>
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "downloads"
|
layout: "downloads"
|
||||||
page_title: "Download Consul"
|
page_title: "Download Consul"
|
||||||
sidebar_current: "downloads-consul"
|
sidebar_current: "downloads-consul"
|
||||||
|
description: |-
|
||||||
|
Below are all available downloads for the latest version of Consul. Please download the proper package for your operating system and architecture.
|
||||||
---
|
---
|
||||||
|
|
||||||
<h1>Download Consul</h1>
|
<h1>Download Consul</h1>
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "downloads"
|
layout: "downloads"
|
||||||
page_title: "Download Consul Web UI"
|
page_title: "Download Consul Web UI"
|
||||||
sidebar_current: "downloads-ui"
|
sidebar_current: "downloads-ui"
|
||||||
|
description: |-
|
||||||
|
From this page you can download the web UI for Consul. This is distributed as a separate ZIP package.
|
||||||
---
|
---
|
||||||
|
|
||||||
<h1>Download Consul Web UI</h1>
|
<h1>Download Consul Web UI</h1>
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
description: Service discovery and configuration made easy. Distributed, highly available, and datacenter-aware.
|
||||||
|
---
|
||||||
|
|
||||||
<!-- Main jumbotron for a primary marketing message or call to action -->
|
<!-- Main jumbotron for a primary marketing message or call to action -->
|
||||||
<div id="jumbotron-mask">
|
<div id="jumbotron-mask">
|
||||||
<div id="jumbotron">
|
<div id="jumbotron">
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Run the Agent"
|
page_title: "Run the Agent"
|
||||||
sidebar_current: "gettingstarted-agent"
|
sidebar_current: "gettingstarted-agent"
|
||||||
|
description: |-
|
||||||
|
After Consul is installed, the agent must be run. The agent can either run in a server or client mode. Each datacenter must have at least one server, although 3 or 5 is recommended. A single server deployment is highly discouraged as data loss is inevitable in a failure scenario.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Run the Consul Agent
|
# Run the Consul Agent
|
||||||
|
|
@ -19,7 +21,7 @@ will be part of the cluster.
|
||||||
|
|
||||||
For simplicity, we'll run a single Consul agent in server mode right now:
|
For simplicity, we'll run a single Consul agent in server mode right now:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul
|
$ consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul
|
||||||
==> WARNING: BootstrapExpect Mode is specified as 1; this is the same as Bootstrap mode.
|
==> WARNING: BootstrapExpect Mode is specified as 1; this is the same as Bootstrap mode.
|
||||||
==> WARNING: Bootstrap mode enabled! Do not enable unless necessary
|
==> WARNING: Bootstrap mode enabled! Do not enable unless necessary
|
||||||
|
|
@ -53,12 +55,10 @@ data. From the log data, you can see that our agent is running in server mode,
|
||||||
and has claimed leadership of the cluster. Additionally, the local member has
|
and has claimed leadership of the cluster. Additionally, the local member has
|
||||||
been marked as a healthy member of the cluster.
|
been marked as a healthy member of the cluster.
|
||||||
|
|
||||||
<div class="alert alert-block alert-warning">
|
~> **Note for OS X Users:** Consul uses your hostname as the
|
||||||
<strong>Note for OS X Users:</strong> Consul uses your hostname as the
|
|
||||||
default node name. If your hostname contains periods, DNS queries to
|
default node name. If your hostname contains periods, DNS queries to
|
||||||
that node will not work with Consul. To avoid this, explicitly set
|
that node will not work with Consul. To avoid this, explicitly set
|
||||||
the name of your node with the <code>-node</code> flag.
|
the name of your node with the `-node` flag.
|
||||||
</div>
|
|
||||||
|
|
||||||
## Cluster Members
|
## Cluster Members
|
||||||
|
|
||||||
|
|
@ -66,7 +66,7 @@ If you run `consul members` in another terminal, you can see the members of
|
||||||
the Consul cluster. You should only see one member (yourself). We'll cover
|
the Consul cluster. You should only see one member (yourself). We'll cover
|
||||||
joining clusters in the next section.
|
joining clusters in the next section.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul members
|
$ consul members
|
||||||
Node Address Status Type Build Protocol
|
Node Address Status Type Build Protocol
|
||||||
Armons-MacBook-Air 10.1.10.38:8301 alive server 0.3.0 2
|
Armons-MacBook-Air 10.1.10.38:8301 alive server 0.3.0 2
|
||||||
|
|
@ -82,7 +82,7 @@ For a strongly consistent view of the world, use the
|
||||||
[HTTP API](/docs/agent/http.html), which forwards the request to the
|
[HTTP API](/docs/agent/http.html), which forwards the request to the
|
||||||
Consul servers:
|
Consul servers:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl localhost:8500/v1/catalog/nodes
|
$ curl localhost:8500/v1/catalog/nodes
|
||||||
[{"Node":"Armons-MacBook-Air","Address":"10.1.10.38"}]
|
[{"Node":"Armons-MacBook-Air","Address":"10.1.10.38"}]
|
||||||
```
|
```
|
||||||
|
|
@ -93,7 +93,7 @@ that you have to make sure to point your DNS lookups to the Consul agent's
|
||||||
DNS server, which runs on port 8600 by default. The format of the DNS
|
DNS server, which runs on port 8600 by default. The format of the DNS
|
||||||
entries (such as "Armons-MacBook-Air.node.consul") will be covered later.
|
entries (such as "Armons-MacBook-Air.node.consul") will be covered later.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ dig @127.0.0.1 -p 8600 Armons-MacBook-Air.node.consul
|
$ dig @127.0.0.1 -p 8600 Armons-MacBook-Air.node.consul
|
||||||
...
|
...
|
||||||
|
|
||||||
|
|
@ -121,4 +121,3 @@ to recover from certain network conditions, while _left_ nodes are no longer con
|
||||||
Additionally, if an agent is operating as a server, a graceful leave is important
|
Additionally, if an agent is operating as a server, a graceful leave is important
|
||||||
to avoid causing a potential availability outage affecting the [consensus protocol](/docs/internals/consensus.html).
|
to avoid causing a potential availability outage affecting the [consensus protocol](/docs/internals/consensus.html).
|
||||||
See the [guides section](/docs/guides/index.html) to safely add and remove servers.
|
See the [guides section](/docs/guides/index.html) to safely add and remove servers.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Registering Health Checks"
|
page_title: "Registering Health Checks"
|
||||||
sidebar_current: "gettingstarted-checks"
|
sidebar_current: "gettingstarted-checks"
|
||||||
|
description: |-
|
||||||
|
We've now seen how simple it is to run Consul, add nodes and services, and query those nodes and services. In this section we will continue by adding health checks to both nodes and services, a critical component of service discovery that prevents using services that are unhealthy.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Health Checks
|
# Health Checks
|
||||||
|
|
@ -29,7 +31,7 @@ the second node.
|
||||||
The first file will add a host-level check, and the second will modify the web
|
The first file will add a host-level check, and the second will modify the web
|
||||||
service definition to add a service-level check.
|
service definition to add a service-level check.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ echo '{"check": {"name": "ping", "script": "ping -c1 google.com >/dev/null", "interval": "30s"}}' >/etc/consul.d/ping.json
|
$ echo '{"check": {"name": "ping", "script": "ping -c1 google.com >/dev/null", "interval": "30s"}}' >/etc/consul.d/ping.json
|
||||||
|
|
||||||
$ echo '{"service": {"name": "web", "tags": ["rails"], "port": 80,
|
$ echo '{"service": {"name": "web", "tags": ["rails"], "port": 80,
|
||||||
|
|
@ -46,7 +48,7 @@ curl every 10 seconds to verify that the web server is running.
|
||||||
Restart the second agent, or send a `SIGHUP` to it. We should now see the
|
Restart the second agent, or send a `SIGHUP` to it. We should now see the
|
||||||
following log lines:
|
following log lines:
|
||||||
|
|
||||||
```
|
```text
|
||||||
==> Starting Consul agent...
|
==> Starting Consul agent...
|
||||||
...
|
...
|
||||||
[INFO] agent: Synced service 'web'
|
[INFO] agent: Synced service 'web'
|
||||||
|
|
@ -66,7 +68,7 @@ Now that we've added some simple checks, we can use the HTTP API to check
|
||||||
them. First, we can look for any failing checks. You can run this curl
|
them. First, we can look for any failing checks. You can run this curl
|
||||||
on either node:
|
on either node:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl http://localhost:8500/v1/health/state/critical
|
$ curl http://localhost:8500/v1/health/state/critical
|
||||||
[{"Node":"agent-two","CheckID":"service:web","Name":"Service 'web' check","Status":"critical","Notes":"","ServiceID":"web","ServiceName":"web"}]
|
[{"Node":"agent-two","CheckID":"service:web","Name":"Service 'web' check","Status":"critical","Notes":"","ServiceID":"web","ServiceName":"web"}]
|
||||||
```
|
```
|
||||||
|
|
@ -77,7 +79,7 @@ our `web` service check.
|
||||||
Additionally, we can attempt to query the web service using DNS. Consul
|
Additionally, we can attempt to query the web service using DNS. Consul
|
||||||
will not return any results, since the service is unhealthy:
|
will not return any results, since the service is unhealthy:
|
||||||
|
|
||||||
```
|
```text
|
||||||
dig @127.0.0.1 -p 8600 web.service.consul
|
dig @127.0.0.1 -p 8600 web.service.consul
|
||||||
...
|
...
|
||||||
|
|
||||||
|
|
@ -91,4 +93,3 @@ Alternatively the HTTP API can be used to add, remove and modify checks dynamica
|
||||||
The API allows for a "dead man's switch" or [TTL based check](/docs/agent/checks.html).
|
The API allows for a "dead man's switch" or [TTL based check](/docs/agent/checks.html).
|
||||||
TTL checks can be used to integrate an application more tightly with Consul, enabling
|
TTL checks can be used to integrate an application more tightly with Consul, enabling
|
||||||
business logic to be evaluated as part of passing a check.
|
business logic to be evaluated as part of passing a check.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Installing Consul"
|
page_title: "Installing Consul"
|
||||||
sidebar_current: "gettingstarted-install"
|
sidebar_current: "gettingstarted-install"
|
||||||
|
description: |-
|
||||||
|
Consul must first be installed on every node that will be a member of a Consul cluster. To make installation easy, Consul is distributed as a binary package for all supported platforms and architectures. This page will not cover how to compile Consul from source.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Install Consul
|
# Install Consul
|
||||||
|
|
@ -28,13 +30,15 @@ you would like.
|
||||||
|
|
||||||
If you are using [homebrew](http://brew.sh/#install) as a package manager,
|
If you are using [homebrew](http://brew.sh/#install) as a package manager,
|
||||||
than you can install consul as simple as:
|
than you can install consul as simple as:
|
||||||
```
|
|
||||||
brew cask install consul
|
```text
|
||||||
|
$ brew cask install consul
|
||||||
```
|
```
|
||||||
|
|
||||||
if you are missing the [cask plugin](http://caskroom.io/) you can install it with:
|
if you are missing the [cask plugin](http://caskroom.io/) you can install it with:
|
||||||
```
|
|
||||||
brew install caskroom/cask/brew-cask
|
```text
|
||||||
|
$ brew install caskroom/cask/brew-cask
|
||||||
```
|
```
|
||||||
|
|
||||||
## Verifying the Installation
|
## Verifying the Installation
|
||||||
|
|
@ -43,7 +47,7 @@ After installing Consul, verify the installation worked by opening a new
|
||||||
terminal session and checking that `consul` is available. By executing
|
terminal session and checking that `consul` is available. By executing
|
||||||
`consul` you should see help output similar to that below:
|
`consul` you should see help output similar to that below:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul
|
$ consul
|
||||||
usage: consul [--version] [--help] <command> [<args>]
|
usage: consul [--version] [--help] <command> [<args>]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul Cluster"
|
page_title: "Consul Cluster"
|
||||||
sidebar_current: "gettingstarted-join"
|
sidebar_current: "gettingstarted-join"
|
||||||
|
description: |-
|
||||||
|
By this point, we've started our first agent and registered and queried one or more services on that agent. This showed how easy it is to use Consul, but didn't show how this could be extended to a scalable production service discovery infrastructure. On this page, we'll create our first real cluster with multiple members.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Cluster
|
# Consul Cluster
|
||||||
|
|
@ -33,7 +35,7 @@ and it *must* be accessible by all other nodes in the cluster. The first node
|
||||||
will act as our server in this cluster. We're still not making a cluster
|
will act as our server in this cluster. We're still not making a cluster
|
||||||
of servers.
|
of servers.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul \
|
$ consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul \
|
||||||
-node=agent-one -bind=172.20.20.10
|
-node=agent-one -bind=172.20.20.10
|
||||||
...
|
...
|
||||||
|
|
@ -44,7 +46,7 @@ This time, we set the bind address to match the IP of the second node
|
||||||
as specified in the Vagrantfile. In production, you will generally want
|
as specified in the Vagrantfile. In production, you will generally want
|
||||||
to provide a bind address or interface as well.
|
to provide a bind address or interface as well.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul agent -data-dir /tmp/consul -node=agent-two -bind=172.20.20.11
|
$ consul agent -data-dir /tmp/consul -node=agent-two -bind=172.20.20.11
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
@ -59,7 +61,7 @@ against each agent and noting that only one member is a part of each.
|
||||||
Now, let's tell the first agent to join the second agent by running
|
Now, let's tell the first agent to join the second agent by running
|
||||||
the following command in a new terminal:
|
the following command in a new terminal:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul join 172.20.20.11
|
$ consul join 172.20.20.11
|
||||||
Successfully joined cluster by contacting 1 nodes.
|
Successfully joined cluster by contacting 1 nodes.
|
||||||
```
|
```
|
||||||
|
|
@ -69,19 +71,16 @@ carefully, you'll see that they received join information. If you
|
||||||
run `consul members` against each agent, you'll see that both agents now
|
run `consul members` against each agent, you'll see that both agents now
|
||||||
know about each other:
|
know about each other:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul members -detailed
|
$ consul members -detailed
|
||||||
Node Address Status Tags
|
Node Address Status Tags
|
||||||
agent-one 172.20.20.10:8301 alive role=consul,dc=dc1,vsn=2,vsn_min=1,vsn_max=2,port=8300,bootstrap=1
|
agent-one 172.20.20.10:8301 alive role=consul,dc=dc1,vsn=2,vsn_min=1,vsn_max=2,port=8300,bootstrap=1
|
||||||
agent-two 172.20.20.11:8301 alive role=node,dc=dc1,vsn=2,vsn_min=1,vsn_max=2
|
agent-two 172.20.20.11:8301 alive role=node,dc=dc1,vsn=2,vsn_min=1,vsn_max=2
|
||||||
```
|
```
|
||||||
|
|
||||||
<div class="alert alert-block alert-info">
|
-> **Remember:** To join a cluster, a Consul agent needs to only
|
||||||
<p><strong>Remember:</strong> To join a cluster, a Consul agent needs to only
|
|
||||||
learn about <em>one existing member</em>. After joining the cluster, the
|
learn about <em>one existing member</em>. After joining the cluster, the
|
||||||
agents gossip with each other to propagate full membership information.
|
agents gossip with each other to propagate full membership information.
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
In addition to using `consul join` you can use the `-join` flag on
|
In addition to using `consul join` you can use the `-join` flag on
|
||||||
`consul agent` to join a cluster as part of starting up the agent.
|
`consul agent` to join a cluster as part of starting up the agent.
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Key/Value Data"
|
page_title: "Key/Value Data"
|
||||||
sidebar_current: "gettingstarted-kv"
|
sidebar_current: "gettingstarted-kv"
|
||||||
|
description: |-
|
||||||
|
In addition to providing service discovery and integrated health checking, Consul provides an easy to use Key/Value store. This can be used to hold dynamic configuration, assist in service coordination, build leader election, and anything else a developer can think to build.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Key/Value Data
|
# Key/Value Data
|
||||||
|
|
@ -22,7 +24,7 @@ in the K/V store.
|
||||||
Querying the agent we started in a prior page, we can first verify that
|
Querying the agent we started in a prior page, we can first verify that
|
||||||
there are no existing keys in the k/v store:
|
there are no existing keys in the k/v store:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl -v http://localhost:8500/v1/kv/?recurse
|
$ curl -v http://localhost:8500/v1/kv/?recurse
|
||||||
* About to connect() to localhost port 8500 (#0)
|
* About to connect() to localhost port 8500 (#0)
|
||||||
* Trying 127.0.0.1... connected
|
* Trying 127.0.0.1... connected
|
||||||
|
|
@ -68,7 +70,7 @@ keys using the `?recurse` parameter.
|
||||||
|
|
||||||
You can also fetch a single key just as easily:
|
You can also fetch a single key just as easily:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl http://localhost:8500/v1/kv/web/key1
|
$ curl http://localhost:8500/v1/kv/web/key1
|
||||||
[{"CreateIndex":97,"ModifyIndex":97,"Key":"web/key1","Flags":0,"Value":"dGVzdA=="}]
|
[{"CreateIndex":97,"ModifyIndex":97,"Key":"web/key1","Flags":0,"Value":"dGVzdA=="}]
|
||||||
```
|
```
|
||||||
|
|
@ -76,7 +78,7 @@ $ curl http://localhost:8500/v1/kv/web/key1
|
||||||
Deleting keys is simple as well. We can delete a single key by specifying the
|
Deleting keys is simple as well. We can delete a single key by specifying the
|
||||||
full path, or we can recursively delete all keys under a root using "?recurse":
|
full path, or we can recursively delete all keys under a root using "?recurse":
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl -X DELETE http://localhost:8500/v1/kv/web/sub?recurse
|
$ curl -X DELETE http://localhost:8500/v1/kv/web/sub?recurse
|
||||||
$ curl http://localhost:8500/v1/kv/web?recurse
|
$ curl http://localhost:8500/v1/kv/web?recurse
|
||||||
[{"CreateIndex":97,"ModifyIndex":97,"Key":"web/key1","Flags":0,"Value":"dGVzdA=="},
|
[{"CreateIndex":97,"ModifyIndex":97,"Key":"web/key1","Flags":0,"Value":"dGVzdA=="},
|
||||||
|
|
@ -89,7 +91,7 @@ key updates. This is done by providing the `?cas=` parameter with the last
|
||||||
`ModifyIndex` value from the GET request. For example, suppose we wanted
|
`ModifyIndex` value from the GET request. For example, suppose we wanted
|
||||||
to update "web/key1":
|
to update "web/key1":
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl -X PUT -d 'newval' http://localhost:8500/v1/kv/web/key1?cas=97
|
$ curl -X PUT -d 'newval' http://localhost:8500/v1/kv/web/key1?cas=97
|
||||||
true
|
true
|
||||||
$ curl -X PUT -d 'newval' http://localhost:8500/v1/kv/web/key1?cas=97
|
$ curl -X PUT -d 'newval' http://localhost:8500/v1/kv/web/key1?cas=97
|
||||||
|
|
@ -102,7 +104,7 @@ However the second operation fails because the `ModifyIndex` is no longer 97.
|
||||||
We can also make use of the `ModifyIndex` to wait for a key's value to change.
|
We can also make use of the `ModifyIndex` to wait for a key's value to change.
|
||||||
For example, suppose we wanted to wait for key2 to be modified:
|
For example, suppose we wanted to wait for key2 to be modified:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl "http://localhost:8500/v1/kv/web/key2?index=101&wait=5s"
|
$ curl "http://localhost:8500/v1/kv/web/key2?index=101&wait=5s"
|
||||||
[{"CreateIndex":98,"ModifyIndex":101,"Key":"web/key2","Flags":42,"Value":"dGVzdA=="}]
|
[{"CreateIndex":98,"ModifyIndex":101,"Key":"web/key2","Flags":42,"Value":"dGVzdA=="}]
|
||||||
```
|
```
|
||||||
|
|
@ -115,4 +117,3 @@ of keys, waiting only until any of the keys has a newer modification time.
|
||||||
|
|
||||||
This is only a few example of what the API supports. For full documentation, please
|
This is only a few example of what the API supports. For full documentation, please
|
||||||
reference the [HTTP API](/docs/agent/http.html).
|
reference the [HTTP API](/docs/agent/http.html).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Next Steps"
|
page_title: "Next Steps"
|
||||||
sidebar_current: "gettingstarted-nextsteps"
|
sidebar_current: "gettingstarted-nextsteps"
|
||||||
|
description: |-
|
||||||
|
That concludes the getting started guide for Consul. Hopefully you're able to see that while Consul is simple to use, it has a powerful set of features. We've covered the basics for all of these features in this guide.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Next Steps
|
# Next Steps
|
||||||
|
|
@ -26,4 +28,3 @@ As a next step, the following resources are available:
|
||||||
The work-in-progress examples folder within the GitHub
|
The work-in-progress examples folder within the GitHub
|
||||||
repository for Consul contains functional examples of various use cases
|
repository for Consul contains functional examples of various use cases
|
||||||
of Consul to help you get started with exactly what you need.
|
of Consul to help you get started with exactly what you need.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Registering Services"
|
page_title: "Registering Services"
|
||||||
sidebar_current: "gettingstarted-services"
|
sidebar_current: "gettingstarted-services"
|
||||||
|
description: |-
|
||||||
|
In the previous page, we ran our first agent, saw the cluster members, and queried that node. On this page, we'll register our first service and query that service. We're not yet running a cluster of Consul agents.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Registering Services
|
# Registering Services
|
||||||
|
|
@ -26,7 +28,7 @@ First, create a directory for Consul configurations. A good directory
|
||||||
is typically `/etc/consul.d`. Consul loads all configuration files in the
|
is typically `/etc/consul.d`. Consul loads all configuration files in the
|
||||||
configuration directory.
|
configuration directory.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ sudo mkdir /etc/consul.d
|
$ sudo mkdir /etc/consul.d
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -35,14 +37,14 @@ pretend we have a service named "web" running on port 80. Additionally,
|
||||||
we'll give it some tags, which we can use as additional ways to query
|
we'll give it some tags, which we can use as additional ways to query
|
||||||
it later.
|
it later.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ echo '{"service": {"name": "web", "tags": ["rails"], "port": 80}}' \
|
$ echo '{"service": {"name": "web", "tags": ["rails"], "port": 80}}' \
|
||||||
>/etc/consul.d/web.json
|
>/etc/consul.d/web.json
|
||||||
```
|
```
|
||||||
|
|
||||||
Now, restart the agent we're running, providing the configuration directory:
|
Now, restart the agent we're running, providing the configuration directory:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul -config-dir /etc/consul.d
|
$ consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul -config-dir /etc/consul.d
|
||||||
==> Starting Consul agent...
|
==> Starting Consul agent...
|
||||||
...
|
...
|
||||||
|
|
@ -69,7 +71,7 @@ for services is `NAME.service.consul`. All DNS names are always in the
|
||||||
querying services, and the `NAME` is the name of the service. For the
|
querying services, and the `NAME` is the name of the service. For the
|
||||||
web service we registered, that would be `web.service.consul`:
|
web service we registered, that would be `web.service.consul`:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ dig @127.0.0.1 -p 8600 web.service.consul
|
$ dig @127.0.0.1 -p 8600 web.service.consul
|
||||||
...
|
...
|
||||||
|
|
||||||
|
|
@ -85,7 +87,7 @@ the service is available on. A records can only hold IP addresses. You can
|
||||||
also use the DNS API to retrieve the entire address/port pair using SRV
|
also use the DNS API to retrieve the entire address/port pair using SRV
|
||||||
records:
|
records:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ dig @127.0.0.1 -p 8600 web.service.consul SRV
|
$ dig @127.0.0.1 -p 8600 web.service.consul SRV
|
||||||
...
|
...
|
||||||
|
|
||||||
|
|
@ -108,7 +110,7 @@ format for tag-based service queries is `TAG.NAME.service.consul`. In
|
||||||
the example below, we ask Consul for all web services with the "rails"
|
the example below, we ask Consul for all web services with the "rails"
|
||||||
tag. We get a response since we registered our service with that tag.
|
tag. We get a response since we registered our service with that tag.
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ dig @127.0.0.1 -p 8600 rails.web.service.consul
|
$ dig @127.0.0.1 -p 8600 rails.web.service.consul
|
||||||
...
|
...
|
||||||
|
|
||||||
|
|
@ -123,7 +125,7 @@ rails.web.service.consul. 0 IN A 172.20.20.11
|
||||||
|
|
||||||
In addition to the DNS API, the HTTP API can be used to query services:
|
In addition to the DNS API, the HTTP API can be used to query services:
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ curl http://localhost:8500/v1/catalog/service/web
|
$ curl http://localhost:8500/v1/catalog/service/web
|
||||||
[{"Node":"agent-one","Address":"172.20.20.11","ServiceID":"web","ServiceName":"web","ServiceTags":["rails"],"ServicePort":80}]
|
[{"Node":"agent-one","Address":"172.20.20.11","ServiceID":"web","ServiceName":"web","ServiceTags":["rails"],"ServicePort":80}]
|
||||||
```
|
```
|
||||||
|
|
@ -136,4 +138,3 @@ any downtime or unavailability to service queries.
|
||||||
|
|
||||||
Alternatively the HTTP API can be used to add, remove, and modify services
|
Alternatively the HTTP API can be used to add, remove, and modify services
|
||||||
dynamically.
|
dynamically.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Web UI"
|
page_title: "Web UI"
|
||||||
sidebar_current: "gettingstarted-ui"
|
sidebar_current: "gettingstarted-ui"
|
||||||
|
description: |-
|
||||||
|
Consul comes with support for a beautiful, functional web UI out of the box. This UI can be used for viewing all services and nodes, viewing all health checks and their current status, and for reading and setting key/value data. The UI automatically supports multi-datacenter.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Web UI
|
# Consul Web UI
|
||||||
|
|
@ -33,7 +35,7 @@ A screenshot of one page of the demo is shown below so you can get an
|
||||||
idea of what the web UI is like. Click the screenshot for the full size.
|
idea of what the web UI is like. Click the screenshot for the full size.
|
||||||
|
|
||||||
<div class="center">
|
<div class="center">
|
||||||
<%= link_to image_tag('consul_web_ui.png'), image_path('consul_web_ui.png') %>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Set Up
|
## Set Up
|
||||||
|
|
@ -45,7 +47,7 @@ is also being run. Then, just append the `-ui-dir` to the `consul agent`
|
||||||
command pointing to the directory where you unzipped the UI (the
|
command pointing to the directory where you unzipped the UI (the
|
||||||
directory with the `index.html` file):
|
directory with the `index.html` file):
|
||||||
|
|
||||||
```
|
```text
|
||||||
$ consul agent -ui-dir /path/to/ui
|
$ consul agent -ui-dir /path/to/ui
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Introduction"
|
page_title: "Introduction"
|
||||||
sidebar_current: "what"
|
sidebar_current: "what"
|
||||||
|
description: |-
|
||||||
|
Welcome to the intro guide to Consul! This guide is the best place to start with Consul. We cover what Consul is, what problems it can solve, how it compares to existing software, and a quick start for using Consul. If you are already familiar with the basics of Consul, the documentation provides more of a reference for all available features.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Introduction to Consul
|
# Introduction to Consul
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. Chef, Puppet, etc."
|
page_title: "Consul vs. Chef, Puppet, etc."
|
||||||
sidebar_current: "vs-other-chef"
|
sidebar_current: "vs-other-chef"
|
||||||
|
description: |-
|
||||||
|
It is not uncommon to find people using Chef, Puppet, and other configuration management tools to build service discovery mechanisms. This is usually done by querying global state to construct configuration files on each node during a periodic convergence run.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. Chef, Puppet, etc.
|
# Consul vs. Chef, Puppet, etc.
|
||||||
|
|
|
||||||
|
|
@ -2,24 +2,27 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. Custom Solutions"
|
page_title: "Consul vs. Custom Solutions"
|
||||||
sidebar_current: "vs-other-custom"
|
sidebar_current: "vs-other-custom"
|
||||||
|
description: |-
|
||||||
|
As a code base grows, a monolithic app usually evolves into a Service Oriented Architecture (SOA). A universal pain point for SOA is service discovery and configuration. In many cases, this leads to organizations building home grown solutions. It is an undisputed fact that distributed systems are hard; building one is error prone and time consuming. Most systems cut corners by introducing single points of failure such as a single Redis or RDBMS to maintain cluster state. These solutions may work in the short term, but they are rarely fault tolerant or scalable. Besides these limitations, they require time and resources to build and maintain.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. Custom Solutions
|
# Consul vs. Custom Solutions
|
||||||
|
|
||||||
As a code base grows, a monolithic app usually evolves into a Service Oriented Architecture (SOA).
|
As a code base grows, a monolithic app usually evolves into a Service Oriented
|
||||||
A universal pain point for SOA is service discovery and configuration. In many
|
Architecture (SOA). A universal pain point for SOA is service discovery and
|
||||||
cases, this leads to organizations building home grown solutions.
|
configuration. In many cases, this leads to organizations building home grown
|
||||||
It is an undisputed fact that distributed systems are hard; building one is error prone and time consuming.
|
solutions. It is an undisputed fact that distributed systems are hard; building
|
||||||
Most systems cut corners by introducing single points of failure such
|
one is error prone and time consuming. Most systems cut corners by introducing
|
||||||
as a single Redis or RDBMS to maintain cluster state. These solutions may work in the short term,
|
single points of failure such as a single Redis or RDBMS to maintain cluster
|
||||||
but they are rarely fault tolerant or scalable. Besides these limitations,
|
state. These solutions may work in the short term, but they are rarely fault
|
||||||
they require time and resources to build and maintain.
|
tolerant or scalable. Besides these limitations, they require time and resources
|
||||||
|
to build and maintain.
|
||||||
|
|
||||||
Consul provides the core set of features needed by a SOA out of the box. By using Consul,
|
Consul provides the core set of features needed by a SOA out of the box. By
|
||||||
organizations can leverage open source work to reduce their time and resource commitment to
|
using Consul, organizations can leverage open source work to reduce their time
|
||||||
re-inventing the wheel and focus on their business applications.
|
and resource commitment to re-inventing the wheel and focus on their business
|
||||||
|
applications.
|
||||||
|
|
||||||
Consul is built on well-cited research, and is designed with the constraints of
|
Consul is built on well-cited research, and is designed with the constraints of
|
||||||
distributed systems in mind. At every step, Consul takes efforts to provide a robust
|
distributed systems in mind. At every step, Consul takes efforts to provide a
|
||||||
and scalable solution for organizations of any size.
|
robust and scalable solution for organizations of any size.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,15 +2,19 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. Other Software"
|
page_title: "Consul vs. Other Software"
|
||||||
sidebar_current: "vs-other"
|
sidebar_current: "vs-other"
|
||||||
|
description: |-
|
||||||
|
The problems Consul solves are varied, but each individual feature has been solved by many different systems. Although there is no single system that provides all the features of Consul, there are other options available to solve some of these problems.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. Other Software
|
# Consul vs. Other Software
|
||||||
|
|
||||||
The problems Consul solves are varied, but each individual feature has been
|
The problems Consul solves are varied, but each individual feature has been
|
||||||
solved by many different systems. Although there is no single system that provides
|
solved by many different systems. Although there is no single system that
|
||||||
all the features of Consul, there are other options available to solve some of these problems.
|
provides all the features of Consul, there are other options available to solve
|
||||||
In this section, we compare Consul to some other options. In most cases, Consul is not
|
some of these problems.
|
||||||
mutually exclusive with any other system.
|
|
||||||
|
In this section, we compare Consul to some other options. In most cases, Consul
|
||||||
|
is not mutually exclusive with any other system.
|
||||||
|
|
||||||
Use the navigation to the left to read the comparison of Consul to specific
|
Use the navigation to the left to read the comparison of Consul to specific
|
||||||
systems.
|
systems.
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. Nagios, Sensu"
|
page_title: "Consul vs. Nagios, Sensu"
|
||||||
sidebar_current: "vs-other-nagios-sensu"
|
sidebar_current: "vs-other-nagios-sensu"
|
||||||
|
description: |-
|
||||||
|
Nagios and Sensu are both tools built for monitoring. They are used to quickly notify operators when an issue occurs.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. Nagios, Sensu
|
# Consul vs. Nagios, Sensu
|
||||||
|
|
@ -46,4 +48,3 @@ integrates a distributed failure detector. This means that if a Consul agent fai
|
||||||
the failure will be detected, and thus all checks being run by that node can be
|
the failure will be detected, and thus all checks being run by that node can be
|
||||||
assumed failed. This failure detector distributes the work among the entire cluster,
|
assumed failed. This failure detector distributes the work among the entire cluster,
|
||||||
and critically enables the edge triggered architecture to work.
|
and critically enables the edge triggered architecture to work.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. Serf"
|
page_title: "Consul vs. Serf"
|
||||||
sidebar_current: "vs-other-serf"
|
sidebar_current: "vs-other-serf"
|
||||||
|
description: |-
|
||||||
|
Serf is a node discovery and orchestration tool and is the only tool discussed so far that is built on an eventually consistent gossip model, with no centralized servers. It provides a number of features, including group membership, failure detection, event broadcasts and a query mechanism. However, Serf does not provide any high-level features such as service discovery, health checking or key/value storage. To clarify, the discovery feature of Serf is at a node level, while Consul provides a service and node level abstraction.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. Serf
|
# Consul vs. Serf
|
||||||
|
|
@ -43,4 +45,3 @@ general purpose tool. Consul uses a CP architecture, favoring consistency over
|
||||||
availability. Serf is a AP system, and sacrifices consistency for availability.
|
availability. Serf is a AP system, and sacrifices consistency for availability.
|
||||||
This means Consul cannot operate if the central servers cannot form a quorum,
|
This means Consul cannot operate if the central servers cannot form a quorum,
|
||||||
while Serf will continue to function under almost all circumstances.
|
while Serf will continue to function under almost all circumstances.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. SkyDNS"
|
page_title: "Consul vs. SkyDNS"
|
||||||
sidebar_current: "vs-other-skydns"
|
sidebar_current: "vs-other-skydns"
|
||||||
|
description: |-
|
||||||
|
SkyDNS is a relatively new tool designed to solve service discovery. It uses multiple central servers that are strongly consistent and fault tolerant. Nodes register services using an HTTP API, and queries can be made over HTTP or DNS to perform discovery.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. SkyDNS
|
# Consul vs. SkyDNS
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,9 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. SmartStack"
|
page_title: "Consul vs. SmartStack"
|
||||||
sidebar_current: "vs-other-smartstack"
|
sidebar_current: "vs-other-smartstack"
|
||||||
|
description: |-
|
||||||
|
SmartStack is another tool which tackles the service discovery problem. It has a rather unique architecture, and has 4 major components: ZooKeeper, HAProxy, Synapse, and Nerve. The ZooKeeper servers are responsible for storing cluster state in a consistent and fault tolerant manner. Each node in the SmartStack cluster then runs both Nerves and Synapses. The Nerve is responsible for running health checks against a service, and registering with the ZooKeeper servers. Synapse queries ZooKeeper for service providers and dynamically configures HAProxy. Finally, clients speak to HAProxy, which does health checking and load balancing across service providers.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. SmartStack
|
# Consul vs. SmartStack
|
||||||
|
|
@ -54,4 +57,3 @@ an integrated key/value store for configuration and multi-datacenter support.
|
||||||
While it may be possible to configure SmartStack for multiple datacenters,
|
While it may be possible to configure SmartStack for multiple datacenters,
|
||||||
the central ZooKeeper cluster would be a serious impediment to a fault tolerant
|
the central ZooKeeper cluster would be a serious impediment to a fault tolerant
|
||||||
deployment.
|
deployment.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
layout: "intro"
|
layout: "intro"
|
||||||
page_title: "Consul vs. ZooKeeper, doozerd, etcd"
|
page_title: "Consul vs. ZooKeeper, doozerd, etcd"
|
||||||
sidebar_current: "vs-other-zk"
|
sidebar_current: "vs-other-zk"
|
||||||
|
description: |-
|
||||||
|
ZooKeeper, doozerd and etcd are all similar in their architecture. All three have server nodes that require a quorum of nodes to operate (usually a simple majority). They are strongly consistent, and expose various primitives that can be used through client libraries within applications to build complex distributed systems.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul vs. ZooKeeper, doozerd, etcd
|
# Consul vs. ZooKeeper, doozerd, etcd
|
||||||
|
|
@ -58,4 +60,3 @@ all these other systems require additional tools and libraries to be built on
|
||||||
top. By using client nodes, Consul provides a simple API that only requires thin clients.
|
top. By using client nodes, Consul provides a simple API that only requires thin clients.
|
||||||
Additionally, the API can be avoided entirely by using configuration files and the
|
Additionally, the API can be avoided entirely by using configuration files and the
|
||||||
DNS interface to have a complete service discovery solution with no development at all.
|
DNS interface to have a complete service discovery solution with no development at all.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -23,8 +23,23 @@
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||||
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||||
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||||
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||||||
|
|
||||||
|
ga('create', 'UA-50021714-1', 'consul.io');
|
||||||
|
ga('send', 'pageview');
|
||||||
|
</script>
|
||||||
|
|
||||||
<%= javascript_include_tag 'application' %>
|
<%= javascript_include_tag 'application' %>
|
||||||
|
|
||||||
|
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<%= javascript_include_tag "html5shiv", "respond.min" %>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
APP.initialize();
|
APP.initialize();
|
||||||
</script>
|
</script>
|
||||||
|
|
|
||||||
|
|
@ -1,43 +1,29 @@
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
|
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
||||||
<meta name="description" content="Service discovery and configuration made easy. Distributed, highly available, and datacenter-aware.">
|
<title><%= current_page.data.page_title ? "#{current_page.data.page_title} - " : "" %>Consul</title>
|
||||||
|
<meta name="description" content="<%= current_page.data.description %>" />
|
||||||
|
|
||||||
|
<%= stylesheet_link_tag "application" %>
|
||||||
|
|
||||||
|
<meta name="HandheldFriendly" content="True" />
|
||||||
|
<meta name="MobileOptimized" content="320" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
|
||||||
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
||||||
|
<meta name="apple-mobile-web-app-status-bar-style" content="white">
|
||||||
|
|
||||||
<link rel="shortcut icon" href="<%= image_path('favicon.png') %>">
|
<link rel="shortcut icon" href="<%= image_path('favicon.png') %>">
|
||||||
|
|
||||||
<title><%= current_page.data.page_title ? "#{current_page.data.page_title} - " : "" %>Consul</title>
|
|
||||||
|
|
||||||
<!-- Bootstrap core CSS -->
|
|
||||||
<%= stylesheet_link_tag "application" %>
|
|
||||||
|
|
||||||
<!-- google fonts -->
|
|
||||||
<!-- <link href='http://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700' rel='stylesheet' type='text/css'>
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- typekit -->
|
|
||||||
<script type="text/javascript" src="//use.typekit.net/kgv0shi.js"></script>
|
<script type="text/javascript" src="//use.typekit.net/kgv0shi.js"></script>
|
||||||
<script type="text/javascript">try{Typekit.load();}catch(e){}</script>
|
<script type="text/javascript">try{Typekit.load();}catch(e){}</script>
|
||||||
|
|
||||||
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<%= javascript_include_tag "html5shiv", "respond.min" %>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<%= yield_content :head %>
|
<%= yield_content :head %>
|
||||||
|
|
||||||
<script>
|
|
||||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
||||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
||||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
||||||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
||||||
|
|
||||||
ga('create', 'UA-50021714-1', 'consul.io');
|
|
||||||
ga('send', 'pageview');
|
|
||||||
|
|
||||||
</script>
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="page-<%= current_page.data.page_title ? "#{current_page.data.page_title} layout-#{current_page.data.layout} page-sub" : "home layout-#{current_page.data.layout}" %>">
|
<body class="page-<%= current_page.data.page_title ? "#{current_page.data.page_title} layout-#{current_page.data.layout} page-sub" : "home layout-#{current_page.data.layout}" %>">
|
||||||
<div id="header" class="<%= current_page.data.page_title == "home" ? "" : "navbar-static-top" %>">
|
<div id="header" class="<%= current_page.data.page_title == "home" ? "" : "navbar-static-top" %>">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
|
|
@ -66,6 +52,5 @@
|
||||||
<li class="li-under"><a href="http://demo.consul.io/">Demo</a></li>
|
<li class="li-under"><a href="http://demo.consul.io/">Demo</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
---
|
||||||
|
layout: false
|
||||||
|
noindex: true
|
||||||
|
---
|
||||||
|
|
||||||
|
User-agent: *
|
||||||
|
Disallow: /404
|
||||||
|
Disallow: /500
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
---
|
||||||
|
layout: false
|
||||||
|
---
|
||||||
|
|
||||||
|
xml.instruct!
|
||||||
|
xml.urlset 'xmlns' => "http://www.sitemaps.org/schemas/sitemap/0.9" do
|
||||||
|
sitemap
|
||||||
|
.resources
|
||||||
|
.select { |page| page.path =~ /\.html/ }
|
||||||
|
.select { |page| !page.data.noindex }
|
||||||
|
.each do |page|
|
||||||
|
xml.url do
|
||||||
|
xml.loc File.join(base_url, page.url)
|
||||||
|
xml.lastmod Date.today.to_time.iso8601
|
||||||
|
xml.changefreq page.data.changefreq || "monthly"
|
||||||
|
xml.priority page.data.priority || "0.5"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Loading…
Reference in New Issue