Deploy GitHub Pages
This commit is contained in:
Travis Bot
parent
b479f09b97
commit
a03213218f
58 changed files with 2308 additions and 376 deletions
|
|
@ -356,6 +356,18 @@
|
|||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../deploy/baremetal/" title="Bare-metal considerations" class="md-nav__link">
|
||||
Bare-metal considerations
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../deploy/rbac/" title="Role Based Access Control (RBAC)" class="md-nav__link">
|
||||
Role Based Access Control (RBAC)
|
||||
|
|
@ -1251,7 +1263,6 @@ git clone https://github.com/$YOUR_GITHUB_USERNAME/ingress-nginx.git
|
|||
cd ingress-nginx
|
||||
</pre></div>
|
||||
|
||||
|
||||
<h3 id="initial-developer-environment-build">Initial developer environment build<a class="headerlink" href="#initial-developer-environment-build" title="Permanent link">¶</a></h3>
|
||||
<blockquote>
|
||||
<p><strong>Prequisites</strong>: Minikube must be installed.
|
||||
|
|
@ -1261,19 +1272,14 @@ See <a href="https://github.com/kubernetes/minikube/releases">releases</a> for i
|
|||
<div class="codehilite"><pre><span></span>$ make dev-env
|
||||
</pre></div>
|
||||
|
||||
|
||||
<h3 id="updating-the-deployment">Updating the deployment<a class="headerlink" href="#updating-the-deployment" title="Permanent link">¶</a></h3>
|
||||
<p>The nginx controller container image can be rebuilt using:</p>
|
||||
<p>The nginx controller container image can be rebuilt using:
|
||||
<div class="codehilite"><pre><span></span>$ <span class="nv">ARCH</span><span class="o">=</span>amd64 <span class="nv">TAG</span><span class="o">=</span>dev <span class="nv">REGISTRY</span><span class="o">=</span><span class="nv">$USER</span>/ingress-controller make build container
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>The image will only be used by pods created after the rebuild. To delete old pods which will cause new ones to spin up:</p>
|
||||
</pre></div></p>
|
||||
<p>The image will only be used by pods created after the rebuild. To delete old pods which will cause new ones to spin up:
|
||||
<div class="codehilite"><pre><span></span>$ kubectl get pods -n ingress-nginx
|
||||
$ kubectl delete pod -n ingress-nginx nginx-ingress-controller-<unique-pod-id>
|
||||
</pre></div>
|
||||
|
||||
|
||||
</pre></div></p>
|
||||
<h2 id="dependencies">Dependencies<a class="headerlink" href="#dependencies" title="Permanent link">¶</a></h2>
|
||||
<p>The build uses dependencies in the <code class="codehilite">vendor</code> directory, which
|
||||
must be installed before building a binary/image. Occasionally, you
|
||||
|
|
@ -1290,12 +1296,10 @@ might need to update the dependencies.</p>
|
|||
<span class="go"> platform : linux/amd64</span>
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>If you have an older version of <code class="codehilite">dep</code>, you can update it as follows:</p>
|
||||
<div class="codehilite"><pre><span></span><span class="gp">$</span> go get -u github.com/golang/dep
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>This will automatically save the dependencies to the <code class="codehilite">vendor/</code> directory.</p>
|
||||
<div class="codehilite"><pre><span></span><span class="gp">$</span> <span class="nb">cd</span> <span class="nv">$GOPATH</span>/src/k8s.io/ingress-nginx
|
||||
<span class="gp">$</span> dep ensure
|
||||
|
|
@ -1303,7 +1307,6 @@ might need to update the dependencies.</p>
|
|||
<span class="gp">$</span> dep prune
|
||||
</pre></div>
|
||||
|
||||
|
||||
<h2 id="building">Building<a class="headerlink" href="#building" title="Permanent link">¶</a></h2>
|
||||
<p>All ingress controllers are built through a Makefile. Depending on your
|
||||
requirements you can build a raw server binary, a local container image,
|
||||
|
|
@ -1316,25 +1319,20 @@ or push an image to a remote repository.</p>
|
|||
<span class="gp">$</span> <span class="nb">export</span> <span class="nv">REGISTRY</span><span class="o">=</span><your-docker-registry>
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>To find the registry simply run: <code class="codehilite">docker system info | grep Registry</code></p>
|
||||
<h3 id="nginx-controller">Nginx Controller<a class="headerlink" href="#nginx-controller" title="Permanent link">¶</a></h3>
|
||||
<p>Build a raw server binary</p>
|
||||
<p>Build a raw server binary
|
||||
<div class="codehilite"><pre><span></span><span class="gp">$</span> make build
|
||||
</pre></div>
|
||||
|
||||
|
||||
</pre></div></p>
|
||||
<p><a href="https://github.com/kubernetes/ingress-nginx/issues/387">TODO</a>: add more specific instructions needed for raw server binary.</p>
|
||||
<p>Build a local container image</p>
|
||||
<div class="codehilite"><pre><span></span><span class="gp">$</span> <span class="nv">TAG</span><span class="o">=</span><tag> <span class="nv">REGISTRY</span><span class="o">=</span><span class="nv">$USER</span>/ingress-controller make docker-build
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>Push the container image to a remote repository</p>
|
||||
<div class="codehilite"><pre><span></span><span class="gp">$</span> <span class="nv">TAG</span><span class="o">=</span><tag> <span class="nv">REGISTRY</span><span class="o">=</span><span class="nv">$USER</span>/ingress-controller make docker-push
|
||||
</pre></div>
|
||||
|
||||
|
||||
<h2 id="deploying">Deploying<a class="headerlink" href="#deploying" title="Permanent link">¶</a></h2>
|
||||
<p>There are several ways to deploy the ingress controller onto a cluster.
|
||||
Please check the <a href="../deploy">deployment guide</a></p>
|
||||
|
|
@ -1344,31 +1342,26 @@ Please check the <a href="../deploy">deployment guide</a></p>
|
|||
<span class="gp">$</span> make <span class="nb">test</span>
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>If you have access to a Kubernetes cluster, you can also run e2e tests using ginkgo.</p>
|
||||
<div class="codehilite"><pre><span></span><span class="gp">$</span> <span class="nb">cd</span> <span class="nv">$GOPATH</span>/src/k8s.io/ingress-nginx
|
||||
<span class="gp">$</span> make e2e-test
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>To run unit-tests for lua code locally, run:</p>
|
||||
<div class="codehilite"><pre><span></span><span class="gp">$</span> <span class="nb">cd</span> <span class="nv">$GOPATH</span>/src/k8s.io/ingress-nginx
|
||||
<span class="gp">$</span> ./rootfs/etc/nginx/lua/test/up.sh
|
||||
<span class="gp">$</span> make lua-test
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>Lua tests are located in <code class="codehilite">$GOPATH/src/k8s.io/ingress-nginx/rootfs/etc/nginx/lua/test</code>. When creating a new test file it must follow the naming convention <code class="codehilite"><mytest>_test.lua</code> or it will be ignored. </p>
|
||||
<h2 id="releasing">Releasing<a class="headerlink" href="#releasing" title="Permanent link">¶</a></h2>
|
||||
<p>All Makefiles will produce a release binary, as shown above. To publish this
|
||||
to a wider Kubernetes user base, push the image to a container registry, like
|
||||
<a href="https://cloud.google.com/container-registry/">gcr.io</a>. All release images are hosted under <code class="codehilite">gcr.io/google_containers</code> and
|
||||
tagged according to a <a href="http://semver.org/">semver</a> scheme.</p>
|
||||
<p>An example release might look like:</p>
|
||||
<p>An example release might look like:
|
||||
<div class="codehilite"><pre><span></span>$ make release
|
||||
</pre></div>
|
||||
|
||||
|
||||
</pre></div></p>
|
||||
<p>Please follow these guidelines to cut a release:</p>
|
||||
<ul>
|
||||
<li>Update the <a href="https://help.github.com/articles/creating-releases/">release</a>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue