Abstract

This is the source code for the codefresh/cf-deploy-kubernetes container. This container is used to demonstrate a Kubernetes deployment using Codefresh.io

Assumptions

The deployment script makes the following assumptions about your application and 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 (i.e. deployment.yml) that describes the Kubernetes deployment parameters and configuration of your application.
3. The script processes deployment.yml as a simple template where all {{ ENV_VARIABLE }} are replaced with a value of $ENV_VARIABLE deployment.yml

Configuration

The following env variables control the deployment configuration:

1. KUBERNETES_DEPLOYMENT_TIMEOUT - How much to wait for a successful deployment before failing the build. Defaults to 120 (secs).
2. KUBECONTEXT - corresponds to the name of a cluster added to codefresh
3. KUBERNETES_NAMESPACE - The namespace to deploy
4. KUBECTL_ACTION - means an action for kubectl <action>. Valid values are apply|create|replace. Default is "apply"

Optional:

SERVER_VERSION - Manually set the Minor kubectl version. Supports 10-22.

Usage in codefresh.io

deployment.yml

---
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}}-{{CF_REVISION}}
          ports:
            - containerPort: 80
              name: http

codefresh.yml

---
version: '1.0'

steps:
  build:
    type: build
    dockerfile: Dockerfile
    image_name: myrepo/apisvc
    tag: '${{CF_BRANCH}}-{{CF_REVISION}}'
    
  push:
    type: push
    candidate: ${{build}}
    tag: '${{CF_BRANCH}}-{{CF_REVISION}}'

  deploy-to-kubernetes:
    image: codefresh/cf-deploy-kubernetes
    tag: latest
    working_directory: ${{clone}}
    commands:
      - /cf-deploy-kubernetes deployment.yml
    environment:
      - KUBECONTEXT=my-clusterg@my-staging
      - KUBERNETES_NAMESPACE=mynamespace