Skip to content

Commit d9a50f2

Browse files
author
Jeff McCormick
committed
update build docs with Makefile target description
1 parent 266cf64 commit d9a50f2

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ endif
1212

1313
#======= Main functions =======
1414
# cd pgo && env GOOS=darwin GOARCH=amd64 go build pgo.go
15+
macpgo: check-go-vars
16+
cd pgo && env GOOS=darwin GOARCH=amd64 go build pgo.go && mv pgo $(GOBIN)/pgo-mac
1517
setup:
1618
godep restore && ./bin/get-deps.sh
1719
deployoperator:
@@ -57,6 +59,8 @@ release: check-go-vars
5759
rm -rf $(RELTMPDIR) $(RELFILE)
5860
mkdir $(RELTMPDIR)
5961
cp $(GOBIN)/pgo $(RELTMPDIR)
62+
cp $(GOBIN)/pgo-mac $(RELTMPDIR)
63+
cp $(COROOT)/examples/pgo-bash-completion $(RELTMPDIR)
6064
cp $(COROOT)/examples/*pgo.yaml* $(RELTMPDIR)
6165
cp $(COROOT)/examples/*pgo.lspvc-template.json $(RELTMPDIR)
6266
cp $(COROOT)/examples/*pgo.csvload-template.json $(RELTMPDIR)

docs/build.asciidoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,25 @@ desired PVC to use when databases and clusters are created.
225225

226226
Strategies for deploying the operator can be found in the link:design.asciidoc[PostgreSQL Operator Design] document.
227227

228+
=== Makefile Targets
229+
230+
The following table describes the Makefile targets:
231+
.Makefile Targets
232+
[width="40%",frame="topbot",options="header,footer"]
233+
|======================
234+
|Target | Description
235+
|setup | fetch the dependent packages required to build with
236+
|deployoperator | deploy the Operator to Kubernetes
237+
|main | compile the postgres-operator
238+
|runmain | locally execute the postgres-operator
239+
|pgo | build the pgo binary
240+
|runpgo | run the pgo binary
241+
|clean | remove binaries and compiled packages, restore dependencies
242+
|operatorimage | compile and build the postgres-operator Docker image
243+
|lsimage | build the lspvc Docker image
244+
|csvloadimage | build the csvload Docker image
245+
|release | build the postgres-operator release
246+
|======================
228247
=== Configuration
229248

230249
The *pgo* client requires three configuration files be copied

0 commit comments

Comments
 (0)