Merge pull request #18186 from sosiouxme/20180117-openshift-diagnostics-unify

Automatic merge from submit-queue.

openshift-diagnostics => diagnostics subcommands

Builds on commit from #17773 (diagnostics: individual parameters).
Removes `openshift-diagnostics` in favor of hidden `oc adm diagnostics` subcommands as proposed with #18149 (comment).

Fixes https://bugzilla.redhat.com/show_bug.cgi?id=1534513 and #18141

Author: openshift-merge-robot

cmd/openshift-diagnostics/main.go

@@ -57,7 +57,7 @@ os::provision::install-cmds() {
   local deployed_root=$1
 
   local output_path="$(os::build::get-bin-output-path "${deployed_root}")"
-  cp ${output_path}/{openshift,openshift-diagnostics,oc} /usr/bin
+  cp ${output_path}/{openshift,oc} /usr/bin
 }
 
 os::provision::add-to-hosts-file() {

contrib/vagrant/provision-util.sh

@@ -566,7 +566,6 @@ function copy-runtime() {
   local target=$2
 
   cp "$(os::util::find::built_binary openshift)" "${target}"
-  cp "$(os::util::find::built_binary openshift-diagnostics)" "${target}"
   cp "$(os::util::find::built_binary oc)" "${target}"
   cp "$(os::util::find::built_binary host-local)" "${target}"
   cp "$(os::util::find::built_binary loopback)" "${target}"

docs/man/man1/.files_generated_oc

@@ -45,7 +45,6 @@ readonly OS_CROSS_COMPILE_TARGETS=(
   cmd/openshift
   cmd/oc
   cmd/oadm
-  cmd/openshift-diagnostics
   cmd/template-service-broker
   vendor/k8s.io/kubernetes/cmd/hyperkube
 )

docs/man/man1/oc-adm-diagnostics-inpod-networkcheck.1

@@ -70,7 +70,6 @@ RUN mkdir -p /opt/cni/bin
 # make reloading easy.  Revisit if/when dind becomes useful for more
 # than dev/test.
 RUN ln -sf /data/openshift /usr/local/bin/ && \
-    ln -sf /data/openshift-diagnostics /usr/local/bin/ && \
     ln -sf /data/oc        /usr/local/bin/ && \
     ln -sf /data/openshift /usr/local/bin/openshift-deploy && \
     ln -sf /data/openshift /usr/local/bin/openshift-docker-build && \

docs/man/man1/oc-adm-diagnostics-inpod-poddiagnostic.1

@@ -17,7 +17,9 @@ import (
 
 	"github.com/openshift/origin/pkg/client/config"
 	"github.com/openshift/origin/pkg/cmd/flagtypes"
+	clientdiag "github.com/openshift/origin/pkg/oc/admin/diagnostics/diagnostics/client"
 	"github.com/openshift/origin/pkg/oc/admin/diagnostics/diagnostics/log"
+	networkdiag "github.com/openshift/origin/pkg/oc/admin/diagnostics/diagnostics/network"
 	"github.com/openshift/origin/pkg/oc/admin/diagnostics/diagnostics/types"
 	"github.com/openshift/origin/pkg/oc/admin/diagnostics/options"
 	"github.com/openshift/origin/pkg/oc/admin/diagnostics/util"
@@ -131,6 +133,11 @@ func NewCmdDiagnostics(name string, fullName string, out io.Writer) *cobra.Comma
 	for _, diag := range available {
 		cmd.AddCommand(NewCmdDiagnosticsIndividual(strings.ToLower(diag.Name()), fullName+" "+strings.ToLower(diag.Name()), out, diag))
 	}
+	// add hidden in-pod subcommands
+	cmd.AddCommand(
+		NewCommandPodDiagnostics(clientdiag.InPodDiagnosticRecommendedName, out),
+		NewCommandNetworkPodDiagnostics(networkdiag.InPodNetworkCheckRecommendedName, out),
+	)
 
 	return cmd
 }

docs/man/man1/oc-ex-diagnostics-inpod-networkcheck.1

@@ -20,9 +20,10 @@ import (
 )
 
 const (
-	DiagnosticPodName  = "DiagnosticPod"
-	ImageTemplateParam = "images"
-	LatestImageParam   = "latest-images"
+	InPodDiagnosticRecommendedName = "inpod-poddiagnostic"
+	DiagnosticPodName              = "DiagnosticPod"
+	ImageTemplateParam             = "images"
+	LatestImageParam               = "latest-images"
 )
 
 // DiagnosticPod is a diagnostic that runs a diagnostic pod and relays the results.
@@ -87,7 +88,7 @@ func (d *DiagnosticPod) runDiagnosticPod(r types.DiagnosticResult) {
 				{
 					Name:    "pod-diagnostics",
 					Image:   imageName,
-					Command: []string{"openshift-diagnostics", "diagnostic-pod", "-l", strconv.Itoa(loglevel)},
+					Command: []string{"oc", "adm", "diagnostics", InPodDiagnosticRecommendedName, "-l", strconv.Itoa(loglevel)},
 				},
 			},
 		},

docs/man/man1/oc-ex-diagnostics-inpod-poddiagnostic.1

@@ -27,12 +27,13 @@ import (
 )
 
 const (
-	NetworkDiagnosticName          = "NetworkCheck"
-	FlagNetworkDiagLogDir          = "logdir"
-	FlagNetworkDiagPodImage        = "pod-image"
-	FlagNetworkDiagTestPodImage    = "test-pod-image"
-	FlagNetworkDiagTestPodProtocol = "test-pod-protocol"
-	FlagNetworkDiagTestPodPort     = "test-pod-port"
+	InPodNetworkCheckRecommendedName = "inpod-networkcheck"
+	NetworkDiagnosticName            = "NetworkCheck"
+	FlagNetworkDiagLogDir            = "logdir"
+	FlagNetworkDiagPodImage          = "pod-image"
+	FlagNetworkDiagTestPodImage      = "test-pod-image"
+	FlagNetworkDiagTestPodProtocol   = "test-pod-protocol"
+	FlagNetworkDiagTestPodPort       = "test-pod-port"
 )
 
 // NetworkDiagnostic is a diagnostic that runs a network diagnostic pod and relays the results.
@@ -181,7 +182,7 @@ func (d *NetworkDiagnostic) runNetworkDiagnostic() {
 	// In Collection phase, results from each node are moved to the user machine where the CLI cmd is executed.
 
 	// TEST Phase: Run network diagnostic pod on all valid nodes in parallel
-	command := fmt.Sprintf("openshift-diagnostics network-diagnostic-pod -l %d", loglevel)
+	command := fmt.Sprintf("oc adm diagnostics %s -l %d", InPodNetworkCheckRecommendedName, loglevel)
 	if err := d.runNetworkPod(command); err != nil {
 		d.res.Error("DNet2006", err, err.Error())
 		return

hack/dind-cluster.sh

@@ -49,10 +49,11 @@ func NewCommandNetworkPodDiagnostics(name string, out io.Writer) *cobra.Command
 	}
 
 	cmd := &cobra.Command{
-		Use:   name,
-		Short: "Within a privileged pod, run network diagnostics",
-		Long:  fmt.Sprintf(longNetworkPodDiagDescription),
-		Run:   commandRunFunc(o),
+		Use:    name,
+		Short:  "Within a privileged pod, run network diagnostics",
+		Long:   fmt.Sprintf(longNetworkPodDiagDescription),
+		Run:    commandRunFunc(o),
+		Hidden: true,
 	}
 	cmd.SetOutput(out) // for output re: usage / help
 

hack/lib/constants.sh

@@ -52,10 +52,11 @@ func NewCommandPodDiagnostics(name string, out io.Writer) *cobra.Command {
 	}
 
 	cmd := &cobra.Command{
-		Use:   name,
-		Short: "Within a pod, run pod diagnostics",
-		Long:  fmt.Sprintf(longPodDiagDescription),
-		Run:   commandRunFunc(o),
+		Use:    name,
+		Short:  "Within a pod, run pod diagnostics",
+		Long:   fmt.Sprintf(longPodDiagDescription),
+		Run:    commandRunFunc(o),
+		Hidden: true,
 	}
 	cmd.SetOutput(out) // for output re: usage / help