drone-kubernetes/README.md

127 lines
4.1 KiB
Markdown
Raw Normal View History

# 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)
2017-01-13 10:07:48 +00:00
This plugin allows to update a Kubernetes deployment.
## Usage
2017-05-25 05:54:49 +00:00
This pipeline will update the `my-deployment` deployment with the image tagged `DRONE_COMMIT_SHA:0:8`
2017-01-13 10:07:48 +00:00
2017-06-28 03:55:53 +00:00
```yaml
2017-01-13 10:07:48 +00:00
pipeline:
deploy:
image: quay.io/honestbee/drone-kubernetes
deployment: my-deployment
repo: myorg/myrepo
2017-01-17 10:12:14 +00:00
container: my-container
2017-06-28 03:55:53 +00:00
tag:
- mytag
- latest
```
2017-01-13 10:07:48 +00:00
2017-03-07 10:06:06 +00:00
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.
2017-02-08 05:45:22 +00:00
2017-06-28 03:55:53 +00:00
```yaml
2017-02-08 05:45:22 +00:00
pipeline:
deploy:
image: quay.io/honestbee/drone-kubernetes
deployment: [server-deploy, worker-deploy]
repo: myorg/myrepo
container: my-container
2017-06-28 03:55:53 +00:00
tag:
- mytag
- latest
```
2017-02-08 05:45:22 +00:00
2017-03-07 10:06:06 +00:00
Deploying multiple containers within the same deployment.
2017-06-28 03:55:53 +00:00
```yaml
2017-03-07 10:06:06 +00:00
pipeline:
deploy:
image: quay.io/honestbee/drone-kubernetes
deployment: my-deployment
repo: myorg/myrepo
container: [container1, container2]
2017-06-28 03:55:53 +00:00
tag:
- mytag
- latest
```
2017-03-07 10:06:06 +00:00
**NOTE**: Combining multi container deployments across multiple deployments is not recommended
2017-02-07 06:09:44 +00:00
This more complex example demonstrates how to deploy to several environments based on the branch, in a `app` namespace
2017-06-28 03:55:53 +00:00
```yaml
2017-02-07 06:09:44 +00:00
pipeline:
deploy-staging:
image: quay.io/honestbee/drone-kubernetes
kubernetes_server: ${KUBERNETES_SERVER_STAGING}
2017-02-20 10:20:47 +00:00
kubernetes_cert: ${KUBERNETES_CERT_STAGING}
2017-02-07 06:09:44 +00:00
kubernetes_token: ${KUBERNETES_TOKEN_STAGING}
deployment: my-deployment
repo: myorg/myrepo
container: my-container
namespace: app
2017-06-28 03:55:53 +00:00
tag:
- mytag
- latest
2017-02-07 06:09:44 +00:00
when:
branch: [ staging ]
deploy-prod:
image: quay.io/honestbee/drone-kubernetes
kubernetes_server: ${KUBERNETES_SERVER_PROD}
kubernetes_token: ${KUBERNETES_TOKEN_PROD}
2017-02-20 10:20:47 +00:00
# notice: no tls verification will be done, warning will is printed
2017-02-07 06:09:44 +00:00
deployment: my-deployment
repo: myorg/myrepo
container: my-container
namespace: app
2017-06-28 03:55:53 +00:00
tag:
- mytag
- latest
2017-02-07 06:09:44 +00:00
when:
branch: [ master ]
2017-06-28 03:55:53 +00:00
```
2017-02-07 06:09:44 +00:00
2017-01-13 10:07:48 +00:00
## Required secrets
2017-06-28 03:55:53 +00:00
```bash
2017-01-13 10:07:48 +00:00
drone secret add --image=honestbee/drone-kubernetes \
your-user/your-repo KUBERNETES_SERVER https://mykubernetesapiserver
2017-02-20 10:20:47 +00:00
drone secret add --image=honestbee/drone-kubernetes \
your-user/your-repo KUBERNETES_CERT <base64 encoded CA.crt>
2017-01-13 10:07:48 +00:00
drone secret add --image=honestbee/drone-kubernetes \
your-user/your-repo KUBERNETES_TOKEN eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJrdWJ...
2017-06-28 03:55:53 +00:00
```
2017-01-13 10:07:48 +00:00
2017-02-20 10:20:47 +00:00
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
2017-01-13 10:07:48 +00:00
## To do
Replace the current kubectl bash script with a go implementation.
### Special thanks
Inspired by [drone-helm](https://github.com/ipedrazas/drone-helm).