2019-02-01 02:58:07 -06:00
# cloud.docker.com Configuration
The automatic build is configured in cloud.docker.com.
The following build configuration is expected:
```yaml
Source Repository: github.com/netbox-community/netbox-docker
Build Location: Build on Docker Hub's infrastructure
Autotest: Internal and External Pull Requests
Repository Links: Enable for Base Image
Build Rules:
- Source Type: Branch
Source: master
2019-10-10 05:42:10 -05:00
Docker Tag: branches
2019-02-01 02:58:07 -06:00
Dockerfile location: Dockerfile
2019-10-14 16:16:51 -05:00
Build Context: /
Autobuild: on
Build Caching: on
2019-02-01 02:58:07 -06:00
- Source Type: Branch
Source: master
2019-10-10 05:42:10 -05:00
Docker Tag: prerelease
2019-02-01 02:58:07 -06:00
Dockerfile location: Dockerfile
2019-10-14 16:16:51 -05:00
Build Context: /
Autobuild: on
Build Caching: on
2019-02-01 02:58:07 -06:00
- Source Type: Branch
Source: master
2019-10-10 05:42:10 -05:00
Docker Tag: release
2019-02-01 02:58:07 -06:00
Dockerfile location: Dockerfile
2019-10-14 16:16:51 -05:00
Build Context: /
Autobuild: on
Build Caching: on
2019-02-01 02:58:07 -06:00
Build Environment Variables:
# Create an app on Github and use it's OATH credentials here
- Key: GITHUB_OAUTH_CLIENT_ID
Value: < secret >
- Key: GITHUB_OAUTH_CLIENT_SECRET
Value: < secret >
Build Triggers:
- Name: Cron Trigger
2019-10-14 16:16:51 -05:00
Trigger URL: < generated >
2019-02-01 02:58:07 -06:00
# Use this trigger in combination with e.g. https://cron-job.org in order to regularly schedule builds
```
## Background Knowledge
The build system of cloud.docker.com is not made for this kind of project.
But we found a way to make it work, and this is how:
1. The docker hub build system [allows to overwrite the scripts that get executed
2019-10-10 05:42:10 -05:00
for `build` , `test` and `push` ](overwrite). See `/hooks/*` .
2. Shared functionality of the scripts `build` , `test` and `push` is extracted to `/hooks/common` .
3. The `build` script runs `run_build()` from `/hooks/common` .
This triggers either `/build-branches.sh` , `/build-latest.sh` or directly `/build.sh` .
2019-02-01 02:58:07 -06:00
4. The `test` script just invokes `docker-compose` commands.
5. The `push` script runs `run_build()` from `hooks/common` with a `--push-only` flag.
This causes the `build.sh` script to not re-build the Docker image, but just the just built image.
2019-10-10 05:42:10 -05:00
The _Docker Tag_ configuration setting (`$DOCKER_TAG`) is only used to select the type (_release_, _prerelease_ , _branches_ ) of the build in `hooks/common` .
Because it has a different meaning in all the other build scripts, it is `unset` after it has served it's purpose.
2019-02-01 02:58:07 -06:00
[overwrite]: https://docs.docker.com/docker-hub/builds/advanced/#override-build-test-or-push-commands
