https://github.com/guidesmiths/kube-deploy

https://github.com/guidesmiths/kube-deploy

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/guidesmiths/kube-deploy
• Owner: guidesmiths
• Created: 2016-08-09T09:50:55.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-29T13:38:37.000Z (about 8 years ago)
• Last Synced: 2024-12-18T09:45:22.995Z (29 days ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 3
• Watchers: 13
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://img.shields.io/travis/guidesmiths/kube-deploy/master.svg)](https://travis-ci.org/guidesmiths/kube-deploy)

[![Code Style](https://img.shields.io/badge/code%20style-imperative-brightgreen.svg)](https://github.com/guidesmiths/eslint-config-imperative)

# kube-deploy

It's meant to be used in continuous integration pipelines in order to update a kubernetes deployment with the most recent docker image. It sends a PATCH request to the kubernetes apiserver in order to do so.

Currently, only [deployments](http://kubernetes.io/docs/user-guide/deployments/) are supported and other types of kubernetes resources will be added when and if they are requested.

## Usage

```

  Usage: kube-deploy [options]   

  Options:

    -h, --help               output usage information

    -u --url         kubernetes API URL

    -n --namespace   optional: kubernetes namespace [default: default]

    -k --insecure-https      optional: ingore SSL certificate validity

```

## Example

It's designed to be used as a script in other packages:

```

"scripts": {

  ...

  "deploy": "kube-deploy -u https://kubernetes.example.com deployment/my-deployment my-container-name docker/image:tag",

  ...

}

```

So that it makes it easy to just say `npm run kube-deploy` in the CI pipeline.

## Authentication

In order to authenticate against the kubernetes deployment, `kube-deploy` will use the access token from the environment variable `KUBERNETES_TOKEN`.

## Docker

You also can run kube-deploy with docker

```

docker run guidesmiths/kube-deploy [options]   

```