- "content": "Table of Contents Project Structure Installation Prerequsites Basic Installation Create HostPath Directory Build Images \u0026amp; Deploy Makefile Targets Next Steps Latest Release: v3.1, 2018-08-01\n Project Structure First, define the following environment variables in .bashrc:\n export GOPATH=$HOME/odev export GOBIN=$GOPATH/bin export CO_NAMESPACE=demo export CO_CMD=kubectl export COROOT=$GOPATH/src/github.com/crunchydata/postgres-operator export CO_IMAGE_PREFIX=crunchydata export CO_IMAGE_TAG=centos7-3.1 export CO_BASEOS=centos7 When deploying on Openshift Container Platform, the CO_CMD environment variable should be:\n export CO_CMD=oc To perform an installation of the operator, first create the project structure as follows on your host, here we assume a local directory called odev -\n mkdir -p $HOME/odev/src $HOME/odev/bin $HOME/odev/pkg mkdir -p $GOPATH/src/github.com/crunchydata/ Next, get a tagged release of the source code -\n cd $GOPATH/src/github.com/crunchydata git clone https://github.com/CrunchyData/postgres-operator.git cd postgres-operator git checkout 3.1 Installation Prerequsites To run the operator and the pgo client, you will need the following -\n a running Kubernetes or OpenShift cluster\n the kubectl or oc clients installed in your PATH and configured to connect to the cluster (e.g. export KUBECONFIG=/etc/kubernetes/admin.conf)\n a Kubernetes namespace created and set to where you want the operator installed. For this install we assume a namespace of demo has been created.\n kubectl create -f examples/demo-namespace.json kubectl config set-context $(kubectl config current-context) --namespace=demo kubectl config view | grep namespace Warning The namespace used by the operator is determined by the CO_NAMESPACE environment variable setting.\n Permissions are granted to the Operator by means of a Service Account called postgres-operator. That service account is added to the Operator deployment.\n The postgres-operator service account is granted priviledges using a role binding pgo-role-binding.\n See here for more details on how to enable RBAC roles and modify the scope of the permissions to suit your needs.\n Basic Installation The basic installation uses the default operator configuration settings, these settings assume you want to use HostPath storage on your Kube cluster for database persistence. Other persistent options are available but require the Advanced Installation below.\n Create HostPath Directory The default Persistent Volume script assumes a default HostPath directory be created called /data:\n sudo mkdir /data sudo chown 777 /data Create some sample Persistent Volumes using the following script:\n go get github.com/blang/expenv $COROOT/pv/create-pv.sh Build Images \u0026amp; Deploy Packaged Images Packaged Images To pull prebuilt versions from Dockerhub of the postgres-operator containers, execute the following Makefile target -\n make pull To pull down the prebuilt pgo binaries, download the tar.gz release file from the following link -\n Github Releases\n extract (e.g. tar xvzf postgres-operator.3.1.tar.gz)\n cd $HOME tar xvzf ./postgres-operator.3.1.tar.gz copy pgo client to somewhere in your path (e.g. cp pgo /usr/local/bin)\n Next, deploy the operator to your Kubernetes cluster -\n cd $COROOT make deployoperator Build from Source Build from Source The purpose of this section is to illustrate how to build the PostgreSQL Operator from source. These are considered advanced installation steps and should be primarily used by developers or those wishing a more precise installation method.\n Requirements The postgres-operator runs on any Kubernetes and Openshift platform that supports Custom Resource Definitions. The Operator is tested on Kubeadm and OpenShift Container Platform environments.\n The operator is developed with the Golang versions greater than or equal to version 1.8. See Golang website for details on installing golang.\n The Operator project builds and operates with the following containers -\n PVC Listing Container\n Remove Data Container\n postgres-operator Container\n apiserver Container\n file load Container\n This Operator is developed and tested on the following operating systems but is known to run on other operating systems -\n CentOS 7\n RHEL 7\n Before compiling the Operator, it\u0026#8217;s necessary to install the Mercurial requirement.\n sudo yum -y install mercurial Then, install the project library dependencies. The godep dependency manager is used for this purpose. Then, compile the PostgreSQL Operator using the Makefile and deploy the operator to your Kubernetes cluster.\n cd $COROOT make setup make all make deployoperator Makefile Targets The following table describes the Makefile targets -\n Table 1. Makefile Targets Target Description all\n compile all binaries and build all images\n setup\n fetch the dependent packages required to build with\n deployoperator\n deploy the Operator (apiserver and postgers-operator) to Kubernetes\n main\n compile the postgres-operator\n runmain\n locally execute the postgres-operator\n pgo\n build the pgo binary\n runpgo\n run the pgo binary\n runapiserver\n run the apiserver binary outside of Kube\n clean\n remove binaries and compiled packages, restore dependencies\n operatorimage\n compile and build the postgres-operator Docker image\n apiserverimage\n compile and build the apiserver Docker image\n lsimage\n build the lspvc Docker image\n loadimage\n build the file load Docker image\n rmdataimage\n build the data deletion Docker image\n release\n build the postgres-operator release\n Next Steps Next, visit the Deployment page to deploy the Operator, verify the installation, and view various storage configurations.\n "
0 commit comments