fluxy

Flux, reimagined.

Workflows

All workflows start with the assumption that I've got a helloworld service running on my platform, and I've pushed a new version of the helloworld image to my image repository, which I now want to release.

Explicit

Which services are running on my platform?

$ fluxctl service list
SERVICE     IP         PORTS        IMAGE
helloworld  10.0.0.99  80/TCP→80    quay.io/weaveworks/helloworld:master-a000001
kubernetes  10.0.0.1   443/TCP→443  (no selector, no RC)

Which images are available for the helloworld service?

$ fluxctl service images --service=helloworld
CONTAINER   IMAGE                          CREATED
helloworld  quay.io/weaveworks/helloworld
            |   master-9a16ff945b9e        2016-07-20 13:19:29.801863476 +0000 UTC
            |   master-b31c617a0fe3        2016-07-20 13:19:29.801863476 +0000 UTC
            |   master-a000002             2016-07-12 17:17:34.599751439 +0000 UTC
            '-> master-a000001             2016-07-12 17:16:17.770847438 +0000 UTC

Update my resource file to use a new image.

$ fluxctl config update --file helloworld-rc.yaml \
    --image=quay.io/weaveworks/helloworld:master-9a16ff945b9e \
    --output=helloworld-rc.yaml

Release a new version of the helloworld service.

$ fluxctl service release --service=helloworld --file=helloworld-rc.yaml
Starting release of helloworld with an update period of 5s... success
Took 37.74884288s

Don't forget to commit and push the updated helloworld-rc.yaml!

Interactive

(Note: not yet implemented.)

$ # I'd like to release the latest version of helloworld.
$ fluxctl service release --service=helloworld --interactive
Querying platform for "helloworld" service...

 SERVICE     IMAGE                                  STATUS
 helloworld  quay.io/weaveworks/helloworld:a000001  At rest

helloworld is at rest, OK to continue.
Looking for a resource file matching "quay.io/weaveworks/helloworld"... found 2.

     FILE                         IMAGE
  1) k8s/dev/helloworld-rc.yaml   quay.io/weaveworks/helloworld:b11111f
  2) k8s/prod/helloworld-rc.yaml  quay.io/weaveworks/helloworld:a000001

Which file(s) to update? 1
OK, will update k8s/dev/helloworld-rc.yaml.
Querying registry for "quay.io/weaveworks/helloworld" images...

    IMAGE                                  CREATED AT               RUNNING
 1) quay.io/weaveworks/helloworld:a000001  2016-07-10 10:09:53 UTC  •
 2) quay.io/weaveworks/helloworld:de9f3b2  2016-07-11 16:15:01 UTC

Which image to release? 2
OK, releasing image "quay.io/weaveworks/helloworld:de9f3b2" to service "helloworld".
Updating file 1 of 1: k8s/dev/helloworld-rc.yaml...

  -     image: quay.io/weaveworks/helloworld:b11111f
  +     image: quay.io/weaveworks/helloworld:de9f3b2

Does this look right? yes
OK, writing 1 file(s) to disk.
Perform the release? yes
Releasing with an update-period of 5s......... complete.
Be sure to commit and push your changes!

Automated

(Note: not yet implemented.)

fluxd continuously polls the platform for services that have been configured to be continuously deployed. For each, it regularly polls the corresponding image repository to find new images. Whenever it finds a new image, it automates a release as follows.

1. Ensure the service is "at rest", and nobody else is deploying.
2. Check out the config repo, containing the resource definition files.
3. Find the relevant file, and update it with the new image name.
   • Optional: sanity check that the file represents the current platform state.
4. Perform a release.
5. Commit and push the updated resource definition file.

Installing

For the minute you will have to build or use the container image quay.io/weaveworks/fluxy.

Developing

Build

Ensure the repository is checked out into $GOPATH/src/github.com/weaveworks/fluxy. Then, from the root,

$ gvt restore
# .. time passes ..
$ make

This makes Docker images, and installs binaries to $GOPATH/bin.

Test

$ go test ./...

Dependency management

We use gvt to manage vendored dependencies. Note that we do not check in the vendor folder.

To get all the dependencies put in the vendor/ folder, use

$ go get -u github.com/FiloSottile/gvt # install gvt if you don't have it
$ gvt restore

To add dependencies, use

$ gvt fetch <dependency>

gvt does not discover dependencies for you, but it will add them recursively; so, it should be sufficient to just add packages you import.

Contribution

Flux follows a typical PR workflow. All contributions should be made as PRs that satisfy the guidelines below.

Guidelines

• All code must abide Go Code Review Comments
• Names should abide What's in a name
• Code must build on both Linux and Darwin, via plain go build
• Code should have appropriate test coverage, invoked via plain go test

In addition, several mechanical checks are enforced. See the lint script for details.