Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 2.87 KB

README.md

File metadata and controls

71 lines (42 loc) · 2.87 KB
Raw

Treehub

Treehub implements an ostree repository storage for over the air updates. This project is part of ota-community-edition.

This project implements an HTTP api that ostree can use to natively pull objects and revisions to update an ostree repository.

An HTTP api is provided to receive ostree repository objects and refs from command line tools such as garage-push, included with sota-tools.

Running

Edit application.conf and run sbt run.

Check ota-community-edition for documentation on how to run this project as part of ota-community-edition.

Testing

To test the current implementation, the following steps can be followed:

  1. Install ostree

    This can be done with your package manager, for example:

     apt install ostree

  2. Create a ostree repository

     ostree --repo=myrepo-developer init --mode=archive-z2

  3. Commit a filesystem tree to the repository

     mkdir developer-files
 echo "This is my file. There are many files like this, but this one is mine." > developer-files/myfile.txt

 ostree --repo=myrepo-developer commit --subject 'created my new shiny file' \
   --branch=master --tree=dir=developer-files

  4. Push your local ostree repository to treehub using the garage-push tool. Please follow the instructions for installation in the aktualizr repository. It will suffice to only build garage-push with make garage-push instead of all default targets with make. Then run garage-push:

     ./src/sota_tools/garage-push --repo myrepo-developer --ref master --credentials <credentials.zip>

  5. For versions of aktualizr/garage-push before 6d025cf17d1600a780a13a7624f8e287c9aaf94c, you will also need to manually push the OSTree ref to treehub:

     curl -XPOST https://treehub.ota.api.here.com/api/v3/refs/heads/master \
   -H "Authorization: Bearer $DEVICE_TOKEN" \
   -d $(cat myrepo-developer/refs/heads/master)

  6. You can now pull your changes in another machine, acting as the client, or the same machine, to test the changes.

     ostree --repo=myrepo-client init --mode=archive-z2

 ostree --repo=myrepo-client remote add \
   --no-gpg-verify garage \
   https://treehub.ota.api.here.com/api/v3/ master

 ostree --repo=myrepo-client pull \
 --http-header="Authorization=Bearer $DEVICE_TOKEN" garage

  7. You now have your changes locally and you can checkout the files:

     ostree --repo=myrepo-client checkout master checkout

 cat checkout/myfile.txt

 This is my file. There are many files like this, but this one is mine.