pallet-example-layered

A simple "hello-world" Forklift pallet illustrating layering of pallets

Introduction

pallet-example-layered is a Forklift pallet defined as an override layer over github.com/forklift-run/pallet-example-minimal. For maintainability reasons, layering is the recommended approach (instead of forking a pallet as a Git repository) for minor customizations of existing pallets.

Usage

Prerequisites

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.

Deployment

You can clone the latest commit of this Forklift pallet to your computer, by using the forklift tool:

forklift plt clone github.com/forklift-run/pallet-example-layered@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/forklift-run/pallet-example-layered@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 a very minimal page with an ASCII-art whale, which is not the NGINX hello-world page provided by github.com/forklift-run/pallet-example-minimal. This is because this pallet overrides the Docker Compose file for the hello feature flag in the simple-demo package to deploy a different container.
• If you open http://localhost/whoami, you should see a blank page - this is because this pallet overrides the simple-demo package deployment configuration from github.com/forklift-run/pallet-example-minimal to remove the /whoami route.
• If you open http://localhost/admin/prometheus, you should see a basic Prometheus query console - this is because this pallet imports the package deployment for Prometheus from github.com/PlanktoScope/pallet-standard.
• If you open http://localhost/admin/grafana/d/host-summary/host-summary?orgId=1&refresh=5s, you should see a Grafana dashboard with system monitoring information about your computer - this is because this pallet imports the package deployment for Grafana from github.com/Planktoscope/pallet-standard.

Forking

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.

Licensing

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.