update kubectl-pg plugin (#1264)

* update kubectl-pg plugin
* fix remaining build issues and update go modules
* some more README updates

Author: FxKu

Makefile

@@ -85,7 +85,7 @@ mocks:
 	GO111MODULE=on go generate ./...
 
 tools:
-	GO111MODULE=on go get k8s.io/client-go@kubernetes-1.19.3
+	GO111MODULE=on go get k8s.io/client-go@kubernetes-1.20.2
 	GO111MODULE=on go get github.com/golang/mock/mockgen@v1.4.4
 	GO111MODULE=on go mod tidy
 
@@ -104,4 +104,4 @@ test:
 	GO111MODULE=on go test ./...
 
 e2e: docker # build operator image to be tested
-	cd e2e; make e2etest
+	cd e2e; make e2etest

go.mod

@@ -14,9 +14,9 @@ require (
 	golang.org/x/mod v0.4.0 // indirect
 	golang.org/x/tools v0.0.0-20201207204333-a835c872fcea // indirect
 	gopkg.in/yaml.v2 v2.4.0
-	k8s.io/api v0.19.4
-	k8s.io/apiextensions-apiserver v0.19.3
-	k8s.io/apimachinery v0.19.4
-	k8s.io/client-go v0.19.3
+	k8s.io/api v0.20.2
+	k8s.io/apiextensions-apiserver v0.19.4
+	k8s.io/apimachinery v0.20.2
+	k8s.io/client-go v0.20.2
 	k8s.io/code-generator v0.19.4
 )

go.sum

@@ -1,125 +1,137 @@
 # Kubectl Plugin for Zalando's Postgres Operator
 
-## Google Summer of Code 2019
-
-This plugin is a prototype developed as a part of GSoC 2019 under the organisation
-**The Postgres Operator**
-
-### GSoC Proposal
+This plugin is a prototype developed as a part of **Google Summer of Code 2019** under the [Postgres Operator](https://summerofcode.withgoogle.com/archive/2019/organizations/6187982082539520/) organization.
 
-[kubectl pg proposal](https://docs.google.com/document/d/1-WMy9HkfZ1XnnMbzplMe9rCzKrRMGaMz4owLVXXPb7w/edit)
+## Installation of kubectl pg plugin
 
-### Weekly Reports
+This project uses Go Modules for dependency management to build locally.
+Install go and enable go modules with ```export GO111MODULE=on```.
+From Go >=1.13 Go modules will be enabled by default.
 
-https://github.com/VineethReddy02/GSoC-Kubectl-Plugin-for-Postgres-Operator-tracker
-
- ### Final Project Report
- 
- https://gist.github.com/VineethReddy02/159283bd368a710379eaf0f6bd60a40a
- 
-
-### Installtion of kubectl pg plugin
-
-This project uses Go Modules for dependency management to build locally
-Install go and enable go modules ```export GO111MODULE=on```
-From Go >=1.13 Go modules will be enabled by default
-```
+```bash
 # Assumes you have a working KUBECONFIG
-$ GO111MODULE="on" 
-# As of now go by default doesn't support Go mods. So explicit enabling is required.
-$ GOPATH/src/github.com/zalando/postgres-operator/kubectl-pg  go mod vendor 
+$ GO111MODULE="on"
+$ GOPATH/src/github.com/zalando/postgres-operator/kubectl-pg  go mod vendor
 # This generate a vendor directory with all dependencies needed by the plugin.
 $ $GOPATH/src/github.com/zalando/postgres-operator/kubectl-pg  go install
 # This will place the kubectl-pg binary in your $GOPATH/bin
 ```
 
-### Before using the kubectl pg plugin make sure to set KUBECONFIG env varibale
+## Before using the kubectl pg plugin make sure to set KUBECONFIG env variable
 
 Ideally KUBECONFIG is found in $HOME/.kube/config else specify the KUBECONFIG path here.
+```export KUBECONFIG=$HOME/.kube/config```
 
-```export KUBECONFIG=$HOME/.kube/config``` 
-
-### To list all commands available in kubectl pg
+## List all commands available in kubectl pg
 
 ```kubectl pg --help``` (or) ```kubectl pg```
 
-### This basically means the operator pod managed to start, so our operator is installed.
+## Check if Postgres Operator is installed and running
 
 ```kubectl pg check```
 
-### To create postgresql cluster using manifest file
+## Create a new cluster using manifest file
 
 ```kubectl pg create -f acid-minimal-cluster.yaml```
 
-### To update existing cluster using manifest file
+## List postgres resources
+
+```kubectl pg list```
+
+List clusters across namespaces
+```kubectl pg list all```
+
+## Update existing cluster using manifest file
 
 ```kubectl pg update -f acid-minimal-cluster.yaml```
 
-### To delete existing cluster using manifest file
+## Delete existing cluster
 
+Using the manifest file:
 ```kubectl pg delete -f acid-minimal-cluster.yaml```
 
-### To delete existing cluster using cluster name
-
+Or by specifying the cluster name:
 ```kubectl pg delete acid-minimal-cluster```
 
---namespace or -n flag to specify namespace if cluster is in other namespace.
-
+Use `--namespace` or `-n` flag if your cluster is in a different namespace to where your current context is pointing to:
 ```kubectl pg delete acid-minimal-cluster -n namespace01```
 
-### To list postgres resources for the current namespace
+## Adding manifest roles to an existing cluster
 
-```kubectl pg list```
+```kubectl pg add-user USER01 -p CREATEDB,LOGIN -c acid-minimal-cluster```
 
-### To list postgres resources across namespaces
+Privileges can only be [SUPERUSER, REPLICATION, INHERIT, LOGIN, NOLOGIN, CREATEROLE, CREATEDB, BYPASSURL]
+Note: By default, a LOGIN user is created (unless NOLOGIN is specified).
 
-```kubectl pg list all```
+## Adding databases to an existing cluster
 
-### To add-user and it's roles to an existing pg cluster
+You have to specify an owner of the new database and this role must already exist in the cluster:
+```kubectl pg add-db DB01 -o OWNER01 -c acid-minimal-cluster```
 
-```kubectl pg add-user USER01 -p CREATEDB,LOGIN -c acid-minimal-cluster```
+## Extend the volume of an existing pg cluster
 
-Privileges can only be [SUPERUSER, REPLICATION, INHERIT, LOGIN, NOLOGIN, CREATEROLE, CREATEDB, BYPASSURL]
+```kubectl pg ext-volume 2Gi -c acid-minimal-cluster```
 
-Note: A login user is created by default unless NOLOGIN is specified, in which case the operator creates a role.
+## Print the version of Postgres Operator and kubectl pg plugin
 
-### To add-db and it's owner to an existing pg cluster
+```kubectl pg version```
 
-```kubectl pg add-db DB01 -o OWNER01 -c acid-minimal-cluster```
+## Connect to the shell of a postgres pod
 
-### To extend volume for an existing pg cluster
+Connect to the master pod:
+```kubectl pg connect -c CLUSTER -m```
 
-```kubectl pg ext-volume 2Gi -c acid-minimal-cluster```
+Connect to a random replica pod:
+```kubectl pg connect -c CLUSTER```
 
-### To find the version of postgres operator and kubectl plugin
+Connect to a certain replica pod:
+```kubectl pg connect -c CLUSTER -r 0```
 
-```kubectl pg version (optional -n NAMESPACE allows to know specific to a namespace)```
+## Connect to a database via psql
 
-### To connect to the shell of a postgres pod
+Adding the `-p` flag allows you to directly connect to a given database with the psql client.
+With `-u` you specify the user. If left out the name of the current OS user is taken.
+`-d` lets you specify the database. If no database is specified, it will be the same as the user name.
 
-```kubectl pg connect -c CLUSTER``` #This connects to a random pod
-```kubectl pg connect -c CLUSTER -m``` #This connects the master
-```kubectl pg connect -c CLUSTER -r 0``` #This connects to the desired replica
+Connect to `app_db` database on the master with role `app_user`:
+```kubectl pg connect -c CLUSTER -m -p -u app_user -d app_db```
 
-### To connect to the psql prompt
+Connect to the `postgres` database on a random replica with role `postgres`:
+```kubectl pg connect -c CLUSTER -p -u postgres```
 
-```kubectl pg connect -c CLUSTER -p -u username``` #This connects to a random pod. Not master
-```kubectl pg connect -c CLUSTER -m -p -u username``` #This connects the master
-```kubectl pg connect -c CLUSTER -r 0 -p -u username``` #This connects to the desired replica
+Connect to a certain replica assuming name of OS user, database role and name are all the same:
+```kubectl pg connect -c CLUSTER -r 0 -p```
 
-Note: -p represents psql prompt
 
-### To get the logs of postgres operator
+## Access Postgres Operator logs
 
 ```kubectl pg logs -o```
 
-### To get the logs of the postgres cluster
+## Access Patroni logs of different database pods
+
+Fetch logs of master:
+```kubectl pg logs -c CLUSTER -m```
+
+Fetch logs of a random replica pod:
+```kubectl pg logs -c CLUSTER```
 
-```kubectl pg logs -c CLUSTER``` #Fetches the logs of a random pod. Not master
-```kubectl pg logs -c CLUSTER -m``` #Fetches the logs of master
-```kubectl pg logs -c CLUSTER -r 2``` #Fecthes the logs of specified replica
+Fetch logs of specified replica
+```kubectl pg logs -c CLUSTER -r 2```
 
 ## Development
 
-- When making changes to plugin make sure to change the major or patch version
-of plugin in ```build.sh``` and run ```./build.sh``` 
+When making changes to the plugin make sure to change the (major/patch) version of plugin in `build.sh` script and run `./build.sh`.
+
+## Google Summer of Code 2019
+
+### GSoC Proposal
+
+[kubectl pg proposal](https://docs.google.com/document/d/1-WMy9HkfZ1XnnMbzplMe9rCzKrRMGaMz4owLVXXPb7w/edit)
+
+### Weekly Reports
+
+https://github.com/VineethReddy02/GSoC-Kubectl-Plugin-for-Postgres-Operator-tracker
+
+### Final Project Report
+
+https://gist.github.com/VineethReddy02/159283bd368a710379eaf0f6bd60a40a

kubectl-pg/README.md

@@ -23,13 +23,15 @@ THE SOFTWARE.
 package cmd
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
+	"log"
+
 	"github.com/spf13/cobra"
 	PostgresqlLister "github.com/zalando/postgres-operator/pkg/generated/clientset/versioned/typed/acid.zalan.do/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
-	"log"
 )
 
 // addDbCmd represents the addDb command
@@ -62,7 +64,7 @@ func addDb(dbName string, dbOwner string, clusterName string) {
 	}
 
 	namespace := getCurrentNamespace()
-	postgresql, err := postgresConfig.Postgresqls(namespace).Get(clusterName, metav1.GetOptions{})
+	postgresql, err := postgresConfig.Postgresqls(namespace).Get(context.TODO(), clusterName, metav1.GetOptions{})
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -84,7 +86,7 @@ func addDb(dbName string, dbOwner string, clusterName string) {
 		log.Fatal("The provided db-name is reserved by postgres")
 	}
 
-	updatedPostgres, err := postgresConfig.Postgresqls(namespace).Patch(postgresql.Name, types.MergePatchType, patch, "")
+	updatedPostgres, err := postgresConfig.Postgresqls(namespace).Patch(context.TODO(), postgresql.Name, types.MergePatchType, patch, metav1.PatchOptions{})
 	if err != nil {
 		log.Fatal(err)
 	}

kubectl-pg/cmd/addDb.go

@@ -23,14 +23,16 @@ THE SOFTWARE.
 package cmd
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
+	"log"
+	"strings"
+
 	"github.com/spf13/cobra"
 	PostgresqlLister "github.com/zalando/postgres-operator/pkg/generated/clientset/versioned/typed/acid.zalan.do/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
-	"log"
-	"strings"
 )
 
 var allowedPrivileges = []string{"SUPERUSER", "REPLICATION", "INHERIT", "LOGIN", "NOLOGIN", "CREATEROLE", "CREATEDB", "BYPASSURL"}
@@ -90,7 +92,7 @@ func addUser(user string, clusterName string, permissions []string) {
 	}
 
 	namespace := getCurrentNamespace()
-	postgresql, err := postgresConfig.Postgresqls(namespace).Get(clusterName, metav1.GetOptions{})
+	postgresql, err := postgresConfig.Postgresqls(namespace).Get(context.TODO(), clusterName, metav1.GetOptions{})
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -114,7 +116,7 @@ func addUser(user string, clusterName string, permissions []string) {
 	}
 
 	patch := applyUserPatch(user, Privileges)
-	updatedPostgresql, err := postgresConfig.Postgresqls(namespace).Patch(postgresql.Name, types.MergePatchType, patch, "")
+	updatedPostgresql, err := postgresConfig.Postgresqls(namespace).Patch(context.TODO(), postgresql.Name, types.MergePatchType, patch, metav1.PatchOptions{})
 	if err != nil {
 		log.Fatal(err)
 	}

kubectl-pg/cmd/addUser.go

@@ -23,6 +23,7 @@ THE SOFTWARE.
 package cmd
 
 import (
+	"context"
 	"fmt"
 	"log"
 
@@ -55,7 +56,7 @@ func check() *v1.CustomResourceDefinition {
 		log.Fatal(err)
 	}
 
-	crdInfo, err := apiExtClient.CustomResourceDefinitions().Get(postgresConstants.PostgresCRDResouceName, metav1.GetOptions{})
+	crdInfo, err := apiExtClient.CustomResourceDefinitions().Get(context.TODO(), postgresConstants.PostgresCRDResouceName, metav1.GetOptions{})
 	if err != nil {
 		log.Fatal(err)
 	}

kubectl-pg/cmd/check.go

@@ -23,13 +23,16 @@ THE SOFTWARE.
 package cmd
 
 import (
+	"context"
 	"fmt"
+	"io/ioutil"
+	"log"
+
 	"github.com/spf13/cobra"
 	v1 "github.com/zalando/postgres-operator/pkg/apis/acid.zalan.do/v1"
 	PostgresqlLister "github.com/zalando/postgres-operator/pkg/generated/clientset/versioned/typed/acid.zalan.do/v1"
-	"io/ioutil"
 	"k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/scheme"
-	"log"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // createCmd kubectl pg create.
@@ -62,7 +65,7 @@ func create(fileName string) {
 	}
 
 	postgresSql := obj.(*v1.Postgresql)
-	_, err = postgresConfig.Postgresqls(postgresSql.Namespace).Create(postgresSql)
+	_, err = postgresConfig.Postgresqls(postgresSql.Namespace).Create(context.TODO(), postgresSql, metav1.CreateOptions{})
 	if err != nil {
 		log.Fatal(err)
 	}