mirror of
https://github.com/danielgormly/drone-plugin-kube.git
synced 2026-06-14 22:11:16 +08:00
Daniel
39 lines
2.5 KiB
Markdown
39 lines
2.5 KiB
Markdown
# drone-plugin-kube
|
|
|
|
[](https://microbadger.com/images/danielgormly/drone-plugin-kube "Get your own version badge on microbadger.com")
|
|
|
|
A simple Drone plugin for updating Kubernetes deployments. Follows from [vallard/drone-kube](https://github.com/vallard/drone-kube) but with dependency management, up-to-date client-go, docs updated to Drone 1.0.0 syntax, examples and a different structure. Note this does not create a Kubernetes deployment, only updates existing deployments.
|
|
|
|
## Usage
|
|
|
|
Add the following [build step](https://docs.drone.io/user-guide/pipeline/steps/) to your drone pipeline definition. Currently this plugin only updates deployments, it does not create them. I can add this behaviour or I will accept pull requests to introduce it.
|
|
|
|
#### drone.yaml partial example
|
|
```yml
|
|
- name: Deploy app
|
|
image: danielgormly/drone-plugin-kube
|
|
settings:
|
|
template: path/to/deployment.yaml # within repo
|
|
ca: LS0tLS1... # BASE64 encoded string of the K8s CA cert
|
|
server: https://10.0.0.20:6443 # K8s master node address
|
|
token:
|
|
from_secret: kubernetes_token # Service account token to a service account that can manage deployments
|
|
namespace: custom # [Optional] Kubernetes namespace to use (defaults to `default`)
|
|
[example_custom_key]: string # [Optional, example] Any additional values you label here will be available for template interpolation (lower case key names only!)
|
|
```
|
|
|
|
## Deployment templates
|
|
|
|
Deployment config files are first interpreted by **aymerick/raymond** ([handlebarsjs](http://handlebarsjs.com/) equivalent). You can use all available raymond expressions and anything you put in settings will be made available in your deployment template e.g. `{{namespace}}`. See [example/deployment.template.yaml](/example/deployment.template.yaml) for a complete example.
|
|
|
|
#### Adding a service account to Kubernetes that can manage deployments
|
|
See [example/Role.yaml](example/Role.yaml), [example/ServiceAccount.yaml](example/ServiceAccount.yaml), [example/RoleBinding.yaml](example/RoleBinding.yaml).
|
|
|
|
## Development notes
|
|
- No tagged releases or support for older go libraries yet, happy to take feedback in Github issues or PRs.
|
|
- Kubernetes client not yet supported by dep, so we are using
|
|
[`brew install glide`](https://github.com/Masterminds/glide).
|
|
- Update dependencies with brew `glide update --strip-vendor`
|
|
- [Creating a Drone plugin in Go](https://docs.drone.io/plugins/examples/golang/)
|
|
- Testing with minikube (OSX: `brew cask install minikube`)
|