Go to file
Gianluca Arbezzano d04bee185a
Merge pull request #28 from gianarb/fix/update-aptrepos-tag-workflow
Run apt-update before installing package in the tag workflow
2020-11-24 20:08:31 +01:00
.github/workflows Run apt-update before installing package in the tag workflow 2020-11-24 19:52:15 +01:00
cmd/getbinariesfromquay Unpack all image and not just the last layer 2020-11-24 17:12:33 +01:00
deploy Bump tinkerbell stack to newest versions 2020-11-12 17:12:42 +01:00
script Missed docker transport in release-binaries 2020-11-24 17:08:08 +01:00
test/_vagrant bump tink for e2e test 2020-11-12 17:29:05 +01:00
.envrc Add shell.nix and .envrc for great good 2020-11-09 17:39:00 -05:00
.gitignore CLI to get binaries from a docker image with multi arch support 2020-11-16 17:50:40 +01:00
.mergify.yml Add mergify and license 2020-09-02 16:31:57 +02:00
CODEOWNERS initial commit 2020-08-20 13:53:27 +02:00
LICENSE Add mergify and license 2020-09-02 16:31:57 +02:00
README.md CLI to get binaries from a docker image with multi arch support 2020-11-16 17:50:40 +01:00
current_versions.sh bump boots to 45a64dad03795133adf7f7177677f3d58a0018e2 2020-11-24 16:41:58 +01:00
generate-envrc.sh Add continuous integration workflow 2020-11-19 11:30:32 +01:00
go.mod Add continuous integration workflow 2020-11-19 11:30:32 +01:00
go.sum Add continuous integration workflow 2020-11-19 11:30:32 +01:00
setup.sh Ensure all files pass ci-non-go.sh checks. 2020-11-09 17:39:00 -05:00
shell.nix Add continuous integration workflow 2020-11-19 11:30:32 +01:00

README.md

This repository is a quick way to get the Tinkerbell stack up and running.

Currently it supports:

  1. Vagrant with libvirt and VirtualBox
  2. Terraform on Packet

Tinkerbell is made of different components: osie, boots, tink-server, tink-worker and so on. Currently they are under heavy development and we are working around the release process for all the components.

We need a way to serve a version of Tinkerbell that you can use and we know what is running the hood. Sandbox runs a pinned version for all the components via commit sha. In this way as a user you won't be effected (ideally) from new code that will may change a bit how Tinkerbell works.

We are keeping the number of bc break as low as possible but in the current state they are expected.

Binary release

As part of a new release for sandbox we want to push binaries to GitHub Release in this way the community will be able to use them if needed.

We build Docker images across many architectures, each of them in its own repository: boots, hegel, tink and so on.

Sandbox is just a collection of those services and we follow the same pattern for getting binaries as well.

There is a go program available in ./cmd/getbinariesfromquay/main.go. You can run it with go run or build it with go build:

$ go run cmd/getbinariesfromquay/main.go -h
  -binary-to-copy string
        The location of the binary you want to copy from inside the image. (default "/usr/bin/hegel")
  -image string
        The image you want to download binaries from. It has to be a multi stage image. (default "docker://quay.io/tinkerbell/hegel")
  -out string
        The directory that will be used to store the release binaries (default "./out")
  -program string
        The name of the program you are extracing binaries for. (eg tink-worker, hegel, tink-server, tink, boots) (default "hegel")

By default it uses the image running on Quay for Hegel and it gets the binary /usr/bin/hegel from there. The directory ./out is used to store images and binaries inside ./out/releases.

To get the binaries for example for boots you can run:

$ go run cmd/getbinariesfromquay/main.go \
    -binary-to-copy /usr/bin/boots \
    -image docker://quay.io/tinkerbell/boots:sha-9625559b \
    -program boots

You will find them in ./out/release