Skip to content

Commit

Permalink
Make README.lint conformant. (#247)
Browse files Browse the repository at this point in the history
README.lint offers a convention-over-configuration approach to README files, simplifying onboarding to a new tech stack.

More at https://github.com/strangelove-ventures/readme-dot-lint.
  • Loading branch information
jonathanpberger committed May 16, 2024
1 parent 9e38cbb commit 713e8b2
Showing 1 changed file with 42 additions and 16 deletions.
58 changes: 42 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
# Heighliner
[![Conforms to README.lint](https://img.shields.io/badge/README.lint-conforming-brightgreen)](https://github.com/strangelove-ventures/readme-dot-lint)

Heighliner is a utility for building production-grade container images for blockchain node software, Cosmos and beyond.

Heighliner images are minimally constructed from scratch images, packaging only the chain binary and a useful reduced set of busybox utilities.
🌌 Why use Heighliner?
=============================

![Heighliner photo](https://static.wikia.nocookie.net/dune/images/7/72/51mMK0akBOL._AC_SY400_-1.jpg/revision/latest)

We built Heighliner to streamline the management and building of production-grade container images for blockchain node software, Cosmos and beyond.

These container images can be used for infrastructure deployments (validator + [horcrux](https://github.com/strangelove-ventures/horcrux), full node, archive node, etc.), end-to-end testing ([interchaintest](https://github.com/strangelove-ventures/interchaintest)), and more.
🌌🌌 Who benefits from Heighliner?
=============================

Heighliner container images are useful for anyone who's responsible for infrastructure deployments like

- validator + [horcrux](https://github.com/strangelove-ventures/horcrux),
- full nodes,
- archive nodes,
- end-to-end testing ([interchaintest](https://github.com/strangelove-ventures/interchaintest)),
- and more.

🌌🌌🌌 What does Heighliner do?
=============================

Heighliner images are minimally constructed from scratch images, packaging only the chain binary and a useful reduced set of busybox utilities.

This repository has a CI/CD pipeline to automatically build images when new git tags are detected on the chain repos in [chains.yaml](./chains.yaml). These images are hosted as packages in the Github Container Registry (ghcr) [here](https://github.com/orgs/strangelove-ventures/packages?repo_name=heighliner)

![Heighliner photo](https://static.wikia.nocookie.net/dune/images/7/72/51mMK0akBOL._AC_SY400_-1.jpg/revision/latest)


🌌🌌🌌🌌 How do I use Heighliner?
=============================

## Add a New Chain

Expand All @@ -25,21 +46,21 @@ To publish heighliner images on your chain repository and/or incorporate heighli
If you would like to build the images yourself, heighliner is a CLI tool to help you do so.
Download the latest [release](https://github.com/strangelove-ventures/heighliner/releases), or build it yourself with:

```bash
```shell
go build
```

#### Example: build the docker image for gaia v6.0.0:

```bash
```shell
heighliner build --chain gaia --git-ref v6.0.0
```

Docker image `heighliner/gaia:v6.0.0` will now be available in your local docker images

#### Example: Cosmos SDK chain development cycle, build a local repository

```bash
```shell
cd ~/gaia-fork
heighliner build -c gaia --local
```
Expand All @@ -48,7 +69,7 @@ Docker image `gaia:local` will be built and stored in your local docker images.

#### Example: Build from a Github fork

```bash
```shell
cd ~/gaia-fork
heighliner build -c gaia -o strangelove-ventures -g working_branch -t image_tag
```
Expand All @@ -59,15 +80,15 @@ Heighliner will build the `working_branch` branch from the `strangelove-ventures

Heighliner can build without a chain present in chains.yaml if the necessary flags are provided.

```bash
```shell
heighliner build -c somegaia -o somefork --repo gaia --dockerfile cosmos --build-target "make install" --build-env "LEDGER_ENABLED=false BUILD_TAGS=muslc" --binaries "/go/bin/gaiad" -g v8.0.0 -t v8.0.0-somefork
```

Docker image `somegaia:v8.0.0-somefork` will be built and stored in your local docker images.

#### Example: build and push the gaia v6.0.0 docker image to ghcr:

```bash
```shell
# docker login ...
heighliner build -r ghcr.io/strangelove-ventures/heighliner -c gaia -g v6.0.0
```
Expand All @@ -76,7 +97,7 @@ Docker image `ghcr.io/strangelove-ventures/heighliner/gaia:v6.0.0` will be built

#### Example: build and push last n releases of osmosis chain

```bash
```shell
# docker login ...
heighliner build -r ghcr.io/strangelove-ventures/heighliner -c osmosis -n 3
```
Expand All @@ -90,33 +111,38 @@ heighliner will fetch the last 3 osmosis release tags from github, build docker

This will make a request to each chain's Github repository to fetch all recent releases. Github rate-limits unauthenticated requests to 60 requests per hour. Authenticated requests have either 1000 (personal) or 15000 (enterprise) per hour. To add Github API authentication, set the `GH_USER` and `GH_PAT` environment variables with your Github username and Github Personal Access Token (PAT), respectively.

```bash
```shell
# docker login ...
export GH_USER=github_username GH_PAT=github_personal_access_token
heighliner build -r ghcr.io/strangelove-ventures/heighliner -n 3
```

heighliner will fetch the last 3 release tags from github for all chains in [chains.yaml](./chains.yaml), build docker images, and push them.



🌌🌌🌌🌌🌌 Extras
=============================

## Cross compiling
Depends on docker [buildkit](https://github.com/moby/buildkit). Requires `buildkitd` server to be running.
Pass `-b` flag to use buildkit.
Pass `-b` flag to use buildkit.

The build will look for the local buildkit unix socket by default. Change address with `--buildkit-addr` flag.

Customize the platform(s) to be built with the `--platform` flag.

#### Example: build x64 and arm64 docker images for gaia v7.0.1:

```bash
```shell
heighliner build -b -c gaia -g v7.0.1
```

Docker images for `heighliner/gaia:v7.0.1` will now be available in your local docker. The manifest for the tag will contain both amd64 and arm64 images.

#### Example: Use custom buildkit server, build x64 and arm64 docker images for gaia v7.0.1, and push:

```bash
```shell
heighliner build -b --buildkit-addr tcp://192.168.1.5:8125 -c gaia -g v7.0.1 -r ghcr.io/strangelove-ventures/heighliner
```

Expand Down

0 comments on commit 713e8b2

Please sign in to comment.