A simple "hello-world" Forklift pallet illustrating a minimal pallet structure
pallet-example-minimal is a Forklift pallet specifying an example set of Forklift packages and package deployments for a "hello world"-style demonstration. This pallet is structured as a monorepo in which all packages to be deployed are also defined by the pallet (because it is also a Forklift repository). Due to its simplicity, this is the recommended approach for small projects where packages aren't intended to be reused externally. By contrast, the pallet at github.com/PlanktoScope/pallet-standard imports all packages from a separate Forklift repository (github.com/PlanktoScope/device-pkgs), because packages for that project are intended to be reusable and recomposable as a set of building blocks.
You will need to have the Docker Engine installed on your computer. Installation instructions are available here.
Then, you will need to set up the forklift
tool on
your computer. Setup instructions are available
here. Note
that currently forklift
is only tested for Linux computers.
You can clone the latest commit of this Forklift pallet to your computer, by
using the forklift
tool:
forklift plt clone github.com/ethanjli/pallet-example-minimal@main
Then you can apply the cloned pallet on your computer using the following sequence of forklift
CLI commands:
sudo -E forklift plt apply
Warning: this will replace all Docker containers on your Docker host with the package deployments specified by this pallet and delete any Docker containers not specified by this pallet's package deployments.
If your user is in the docker
group (so that you don't need to use sudo
when running docker
commands), then you can just run a single command instead of the two commands listed above:
forklift plt switch github.com/ethanjli/pallet-example-minimal@main
This pallet will bring up a web server at port 80. If you open http://localhost/hello in your web browser after deploying the pallet, you should see an NGINX page which prints some basic information such as the current date. If you open http://localhost/whoami, you should see another page with some additional information (e.g. your browser's user agent).
To make your own copy of this repository for experimentation, you should fork this repository to a
new repository. Then, update the path
fields of the forklift-pallet.yml
and
forklift-repository.yml
files to match the path of your new repository.
Forklift packages deployed by this pallet have their own software licenses, as specified in the definitions of those packages. Any source code provided with this Forklift pallet is covered by the following information, except where otherwise indicated:
Copyright Ethan Li and Forklift project contributors
SPDX-License-Identifier: Apache-2.0 OR BlueOak-1.0.0
You can use the source code provided here either under the Apache 2.0 License or under the Blue Oak Model License 1.0.0; you get to decide. We are making the software available under the Apache license because it's OSI-approved, but we like the Blue Oak Model License more because it's easier to read and understand.