Skip to content

Commit

Permalink
[DOCS] - Development Docs (#136)
Browse files Browse the repository at this point in the history
The development docs were a little out of date. This PR just brings them up to date.
  • Loading branch information
gambol99 authored Jun 8, 2022
1 parent ae84647 commit 14aace0
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,31 @@ A typical workflow for development would be to use Kind.
# Create a new local cluster for testing
$ kind create cluster

# Make a copy of the helm values (note ./dev is intentionally ignored by .gitignore)
# Create a values file for helm (note ./dev is intentionally ignored by .gitignore)
$ mkdir -p dev
$ cp charts/values.yaml dev/values.yaml

# Use the following values
$ vim dev/values.yaml
```

```YAML
---
replicaCount: 1
controller:
costs:
# Add this if you're testing infracost
#secret: infracost
images:
# is the controller image
controller: quay.io/appvia/terraform-controller:latest
controller: quay.io/appvia/terraform-controller:ci
# The terraform image used when running jobs
executor: quay.io/appvia/terraform-executor:latest
executor: quay.io/appvia/terraform-executor:ci
```
```shell
# Builds the images locally as <IMAGE>:latest and loads them into a kind cluster
$ make controller-kind

# Change the values of the images to :latest in values.yaml
$ helm install terraform-controller charts --create-namespace --values dev/values.yaml
$ helm install terraform-controller charts/terraform-controller --create-namespace --values dev/values.yaml
```

You can easily iterate locally by running `make controller-kind` again to build, load and restart.
Expand Down

0 comments on commit 14aace0

Please sign in to comment.