https://github.com/deis/workflow-manager-api

Deis Workflow Manager API
https://github.com/deis/workflow-manager-api

deis-workflow k8s kubernetes metadata versioning

Last synced: 9 days ago
JSON representation

Deis Workflow Manager API

• Host: GitHub
• URL: https://github.com/deis/workflow-manager-api
• Owner: deis
• License: mit
• Created: 2016-01-25T23:11:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-09T16:59:10.000Z (over 6 years ago)
• Last Synced: 2024-06-20T11:16:17.202Z (6 months ago)
• Topics: deis-workflow, k8s, kubernetes, metadata, versioning
• Language: Go
• Homepage:
• Size: 313 KB
• Stars: 5
• Watchers: 12
• Forks: 0
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

|![](https://upload.wikimedia.org/wikipedia/commons/thumb/1/17/Warning.svg/156px-Warning.svg.png) | Deis Workflow is no longer maintained.
Please [read the announcement](https://deis.com/blog/2017/deis-workflow-final-release/) for more detail. |

|---:|---|

| 09/07/2017 | Deis Workflow [v2.18][] final release before entering maintenance mode |

| 03/01/2018 | End of Workflow maintenance: critical patches no longer merged |

| | [Hephy](https://github.com/teamhephy/workflow) is a fork of Workflow that is actively developed and accepts code contributions. |

# Deis Workflow Manager Service API

The Workflow Manager Service API is responsible for interfacing with Deis Workflow data. It is a golang https implementation that speaks JSON. The API is the source of authority for the following:

* metadata about unique Deis clusters that have checked in: which components are installed at the time of check-in, and which versions

* released version history for each Deis cluster component

Additionally, the API is the official interface for accepting Workflow Manager data, e.g.:

* Deis cluster component version CRUD operations

  * i.e., centrally store latest stable version information for all Deis cluster components

* Deis unique cluster anonymous registration

  * i.e., receive Deis Workflow Manager client usage statistics

# Usage

To download dependencies:

```

$ make bootstrap

```

To test:

```

$ make test

```

_Note_: if you prefer to run tests with `go test`, you'll need

[`glide`](https://github.com/Masterminds/glide) on your `PATH`. Once you have it,

run `go test -tags testonly $(glide nv)` to run tests.

To build:

```

$ IMAGE_PREFIX=$MY_DOCKERHUB_ACCOUNT make build docker-build docker-push

```

(All of the above operations assume a local Docker environment.)

# Status

A working, minimal API is currently live at https://versions.deis.com.