Skip to content
This repository has been archived by the owner on Dec 21, 2020. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
recollir committed Jan 5, 2016
0 parents commit 9730fda
Show file tree
Hide file tree
Showing 10 changed files with 129 additions and 0 deletions.
5 changes: 5 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
The development of flod2 was made possible by the significant contributions of
the following people:

Paul Beckingham (Principal Author)
Federico Hernandez (Principal Author)
23 changes: 23 additions & 0 deletions COPYING
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
flod2 - grid testing.

Copyright 2012 - 2016, Göteborg Bit Factory.

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.

http://www.opensource.org/licenses/mit-license.php
23 changes: 23 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
flod2 - grid testing.

Copyright 2012 - 2016, Göteborg Bit Factory.

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.

http://www.opensource.org/licenses/mit-license.php
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Flod2 - Lightweight Continuous Integration

Flod2 uses the simplest, most flexible technology to create a CI solution that
uses minimal resources, yet delivers build status as fast as possible.


## Design

Flod consists of two main components.

The first is the flod binary, and is a queue management tool that triggers hook
scripts when event files appear in a queue, calling the script with a reference
to the event file and managing that file. The flod binary knows nothing about
CI.

The second component manages a single VM instance. It creates it, then can
install tools and libraries on it, copies a build script to it, and runs that
build script. It waits for a result event to appear, and then shuts down the
VM.

Everything else is a small script that is launched based on events triggering
hooks, each script having a small and well-defined purpose.

The combined effect is that a single commit will launch multiple VMs that test
that commit, yielding several results events, which contribute to a status
report. Then the VMs will be shut down and the system returns goes idle,
thereby using minimal resources.


## Workflow

1. A repository commit (task.git) triggers a VCS hook (git on-push) that
composes and queues a commit-event file. This needs to be a very fast
operation. The commit-event file identifies the repository, branch, and a
range of commits.

2. A commit-event triggers a portability-build script that uses stored
configuration to enumerate supported platforms and composes a build-event
file tailored for each platform. The VM instance component is run, with
the build-event file.

3. The VM instance component creates a VM, installs software, installs a
build/test/report script, then runs that. It then waits for a result event
file to appear, shuts down the VM and queues the results event.

4. The result-event triggers a report script that (in an undefined way)
creates a status report of the commit.

There are other steps/events/scripts, for example, HTML report aggregation,
project overview report creation, performance testing on good builds, result
event archiving, tarball creation and so on.


## Data Storage

There needs to be a hierarchy constituting project/branch/commit/platform,
where result events are stored permanently.

All events should be archived. Archived events may be purged later.


## Configuration

There needs to be platform-specific configuration, including:

1. Platform-specific depdendencies, for example the presence of a 'libuuid'
library is necessary on Fedora, but not on OSX.

2. Project-specific configuration, for example a sequence of commands to run
in order to build and test a project.

3. Permanent queue details, such as a location, and set of triggered scripts.
Empty file added doc/README.md
Empty file.
6 changes: 6 additions & 0 deletions orchestration/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Ansible

# Terraform

# Provider APIs

Empty file added orchestration/ansible/README.md
Empty file.
Empty file.
Empty file added scripts/README.md
Empty file.
Empty file added src/README.md
Empty file.

0 comments on commit 9730fda

Please sign in to comment.