InfraBox Examples

Prerequisites

To be able to run the examples locally you should install infraboxcli. See How to install infraboxcli for instructions.

Run examples

To run jobs locally cd into a directory which contains a infrabox.json file. Now simply run

$ infrabox run

This will now run all the jobs defined in infrabox.json. If you want to run only a single job use:

$ infrabox run <job-name>

For more details on how to run jobs see the infraboxcli documentation

Use InfraBox playground

Instead of running the examples on your local machine you may also use the InfraBox playground at https://infrabox.ninja. You can use it for free with up to 1 CPU and 1024MB per job.

Quickstart Guides:

• Connect your github repository
• Upload a workflow (you don't need a git repository)

Examples

1. Hello World: Run you first hello world job on InfraBox
2. A simple C++ project: Compile and test a simple C++ program
3. Upload your testresult: If you run tests in your job you can get the results visualized by InfraBox
4. Create custom badges: An easy way of creating for your jobs
5. Docker build arguments: Set Docker build arguments for your jobs
6. Caching: Cache data between runs to speed up your builds
7. Timeouts: Set timeouts for your jobs
8. Environment Variables: Set environment vars for your jobs
9. Secrets: How to handle passwords and other sensitive data
10. Deploy: Deploy your docker containers to a registry
11. Job Dependencies: Run multiple jobs with dependencies
12. Transfer data: Transfer data between your jobs
13. Docker Compose: Use docker compose in your job to run multiple containers
14. Workflows: Split up your job graph into multiple workflows
15. GIT Workflows: Included external workflows into your build
16. Kubernetes Support: Use the built-in kubernetes support for your e2e testing
17. Dynamic Workflows: Modify your job graph at runtime for full flexibility

External Service Integrations

1. Slack: Report your build status

See also Job Definitions for documentation about using all the different job types.

Best practice

Please have a look at the Docker Best Practice Guide. It contains several useful tips on how to write good Dockerfiles.

In general it's a good idea to keep your containers small. So only install the libraries and components to really need. If possible use alpine images, because they are much smaller then the ubuntu images. This saves you time, because less data has to be downloaded for every job.