Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 2.26 KB

README.md

File metadata and controls

80 lines (51 loc) · 2.26 KB
Raw

Push-Deploy

Push-Deploy is a Python application which helps to securely and simply enable communication between external tools (GitHub Actions, Circle CI, etc…) and Kubernetes without exposing cluster credentials. Instead it exposes an API which accepts parameters.

Push-deploy is focused on projects which may not have semver in place where other tools like keel.sh and weave/flux would make more sense.

--

Disclaimer

This is pre-release software and is very limited. It will have bugs and lacks many features planned for later releases. The API may also change in ways which are not backwards compatible.

Configuration

  • PD_REGISTRY: Registry URI e.g. 258640715359.dkr.ecr.us-west-2.amazonaws.com
  • PD_SECRET_KEY: A very long (64+ Char) Alpha Numeric string
  • PD_USER: Username to authenticate with
  • PD_PASSWORD: Password to authenticate with

Usage

TOKEN=$(
    curl --header "Content-Type: application/json" \
    --request POST \
    -d '{"username":"${USERNAME}","password":"${PASSWORD}"}' \
    https://pushdeploy.domain.com/api/v1/auth
    )
curl --header "Authorization: Bearer ${TOKEN}" \
--request POST \
"https://pushdeploy.domain.com/api/v1/deployment?name=${NAME}&namespace=${NAMESPACE}&image_name=${IMAGE_NAME}&image_tag=${IMAGE_TAG}"

v1 Endpoints

  • /api/v1/cronjob -> v1beta1/cronjob

  • /api/v1/daemonset -> apps/v1/daemonset

  • /api/v1/deployment -> apps/v1/deployment

  • /api/v1/deploy -> apps/v1/deployments (Deprecated)

v1 Parameters

  • name=name of object
  • namespace=namespace of object
  • image_name=image name
  • image_tag=image tag

Contributing

Dependencies

Note: push-deploy uses config.load_incluster_config()and depends on the kubernetes api and thus cannot be meaningfuly run outside of a cluster.

  • Local Docker Daemon

  • Kubernetes Cluster (Remote or local e.g. Docker for Mac Kubernetes, Microk8s, Minikube, etc...)

  • Tilt

Resources

Usage

From root:

$ tilt up

Tilt will now continuously monitor for changes and rebuild and re-apply.