add better docs around all special cluster name including pgo CLI help text and hugo docs, also fix all support in label command

Author: jmccormick2001

apiserver/clusterservice/scaleimpl.go

@@ -39,6 +39,12 @@ func ScaleCluster(name, replicaCount, resourcesConfig, storageConfig, nodeLabel,
 	response := msgs.ClusterScaleResponse{}
 	response.Status = msgs.Status{Code: msgs.Ok, Msg: ""}
 
+	if name == "all" {
+		response.Status.Code = msgs.Error
+		response.Status.Msg = "all is not allowed for the scale command"
+		return response
+	}
+
 	cluster := crv1.Pgcluster{}
 	err = apiserver.RESTClient.Get().
 		Resource(crv1.PgclusterResourcePlural).

apiserver/labelservice/labelimpl.go

@@ -58,9 +58,7 @@ func Label(request *msgs.LabelRequest) msgs.LabelResponse {
 	}
 
 	clusterList := crv1.PgclusterList{}
-	if request.Selector != "" {
-		log.Debug("selector is " + request.Selector)
-
+	if request.Selector == "" || request.Args[0] == "all" {
 		err = kubeapi.GetpgclustersBySelector(apiserver.RESTClient,
 			&clusterList, request.Selector, apiserver.Namespace)
 		if err != nil {
@@ -75,7 +73,7 @@ func Label(request *msgs.LabelRequest) msgs.LabelResponse {
 			return resp
 		}
 	} else {
-		//each arg represents a cluster name or the special 'all' value
+		//each arg represents a cluster name
 		items := make([]crv1.Pgcluster, 0)
 		for _, cluster := range request.Args {
 			result := crv1.Pgcluster{}

apiserver/upgradeservice/upgradeimpl.go

@@ -170,7 +170,7 @@ func CreateUpgrade(request *msgs.CreateUpgradeRequest) msgs.CreateUpgradeRespons
 			&cl, arg, apiserver.Namespace)
 		if !found {
 			response.Status.Code = msgs.Error
-			response.Status.Msg = err.Error()
+			response.Status.Msg = arg + " is not a valid pgcluster"
 			return response
 		}
 

hugo/content/getting-started/_index.adoc

@@ -20,6 +20,16 @@ export CO_APISERVER_URL=https://10.104.47.110:8443
 pgo version
 ....
 
+== Cluster Names
+
+Many of the pgo commands take in a cluster name, in some cases
+the special name of *all* is accepted which will cause the
+command to be applied to all PostgreSQL clusters.  For
+example:
+....
+pgo df all
+....
+
 == General
 
 === Operator Version
@@ -309,7 +319,7 @@ the selected cluster, but will not delete the data or the backups unless specifi
 
 ==== Syntax
 
-$ pgo delete cluster NAME [FLAGS]
+$ pgo delete cluster NAME|all [FLAGS]
 
 ==== Flags
 
@@ -377,7 +387,7 @@ any and all specified options (such as whether crunchy_collect is enabled).
 
 ==== Syntax
 
-$ pgo show cluster NAME [FLAGS]
+$ pgo show cluster NAME|all [FLAGS]
 
 ==== Flags
 
@@ -439,7 +449,7 @@ out as connections are tried, along with the connection status.
 
 ==== Syntax
 
-$ pgo test NAME [FLAGS]
+$ pgo test NAME|all [FLAGS]
 
 ==== Flags
 
@@ -1000,7 +1010,7 @@ input being valid.
 
 ==== Syntax
 
-$ pgo label [NAME] [FLAGS]
+$ pgo label [NAME]|all [FLAGS]
 
 ==== Flags
 
@@ -1033,11 +1043,12 @@ pgo label mycluster --label=env=research
 Or if you wanted to apply if to a selection of clusters:
 ....
 pgo label --label=env=research  --selector=project=xray
+pgo label all --label=env=research 
 ....
 
 In the first example, a label of *env=research* is applied to the cluster
 *mycluster*. The second example will apply the label to any clusters that
-have an existing label of *project=xray* applied.
+have an existing label of *project=xray* applied or to all clusters.
 
 === Creating SQL Policies
 
@@ -1131,6 +1142,7 @@ pgo show cluster --selector=policy1=pgpolicy
 To delete a policy use the following form:
 ....
 pgo delete policy policy1
+pgo delete policy all
 ....
 
 === Loading Data

pgo/cmd/delete.go

@@ -197,6 +197,7 @@ var deleteClusterCmd = &cobra.Command{
 	Short: "Delete a PostgreSQL cluster",
 	Long: `Delete a PostgreSQL cluster. For example:
 
+    pgo delete cluster all
     pgo delete cluster mycluster`,
 	Run: func(cmd *cobra.Command, args []string) {
 		if len(args) == 0 && Selector == "" {

pgo/cmd/df.go

@@ -34,6 +34,7 @@ var dfCmd = &cobra.Command{
 	Long: `Displays the disk status for PostgreSQL clusters. For example:
 
 	pgo df mycluster
+	pgo df all
 	pgo df --selector=env=research`,
 	Run: func(cmd *cobra.Command, args []string) {
 		log.Debug("df called")

pgo/cmd/label.go

@@ -35,6 +35,7 @@ var labelCmd = &cobra.Command{
 
 	pgo label mycluster yourcluster --label=environment=prod
 	pgo label mycluster yourcluster --label=environment=prod  --delete-label
+	pgo label all --label=environment=prod 
 	pgo label --label=environment=prod --selector=name=mycluster
 	pgo label --label=environment=prod --selector=status=final --dry-run`,
 	Run: func(cmd *cobra.Command, args []string) {

pgo/cmd/show.go

@@ -194,6 +194,7 @@ var ShowClusterCmd = &cobra.Command{
 	Short: "Show cluster information",
 	Long: `Show a PostgreSQL cluster. For example:
 
+	pgo show cluster all
 	pgo show cluster mycluster`,
 	Run: func(cmd *cobra.Command, args []string) {
 		if Selector == "" && len(args) == 0 {

pgo/cmd/test.go

@@ -30,7 +30,9 @@ var testCmd = &cobra.Command{
 	Short: "Test cluster connectivity",
 	Long: `TEST allows you to test the connectivity for a cluster. For example:
 
-	pgo test mycluster`,
+	pgo test mycluster
+	pgo test --selector=env=research
+	pgo test all`,
 	Run: func(cmd *cobra.Command, args []string) {
 		log.Debug("test called")
 		if Selector == "" && len(args) == 0 {