sloppy.io offers various solutions on different levels for integration into your DevOps toolchain: From providing you with a CLI and API that you can use in your build, to simply using webhooks and, finally, your own complete DevOps toolchain with sloppy.io Agile.
How it works
Our API lets you use all our features in your scripts, so that you can automatically create, maintain, and monitor apps from your environment. You can find our API docs here. Alternatively, you can also use our CLI feature.
We support triggering a deployment via a special API method. When called, the application in question is deployed. Using these so-called webhooks, you can automatically deploy applications by pushing images to your registry of choice.
In addition to letting you integrate sloppy.io into your own toolchain, we can also provide you with your own one. Based on GitLab CE and our Docker hosting platform, you can compose, deploy, and immediately test your staged build under a ssl-protected URL. Fore more information, click here.
You can find setup information for the API and sloppy.io Agile under the respective links posted above.
Whenever you push an image to a Docker registry like Docker Hub, that registry can notify other services. Technically, this is a HTTP POST request to a specific URL.
Get webhooks URL
Since existing webhooks have no support for authentication, we provide a special URL for you. To find it open the Dashboard of the sloppy.io Web UI, select the project and go to the settings of the app. Heading forward to the “Advanced” tab, you can copy the webhook URL.
Example of a webhooks URL provided by the Web UI
Setup for different registries
Any registry using POST operations with a JSON Payload should work. We’ve tested Docker Hub and quay.io - if you're using any of these registries, you can see the detailed instructions for webhooks setup here:
- Set up Webhooks on Docker Hub
- Set up Webhooks on quay.io
Using tags for webhooks
If you haven’t specified an image tag in your application, sloppy.io automatically defaults to the
latest tag. Both Docker Hub and quay.io provide the name of tags pushed to the repository.
In theses cases, sloppy.io only deploys if the pushed tag matches the configured tag. In other words, you’re save to maintain images with multiple tags on these platforms.
If you are using other registries, all pushes trigger a deployment. The deployment will always use the image with the tag configured in the sloppy.io application.
Integration into other registries
If you’re working with a registry that has its own payload format, including tags, let us know and we can work on the proper integration.
Tags with semver or other versioning schemes
We currently only deploy when using
latest or updating an existing tag. When you push new tags for each change (using semver, like 1.4.2; or maybe git commit hashes like a1b2c3d4), you’d currently have to update the image tag each time (using our API).
We plan to expand our webhook feature and are interested in your usecases and feedback!
- API: Basic, Professional, Business
- Webhooks: Professional, Business
- sloppy.io Agile: Additional Resource