Important Notice

This public repository is read-only and no longer maintained.

InfraBox Examples

This repo contains examples for InfraBox, a continuous integration system.

Requirements

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

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. Push Images
    • Push to Docker registry: Deploy your docker images to a registry
    • Push to GCR: Deploy your docker images to a GCR
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. Services
    • Kubernetes Namespace: Provision a Kubernetes namespaces for your tests
    • Kubernetes Cluster (GKE): Provision a GKE Kubernetes Cluster for your tests
    • Kubernetes Gardener: Provision a Gardener Kubernetes Cluster for your tests
17. Dynamic Workflows: Modify your job graph at runtime for full flexibility
18. Build and use Image: In the same build
19. Access git information: Access the cloned git repository

External Service Integrations

1. Slack: Report your build status

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

How to get support

If you need help please post your questions to Stack Overflow. In case you found a bug please open a Github Issue. Follow us on Twitter: @Infra_Box or have look at our Slack channel infrabox.slack.com.

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.

License

Copyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.