Merge pull request #34 from charlieegan3/explain-dummy-config

Explain example preflight.yaml in image

Author: jetstack-bot

Dockerfile

@@ -1,24 +1,25 @@
-  # STAGE 1
-  FROM golang:1.13.4 as builder
+# STAGE 1
+FROM golang:1.13.4 as builder
 
-  WORKDIR /go/github.com/jetstack/preflight
+WORKDIR /go/github.com/jetstack/preflight
 
-  # Run a dependency resolve with just the go mod files present for
-  # better caching
-  COPY ./go.mod .
-  COPY ./go.sum .
+# Run a dependency resolve with just the go mod files present for
+# better caching
+COPY ./go.mod .
+COPY ./go.sum .
 
-  RUN go mod download
+RUN go mod download
 
-  ## Bring in everything else and build an amd64 image
-  COPY . .
-  RUN GOOS=linux GOARCH=amd64 go install .
+## Bring in everything else and build an amd64 image
+COPY . .
+RUN GOOS=linux GOARCH=amd64 go install .
 
-  # STAGE 2
-  # Use a distroless nonroot base image for just our executable
-  FROM gcr.io/distroless/base:nonroot
-  COPY --from=builder /go/bin/preflight /bin/preflight
-  ADD ./preflight-packages /preflight-packages
-  ADD ./examples/pods.preflight.yaml /etc/preflight/preflight.yaml
-  ENTRYPOINT ["preflight"]
-  CMD ["check", "--config-file", "/etc/preflight/preflight.yaml"]
+# STAGE 2
+# Use a distroless nonroot base image for just our executable
+FROM gcr.io/distroless/base:nonroot
+COPY --from=builder /go/bin/preflight /bin/preflight
+ADD ./preflight-packages /preflight-packages
+# load in an example preflight.yaml
+ADD ./examples/pods.preflight.yaml /etc/preflight/preflight.yaml
+ENTRYPOINT ["preflight"]
+CMD ["check", "--config-file", "/etc/preflight/preflight.yaml"]