github/linuxkit
1
0
Fork 0
mirror of https://github.com/linuxkit/linuxkit.git synced 2025-07-21 10:09:07 +00:00
Code Issues Projects Releases Wiki Activity

docs: Update packet.net documentation

Browse Source 
Signed-off-by: Rolf Neugebauer <rolf.neugebauer@docker.com>
This commit is contained in:
Rolf Neugebauer 2018-01-10 18:26:54 +00:00
parent 1cef947ee1
commit 293b2bb982
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/platform-packet.md
View File

@ -40,11 +40,17 @@ retry the boot typically fixes this.
## Boot ## Boot
LinuxKit on Packet boots the `kernel+initrd` output from moby LinuxKit on Packet boots the `kernel+initrd` output from moby via
via [iPXE](https://help.packet.net/technical/infrastructure/custom-ipxe)
[iPXE](https://help.packet.net/technical/infrastructure/custom-ipxe). iPXE which also requires a iPXE script. iPXE booting requires a HTTP server
booting requires a HTTP server on which you can store your images. The on which you can store your images. The `-base-url` option specifies
`-base-url` option specifies the URL to the HTTP server. the URL to a HTTP server from which `<name>-kernel`,
`<name>-initrd.img`, and `<name>-packet.ipxe` can be downloaded during
boot.
If you have your own HTTP server, you can use `linuxkit push packet`
to create the files (including the iPXE script) you need to make
available.
If you don't have a public HTTP server at hand, you can use the If you don't have a public HTTP server at hand, you can use the
`-serve` option. This will create a local HTTP server which can either `-serve` option. This will create a local HTTP server which can either
@ -62,9 +68,10 @@ PACKET_API_KEY=<API key> PACKET_PROJECT_ID=<Project ID> \
linuxkit run packet -serve :8080 -base-url <ngrok url> packet linuxkit run packet -serve :8080 -base-url <ngrok url> packet
``` ```
To boot a `arm64` image for Type 2a machine (`-machine To boot a `arm64` image for Type 2a machine (`-machine baremetal_2a`)
baremetal_2a`) you currently need build using `linuxkit build packet.yml packet.arm64.yml` and then un-compress both the kernel and you currently need to build using `linuxkit build packet.yml
the initrd before booting, e.g: packet.arm64.yml` and then un-compress both the kernel and the initrd
before booting, e.g:
```sh ```sh
mv packet-initrd.img packet-initrd.img.gz && gzip -d packet-initrd.img.gz mv packet-initrd.img packet-initrd.img.gz && gzip -d packet-initrd.img.gz
@ -78,12 +85,16 @@ PACKET_API_KEY=<API key> PACKET_PROJECT_ID=<Project ID> \
linuxkit run packet -machine baremetal_2a -serve :8080 -base-url -base-url <ngrok url> packet linuxkit run packet -machine baremetal_2a -serve :8080 -base-url -base-url <ngrok url> packet
``` ```
Alternatively, `linuxkit push packet` will uncompress the kernel and
initrd images on arm machines (or explicitly via the `-decompress`
flag. There is also a `linuxkit serve` command which will start a
local HTTP server serving the specified directory.
**Note**: It may take several minutes to deploy a new server. If you **Note**: It may take several minutes to deploy a new server. If you
are attached to the console, you should see the BIOS and the boot are attached to the console, you should see the BIOS and the boot
messages. messages.
## Console ## Console
By default, `linuxkit run packet ...` will connect to the By default, `linuxkit run packet ...` will connect to the