updated readme

Author: kosta-codefresh

README.md

@@ -14,9 +14,10 @@ Kubernetes configuration:
 1. The application is deployed using the Kubernetes deployment API (versus the
 the replication controller directly). For more information read
 http://kubernetes.io/docs/user-guide/deployments/
-2. The tested codebase has a yaml file that describes the Kubernetes deployment
+2. The tested codebase has a yaml file (i.e. deployment.yml) that describes the Kubernetes deployment
 parameters and configuration of your application.
-3. At the moment, only the basic username/pass authentication is supported.
+3. The script processes deployment.yml as a simple template where all `{{ ENV_VARIABLE }}` are replaced with a value of $ENV_VARIABLE deployment.yml
+4. At the moment, only the basic username/pass authentication is supported.
 
 # Configuration
 
@@ -28,9 +29,59 @@ before failing the build. Defaults to 120 (secs).
 3. KUBERNETES_PASSWORD - The password for the Kubernetes cluster. Mandatory.
 4. KUBERNETES_SERVER - The server (HTTPS endpoint) of the Kubernetes cluster's
 API. Mandatory.
-5. DOCKER_IMAGE_TAG - The docker tag to use for the deployment. Requires the
-`deployment.yml` file to specify a `$DOCKER_IMAGE_TAG` variable so it can be
-substitutes at deployment time.
-6. FORCE_RE_CREATE_RESOURCE - Will force re-creation of the deployment
 
+# Usage in codefresh
 
+### deployment.yml
+
+```yaml
+---
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+  name: api-svc
+spec:
+  replicas: 1
+  template:
+    metadata:
+      annotations:
+        revision: "{{CF_REVISION}}"
+      labels:
+        app: api-svc
+    spec:
+      containers:
+        - name: apisvc
+          image: myrepo/apisvc:{{CF_BRANCH}}
+          ports:
+            - containerPort: 80
+              name: http
+
+```
+
+### codefresh.yml
+```yaml
+---
+version: '1.0'
+
+steps:
+  build:
+    type: build
+    working-directory: ${{initial-clone}}
+    image-name: $docker-image
+    tag: ${{CF_BRANCH}}
+  push:
+    type: push
+    candidate: ${{build}}
+    tag: ${{CF_BRANCH}}
+
+  deploy-to-kubernetes:
+    image: codefresh/cf-deploy-kubernetes
+    tag: latest
+    working-directory: ${{initial-clone}}
+    commands:
+      - /cf-deploy-kubernetes deployment.yml
+    environment:
+      - KUBERNETES_USER=${{KUBERNETES_USER}}
+      - KUBERNETES_PASSWORD=${{KUBERNETES_PASSWORD}}
+      - KUBERNETES_SERVER=${{KUBERNETES_SERVER}}
+```