-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinstall.html
More file actions
180 lines (157 loc) · 7.34 KB
/
install.html
File metadata and controls
180 lines (157 loc) · 7.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installing Kanister — kanister 0.1.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tutorial" href="tutorial.html" />
<link rel="prev" title="Welcome to kanister’s documentation!" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="installing-kanister">
<span id="install"></span><h1>Installing Kanister<a class="headerlink" href="#installing-kanister" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="installation-overview">
<p class="topic-title first">Installation Overview</p>
<ul class="simple">
<li><a class="reference internal" href="#quickstart" id="id1">Quickstart</a></li>
<li><a class="reference internal" href="#prerequisites" id="id2">Prerequisites</a></li>
<li><a class="reference internal" href="#building-and-deploying-from-source" id="id3">Building and Deploying from Source</a><ul>
<li><a class="reference internal" href="#deploy-released-controller" id="id4">Deploy Released Controller</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="quickstart">
<h2><a class="toc-backref" href="#id1">Quickstart</a><a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
<p>This will install the controller in the default namespace</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># pull the kanister repo</span>
$ git clone git@github.com:kanisterio/kanister.git
<span class="c1"># install Kanister operator controller in the default namepsace</span>
$ kubectl -f apply kanister/bundle.yaml
</pre></div>
</div>
<div class="admonition-todo admonition" id="index-0">
<p class="first admonition-title">Todo</p>
<p class="last">Consider using <cite>make deploy</cite> in the quickstart section</p>
</div>
</div>
<div class="section" id="prerequisites">
<h2><a class="toc-backref" href="#id2">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>kubernetes 1.7 or higher</li>
<li><a class="reference external" href="https://kubernetes.io/docs/tasks/tools/install-kubectl/">kubectl</a> installed
and setup</li>
<li>docker</li>
</ul>
</div>
<div class="section" id="building-and-deploying-from-source">
<h2><a class="toc-backref" href="#id3">Building and Deploying from Source</a><a class="headerlink" href="#building-and-deploying-from-source" title="Permalink to this headline">¶</a></h2>
<p>To build, package and deploy the controller to your kubernetes cluster. It will
push the controller docker image to your docker repo <cite><MY REGISTRY></cite></p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># build controller binary</span>
$ make build
<span class="c1"># package the binary in a docker image and push it to your image registry</span>
$ make push <span class="nv">REGISTRY</span><span class="o">=</span><MY REGISTRY>
<span class="c1"># deploy the controller to your kubernetes repo</span>
$ make deploy <span class="nv">REGISTRY</span><span class="o">=</span><MY REGISTRY>
</pre></div>
</div>
<div class="section" id="deploy-released-controller">
<h3><a class="toc-backref" href="#id4">Deploy Released Controller</a><a class="headerlink" href="#deploy-released-controller" title="Permalink to this headline">¶</a></h3>
<p>Deploy a realeased version of the controller to a specific namespace
<cite><NAMESPACE></cite></p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># build controller binary</span>
$ make deploy <span class="nv">NAMESPACE</span><span class="o">=</span><NAMESPACE> <span class="nv">VERSION</span><span class="o">=</span><span class="s2">"0.1.0"</span>
</pre></div>
</div>
<div class="admonition-todo admonition" id="index-1">
<p class="first admonition-title">Todo</p>
<ul class="last simple">
<li>Namespaces currently not supported.</li>
<li>Package images in kanisterio/kanister based on tagged versions.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installing Kanister</a><ul>
<li><a class="reference internal" href="#quickstart">Quickstart</a></li>
<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
<li><a class="reference internal" href="#building-and-deploying-from-source">Building and Deploying from Source</a><ul>
<li><a class="reference internal" href="#deploy-released-controller">Deploy Released Controller</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to kanister’s documentation!</a></li>
<li>Next: <a href="tutorial.html" title="next chapter">Tutorial</a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/install.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017, Kasten.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.2</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
<a href="_sources/install.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>