Expand developer docs

examples/deployment/nginx/README.md

@@ -0,0 +1,49 @@
+# Deploying an Nginx Ingress controller
+
+This example aims to demonstrate the deployment of an nginx ingress controller.
+
+## Default Backend
+
+The default backend is a Service capable of handling all url paths and hosts the
+nginx controller doesn't understand. This most basic implementation just returns
+a 404 page:
+```console
+$ kubectl create -f default-backend.yaml
+replicationcontroller "default-http-backend" created
+
+$ kubectl expose rc default-http-backend --port=80 --target-port=8080 --name=default-http-backend
+service "default-http-backend" exposed
+
+$ kubectl get po
+NAME                             READY     STATUS              RESTARTS   AGE
+default-http-backend-ppqdj       1/1       Running             0          1m
+```
+
+## Controller
+
+You can deploy the controller as follows:
+
+```console
+$ kubectl create -f rc.yaml
+replicationcontroller "nginx-ingress-controller" created
+
+$ kubectl get po
+NAME                             READY     STATUS              RESTARTS   AGE
+default-http-backend-ppqdj       1/1       Running             0          1m
+nginx-ingress-controller-vbgf9   0/1       ContainerCreating   0          2s
+```
+
+Note the default settings of this controller:
+* serves a `/healthz` url on port 10254, as both a liveness and readiness probe
+* takes a `--default-backend-service` arg pointing to a Service, created above
+
+## Running on a cloud provider
+
+If you're running this ingress controller on a cloudprovider, you should assume
+the provider also has a native Ingress controller and set the annotation
+`kubernetes.io/ingress.class: nginx` in all Ingresses meant for this controller.
+You might also need to open a firewall-rule for ports 80/443 of the nodes the
+controller is running on.
+
+
+

examples/deployment/nginx/default-backend.yaml

@@ -0,0 +1,36 @@
+apiVersion: v1
+kind: ReplicationController
+metadata:
+  name: default-http-backend
+spec:
+  replicas: 1
+  selector:
+    app: default-http-backend
+  template:
+    metadata:
+      labels:
+        app: default-http-backend
+    spec:
+      terminationGracePeriodSeconds: 60
+      containers:
+      - name: default-http-backend
+        # Any image is permissable as long as:
+        # 1. It serves a 404 page at /
+        # 2. It serves 200 on a /healthz endpoint
+        image: gcr.io/google_containers/defaultbackend:1.0
+        livenessProbe:
+          httpGet:
+            path: /healthz
+            port: 8080
+            scheme: HTTP
+          initialDelaySeconds: 30
+          timeoutSeconds: 5
+        ports:
+        - containerPort: 8080
+        resources:
+          limits:
+            cpu: 10m
+            memory: 20Mi
+          requests:
+            cpu: 10m
+            memory: 20Mi

examples/deployment/nginx/rc.yaml

@@ -0,0 +1,51 @@
+apiVersion: v1
+kind: ReplicationController
+metadata:
+  name: nginx-ingress-controller
+  labels:
+    k8s-app: nginx-ingress-lb
+spec:
+  replicas: 1
+  selector:
+    k8s-app: nginx-ingress-lb
+  template:
+    metadata:
+      labels:
+        k8s-app: nginx-ingress-lb
+        name: nginx-ingress-lb
+    spec:
+      terminationGracePeriodSeconds: 60
+      containers:
+      - image: gcr.io/google_containers/nginx-ingress-controller:0.8.3
+        name: nginx-ingress-lb
+        imagePullPolicy: Always
+        readinessProbe:
+          httpGet:
+            path: /healthz
+            port: 10254
+            scheme: HTTP
+        livenessProbe:
+          httpGet:
+            path: /healthz
+            port: 10254
+            scheme: HTTP
+          initialDelaySeconds: 10
+          timeoutSeconds: 1
+        # use downward API
+        env:
+          - name: POD_NAME
+            valueFrom:
+              fieldRef:
+                fieldPath: metadata.name
+          - name: POD_NAMESPACE
+            valueFrom:
+              fieldRef:
+                fieldPath: metadata.namespace
+        ports:
+        - containerPort: 80
+          hostPort: 80
+        - containerPort: 443
+          hostPort: 443
+        args:
+        - /nginx-ingress-controller
+        - --default-backend-service=$(POD_NAMESPACE)/default-http-backend