Build into local directories rather than $GOPATH/bin

This makes it a bit easier to setup the project and allows it to be outside of $GOPATH/src. Issue: [ch9453]

Author: cbandy

Makefile

@@ -1,9 +1,7 @@
-GOPATH ?= $(HOME)/odev/go
-GOBIN ?= $(GOPATH)/bin
 
 # Default values if not already set
 ANSIBLE_VERSION ?= 2.9.*
-PGOROOT ?= $(GOPATH)/src/github.com/crunchydata/postgres-operator
+PGOROOT ?= $(CURDIR)
 PGO_BASEOS ?= centos7
 PGO_CMD ?= kubectl
 PGO_IMAGE_PREFIX ?= crunchydata
@@ -73,10 +71,12 @@ ifeq ("$(PGO_BASEOS)", "centos8")
 endif
 
 DEBUG_BUILD ?= false
-GCFLAGS=
+GO_BUILD = $(GO_CMD) build
+GO_CMD = $(GO_ENV) go
+
 # Disable optimizations if creating a debug build
 ifeq ("$(DEBUG_BUILD)", "true")
-GCFLAGS=all=-N -l
+GO_BUILD += -gcflags='all=-N -l'
 endif
 
 # To build a specific image, run 'make <name>-image' (e.g. 'make pgo-apiserver-image')
@@ -92,76 +92,65 @@ images = pgo-apiserver \
 crunchy-postgres-exporter \
 postgres-operator
 
-.PHONY: all installrbac setup setupnamespaces cleannamespaces bounce \
-deployoperator runmain runapiserver cli-docs clean push pull \
-release default
+.PHONY: all installrbac setup setupnamespaces cleannamespaces \
+deployoperator cli-docs clean push pull release
 
 
 #======= Main functions =======
 all: linuxpgo $(images:%=%-image)
 
 installrbac:
-cd deploy && ./install-rbac.sh
+PGOROOT='$(PGOROOT)' ./deploy/install-rbac.sh
 
 setup:
-./bin/get-deps.sh
+PGOROOT='$(PGOROOT)' ./bin/get-deps.sh
 
 setupnamespaces:
-cd deploy && ./setupnamespaces.sh
+PGOROOT='$(PGOROOT)' ./deploy/setupnamespaces.sh
 
 cleannamespaces:
-cd deploy && ./cleannamespaces.sh
-
-bounce:
-$(PGO_CMD) \
---namespace=$(PGO_OPERATOR_NAMESPACE) \
-get pod \
---selector=name=postgres-operator \
--o=jsonpath="{.items[0].metadata.name}" \
-| xargs $(PGO_CMD) --namespace=$(PGO_OPERATOR_NAMESPACE) delete pod
+PGOROOT='$(PGOROOT)' ./deploy/cleannamespaces.sh
 
 deployoperator:
-cd deploy && ./deploy.sh
+PGOROOT='$(PGOROOT)' ./deploy/deploy.sh
 
 
 #======= Binary builds =======
 build-pgo-apiserver:
-go install -gcflags='$(GCFLAGS)' apiserver.go
-cp $(GOBIN)/apiserver bin/
+$(GO_BUILD) -o bin/apiserver apiserver.go
 
 build-pgo-backrest:
-go install -gcflags='$(GCFLAGS)' pgo-backrest/pgo-backrest.go
-cp $(GOBIN)/pgo-backrest bin/pgo-backrest/
+$(GO_BUILD) -o bin/pgo-backrest/pgo-backrest pgo-backrest/pgo-backrest.go
 
 build-pgo-rmdata:
-go install -gcflags='$(GCFLAGS)' pgo-rmdata/pgo-rmdata.go
-cp $(GOBIN)/pgo-rmdata bin/pgo-rmdata/
+$(GO_BUILD) -o bin/pgo-rmdata/pgo-rmdata pgo-rmdata/pgo-rmdata.go
 
 build-pgo-scheduler:
-go install -gcflags='$(GCFLAGS)' pgo-scheduler/pgo-scheduler.go
-cp $(GOBIN)/pgo-scheduler bin/pgo-scheduler/
+$(GO_BUILD) -o bin/pgo-scheduler/pgo-scheduler pgo-scheduler/pgo-scheduler.go
 
 build-postgres-operator:
-go install -gcflags='$(GCFLAGS)' postgres-operator.go
-cp $(GOBIN)/postgres-operator bin/postgres-operator/
+$(GO_BUILD) -o bin/postgres-operator postgres-operator.go
 
 build-pgo-client:
-go install -gcflags='$(GCFLAGS)' pgo/pgo.go
-cp $(GOBIN)/pgo bin/pgo
+$(GO_BUILD) -o bin/pgo pgo/pgo.go
 
 build-pgo-%:
 $(info No binary build needed for $@)
 
 build-crunchy-postgres-exporter:
 $(info No binary build needed for $@)
 
-linuxpgo: build-pgo-client
+linuxpgo: GO_ENV += GOOS=linux GOARCH=amd64
+linuxpgo:
+$(GO_BUILD) -o bin/pgo pgo/pgo.go
 
+macpgo: GO_ENV += GOOS=darwin GOARCH=amd64
 macpgo:
-cd pgo && env GOOS=darwin GOARCH=amd64 go build pgo.go && mv pgo $(GOBIN)/pgo-mac
+$(GO_BUILD) -o bin/pgo-mac pgo/pgo.go
 
+winpgo: GO_ENV += GOOS=windows GOARCH=386
 winpgo:
-cd pgo && env GOOS=windows GOARCH=386 go build pgo.go && mv pgo.exe $(GOBIN)/pgo.exe
+$(GO_BUILD) -o bin/pgo.exe pgo/pgo.go
 
 
 #======= Image builds =======
@@ -221,11 +210,19 @@ cli-docs:
 cd $(PGOROOT)/docs/content/operatorcli/cli && go run $(PGOROOT)/pgo/generatedocs.go
 
 clean: clean-deprecated
-rm -rf $(GOPATH)/pkg/* $(GOBIN)/postgres-operator $(GOBIN)/apiserver $(GOBIN)/*pgo
+rm -f bin/apiserver
+rm -f bin/postgres-operator
+rm -f bin/pgo bin/pgo-mac bin/pgo.exe
+rm -f bin/pgo-backrest/pgo-backrest
+rm -f bin/pgo-rmdata/pgo-rmdata
+rm -f bin/pgo-scheduler/pgo-scheduler
 
 clean-deprecated:
 @# packages used to be downloaded into the vendor directory
 [ ! -d vendor ] || rm -r vendor
+@# executables used to be compiled into the $GOBIN directory
+[ ! -n '$(GOBIN)' ] || rm -f $(GOBIN)/postgres-operator $(GOBIN)/apiserver $(GOBIN)/*pgo
+[ ! -d bin/postgres-operator ] || rm -r bin/postgres-operator
 
 push: $(images:%=push-%) ;
 
@@ -243,9 +240,9 @@ release: linuxpgo macpgo winpgo
 cp -r $(PGOROOT)/examples $(RELTMPDIR)
 cp -r $(PGOROOT)/deploy $(RELTMPDIR)
 cp -r $(PGOROOT)/conf $(RELTMPDIR)
-cp $(GOBIN)/pgo $(RELTMPDIR)
-cp $(GOBIN)/pgo-mac $(RELTMPDIR)
-cp $(GOBIN)/pgo.exe $(RELTMPDIR)
+cp bin/pgo $(RELTMPDIR)
+cp bin/pgo-mac $(RELTMPDIR)
+cp bin/pgo.exe $(RELTMPDIR)
 cp $(PGOROOT)/examples/pgo-bash-completion $(RELTMPDIR)
 tar czvf $(RELFILE) -C $(RELTMPDIR) .
 

bin/.gitignore

@@ -1,2 +1,5 @@
-apiserver
-pgo
+/apiserver
+/pgo
+/pgo-mac
+/pgo.exe
+/postgres-operator

bin/get-deps.sh

@@ -18,17 +18,6 @@ BINDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 EVTDIR="$BINDIR/pgo-event"
 POSTGRES_EXPORTER_VERSION=0.8.0
 
-# Precondition checks
-if [ "$GOPATH" = "" ]; then
-# Alternatively, take dep approach of go env GOPATH later in the process
-echo "GOPATH not defined, exiting..." >&2
-exit 1
-fi
-if ! (echo $PATH | egrep -q "$GOPATH/bin") ; then
-echo '$GOPATH/bin not part of $PATH, exiting...' >&2
-exit 2
-fi
-
 
 # Idempotent installations
 if (yum repolist | egrep -q '^epel/') ; then

bin/postgres-operator/.gitignore

@@ -31,28 +31,12 @@ read -n1 -rsp $'Press any key to continue the upgrade or Ctrl+C to exit...\n'
 # Remove the current Operator
 $DIR/cleanup.sh
 
-# Set up the defined namespaces for use with the new Operator version
-$DIR/setupnamespaces.sh
-
-# Install the correct RBAC
-$DIR/install-rbac.sh
-
 # Deploy the new Operator
-$DIR/deploy.sh
-
-# Store the current location of the PGO client
-MYPGO=`which pgo`
-# Store the expected location of the PGO client
-BASHPGO="${GOBIN}/pgo"
-
-if [ "$MYPGO" != "$BASHPGO" ]; then
-
-echo "Current location\(${MYPG}O\) does not match the expected location \(${BASHPGO}\). You will need to manually install the updated Posgres Operator client in your preferred location."
+make -C "$(dirname $DIR)" setupnamespaces installrbac deployoperator build-pgo-client
 
-else
-# install the new PGO client
-go install $PGOROOT/pgo/pgo.go
-cp $GOBIN/pgo $PGOROOT/bin/pgo
+if [ ! "$(command -v pgo)" -ef "$(dirname $DIR)/bin/pgo" ]; then
+echo "Current location ($(command -v pgo)) does not match the expected location ($(dirname $DIR)/bin/pgo)." \
+'You will need to manually install the updated Postgres Operator client in your preferred location.'
 fi
 
 # Final instructions

bin/postgres-operator/README.txt

@@ -21,8 +21,7 @@ The following environment variables are expected by the steps in this guide:
 
 Variable | Example | Description
 -------- | ------- | -----------
-`GOPATH` | $HOME/odev | Golang project directory
-`PGOROOT` | $GOPATH/src/github.com/crunchydata/postgres-operator | Operator repository location
+`PGOROOT` | $HOME/postgres-operator | Operator repository location
 `PGO_CONF_DIR` | $PGOROOT/installers/ansible/roles/pgo-operator/files | Operator Config Template Directory
 `PGO_BASEOS` | {{< param centosBase >}} | Base OS for container images
 `PGO_CMD` | kubectl | Cluster management tool executable
@@ -38,9 +37,7 @@ Variable | Example | Description
 ## Other requirements
 
 * The development host has been created, has access to `yum` updates, and has a regular user account with `sudo` rights to run `yum`.
-* `GOPATH` points to a directory containing `src`,`pkg`, and `bin` directories.
-* The development host has `$GOPATH/bin` added to its `PATH` environment variable. Development tools will be installed to this path. Defining a `GOBIN` environment variable other than `$GOPATH/bin` may yield unexpected results.
-* The development host has `git` installed and has cloned the postgres-operator repository to `$GOPATH/src/github.com/crunchydata/postgres-operator`. Makefile targets below are run from the repository directory.
+* The development host has `git` installed and has cloned the [postgres-operator](https://github.com/CrunchyData/postgres-operator.git) repository. Makefile targets below are run from the repository directory.
 * Deploying the Operator will require deployment access to a Kubernetes or OpenShift cluster
 * Once you have cloned the git repository, you will need to download the CentOS 7 repository files and GPG keys and place them in the `$PGOROOT/conf` directory. You can do so with the following code:
 
@@ -61,7 +58,6 @@ Configuring build dependencies is automated via the `setup` target in the projec
 
 The setup target ensures the presence of:
 
-* `GOPATH` and `PATH` as described in the prerequisites
 * EPEL yum repository
 * [`go`](https://golang.org/) compiler version 1.13+
 * NSQ messaging binaries
@@ -109,7 +105,7 @@ This assumes you have Docker installed and running on your development host.
 By default, the Makefile will use buildah to build the container images, to override this default to use docker to build the images, set the IMGBUILDER variable to `docker`
 
 
-After a full compile, you will have a `pgo` binary in `$HOME/odev/bin` and the Operator images in your local Docker registry.
+After a full compile, you will have a `pgo` binary in `$PGOROOT/bin` and the Operator images in your local Docker registry.
 
 # Deployment
 

deploy/upgrade-pgo.sh

@@ -7,7 +7,7 @@ weight: 100
 
 A full installation of the Operator includes the following steps:
 
- - create a project structure
+ - get the Operator project
  - configure your environment variables
  - configure Operator templates
  - create security resources
@@ -23,24 +23,18 @@ The Operator can be deployed by multiple methods including:
  * Openshift Console installation using OLM
 
 
-## Default Installation - Create Project Structure
+## Default Installation - Get Project
 
-The Operator follows a golang project structure, you can create a structure as follows on your local Linux host:
+The Operator project is hosted on GitHub. You can get a copy using `git clone`:
 
- mkdir -p $HOME/odev/src/github.com/crunchydata $HOME/odev/bin $HOME/odev/pkg
- cd $HOME/odev/src/github.com/crunchydata
- git clone https://github.com/CrunchyData/postgres-operator.git
+ git clone -b v{{< param operatorVersion >}} https://github.com/CrunchyData/postgres-operator.git
  cd postgres-operator
-git checkout v{{< param operatorVersion >}}
-
-
-This creates a directory structure under your HOME directory name *odev* and clones the current Operator version to that structure. 
 
 ## Default Installation - Configure Environment
 
 Environment variables control aspects of the Operator installation. You can copy a sample set of Operator environment variables and aliases to your *.bashrc* file to work with.
 
- cat $HOME/odev/src/github.com/crunchydata/postgres-operator/examples/envs.sh >> $HOME/.bashrc
+ cat ./examples/envs.sh >> $HOME/.bashrc
  source $HOME/.bashrc
 
 ## Default Installation - Namespace Creation

docs/content/contributing/developer-setup.md

@@ -1,6 +1,3 @@
-export GOPATH=$HOME/odev
-export GOBIN=$GOPATH/bin
-export PATH=$PATH:$GOBIN
 # NAMESPACE is the list of namespaces the Operator will watch
 export NAMESPACE=pgouser1,pgouser2
 
@@ -15,7 +12,7 @@ export PGO_OPERATOR_NAMESPACE=pgo
 export PGO_CMD=kubectl
 
 # the directory location of the Operator scripts
-export PGOROOT=$GOPATH/src/github.com/crunchydata/postgres-operator
+export PGOROOT=$HOME/postgres-operator
 
 # the directory location of the Json Config Templates
 export PGO_CONF_DIR=$PGOROOT/installers/ansible/roles/pgo-operator/files