Merge pull request #234 from jputrino/v1

Merge updates for release v1.1 (Democrat)

.github/ISSUE_TEMPLATE.md

@@ -1,21 +1,31 @@
-* Title: A short but descriptive summary of the issue, whether it be a bug or enhancement.
-* Details: For bugs, use the below template.
-* **Do not include requests for development or report issues with code or products here. This repository contains documentation only.**>
+// Title: Provide a short but descriptive summary of the issue.
 
-## Version
-<Fill in the version you have installed, such as 1.0>
+// **Do not include requests for development or report issues with code or products here.** 
+This repository contains documentation only.
 
-## Description
-<Describe the bug in detail, steps taken to produce the issue, provide URL(s) to the page(s) in question>
 
+## Bugs
+Describe the bug in detail: 
 
-* Details: For enhancements, use the below template.
+- What doc are you reporting an issue with (provide URL)?
 
-## Description
-<Describe the enhancement request in detail>
+- What information is inaccurate? 
 
-## Environment
-<Describe the environment for which you would like new documentation. 
+- Is information missing?
 
+- Is a code sample incorrect?
 
 
+## Requests
+Provide details regarding what you would like to see added to our documentation:
+
+### Environment
+
+- [ ] Cloud Foundry
+- [ ] Kubernetes
+- [ ] OpenShift
+- [ ] Mesos/Marathon)
+
+### Use Case 
+(i.e., what are you trying to do that you can't find documentation for?)
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +1,13 @@
+@<reviewer_id>
 
-## Headline or summary  of the issue you are fixing
-`@` mention any reviewer(s) you would like to review your work.
-
-### Reference the `#<issueid>` 
-If your PR does not correspond to an existing Issue, create one before moving forward.
-
+#### What issues does this address?
 Fixes #<issueid>
+WIP #<issueid>
+...
 
-### Describe the problem / feature to which this change applies
-Problem:
+#### What's this change do?
 
-### Describe the change(s) made and why
-Analysis:
+#### Where should the reviewer start?
 
+#### Any background context?
 

docs/_static/config_examples/app_asp-enabled-custom.json

@@ -38,5 +38,5 @@
     "maximumOverCapacity": 1,
     "minimumHealthCapacity": 1
   },
-  "id": "demo_app-custom"
+  "id": "demo-app-custom"
 }

docs/_static/config_examples/app_asp-enabled-defaults.json

@@ -29,5 +29,5 @@
     "maximumOverCapacity": 1,
     "minimumHealthCapacity": 1
   },
-  "id": "demo_app"
+  "id": "demo-app"
 }

docs/_static/config_examples/f5-asp-k8s-example-daemonset.yaml

@@ -12,7 +12,7 @@ spec:
       hostNetwork: true
       containers:
         - name: f5-asp
-          image: "f5networks/asp:1.0.0"
+          image: "store/f5networks/asp:1.0.0"
           args:
             # the config file is loaded from the ConfigMap; it contains the
             # ASP global config
@@ -30,6 +30,10 @@ spec:
           - name: asp-config
             # the path the directory will be added to; do not change
             mountPath: /etc/configmap
+      # provide the name of the Secret containing the Docker login credentials
+      # REQUIRED TO PULL THE ASP IMAGE FROM DOCKER STORE
+      imagePullSecrets:
+        - name: <my-secret>
       volumes:
         - name: plugin-config
           hostPath:

docs/_static/config_examples/f5-k8s-bigip-ctlr_image-secret.yaml

@@ -13,9 +13,8 @@ spec:
     spec:
       containers:
         - name: k8s-bigip-ctlr
-          # replace the version as appropriate
-          # (e.g., f5networks/k8s-bigip-ctlr:1.1.0-beta.1)
-          image: "f5networks/k8s-bigip-ctlr:1.0.0"
+          # replace the version as needed
+          image: "f5networks/k8s-bigip-ctlr:1.1.0"
           env:
             - name: BIGIP_USERNAME
               valueFrom:
@@ -34,13 +33,12 @@ spec:
             "--bigip-url=10.190.24.171",
             "--bigip-partition=kubernetes",
             # To manage a single namespace, enter it below
-            # (required in v1.0)
+            # (required in v1.0.0)
             # To manage all namespaces, omit the `namespace` entry
-            # (default as of v1.1.0-beta.1 )
+            # (default as of v1.1.0)
             # To manage multiple namespaces, enter a separate flag for each
-            # below
-            # (as of v1.1.0-beta.1 )
+            # namespace below (as of v1.1.0)
             "--namespace=default",
-          ]
+            ]
       imagePullSecrets:
         - name: f5-docker-images

docs/_static/config_examples/f5-k8s-bigip-ctlr_openshift-sdn.yaml

@@ -13,15 +13,15 @@ spec:
     spec:
       containers:
         - name: k8s-bigip-ctlr
-          image: "f5networks/k8s-bigip-ctlr:1.0.0"
+          image: "f5networks/k8s-bigip-ctlr:1.1.0"
           env:
             - name: BIGIP_USERNAME
               valueFrom:
                 secretKeyRef:
                   name: bigip-login
                   key: username
             - name: BIGIP_PASSWORD
-                valueFrom:
+              valueFrom:
                 secretKeyRef:
                   name: bigip-login
                   key: password
@@ -32,15 +32,14 @@ spec:
             "--bigip-url=10.190.24.171",
             "--bigip-partition=kubernetes",
             # To manage a single namespace, enter it below
-            # (required in v1.0)
+            # (required in v1.0.0)
             # To manage all namespaces, omit the `namespace` entry
-            # (default as of v1.1.0-beta.1 )
+            # (default as of v1.1.0)
             # To manage multiple namespaces, enter a separate flag for each
-            # below
-            # (as of v1.1.0-beta.1 )
+            # namespace below (as of v1.1.0)
             "--namespace=default",
             "--pool-member-type=cluster",
             "--openshift-sdn-name=/Common/openshift_vxlan"
-          ]
+            ]
       imagePullSecrets:
         - name: f5-docker-images

docs/_static/config_examples/f5-k8s-ingress-fanout.yaml

@@ -0,0 +1,25 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: ing-fanout
+  namespace: default
+  annotations:
+    # IP address of a BIG-IP pool member
+    virtual-server.f5.com/ip: "1.2.3.4"
+    # BIG-IP partition
+    virtual-server.f5.com/partition: "k8s"
+    # Load balancing algorithm
+    virtual-server.f5.com/balance: "round-robin"
+spec:
+  rules:
+  - host: mysite.example.com
+    http:
+      paths:
+      - path: /mysite/app1
+        backend:
+          serviceName: myService1
+          servicePort: 80
+      - path: /mysite/app2
+        backend:
+          serviceName: myService2
+          servicePort: 80

docs/_static/config_examples/f5-k8s-ingress-health-monitor.yaml

@@ -0,0 +1,38 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: ing1
+  namespace: default
+  annotations:
+    virtual-server.f5.com/ip:        "1.2.3.4"
+    virtual-server.f5.com/partition: "k8s"
+    virtual-server.f5.com/health: |
+      [
+        {
+          "path":     "svc1.example.com/app1",
+          "send":     "HTTP GET /health/app1",
+          "interval": 5,
+          "timeout":  10
+        }, {
+          "path":     "svc2.example.com/app2",
+          "send":     "HTTP GET /health/app2",
+          "interval": 5,
+          "timeout":  5
+        }
+      ]
+spec:
+  rules:
+  - host: svc1.example.com
+    http:
+      paths:
+      - backend:
+          serviceName: svc1
+          servicePort: 8080
+        path: /app1
+  - host: svc2.example.com
+    http:
+      paths:
+      - backend:
+          serviceName: svc2
+          servicePort: 9090
+        path: /app2

docs/_static/config_examples/f5-k8s-ingress-tls.yaml

@@ -0,0 +1,24 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: ingressTLS
+  namespace: default
+  annotations:
+    # Provide an IP address for the BIG-IP pool you want to handle traffic.
+    virtual-server.f5.com/ip: "1.2.3.4"
+    # Specify the BIG-IP partition containing the virtual server.
+    virtual-server.f5.com/partition: "k8s"
+    # Allow/deny TLS connections
+    ingress.kubernetes.io/ssl-redirect: "true"
+    # Allow/deny HTTP connections
+    ingress.kubernetes.io/allow-http: "false"
+spec:
+  tls:
+    # Provide the BIG-IP SSL Profile you want to use.
+    # Follows the format "/partition/profile_name".
+    - secretName: /Common/clientssl
+  backend:
+    # The name of a single Kubernetes Service you want to expose to external
+    # traffic using TLS
+    serviceName: myService
+    servicePort: 443

docs/_static/config_examples/f5-k8s-ingress-virtual-hosting.yaml

@@ -0,0 +1,34 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+ name: ing-virtual-hosting
+ namespace: default
+ annotations:
+  # BIG-IP pool member IP address
+  virtual-server.f5.com/ip: "1.2.3.4"
+  # BIG-IP partition
+  virtual-server.f5.com/partition: "k8s"
+  # Load balancing algorithm
+  virtual-server.f5.com/balance: "round-robin"
+  # Specify the port you want to handle requests
+  virtual-server.f5.com/http-port: "80"
+spec:
+ rules:
+ # URL
+ - host: mysite.example.com
+   http:
+     # path to Service from URL
+     paths:
+       - path: /myApp1
+         backend:
+           serviceName: myService1
+           servicePort: 80
+ # URL
+ - host: yoursite.example.com
+   http:
+     # path to Service from URL
+     paths:
+       - path: /myApp2
+         backend:
+           serviceName: myService2
+           servicePort: 80

docs/_static/config_examples/f5-k8s-ingress-virtual-hosting_all.yaml

@@ -0,0 +1,28 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+ name: ing-virtual-hosting
+ namespace: default
+ annotations:
+  # BIG-IP pool member IP address
+  virtual-server.f5.com/ip: "1.2.3.4"
+  # BIG-IP partition
+  virtual-server.f5.com/partition: "k8s"
+  # Load balancing algorithm
+  virtual-server.f5.com/balance: "round-robin"
+  # Specify the port you want to handle requests
+  virtual-server.f5.com/http-port: "80"
+spec:
+ rules:
+ # omit host name (URL) to match all hosts
+ - http:
+     # Provide path to each Service you want to proxy
+     paths:
+     - path: /myApp1
+       backend:
+         serviceName: myService1
+         servicePort: 80
+     - path: /myApp2
+       backend:
+         serviceName: myService2
+         servicePort: 80

docs/_static/config_examples/f5-k8s-single-ingress.yaml

@@ -0,0 +1,15 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: ingress1
+  namespace: default
+  annotations:
+    # Provide an IP address from the external VLAN on your BIG-IP device
+    virtual-server.f5.com/ip: "10.190.25.70"
+    # Specify the BIG-IP partition containing the virtual server
+    virtual-server.f5.com/partition: "k8s"
+spec:
+  backend:
+    # The name of the Kubernetes Service you want to expose to external traffic
+    serviceName: myService
+    servicePort: 80

docs/_static/config_examples/f5-kctlr-openshift-clusterrole-binding.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: ClusterRoleBinding
+metadata:
+    name: bigip-ctlr-role
+userNames:
+- system:serviceaccount:default:bigip-ctlr
+subjects:
+- kind: ServiceAccount
+  namespace: default
+  name: bigip-ctlr
+roleRef:
+  name: system:bigip-ctlr

docs/_static/config_examples/f5-kctlr-openshift-clusterrole.yaml

@@ -0,0 +1,34 @@
+apiVersion: v1
+kind: ClusterRole
+metadata:
+  annotations:
+    authorization.openshift.io/system-only: "true"
+  name: system:bigip-ctlr
+rules:
+- apiGroups:
+  - ""
+  - "extensions"
+  resources:
+  - nodes
+  - services
+  - endpoints
+  - namespaces
+  - ingresses
+  verbs:
+  - get
+  - list
+  - watch
+- apiGroups:
+  - ""
+  - "extensions"
+  resources:
+  - configmaps
+  - events
+  - ingresses/status
+  verbs:
+  - get
+  - list
+  - watch
+  - update
+  - create
+  - patch