djpbessems/Tinkerbell.Sandbox
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
108 Commits 12 Branches 6 Tags 336 KiB
Shell 47.3%
Go 38.7%
HCL 10.8%
Smarty 1.3%
Dockerfile 1%
Other 0.9%
4243501dca
Go to file
Nahum Shalman 4243501dca Fix setup.sh to work when .nat_interface doesn't exist 
Signed-off-by: Nahum Shalman <nshalman@equinix.com>
2021-04-12 16:35:08 +00:00
.github/workflows chore: install btrfs-progs as an attempt to make get-binaries script to work 2021-03-24 13:39:36 +01:00
cmd New tool to bump current_versions.sh automatically 2021-02-12 14:47:46 +01:00
deploy Fix NAT to reference correct interfaces 2021-04-08 16:17:38 +00:00
script Missed docker transport in release-binaries 2020-11-24 17:08:08 +01:00
test/vagrant Rename _vagrant to vagrant 2021-03-18 15:11:55 +01:00
.envrc Add shell.nix and .envrc for great good 2020-11-09 17:39:00 -05:00
.gitattributes Force Unix line endings for shell scripts 2020-12-07 23:31:00 +01:00
.gitignore Add .env to .gitignore 2020-12-07 23:31:00 +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
current_versions.sh Revert osie because the latest version broke tink-worker installation 2021-03-24 09:35:22 +01:00
generate-envrc.sh Set NGINX to bind on TINKERBELL_HOST_IP:8080 2021-01-25 15:19:23 -05:00
go.mod Rename _vagrant to vagrant 2021-03-18 15:11:55 +01:00
go.sum Rename _vagrant to vagrant 2021-03-18 15:11:55 +01:00
LICENSE Add mergify and license 2020-09-02 16:31:57 +02:00
README.md Making statement on breaking changes clearer 2021-01-04 12:07:15 -08:00
setup.sh Fix setup.sh to work when .nat_interface doesn't exist 2021-04-12 16:35:08 +00:00
shell.nix Add jq to the nix-shell environment 2021-04-06 14:34:14 +00: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 breaking changes 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