# Kubernetes plugin for drone.io [![Docker Repository on Quay](https://quay.io/repository/honestbee/drone-kubernetes/status "Docker Repository on Quay")](https://quay.io/repository/honestbee/drone-kubernetes) This plugin allows to update a Kubernetes deployment. ## Usage This pipeline will update the `my-deployment` deployment with the image tagged `DRONE_COMMIT_SHA:0:8` ```yaml pipeline: deploy: image: quay.io/honestbee/drone-kubernetes deployment: my-deployment repo: myorg/myrepo container: my-container tag: - mytag - latest ``` Deploying containers across several deployments, eg in a scheduler-worker setup. Make sure your container `name` in your manifest is the same for each pod. ```yaml pipeline: deploy: image: quay.io/honestbee/drone-kubernetes deployment: [server-deploy, worker-deploy] repo: myorg/myrepo container: my-container tag: - mytag - latest ``` Deploying multiple containers within the same deployment. ```yaml pipeline: deploy: image: quay.io/honestbee/drone-kubernetes deployment: my-deployment repo: myorg/myrepo container: [container1, container2] tag: - mytag - latest ``` **NOTE**: Combining multi container deployments across multiple deployments is not recommended This more complex example demonstrates how to deploy to several environments based on the branch, in a `app` namespace ```yaml pipeline: deploy-staging: image: quay.io/honestbee/drone-kubernetes kubernetes_server: ${KUBERNETES_SERVER_STAGING} kubernetes_cert: ${KUBERNETES_CERT_STAGING} kubernetes_token: ${KUBERNETES_TOKEN_STAGING} deployment: my-deployment repo: myorg/myrepo container: my-container namespace: app tag: - mytag - latest when: branch: [ staging ] deploy-prod: image: quay.io/honestbee/drone-kubernetes kubernetes_server: ${KUBERNETES_SERVER_PROD} kubernetes_token: ${KUBERNETES_TOKEN_PROD} # notice: no tls verification will be done, warning will is printed deployment: my-deployment repo: myorg/myrepo container: my-container namespace: app tag: - mytag - latest when: branch: [ master ] ``` **_Version 1.0_ example for using a .tags file** Use .tags file option: USE_TAGS_FILE
The default is FALSE unless the value of USE_TAGS_FILE is one of: y,Y,t,T,true,TRUE,yes,YES
The .tags file was used by the docker plugin when we created out container
A .tags file is a comma separated list of tags: 1.0.1,1.0,1,latest (see docker plugin docs)
We will use the first tag in the list, so create your file accordingly ```yaml - name: kubernetes-deploy image: quay.io/honestbee/drone-kubernetes settings: kubernetes_server: from_secret: KUBERNETES_SERVER kubernetes_token: from_secret: KUBERNETES_TOKEN deployment: my-deployment repo: myorg/myrepo container: my-container namespace: app use_tags_file: true ``` ## Required secrets ```bash drone secret add --image=honestbee/drone-kubernetes \ your-user/your-repo KUBERNETES_SERVER https://mykubernetesapiserver drone secret add --image=honestbee/drone-kubernetes \ your-user/your-repo KUBERNETES_CERT drone secret add --image=honestbee/drone-kubernetes \ your-user/your-repo KUBERNETES_TOKEN eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJrdWJ... ``` When using TLS Verification, ensure Server Certificate used by kubernetes API server is signed for SERVER url ( could be a reason for failures if using aliases of kubernetes cluster ) ## How to get token 1. After deployment inspect you pod for name of (k8s) secret with **token** and **ca.crt** ```bash kubectl describe po/[ your pod name ] | grep SecretName | grep token ``` (When you use **default service account**) 2. Get data from you (k8s) secret ```bash kubectl get secret [ your default secret name ] -o yaml | egrep 'ca.crt:|token:' ``` 3. Copy-paste contents of ca.crt into your drone's **KUBERNETES_CERT** secret 4. Decode base64 encoded token ```bash echo [ your k8s base64 encoded token ] | base64 -d && echo'' ``` 5. Copy-paste decoded token into your drone's **KUBERNETES_TOKEN** secret ### RBAC When using a version of kubernetes with RBAC (role-based access control) enabled, you will not be able to use the default service account, since it does not have access to update deployments. Instead, you will need to create a custom service account with the appropriate permissions (`Role` and `RoleBinding`, or `ClusterRole` and `ClusterRoleBinding` if you need access across namespaces using the same service account). As an example (for the `web` namespace): ```yaml apiVersion: v1 kind: ServiceAccount metadata: name: drone-deploy namespace: web --- apiVersion: rbac.authorization.k8s.io/v1beta1 kind: Role metadata: name: drone-deploy namespace: web rules: - apiGroups: ["extensions"] resources: ["deployments"] verbs: ["get","list","patch","update"] --- apiVersion: rbac.authorization.k8s.io/v1beta1 kind: RoleBinding metadata: name: drone-deploy namespace: web subjects: - kind: ServiceAccount name: drone-deploy namespace: web roleRef: kind: Role name: drone-deploy apiGroup: rbac.authorization.k8s.io ``` Once the service account is created, you can extract the `ca.cert` and `token` parameters as mentioned for the default service account above: ``` kubectl -n web get secrets # Substitute XXXXX below with the correct one from the above command kubectl -n web get secret/drone-deploy-token-XXXXX -o yaml | egrep 'ca.crt:|token:' ``` ## To do Replace the current kubectl bash script with a go implementation. ### Special thanks Inspired by [drone-helm](https://github.com/ipedrazas/drone-helm).