Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mastodon/packer
Build automation for DigitalOcean 1-click Install Image
https://github.com/mastodon/packer
digitalocean mastodon packer
Last synced: 3 months ago
JSON representation
Build automation for DigitalOcean 1-click Install Image
- Host: GitHub
- URL: https://github.com/mastodon/packer
- Owner: mastodon
- License: mit
- Created: 2020-03-31T12:07:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T17:33:08.000Z (about 1 year ago)
- Last Synced: 2024-04-13T12:57:58.974Z (8 months ago)
- Topics: digitalocean, mastodon, packer
- Language: Shell
- Homepage:
- Size: 48.8 KB
- Stars: 8
- Watchers: 5
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Build Automation with Packer
[Packer](https://www.packer.io/intro/index.html) is a tool for creating images from a single source configuration. Using this Packer template reduces the entire process of creating, configuring, validating, and snapshotting a build Droplet to a single command:
```
packer build marketplace-image.pkr.hcl
```
This Packer template uses the same LAMP-based example as the [Fabric sample project](../fabric). Like the Fabric sample project, you can modify this template to use as a starting point for your image.
## Usage
To run the LAMP example that this template uses by default, you'll need to [install Packer](https://www.packer.io/intro/getting-started/install.html) and [create a DigitalOcean personal access token](https://www.digitalocean.com/docs/api/create-personal-access-token/) and set it to the `DIGITALOCEAN_TOKEN` environment variable. Running `packer build marketplace-image.pkr.hcl` without any other modifications will create a build Droplet configured with LAMP, clean and verify it, then power it down and snapshot it.
> ⚠️ The image validation script in `scripts/99-img_check.sh` is copied from the [top-level `scripts` directory](../scripts) in this repository. The top-level location is the script's canonical source, so make sure you're using the latest version from there.
To start adapting this template for your own image, there are some variables that can be set:
* `image_name` defines the name of the resulting snapshot, which by default is `mastodon-digitalocean-` with a UNIX timestamp appended.
You can also modify these variables at runtime by using [the `-var` flag](https://www.packer.io/docs/templates/user-variables.html#setting-variables).
## Configuration Details
By using [Packer's DigitalOcean Builder](https://www.packer.io/docs/builders/digitalocean.html) to integrate with the [DigitalOcean API](https://developers.digitalocean.com/), this template fully automates Marketplace image creation.
This template uses Packer's [file provisioner](https://www.packer.io/docs/provisioners/file.html) to upload complete directories to the Droplet. The contents of `files/var/` will be uploaded to `/var/`. Likewise, the contents of `files/etc/` will be uploaded to `/etc/`. One important thing to note about the file provisioner, from Packer's docs:
> The destination directory must already exist. If you need to create it, use a shell provisioner just prior to the file provisioner in order to create the directory. If the destination directory does not exist, the file provisioner may succeed, but it will have undefined results.
This template also uses Packer's [shell provisioner](https://www.packer.io/docs/provisioners/shell.html) to run scripts from the `/scripts` directory and install APT packages using an inline task.
Learn more about using Packer in [the official Packer documentation](https://www.packer.io/docs/index.html).