Awesome
docker-flatbuffers - Docker tooling for Flatbuffers
docker-flatbuffers is Docker tooling for FlatBuffers. It also include C-language support using flatcc.
Rather than building your own FlatBuffers installation, you can run flatc or flatcc in a container and "bind mount" your input and output directories (see Usage As a Build Tool):
docker run -v /proj/src:/src -v /proj/dest:/dest neomantra/flatbuffers flatc --cpp --js --ruby -o /dest /src/monster.fbs
Supported Tags
Images are availble in both gcc and clang variants, representing which toolchain was FlatBuffers was built from. The plain, undecorated tag name uses gcc. "master" branches are tagged with YYYYMMDD of the image build dates.
Specific FlatBuffers/flatc and flatcc releases are tagged with their version name. The flatc version is prefixed with v and the flatcc version is prefixed with cc.
gcc,latestclanggcc-v1.8.0,v1.8.0clang-v1.8.0gcc-v1.8.0-cc0.5.1
The builds are managed by Travis-CI.
For best stability, pin your images to the full tag, for example neomantra/flatbuffers:gcc-v1.8.0-cc0.5.1.
Table of Contents
- Supported Tags
- Usage As An Image Build Stage
- Usage As A Build Tool
- Files In This Image
- Customizing The Docker Image Build
- Authors
- Copyright & License
Usage As An Image Build Stage
You can COPY from this image into your own images using the following Dockerfile stanzas. Select the image, tag, and artifacts most appropriate for your project. The included files are listed in the Files In This Image section.
COPY --from=neomantra/flatbuffers /usr/local/bin/flatc /usr/local/bin/flatc
COPY --from=neomantra/flatbuffers /usr/local/include/flatbuffers /usr/local/include/flatbuffers
COPY --from=neomantra/flatbuffers /usr/local/lib/libflatbuffers.a /usr/local/lib/libflatbuffers.a
COPY --from=neomantra/flatbuffers /usr/local/lib/cmake/flatbuffers /usr/local/lib/cmake/flatbuffers
COPY --from=neomantra/flatbuffers /usr/local/bin/flatcc /usr/local/bin/flatcc
COPY --from=neomantra/flatbuffers /usr/local/include/flatcc /usr/local/include/flatcc
COPY --from=neomantra/flatbuffers /usr/local/lib/libflatcc.a /usr/local/lib/libflatccrt.a /usr/local/lib/
Usage As A Build Tool
You can generate files on the host through volume bind mounts. The idea is that you mount a source directory into the container, invoke flatc on a schema in it, and write the output to a mounted destination.
Example:
# Input on host is in /my/src.
# Output written to /my/dest.
docker run -v /my/src:/src -v /my/dest:/dest neomantra/flatbuffers flatc --cpp --scoped-enums -o /dest /src/monster.fbs
Files In This Image
This image is slim, containing the debian-slim base image and the build artifacts of FlatBuffers and flatcc:
FlatBuffers
/usr/local/bin/flatc
/usr/local/include/flatbuffers
/usr/local/include/flatbuffers/idl.h
/usr/local/include/flatbuffers/registry.h
/usr/local/include/flatbuffers/reflection.h
/usr/local/include/flatbuffers/flexbuffers.h
/usr/local/include/flatbuffers/flatc.h
/usr/local/include/flatbuffers/minireflect.h
/usr/local/include/flatbuffers/base.h
/usr/local/include/flatbuffers/grpc.h
/usr/local/include/flatbuffers/flatbuffers.h
/usr/local/include/flatbuffers/reflection_generated.h
/usr/local/include/flatbuffers/hash.h
/usr/local/include/flatbuffers/stl_emulation.h
/usr/local/include/flatbuffers/util.h
/usr/local/include/flatbuffers/code_generators.h
/usr/local/include/flatbuffers/idl_parser.cpp
/usr/local/include/flatbuffers/idl_gen_text.cpp
/usr/local/lib/libflatbuffers.a
/usr/local/lib/cmake/flatbuffers/FlatbuffersConfig.cmake
/usr/local/lib/cmake/flatbuffers/FlatbuffersConfigVersion.cmake
/usr/local/lib/cmake/flatbuffers/FlatbuffersTargets.cmake
/usr/local/lib/cmake/flatbuffers/FlatbuffersTargets-release.cmake
/usr/local/lib/cmake/flatbuffers/FlatcTargets.cmake
/usr/local/lib/cmake/flatbuffers/FlatcTargets-release.cmake
flatcc
# Compiler:
/usr/local/bin/flatcc
/usr/local/lib/lib/libflatcc.a
/usr/local/include/flatcc/flatcc.h
# Runtime:
/usr/local/include/include/flatcc
/usr/local/include/include/flatcc/reflection
/usr/local/include/include/flatcc/support
/usr/local/lib/libflatccrt.a
Customizing The Docker Image Build
The Docker image build can be customized using the following build arguments. They are activated by applying --build-arg <arg>=<value> to your docker build run.
| Arg | Default | Description |
|---|---|---|
| FLATBUFFERS_IMAGE_BASE | debian | Docker image to use as a base image |
| FLATBUFFERS_IMAGE_TAG | bullseye-slim | Docker image tag to use as a base image |
| FLATBUFFERS_ARCHIVE_BASE_URL | https://github.com/google/flatbuffers/archive | URL to download the flatbuffers archive from |
| FLATBUFFERS_ARCHIVE_TAG | master | FlatBuffers tag to download |
| FLATBUFFERS_BUILD_TYPE | Release | CMake build type (e.g. Release, Debug) |
| FLATBUFFERS_USE_CLANG | false | Set to exactly "true" to build with clang instead of gcc |
| FLATCC_ARCHIVE_BASE_URL | https://github.com/dvidelabs/flatcc/archive/ | URL to download the flatcc archive from |
| FLATCC_ARCHIVE_TAG | master | flatcc tag to download |
Authors
This tooling was created by Evan Wies and sponsored by Neomantra.
Image build minutes are sponsored by Travis CI, allowing transparent production and distribution of this software.
Copyright & License
This software is released under the MIT License.
Copyright (c) 2018-2023, Neomantra BV and Evan Wies evan@neomantra.net
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.