Skip to content

Commit

Permalink
Update README with new flags
Browse files Browse the repository at this point in the history
The command line flags were changed recently to be more aligned with the
shipwright build project `BuildSpec` and the examples were out of date.

Fix examples to match current flags.

Add test plan example.

Update example image.
  • Loading branch information
HeavyWombat committed Oct 20, 2020
1 parent 5614c11 commit 4730a3b
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 10 deletions.
Binary file modified .docs/example-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 56 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,78 @@ Create synthetic load for [shipwright-io/build](https://github.com/shipwright-io

## Examples

### Kaniko buildrun
### Build Runs

#### Kaniko buildrun

```sh
build-load \
buildruns \
--build-type=kaniko \
--namespace test-namespace \
--cluster-build-strategy=kaniko \
--source-url=https://github.com/EmilyEmily/docker-simple \
--output-registry-hostname=docker.io \
--output-registry-namespace=boatyard \
--output-registry-secret-ref=registry-credentials
--output-image-url=docker.io/boatyard \
--output-secret-ref=registry-credentials
```

### Buildpacks buildrun
#### Buildpacks buildrun

```sh
build-load \
buildruns \
--build-type=buildpack \
--namespace test-namespace \
--cluster-build-strategy=buildpacks-v3 \
--source-url=https://github.com/sclorg/nodejs-ex \
--output-registry-hostname=docker.io \
--output-registry-namespace=boatyard \
--output-registry-secret-ref=registry-credentials
--output-image-url=docker.io/boatyard \
--output-secret-ref=registry-credentials
```

### Test Plan

#### Use Test Plan YAML

```yaml
---
namespace: test-namespace
steps:
- name: kaniko
buildSpec:
source:
url: https://github.com/EmilyEmily/docker-simple
contextDir: /
strategy:
name: kaniko
kind: ClusterBuildStrategy
dockerfile: Dockerfile
output:
image: docker.io/boatyard
credentials:
name: reg-cred

- name: buildpacks
buildSpec:
source:
url: https://github.com/sclorg/nodejs-ex
contextDir: /
strategy:
name: buildpacks-v3
kind: ClusterBuildStrategy
output:
image: docker.io/boatyard
credentials:
name: reg-cred
```
Run the test plan using:
```sh
build-load \
buildruns-testplan \
--testplan testplan.yml
```

The test plan can also be piped into the program using `-` as the filename and a here-doc YAML.

## Setup

### Download via Homebrew
Expand Down

0 comments on commit 4730a3b

Please sign in to comment.