diagnostics: enable per-diagnostic parameters

Adds the ability to specify parameters for individual diagnostics on the
command line (without proliferating flags).

Addresses #14640

Author: sosiouxme

contrib/completions/bash/oc

@@ -6,21 +6,26 @@ import (
 	"k8s.io/apimachinery/pkg/util/sets"
 	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
 
+	"github.com/openshift/origin/pkg/cmd/util/variable"
 	clientdiags "github.com/openshift/origin/pkg/oc/admin/diagnostics/diagnostics/client"
 	networkdiags "github.com/openshift/origin/pkg/oc/admin/diagnostics/diagnostics/network"
 	"github.com/openshift/origin/pkg/oc/admin/diagnostics/diagnostics/types"
 )
 
-var (
-	// availableClientDiagnostics contains the names of client diagnostics that can be executed
-	// during a single run of diagnostics. Add more diagnostics to the list as they are defined.
-	availableClientDiagnostics = sets.NewString(clientdiags.ConfigContextsName, clientdiags.DiagnosticPodName, networkdiags.NetworkDiagnosticName)
-)
+// availableClientDiagnostics returns definitions of client diagnostics that can be executed
+// during a single run of diagnostics. Add more diagnostics to the list as they are defined.
+func availableClientDiagnostics() types.DiagnosticList {
+	return types.DiagnosticList{clientdiags.ConfigContext{}, &clientdiags.DiagnosticPod{}, &networkdiags.NetworkDiagnostic{}}
+}
+
+func clientParameterizedDiagnostics() types.ParameterizedDiagnosticMap {
+	return types.NewParameterizedDiagnosticMap(&networkdiags.NetworkDiagnostic{})
+}
 
 // buildClientDiagnostics builds client Diagnostic objects based on the rawConfig passed in.
 // Returns the Diagnostics built, "ok" bool for whether to proceed or abort, and an error if any was encountered during the building of diagnostics.) {
-func (o DiagnosticsOptions) buildClientDiagnostics(rawConfig *clientcmdapi.Config) ([]types.Diagnostic, bool, error) {
-	available := availableClientDiagnostics
+func (o DiagnosticsConfig) buildClientDiagnostics(rawConfig *clientcmdapi.Config) ([]types.Diagnostic, bool, error) {
+	available := availableClientDiagnostics().Names()
 
 	networkClient, err := o.Factory.OpenshiftInternalNetworkClient()
 	kubeClient, clientErr := o.Factory.ClientSet()
@@ -30,7 +35,7 @@ func (o DiagnosticsOptions) buildClientDiagnostics(rawConfig *clientcmdapi.Confi
 	}
 
 	diagnostics := []types.Diagnostic{}
-	requestedDiagnostics := available.Intersection(sets.NewString(o.RequestedDiagnostics...)).List()
+	requestedDiagnostics := available.Intersection(sets.NewString(o.RequestedDiagnostics.List()...)).List()
 	for _, diagnosticName := range requestedDiagnostics {
 		switch diagnosticName {
 		case clientdiags.ConfigContextsName:
@@ -52,23 +57,18 @@ func (o DiagnosticsOptions) buildClientDiagnostics(rawConfig *clientcmdapi.Confi
 				Level:               o.LogOptions.Level,
 				Factory:             o.Factory,
 				PreventModification: o.PreventModification,
-				ImageTemplate:       o.ImageTemplate,
+				ImageTemplate:       variable.NewDefaultImageTemplate(),
 			})
 		case networkdiags.NetworkDiagnosticName:
-			diagnostics = append(diagnostics, &networkdiags.NetworkDiagnostic{
-				KubeClient:           kubeClient,
-				NetNamespacesClient:  networkClient.Network(),
-				ClusterNetworkClient: networkClient.Network(),
-				ClientFlags:          o.ClientFlags,
-				Level:                o.LogOptions.Level,
-				Factory:              o.Factory,
-				PreventModification:  o.PreventModification,
-				LogDir:               o.NetworkOptions.LogDir,
-				PodImage:             o.NetworkOptions.PodImage,
-				TestPodImage:         o.NetworkOptions.TestPodImage,
-				TestPodProtocol:      o.NetworkOptions.TestPodProtocol,
-				TestPodPort:          o.NetworkOptions.TestPodPort,
-			})
+			nd := o.ParameterizedDiagnostics[diagnosticName].(*networkdiags.NetworkDiagnostic)
+			nd.KubeClient = kubeClient
+			nd.NetNamespacesClient = networkClient.Network()
+			nd.ClusterNetworkClient = networkClient.Network()
+			nd.ClientFlags = o.ClientFlags
+			nd.Level = o.LogOptions.Level
+			nd.Factory = o.Factory
+			nd.PreventModification = o.PreventModification
+			diagnostics = append(diagnostics, nd)
 		default:
 			return nil, false, fmt.Errorf("unknown diagnostic: %v", diagnosticName)
 		}

contrib/completions/zsh/oc

@@ -25,27 +25,27 @@ import (
 	"k8s.io/kubernetes/pkg/apis/authorization"
 )
 
-var (
-	// availableClusterDiagnostics contains the names of cluster diagnostics that can be executed
-	// during a single run of diagnostics. Add more diagnostics to the list as they are defined.
-	availableClusterDiagnostics = sets.NewString(
-		agldiags.AggregatedLoggingName,
-		clustdiags.ClusterRegistryName,
-		clustdiags.ClusterRouterName,
-		clustdiags.ClusterRolesName,
-		clustdiags.ClusterRoleBindingsName,
-		clustdiags.MasterNodeName,
-		clustdiags.MetricsApiProxyName,
-		clustdiags.NodeDefinitionsName,
-		clustdiags.RouteCertificateValidationName,
-		clustdiags.ServiceExternalIPsName,
-	)
-)
+// availableClusterDiagnostics contains the names of cluster diagnostics that can be executed
+// during a single run of diagnostics. Add more diagnostics to the list as they are defined.
+func availableClusterDiagnostics() types.DiagnosticList {
+	return types.DiagnosticList{
+		&agldiags.AggregatedLogging{},
+		&clustdiags.ClusterRegistry{},
+		&clustdiags.ClusterRouter{},
+		&clustdiags.ClusterRoles{},
+		&clustdiags.ClusterRoleBindings{},
+		&clustdiags.MasterNode{},
+		&clustdiags.MetricsApiProxy{},
+		&clustdiags.NodeDefinitions{},
+		&clustdiags.RouteCertificateValidation{},
+		&clustdiags.ServiceExternalIPs{},
+	}
+}
 
 // buildClusterDiagnostics builds cluster Diagnostic objects if a cluster-admin client can be extracted from the rawConfig passed in.
 // Returns the Diagnostics built, "ok" bool for whether to proceed or abort, and an error if any was encountered during the building of diagnostics.) {
-func (o DiagnosticsOptions) buildClusterDiagnostics(rawConfig *clientcmdapi.Config) ([]types.Diagnostic, bool, error) {
-	requestedDiagnostics := availableClusterDiagnostics.Intersection(sets.NewString(o.RequestedDiagnostics...)).List()
+func (o DiagnosticsConfig) buildClusterDiagnostics(rawConfig *clientcmdapi.Config) ([]types.Diagnostic, bool, error) {
+	requestedDiagnostics := availableClusterDiagnostics().Names().Intersection(sets.NewString(o.RequestedDiagnostics.List()...)).List()
 	if len(requestedDiagnostics) == 0 { // no diagnostics to run here
 		return nil, true, nil // don't waste time on discovery
 	}
@@ -124,7 +124,7 @@ func (o DiagnosticsOptions) buildClusterDiagnostics(rawConfig *clientcmdapi.Conf
 }
 
 // attempts to find which context in the config might be a cluster-admin for the server in the current context.
-func (o DiagnosticsOptions) findClusterClients(rawConfig *clientcmdapi.Config) (*rest.Config, kclientset.Interface, bool, string, error) {
+func (o DiagnosticsConfig) findClusterClients(rawConfig *clientcmdapi.Config) (*rest.Config, kclientset.Interface, bool, string, error) {
 	if o.ClientClusterContext != "" { // user has specified cluster context to use
 		if context, exists := rawConfig.Contexts[o.ClientClusterContext]; !exists {
 			configErr := fmt.Errorf("Specified '%s' as cluster-admin context, but it was not found in your client configuration.", o.ClientClusterContext)
@@ -160,7 +160,7 @@ func (o DiagnosticsOptions) findClusterClients(rawConfig *clientcmdapi.Config) (
 }
 
 // makes the client from the specified context and determines whether it is a cluster-admin.
-func (o DiagnosticsOptions) makeClusterClients(rawConfig *clientcmdapi.Config, contextName string, context *clientcmdapi.Context) (*rest.Config, kclientset.Interface, bool, string, error) {
+func (o DiagnosticsConfig) makeClusterClients(rawConfig *clientcmdapi.Config, contextName string, context *clientcmdapi.Context) (*rest.Config, kclientset.Interface, bool, string, error) {
 	overrides := &clientcmd.ConfigOverrides{Context: *context}
 	clientConfig := clientcmd.NewDefaultClientConfig(*rawConfig, overrides)
 	serverUrl := rawConfig.Clusters[context.Cluster].Server

pkg/oc/admin/diagnostics/client.go

@@ -11,18 +11,21 @@ import (
 )
 
 // determine if we even have a client config
-func (o DiagnosticsOptions) detectClientConfig() (bool, []types.DiagnosticError, []types.DiagnosticError) {
+func (o DiagnosticsConfig) detectClientConfig() (bool, bool, []types.DiagnosticError, []types.DiagnosticError) {
+	if o.ClientFlags == nil {
+		return false, false, []types.DiagnosticError{}, []types.DiagnosticError{}
+	}
 	diagnostic := &clientdiagnostics.ConfigLoading{ConfFlagName: config.OpenShiftConfigFlagName, ClientFlags: o.ClientFlags}
 	o.Logger.Notice("CED2011", "Determining if client configuration exists for client/cluster diagnostics")
 	result := diagnostic.Check()
 	for _, entry := range result.Logs() {
 		o.Logger.LogEntry(entry)
 	}
-	return diagnostic.SuccessfulLoad(), result.Warnings(), result.Errors()
+	return true, diagnostic.SuccessfulLoad(), result.Warnings(), result.Errors()
 }
 
 // use the base factory to return a raw config (not specific to a context)
-func (o DiagnosticsOptions) buildRawConfig() (*clientcmdapi.Config, error) {
+func (o DiagnosticsConfig) buildRawConfig() (*clientcmdapi.Config, error) {
 	kubeConfig, configErr := o.Factory.OpenShiftClientConfig().RawConfig()
 	if configErr != nil {
 		return nil, configErr