~adam-stokes/conjure/conjure-up-io : revision 22

1

<!DOCTYPE html>

2

3

<head>

4

5

6

7

8

9

<title>conjure-up User Manual</title>

10

11

<style>

12

/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */

13

/* Remove comment around @import statement below when using as a custom stylesheet */

14

/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/

15

article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}

16

audio,canvas,video{display:inline-block}

17

audio:not([controls]){display:none;height:0}

18

[hidden],template{display:none}

19

script{display:none!important}

20

html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}

21

body{margin:0}

22

a{background:transparent}

23

a:focus{outline:thin dotted}

24

a:active,a:hover{outline:0}

25

h1{font-size:2em;margin:.67em 0}

26

abbr[title]{border-bottom:1px dotted}

27

b,strong{font-weight:bold}

28

dfn{font-style:italic}

29

hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}

30

mark{background:#ff0;color:#000}

31

code,kbd,pre,samp{font-family:monospace;font-size:1em}

32

pre{white-space:pre-wrap}

33

q{quotes:"\201C" "\201D" "\2018" "\2019"}

34

small{font-size:80%}

35

sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}

36

sup{top:-.5em}

37

sub{bottom:-.25em}

38

img{border:0}

39

svg:not(:root){overflow:hidden}

40

figure{margin:0}

41

fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}

42

legend{border:0;padding:0}

43

button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}

44

button,input{line-height:normal}

45

button,select{text-transform:none}

46

button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}

47

button[disabled],html input[disabled]{cursor:default}

48

input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}

49

input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}

50

input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}

51

button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}

52

textarea{overflow:auto;vertical-align:top}

53

table{border-collapse:collapse;border-spacing:0}

54

*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}

55

html,body{font-size:100%}

56

body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto}

57

a:hover{cursor:pointer}

58

img,object,embed{max-width:100%;height:auto}

59

object,embed{height:100%}

60

img{-ms-interpolation-mode:bicubic}

61

.left{float:left!important}

62

.right{float:right!important}

63

.text-left{text-align:left!important}

64

.text-right{text-align:right!important}

65

.text-center{text-align:center!important}

66

.text-justify{text-align:justify!important}

67

.hide{display:none}

68

body{-webkit-font-smoothing:antialiased}

69

img,object,svg{display:inline-block;vertical-align:middle}

70

textarea{height:auto;min-height:50px}

71

select{width:100%}

72

.center{margin-left:auto;margin-right:auto}

73

.spread{width:100%}

74

p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}

75

.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}

76

div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}

77

a{color:#2156a5;text-decoration:underline;line-height:inherit}

78

a:hover,a:focus{color:#1d4b8f}

79

a img{border:none}

80

p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}

81

p aside{font-size:.875em;line-height:1.35;font-style:italic}

82

h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}

83

h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}

84

h1{font-size:2.125em}

85

h2{font-size:1.6875em}

86

h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}

87

h4,h5{font-size:1.125em}

88

h6{font-size:1em}

89

hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}

90

em,i{font-style:italic;line-height:inherit}

91

strong,b{font-weight:bold;line-height:inherit}

92

small{font-size:60%;line-height:inherit}

93

code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}

94

ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}

95

ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}

96

ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}

97

ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}

98

ul.square{list-style-type:square}

99

ul.circle{list-style-type:circle}

100

ul.disc{list-style-type:disc}

101

ul.no-bullet{list-style:none}

102

ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}

103

dl dt{margin-bottom:.3125em;font-weight:bold}

104

dl dd{margin-bottom:1.25em}

105

abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}

106

abbr{text-transform:none}

107

blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}

108

blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}

109

blockquote cite:before{content:"\2014 \0020"}

110

blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}

111

blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}

112

@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}

113

h1{font-size:2.75em}

114

h2{font-size:2.3125em}

115

h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}

116

h4{font-size:1.4375em}}

117

table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}

118

table thead,table tfoot{background:#f7f8f7;font-weight:bold}

119

table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}

120

table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}

121

table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}

122

table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}

123

body{tab-size:4}

124

h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}

125

h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}

126

.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}

127

.clearfix:after,.float-group:after{clear:both}

128

*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}

129

pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}

130

.keyseq{color:rgba(51,51,51,.8)}

131

kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}

132

.keyseq kbd:first-child{margin-left:0}

133

.keyseq kbd:last-child{margin-right:0}

134

.menuseq,.menu{color:rgba(0,0,0,.8)}

135

b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}

136

b.button:before{content:"[";padding:0 3px 0 2px}

137

b.button:after{content:"]";padding:0 2px 0 3px}

138

p a>code:hover{color:rgba(0,0,0,.9)}

139

#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}

140

#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}

141

#header:after,#content:after,#footnotes:after,#footer:after{clear:both}

142

#content{margin-top:1.25em}

143

#content:before{content:none}

144

#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}

145

#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}

146

#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}

147

#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}

148

#header .details span:first-child{margin-left:-.125em}

149

#header .details span.email a{color:rgba(0,0,0,.85)}

150

#header .details br{display:none}

151

#header .details br+span:before{content:"\00a0\2013\00a0"}

152

#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}

153

#header .details br+span#revremark:before{content:"\00a0|\00a0"}

154

#header #revnumber{text-transform:capitalize}

155

#header #revnumber:after{content:"\00a0"}

156

#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}

157

#toc{border-bottom:1px solid #efefed;padding-bottom:.5em}

158

#toc>ul{margin-left:.125em}

159

#toc ul.sectlevel0>li>a{font-style:italic}

160

#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}

161

#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}

162

#toc li{line-height:1.3334;margin-top:.3334em}

163

#toc a{text-decoration:none}

164

#toc a:active{text-decoration:underline}

165

#toctitle{color:#7a2518;font-size:1.2em}

166

@media only screen and (min-width:768px){#toctitle{font-size:1.375em}

167

body.toc2{padding-left:15em;padding-right:0}

168

#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}

169

#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}

170

#toc.toc2>ul{font-size:.9em;margin-bottom:0}

171

#toc.toc2 ul ul{margin-left:0;padding-left:1em}

172

#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}

173

body.toc2.toc-right{padding-left:0;padding-right:15em}

174

body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}

175

@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}

176

#toc.toc2{width:20em}

177

#toc.toc2 #toctitle{font-size:1.375em}

178

#toc.toc2>ul{font-size:.95em}

179

#toc.toc2 ul ul{padding-left:1.25em}

180

body.toc2.toc-right{padding-left:0;padding-right:20em}}

181

#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}

182

#content #toc>:first-child{margin-top:0}

183

#content #toc>:last-child{margin-bottom:0}

184

#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}

185

#footer-text{color:rgba(255,255,255,.8);line-height:1.44}

186

.sect1{padding-bottom:.625em}

187

@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}

188

.sect1+.sect1{border-top:1px solid #efefed}

189

#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}

190

#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}

191

#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}

192

#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}

193

#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}

194

.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}

195

.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}

196

table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}

197

.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}

198

table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}

199

.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}

200

.admonitionblock>table td.icon{text-align:center;width:80px}

201

.admonitionblock>table td.icon img{max-width:none}

202

.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}

203

.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}

204

.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}

205

.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}

206

.exampleblock>.content>:first-child{margin-top:0}

207

.exampleblock>.content>:last-child{margin-bottom:0}

208

.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}

209

.sidebarblock>:first-child{margin-top:0}

210

.sidebarblock>:last-child{margin-bottom:0}

211

.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}

212

.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}

213

.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}

214

.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}

215

.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}

216

.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}

217

@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}

218

@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}

219

.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}

220

.listingblock pre.highlightjs{padding:0}

221

.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}

222

.listingblock pre.prettyprint{border-width:0}

223

.listingblock>.content{position:relative}

224

.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}

225

.listingblock:hover code[data-lang]:before{display:block}

226

.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}

227

.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}

228

table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}

229

table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}

230

table.pyhltable td.code{padding-left:.75em;padding-right:0}

231

pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}

232

pre.pygments .lineno{display:inline-block;margin-right:.25em}

233

table.pyhltable .linenodiv{background:none!important;padding-right:0!important}

234

.quoteblock{margin:0 1em 1.25em 1.5em;display:table}

235

.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}

236

.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}

237

.quoteblock blockquote{margin:0;padding:0;border:0}

238

.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}

239

.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}

240

.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}

241

.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}

242

.quoteblock .quoteblock blockquote{padding:0 0 0 .75em}

243

.quoteblock .quoteblock blockquote:before{display:none}

244

.verseblock{margin:0 1em 1.25em 1em}

245

.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}

246

.verseblock pre strong{font-weight:400}

247

.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}

248

.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}

249

.quoteblock .attribution br,.verseblock .attribution br{display:none}

250

.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}

251

.quoteblock.abstract{margin:0 0 1.25em 0;display:block}

252

.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}

253

.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}

254

table.tableblock{max-width:100%;border-collapse:separate}

255

table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}

256

table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}

257

table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}

258

table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}

259

table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}

260

table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}

261

table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}

262

table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}

263

table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}

264

table.frame-all{border-width:1px}

265

table.frame-sides{border-width:0 1px}

266

table.frame-topbot{border-width:1px 0}

267

th.halign-left,td.halign-left{text-align:left}

268

th.halign-right,td.halign-right{text-align:right}

269

th.halign-center,td.halign-center{text-align:center}

270

th.valign-top,td.valign-top{vertical-align:top}

271

th.valign-bottom,td.valign-bottom{vertical-align:bottom}

272

th.valign-middle,td.valign-middle{vertical-align:middle}

273

table thead th,table tfoot th{font-weight:bold}

274

tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}

275

tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}

276

p.tableblock>code:only-child{background:none;padding:0}

277

p.tableblock{font-size:1em}

278

td>div.verse{white-space:pre}

279

ol{margin-left:1.75em}

280

ul li ol{margin-left:1.5em}

281

dl dd{margin-left:1.125em}

282

dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}

283

ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}

284

ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}

285

ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}

286

ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}

287

ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}

288

ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}

289

ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}

290

ul.inline>li>*{display:block}

291

.unstyled dl dt{font-weight:400;font-style:normal}

292

ol.arabic{list-style-type:decimal}

293

ol.decimal{list-style-type:decimal-leading-zero}

294

ol.loweralpha{list-style-type:lower-alpha}

295

ol.upperalpha{list-style-type:upper-alpha}

296

ol.lowerroman{list-style-type:lower-roman}

297

ol.upperroman{list-style-type:upper-roman}

298

ol.lowergreek{list-style-type:lower-greek}

299

.hdlist>table,.colist>table{border:0;background:none}

300

.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}

301

td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}

302

td.hdlist1{font-weight:bold;padding-bottom:1.25em}

303

.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}

304

.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}

305

.colist>table tr>td:last-of-type{padding:.25em 0}

306

.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}

307

.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}

308

.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}

309

.imageblock>.title{margin-bottom:0}

310

.imageblock.thumb,.imageblock.th{border-width:6px}

311

.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}

312

.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}

313

.image.left{margin-right:.625em}

314

.image.right{margin-left:.625em}

315

a.image{text-decoration:none;display:inline-block}

316

a.image object{pointer-events:none}

317

sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}

318

sup.footnote a,sup.footnoteref a{text-decoration:none}

319

sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}

320

#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}

321

#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}

322

#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}

323

#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}

324

#footnotes .footnote:last-of-type{margin-bottom:0}

325

#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}

326

.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}

327

.gist .file-data>table td.line-data{width:99%}

328

div.unbreakable{page-break-inside:avoid}

329

.big{font-size:larger}

330

.small{font-size:smaller}

331

.underline{text-decoration:underline}

332

.overline{text-decoration:overline}

333

.line-through{text-decoration:line-through}

334

.aqua{color:#00bfbf}

335

.aqua-background{background-color:#00fafa}

336

.black{color:#000}

337

.black-background{background-color:#000}

338

.blue{color:#0000bf}

339

.blue-background{background-color:#0000fa}

340

.fuchsia{color:#bf00bf}

341

.fuchsia-background{background-color:#fa00fa}

342

.gray{color:#606060}

343

.gray-background{background-color:#7d7d7d}

344

.green{color:#006000}

345

.green-background{background-color:#007d00}

346

.lime{color:#00bf00}

347

.lime-background{background-color:#00fa00}

348

.maroon{color:#600000}

349

.maroon-background{background-color:#7d0000}

350

.navy{color:#000060}

351

.navy-background{background-color:#00007d}

352

.olive{color:#606000}

353

.olive-background{background-color:#7d7d00}

354

.purple{color:#600060}

355

.purple-background{background-color:#7d007d}

356

.red{color:#bf0000}

357

.red-background{background-color:#fa0000}

358

.silver{color:#909090}

359

.silver-background{background-color:#bcbcbc}

360

.teal{color:#006060}

361

.teal-background{background-color:#007d7d}

362

.white{color:#bfbfbf}

363

.white-background{background-color:#fafafa}

364

.yellow{color:#bfbf00}

365

.yellow-background{background-color:#fafa00}

366

span.icon>.fa{cursor:default}

367

.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}

368

.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}

369

.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}

370

.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}

371

.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}

372

.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}

373

.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}

374

.conum[data-value] *{color:#fff!important}

375

.conum[data-value]+b{display:none}

376

.conum[data-value]:after{content:attr(data-value)}

377

pre .conum[data-value]{position:relative;top:-.125em}

378

b.conum *{color:inherit!important}

379

.conum:not([data-value]):empty{display:none}

380

dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}

381

h1,h2,p,td.content,span.alt{letter-spacing:-.01em}

382

p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}

383

p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}

384

p{margin-bottom:1.25rem}

385

.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}

386

.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}

387

.print-only{display:none!important}

388

@media print{@page{margin:1.25cm .75cm}

389

*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}

390

a{color:inherit!important;text-decoration:underline!important}

391

a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}

392

a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}

393

abbr[title]:after{content:" (" attr(title) ")"}

394

pre,blockquote,tr,img,object,svg{page-break-inside:avoid}

395

thead{display:table-header-group}

396

svg{max-width:100%}

397

p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}

398

h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}

399

#toc,.sidebarblock,.exampleblock>.content{background:none!important}

400

#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}

401

.sect1{padding-bottom:0!important}

402

.sect1+.sect1{border:0!important}

403

#header>h1:first-child{margin-top:1.25rem}

404

body.book #header{text-align:center}

405

body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}

406

body.book #header .details{border:0!important;display:block;padding:0!important}

407

body.book #header .details span:first-child{margin-left:0!important}

408

body.book #header .details br{display:block}

409

body.book #header .details br+span:before{content:none!important}

410

body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}

411

body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}

412

.listingblock code[data-lang]:before{display:block}

413

#footer{background:none!important;padding:0 .9375em}

414

#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}

415

.hide-on-print{display:none!important}

416

.print-only{display:block!important}

417

.hide-for-print{display:none!important}

418

.show-for-print{display:inherit!important}}

419

</style>

420

421

<style>

422

.listingblock .pygments .hll { background-color: #ffffcc }

423

.listingblock .pygments { background: #f8f8f8; }

424

.listingblock .pygments .tok-c { color: #408080; font-style: italic } /* Comment */

425

.listingblock .pygments .tok-err { border: 1px solid #FF0000 } /* Error */

426

.listingblock .pygments .tok-k { color: #008000; font-weight: bold } /* Keyword */

427

.listingblock .pygments .tok-o { color: #666666 } /* Operator */

428

.listingblock .pygments .tok-ch { color: #408080; font-style: italic } /* Comment.Hashbang */

429

.listingblock .pygments .tok-cm { color: #408080; font-style: italic } /* Comment.Multiline */

430

.listingblock .pygments .tok-cp { color: #BC7A00 } /* Comment.Preproc */

431

.listingblock .pygments .tok-cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */

432

.listingblock .pygments .tok-c1 { color: #408080; font-style: italic } /* Comment.Single */

433

.listingblock .pygments .tok-cs { color: #408080; font-style: italic } /* Comment.Special */

434

.listingblock .pygments .tok-gd { color: #A00000 } /* Generic.Deleted */

435

.listingblock .pygments .tok-ge { font-style: italic } /* Generic.Emph */

436

.listingblock .pygments .tok-gr { color: #FF0000 } /* Generic.Error */

437

.listingblock .pygments .tok-gh { color: #000080; font-weight: bold } /* Generic.Heading */

438

.listingblock .pygments .tok-gi { color: #00A000 } /* Generic.Inserted */

439

.listingblock .pygments .tok-go { color: #888888 } /* Generic.Output */

440

.listingblock .pygments .tok-gp { color: #000080; font-weight: bold } /* Generic.Prompt */

441

.listingblock .pygments .tok-gs { font-weight: bold } /* Generic.Strong */

442

.listingblock .pygments .tok-gu { color: #800080; font-weight: bold } /* Generic.Subheading */

443

.listingblock .pygments .tok-gt { color: #0044DD } /* Generic.Traceback */

444

.listingblock .pygments .tok-kc { color: #008000; font-weight: bold } /* Keyword.Constant */

445

.listingblock .pygments .tok-kd { color: #008000; font-weight: bold } /* Keyword.Declaration */

446

.listingblock .pygments .tok-kn { color: #008000; font-weight: bold } /* Keyword.Namespace */

447

.listingblock .pygments .tok-kp { color: #008000 } /* Keyword.Pseudo */

448

.listingblock .pygments .tok-kr { color: #008000; font-weight: bold } /* Keyword.Reserved */

449

.listingblock .pygments .tok-kt { color: #B00040 } /* Keyword.Type */

450

.listingblock .pygments .tok-m { color: #666666 } /* Literal.Number */

451

.listingblock .pygments .tok-s { color: #BA2121 } /* Literal.String */

452

.listingblock .pygments .tok-na { color: #7D9029 } /* Name.Attribute */

453

.listingblock .pygments .tok-nb { color: #008000 } /* Name.Builtin */

454

.listingblock .pygments .tok-nc { color: #0000FF; font-weight: bold } /* Name.Class */

455

.listingblock .pygments .tok-no { color: #880000 } /* Name.Constant */

456

.listingblock .pygments .tok-nd { color: #AA22FF } /* Name.Decorator */

457

.listingblock .pygments .tok-ni { color: #999999; font-weight: bold } /* Name.Entity */

458

.listingblock .pygments .tok-ne { color: #D2413A; font-weight: bold } /* Name.Exception */

459

.listingblock .pygments .tok-nf { color: #0000FF } /* Name.Function */

460

.listingblock .pygments .tok-nl { color: #A0A000 } /* Name.Label */

461

.listingblock .pygments .tok-nn { color: #0000FF; font-weight: bold } /* Name.Namespace */

462

.listingblock .pygments .tok-nt { color: #008000; font-weight: bold } /* Name.Tag */

463

.listingblock .pygments .tok-nv { color: #19177C } /* Name.Variable */

464

.listingblock .pygments .tok-ow { color: #AA22FF; font-weight: bold } /* Operator.Word */

465

.listingblock .pygments .tok-w { color: #bbbbbb } /* Text.Whitespace */

466

.listingblock .pygments .tok-mb { color: #666666 } /* Literal.Number.Bin */

467

.listingblock .pygments .tok-mf { color: #666666 } /* Literal.Number.Float */

468

.listingblock .pygments .tok-mh { color: #666666 } /* Literal.Number.Hex */

469

.listingblock .pygments .tok-mi { color: #666666 } /* Literal.Number.Integer */

470

.listingblock .pygments .tok-mo { color: #666666 } /* Literal.Number.Oct */

471

.listingblock .pygments .tok-sb { color: #BA2121 } /* Literal.String.Backtick */

472

.listingblock .pygments .tok-sc { color: #BA2121 } /* Literal.String.Char */

473

.listingblock .pygments .tok-sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */

474

.listingblock .pygments .tok-s2 { color: #BA2121 } /* Literal.String.Double */

475

.listingblock .pygments .tok-se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */

476

.listingblock .pygments .tok-sh { color: #BA2121 } /* Literal.String.Heredoc */

477

.listingblock .pygments .tok-si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */

478

.listingblock .pygments .tok-sx { color: #008000 } /* Literal.String.Other */

479

.listingblock .pygments .tok-sr { color: #BB6688 } /* Literal.String.Regex */

480

.listingblock .pygments .tok-s1 { color: #BA2121 } /* Literal.String.Single */

481

.listingblock .pygments .tok-ss { color: #19177C } /* Literal.String.Symbol */

482

.listingblock .pygments .tok-bp { color: #008000 } /* Name.Builtin.Pseudo */

483

.listingblock .pygments .tok-vc { color: #19177C } /* Name.Variable.Class */

484

.listingblock .pygments .tok-vg { color: #19177C } /* Name.Variable.Global */

485

.listingblock .pygments .tok-vi { color: #19177C } /* Name.Variable.Instance */

486

.listingblock .pygments .tok-il { color: #666666 } /* Literal.Number.Integer.Long */

487

</style>

488

</head>

489

490

491

<h1>conjure-up User Manual</h1>

492

493

<span id="author" class="author">Adam Stokes</span><br>

494

<span id="email" class="email"><a href="https://github.com/battlemidget">@battlemidget</a></span><br>

495

<span id="author2" class="author">Mike McCracken</span><br>

496

497

<span id="revnumber">version 2.0.1~beta1,</span>

498

499

500

</div>

501

502

<div id="toctitle">Table of Contents</div>

503

504

<li><a href="#getting-started">Getting Started</a>

505

506

<li><a href="#hardware-requirements">Hardware Requirements</a>

507

508

<li><a href="#public-cloud">Public Cloud</a></li>

509

<li><a href="#localhost">Localhost</a></li>

510

</ul>

511

</li>

512

<li><a href="#configure-lxdzfs">Configure LXD/ZFS</a></li>

513

<li><a href="#installing-conjure-up">Installing conjure-up</a></li>

514

<li><a href="#summon-a-spell">Summon a Spell</a></li>

515

<li><a href="#uninstalling">Uninstalling</a></li>

516

</ul>

517

</li>

518

<li><a href="#usage">Advanced Spell Summoning</a>

519

520

<li><a href="#githubbitbucket">GitHub/BitBucket</a></li>

521

<li><a href="#remote-web-server">Remote Web Server</a></li>

522

<li><a href="#local-filesystem">Local Filesystem</a></li>

523

<li><a href="#running-in-headless-mode">Running in Headless Mode</a></li>

524

</ul>

525

</li>

526

<li><a href="#troubleshoot">Troubleshoot</a>

527

528

<li><a href="#_check_logs">Check logs</a></li>

529

</ul>

530

</li>

531

</ul>

532

</div>

533

</div>

534

535

536

537

538

<p><strong>conjure-up</strong> is a thin layer spanning a few different underlying

539

technologies - <a href="https://jujucharms.com">Juju</a>, <a href="http://maas.io">MAAS</a>,

540

and <a href="http://linuxcontainers.org">LXD</a>.</p>

541

</div>

542

543

<p><strong>conjure-up</strong> provides you with a streamlined, turnkey solution. In order

544

to provide that streamlined approach, <strong>conjure-up</strong> makes use of

545

processing scripts. These scripts are executed at 3 different times in

546

the deployment, just after a Juju bootstrap, just before a Juju deploy,

547

and right after a Juju deploy.</p>

548

</div>

549

550

<p>Processing scripts give you the flexibility to alter LXD profiles in

551

order to expose additional network interfaces to Neutron services,

552

import images into Glance once the service is available, or notifying

553

the Deployment status screen that your solution is ready and can be

554

viewed at a specific URL.</p>

555

</div>

556

557

<p>With these powerful concepts you can package up the solution that can

558

then be provided to coworkers who can easily deploy your solutions in

559

any Public Cloud, MAAS, or LXD.</p>

560

</div>

561

</div>

562

</div>

563

564

<h2 id="getting-started">Getting Started</h2>

565

566

567

<h3 id="hardware-requirements">Hardware Requirements</h3>

568

569

<h4 id="public-cloud">Public Cloud</h4>

570

571

<p>For <strong>Public Cloud</strong> deployments hardware requirements(<em>constraints</em>)

572

are handled by the Spell authors and will automatically be allocated

573

during deploy.</p>

574

</div>

575

</div>

576

577

<h4 id="localhost">Localhost</h4>

578

579

<p>For <strong>localhost</strong> deployments the following setup is recommended:</p>

580

</div>

581

582

<ul>

583

<li>

584

<p>2 cores</p>

585

</li>

586

<li>

587

588

</li>

589

<li>

590

591

</li>

592

<li>

593

<p>250G SSD with a seperate block device for ZFS. Our recommendation for

594

that device is 100G.</p>

595

</li>

596

</ul>

597

</div>

598

</div>

599

</div>

600

601

<h3 id="configure-lxdzfs">Configure LXD/ZFS</h3>

602

603

<p>If you plan on using the <strong>localhost</strong> provider a properly configured

604

network bridge is required and optionally(<strong>but highly recommended</strong>)

605

configuring ZFS. Skip if you plan on using any other public cloud.</p>

606

</div>

607

608

609

610

</div>

611

</div>

612

613

<p>LXD will go through a series of questions including the setup of ZFS and

614

a network bridge. Make sure to utilize your seperate block device for

615

the ZFS pool here.</p>

616

</div>

617

618

<p>There may be times where conjure-up will error out due to

619

not finding a suitable lxdbr0 bridge device. Since LXD is socket

620

activated you may need to run <code>lxc finger</code> and re-try conjure-up

621

installation.</p>

622

</div>

623

624

<table>

625

<tr>

626

627

628

</td>

629

630

For best results make sure to allocate at least a 20G ZFS

631

pool size.

632

</td>

633

</tr>

634

</table>

635

</div>

636

</div>

637

638

<h3 id="installing-conjure-up">Installing conjure-up</h3>

639

640

<p>We are currently in a pre-release phase. In order to help test

641

conjure-up we ask that you install from the PPA until otherwise noted:</p>

642

</div>

643

644

645

<pre class="pygments highlight"><code data-lang="bash">$ sudo apt-add-repository ppa:conjure-up/next</code></pre>

646

</div>

647

</div>

648

649

<p>Juju is one of the underlying technologies used and is also currently in

650

beta. Please use their PPA until otherwise noted:</p>

651

</div>

652

653

654

<pre class="pygments highlight"><code data-lang="bash">$ sudo apt-add-repository ppa:juju/devel</code></pre>

655

</div>

656

</div>

657

658

<p>Finally, update your apt cache and install necessary packages:</p>

659

</div>

660

661

662

<pre class="pygments highlight"><code data-lang="bash">$ sudo apt update

663

$ sudo apt install conjure-up</code></pre>

664

</div>

665

</div>

666

</div>

667

668

<h3 id="summon-a-spell">Summon a Spell</h3>

669

670

<p>To deploy solutions such as OpenStack you will summon a spell:</p>

671

</div>

672

673

674

<pre class="pygments highlight"><code data-lang="bash">$ conjure-up openstack</code></pre>

675

</div>

676

</div>

677

678

<table>

679

<tr>

680

681

682

</td>

683

684

<strong>OpenStack with NovaLXD</strong> is a special case where it is

685

required for you to install the openstack package. Simply running <code>sudo

686

apt install openstack</code> prior to running conjure-up will setup the

687

necessary requirements for a successful deployment.

688

</td>

689

</tr>

690

</table>

691

</div>

692

693

<p>To see a list of all available spells run:</p>

694

</div>

695

696

697

<pre class="pygments highlight"><code data-lang="bash">$ conjure-up</code></pre>

698

</div>

699

</div>

700

701

702

703

<table>

704

<tr>

705

706

707

</td>

708

709

Several remote locations are supported please see <a href="#usage">Advanced Spell Summoning</a>

710

for further details.

711

</td>

712

</tr>

713

</table>

714

</div>

715

</div>

716

</div>

717

</div>

718

719

<h3 id="uninstalling">Uninstalling</h3>

720

721

<p><strong>conjure-up</strong> uses Juju under the hood and to remove a deployment

722

requires the use of <code>juju help commands</code>.</p>

723

</div>

724

725

726

727

<table>

728

<tr>

729

730

731

</td>

732

733

You’ll need to be familiar with Juju

734

<a href="https://jujucharms.com/docs/devel/controllers">controllers</a> and

735

<a href="https://jujucharms.com/docs/devel/models">models</a>

736

</td>

737

</tr>

738

</table>

739

</div>

740

</div>

741

</div>

742

743

<p>The basics of removing a deployed spell are as follows:</p>

744

</div>

745

746

747

<pre class="pygments highlight"><code data-lang="bash"><span class="tok-c1"># Deploy openstack</span>

748

$ conjure-up openstack

749

750

<span class="tok-c1"># List Juju information</span>

751

$ juju controllers

752

CONTROLLER MODEL USER CLOUD/REGION

753

teddy* default admin@local localhost/localhost

754

755

$ juju models

756

MODEL OWNER STATUS LAST CONNECTION

757

controller admin@local available never connected

758

default* admin@local available just now

759

760

<span class="tok-c1"># Remove the default model is houses our OpenStack deployment</span>

761

$ juju destroy-model default

762

763

<span class="tok-c1"># Or destroy the entire environment and start over</span>

764

$ juju kill-controller teddy</code></pre>

765

</div>

766

</div>

767

</div>

768

</div>

769

</div>

770

771

<h2 id="usage">Advanced Spell Summoning</h2>

772

773

774

<p><strong>conjure-up</strong> includes several spells in addition to supporting summoning

775

spells from several remote repositories and from a local directory on

776

your filesystem.</p>

777

</div>

778

779

<h3 id="githubbitbucket">GitHub/BitBucket</h3>

780

781

<p>Not quite ready to push your spell to the charm registry? That’s ok,

782

simply push your spell to GitHub and conjure-up can deploy from there:</p>

783

</div>

784

785

786

<pre>$ conjure-up battlemidget/ghost</pre>

787

</div>

788

</div>

789

790

<p>This would pull from GitHub repo <a href="https://github.com/battlemidget/ghost" class="bare">https://github.com/battlemidget/ghost</a></p>

791

</div>

792

</div>

793

794

<h3 id="remote-web-server">Remote Web Server</h3>

795

796

<p><strong>conjure-up</strong> will also support downloading directly from a webserver.

797

For example, if you have your spell zipped up and stored at

798

<a href="http://example.com/my-conjure-spell.zip" class="bare">http://example.com/my-conjure-spell.zip</a> you could install it like so:</p>

799

</div>

800

801

802

<pre>$ conjure-up http://example.com/my-conjure-spell.zip</pre>

803

</div>

804

</div>

805

</div>

806

807

<h3 id="local-filesystem">Local Filesystem</h3>

808

809

<p>Passing in either the directory path of the spell or if the current

810

working directory is a spell:</p>

811

</div>

812

813

814

<pre>$ conjure-up ~/spells/openstack/openstack-novalxd</pre>

815

</div>

816

</div>

817

818

819

</div>

820

821

822

<pre>$ ~/spells/openstack/openstack-novalxd> conjure-up .</pre>

823

</div>

824

</div>

825

</div>

826

827

<h3 id="running-in-headless-mode">Running in Headless Mode</h3>

828

829

<p><strong>conjure-up</strong> is meant to be a teaching tool in addition to a full blown

830

application deployment tool. By Default <strong>conjure-up</strong> will walk you

831

through the entire deployment process and help you understand what it is

832

you are deploying.</p>

833

</div>

834

835

<p>Where this doesn’t make sense is if you are wanting to deploy your

836

application in an automated fashion. For example, integrating the

837

deployment with a Jenkins CI server.</p>

838

</div>

839

840

<p>For these cases <strong>conjure-up</strong> provides a headless mode.</p>

841

</div>

842

843

<p>To deploy in a headless mode you’ll need to have credentials defined if

844

deploying to a Public Cloud or make sure LXD is configured if deploying

845

to Localhost.</p>

846

</div>

847

848

<p>To deploy OpenStack to a Localhost provider:</p>

849

</div>

850

851

852

<pre>$ conjure-up openstack localhost</pre>

853

</div>

854

</div>

855

856

<p>If we want to deploy to a cloud like AWS:</p>

857

</div>

858

859

860

<pre>$ conjure-up observable-kubernetes aws</pre>

861

</div>

862

</div>

863

864

<table>

865

<tr>

866

867

868

</td>

869

870

Keep in mind you’ll need to have credentials defined, see

871

<a href="https://jujucharms.com/docs/devel/credentials">Juju credentials</a> for more

872

details.

873

</td>

874

</tr>

875

</table>

876

</div>

877

</div>

878

</div>

879

</div>

880

881

<h2 id="troubleshoot">Troubleshoot</h2>

882

883

884

<h3 id="_check_logs">Check logs</h3>

885

886

<p><strong>conjure-up</strong> logs are written to <strong>journald</strong> by default. Viewing those logs can be done with:</p>

887

</div>

888

889

890

<pre class="pygments highlight"><code data-lang="bash">$ journalctl <span class="tok-p">|</span>grep conjure-up</code></pre>

891

</div>

892

</div>

893

</div>

894

</div>

895

</div>

896

</div>

897

898

899

Version 2.0.1~beta1<br>

900

Last updated 2016-09-13 05:23:40 EDT

901

</div>

902

</div>

903

</body>

904

</html>

b'\\ No newline at end of file'