Generic service to manage geo-distributed resources.
Cheops is a follow-up from the original PoC for scope-lang's sharing, which can be found here. The goal of Cheops is to make it more generic, and with more functionalities.
Cheops work is supported by Inria, IMT Atlantique and Orange Labs.
Cheops OpenInfra 2022 Video presentation
This research prototype is currently under heavy development. If you are interested to know more about this project, please contact us.
-
Euro-Par 2021
- Preprint: Ronan-Alexandre Cherrueau, Marie Delavergne, Adrien Lebre. Geo-Distribute Cloud Applications at the Edge. EURO-PAR 2021 - 27th International European Conference on Parallel and Distributed Computing, Aug 2021, Lisbon, Portugal. pp.1-14. ⟨hal-03212421⟩
- Article: Cherrueau, RA., Delavergne, M., Lèbre, A. (2021). Geo-distribute Cloud Applications at the Edge. In: Sousa, L., Roma, N., Tomás, P. (eds) Euro-Par 2021: Parallel Processing. Euro-Par 2021. Lecture Notes in Computer Science(), vol 12820. Springer, Cham. https://doi.org/10.1007/978-3-030-85665-6_19
-
AMP 2021
-
ICSOC 2022 : Marie Delavergne, Geo Johns Antony, and Adrien Lebre. "Cheops, a service to blow away Cloud applications to the Edge." Service-Oriented Computing: 20th International Conference, ICSOC 2022, Seville, Spain, November 29–December 2, 2022, Proceedings. Cham: Springer Nature Switzerland, 2022.
- Research Report: Marie Delavergne, Geo Johns Antony, Adrien Lebre. Cheops, a service to blow away Cloud applications to the Edge. [Research Report] RR-9486, Inria Rennes - Bretagne Atlantique. 2022, pp.1-16. ⟨hal-03770492v2⟩
GNU Affero General Public License
See the LICENSE document for the full text
# Install and run Couchdb
sh -x install-run-couchdb.sh
# Install and run kube
sh -x install-run-kube.sh
# Get go 1.19
apt install golang-1.19
rm cheops.log 2> /dev/null
killall cheops.com 2> /dev/null
/usr/lib/go-1.19/bin/go build
kubectl delete all --all
MYFQDN=<my.fq.dn> ./cheops.com 2> cheops.log &
If you can, deploy some nodes in grid5000 and use the jupyter notebook in tests/g5k. There are instructions there about what can be used and done
TODO: update
Cheops is designed in a P2P manner considering each resource as a black box:
- Uses scope-lang to define where resources will be replicated and uses the forwarding operation.
- Agents are located on each site
- Uses heartbeat to check if sites are up and in the network
- Uses a geo-distributed like database to have resource information only where relevant
- Will provide different level of consistency, the 2 lasts requiring
transactionable resources (having the ability to rollback any
operation done on them):
- "none": No guarantees (operations are triggered and that's all).
- eventual: every operation on a replica will be applied to the others eventually (will be the focus for now).
- transactional eventual: either with two phases commit or long-lived transactions, depending on the resources involved. Ensures transactions while still being available. cf Cure and Sagas.
- strong serializable : strongest consistency, but the system might be unavailable a lot.
+---------------------+ +---------------------+
| | | |
| Cheops agent 1 +<------------------------>+ Cheops agent 2 |
| | | |
| +---+--+ +--+---+ |
| | DB | | DB | |
+-------+--+------+ +<------------------>+ +---+----+--------+
^ | +------+ +------+ | ^
| | | |
| | +------------------------------------------+ |
| | | |
| +-----------------------------------------------v |
| | | |
v v v v
+----+-----+------+ +-----+--+--------+
| | | |
| | | |
| Service A1 | | Service A2 |
| | | |
| | | |
+-----------------+ +-----------------+
TODO: update
In more details:
.
├── api # API package
│ └── api.go # Defines the router and routes
├── broker
│ ├── broker_receive.go
│ ├── dep.json
│ ├── deployment.json
│ └── go.mod
├── client
│ ├── deployment.json
│ └── server.go
├── endpoint # Endpoint package
│ ├── endpoint.go # Manage different endpoints (services, related to the application)
│ └── site.go # Manage different sites (cheops to cheops)
├── replication # Replication package
│ └── replication.go # Replicants and replicas management
├── request # Request package
│ └── request.go # Get the request and transfer it to the driver
├── glue
│ ├── k8s # Driver for Kubernetes
│ │ ├── fetch.go # Interpreter for the request
│ │ └── go.mod
│ └── openstack # Driver for OpenStack
│ ├── fetch.go #
│ └── go.mod #
├── infos
│ ├── Poster_Compas_2022.pdf
│ └── Slides_OpenInfra_Summit_2022.pdf
├── operation
│ ├── operation.go
│ └── replication.go
├── request
│ ├── request.go
│ └── scope.go
├── tests # Where are the tests
│ ├── .gitignore # Gitignore for the tests
│ ├── README.md # README for the tests
│ ├── requirements.txt # Requirements file for the tests (cf README)
│ ├── testingAPI.yaml # API tests
│ ├── serviceA # Mock service to test Cheops
│ └── serviceB # Mock service to test Cheops
├── tutorials
├── utils # Where are the tests
│ ├── config.go
│ ├── database.go
│ ├── launch_db.sh
│ └── utils.go
├── .gitignore # Specify which file to ignore in git versioning
├── config.yml
├── dockerfile
├── go.mod
├── install.sh
├── k8s_debian.sh
├── main.go
├── README.md # This file
TODO: update
When a creation request is made to an application, envoy captures it and transfers it to Cheops. Cheops uses its list of drivers to check which one to use. The request is read by the driver, and the scope is extracted and sent to the module in charge of location interpretation.
A replicant is created with a metaID and added to the database (for now, a KV store). In parallel, the request is separated in as many local requests as necessary and sent to the Cheops of involved sites, with the replicant to add in their database.
Every Cheops involved sends the request back to the right service locally and adds the replicant to its database. When receiving the response, they add the local ID to the replicant and transfer the information to all involved Cheops again.
- Please follow usual Golang conventions. If you find some infractions, please report (or edit) them.
- When adding, removing or change the use of a file, please change the corresponding entry in the README.md.
- Don't hesitate to report an issue!
- Thanks for any contribution :)
- https://www.nicolasmerouze.com/middlewares-golang-best-practices-examples
- https://medium.com/the-andela-way/build-a-restful-json-api-with-golang-85a83420c9da
- https://golang.org/doc/effective_go
This project has been envisionned in the context of the Discovery Initiative. To go beyond the clouds and to also stay close to the scope, the name Cheops was chosen.