Git Product home page Git Product logo

disrupt's Introduction

Disrupt (Docker Swarm Service Updater)

GitHub release GitHub GitHub contributors

Build Status Docker Pulls Discord Widget

Usage

version: '3'

services:
  whoami:
    image: jwilder/whoami
    ports:
      - 8080:8000

  disrupt:
    image: blamebutton/disrupt
    volumes:
      # Mount the Docker socket, this is required for interacting with the Docker API.
      - /var/run/docker.sock:/var/run/docker.sock
    deploy:
      placement:
        constraints:
          # Disrupt needs permission to update services, only managers are allowed to do that.
          - node.role == manager

For more examples, check out the examples folder

Note: Docker Swarm does not support running locally built images, so neither does Disrupt.

Configuration

Configuration of Disrupt is done through environment variables. This is done to make the deployment of Disrupt environment-agnostic.

Below is a list of environment variables available to be configured.

Name Type Options
UPDATE_DELAY Integer default = 300
NOTIFICATION_URL String Any Apprise compatible URL

Notifications

Disrupt uses the Apprise notification library for Python. Check out their documentation for more advanced usages.

Here is a small list of notification providers that Apprise supports:

  • Slack
  • Discord
  • Telegram
  • PushBullet
  • Dbus
  • Mail
  • Custom notifications to a given URL in JSON or XML format

Contributing

Feel free to make a feature request or if you have Python experience; pull requests are welcome too!

Troubleshooting

Could not connect to Docker Engine

Did you mount the Docker socket to the container? Check out the example if you want to know how.

In the special case that you are accessing Docker over TCP, you should place Disrupt in the same network as your TCP socket. Using a Docker socket proxy (like docker-socket-proxy, or sockguard) is recommended for enhanced security in this case. You could then configure the proxy to only allow GET requests for service info, for example. That way, if the Disrupt container gets compromised it can't do any harm to the cluster in the form of modifications/destructive instructions.

Support

If you're having trouble getting Disrupt to work, we have a Discord for support and questions.

disrupt's People

Contributors

bram-pkg avatar raqbit avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.