Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
franklinkim committed Oct 6, 2024
1 parent 89d7235 commit 9ced2b7
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,27 @@ Another way to think of it would be `helm-compose`, because it makes k8s and hel
Configure your squadron

```yaml
# squadron.yaml
version: '2.0'
# https://raw.githubusercontent.com/foomo/squadron/refs/heads/main/squadron.schema.json
version: '2.1'

# squadron template vars
vars: {}

# helm global vars
global: {}

# squadron definitions
squadron:
# squadron units
site:
# squadron unit
frontend:
# helm chart definition
chart:
name: mychart
version: 0.1.0
repository: http://helm.mycompany.com/repository
# container builds
builds:
service:
tag: latest
Expand All @@ -34,11 +45,16 @@ squadron:
build_arg:
- "foo=foo"
- "bar=bar"
# helm chart values
values:
image: docker.mycompany.com/mycomapny/frontend:latest
# squadron unit
backend:
# helm chart definition
chart: <% env "PROJECT_ROOT" %>/path/to/chart
# kustomize path
kustomize: <% env "PROJECT_ROOT" %>/path/to/kustomize
# container builds
builds:
service:
tag: latest
Expand All @@ -47,6 +63,7 @@ squadron:
build_arg:
- "foo=foo"
- "bar=bar"
# helm chart values
values:
image: docker.mycompany.com/mycomapny/backend:latest
```
Expand Down

0 comments on commit 9ced2b7

Please sign in to comment.