Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var AutocompleteClusterNamesTask = inspectiontaskbase.NewCachedTask(googlecloudk8scommon_contract.AutocompleteClusterNamesTaskID, []taskid.UntypedTaskReference{ googlecloudk8scommon_contract.ClusterNamePrefixTaskRef, googlecloudcommon_contract.InputProjectIdTaskID.Ref(), googlecloudcommon_contract.InputStartTimeTaskID.Ref(), googlecloudcommon_contract.InputEndTimeTaskID.Ref(), googlecloudk8scommon_contract.AutocompleteMetricsK8sContainerTaskID.Ref(), googlecloudcommon_contract.APIClientFactoryTaskID.Ref(), googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref(), }, func(ctx context.Context, prevValue inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]) (inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult], error) { clusterNamePrefix := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.ClusterNamePrefixTaskRef) projectID := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputProjectIdTaskID.Ref()) startTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputStartTimeTaskID.Ref()) endTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputEndTimeTaskID.Ref()) metricsType := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteMetricsK8sContainerTaskID.Ref()) cf := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientFactoryTaskID.Ref()) optionInjector := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref()) currentDigest := fmt.Sprintf("%s-%s-%d-%d", clusterNamePrefix, projectID, startTime.Unix(), endTime.Unix()) if projectID != "" && currentDigest == prevValue.DependencyDigest { return prevValue, nil } errorString := "" hintString := "" if endTime.Before(time.Now().Add(-time.Hour * 24 * 30 * 24)) { hintString = "The end time is more than 24 months ago. Suggested cluster names may not be complete." } client, err := cf.MonitoringMetricClient(ctx, googlecloud.Project(projectID)) if err != nil { return prevValue, fmt.Errorf("failed to create monitoring metric client: %w", err) } defer client.Close() ctx = optionInjector.InjectToCallContext(ctx, googlecloud.Project(projectID)) filter := fmt.Sprintf(`metric.type="%s" AND resource.type="k8s_container"`, metricsType) clusterNames, err := googlecloud.QueryDistinctLabelValuesFromMetrics(ctx, client, projectID, filter, startTime, endTime, "resource.label.cluster_name", "cluster_name") if err != nil { errorString = err.Error() } clusterNames = filterAndTrimPrefixFromClusterNames(clusterNames, clusterNamePrefix) if hintString == "" && errorString == "" && len(clusterNames) == 0 { hintString = fmt.Sprintf("No cluster names found between %s and %s. It is highly likely that the time range is incorrect. Please verify the time range, or proceed by manually entering the cluster name.", startTime.Format(time.RFC3339), endTime.Format(time.RFC3339)) } return inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]{ DependencyDigest: currentDigest, Value: &googlecloudk8scommon_contract.AutocompleteResult{ Values: clusterNames, Error: errorString, Hint: hintString, }, }, nil })
var AutocompleteMetricsK8sContainerTask = coretask.NewTask(googlecloudk8scommon_contract.AutocompleteMetricsK8sContainerTaskID, []taskid.UntypedTaskReference{}, func(ctx context.Context) (string, error) { return "kubernetes.io/anthos/up", nil })
AutocompleteMetricsK8sContainerTask is the task to provide the default metrics type to collect the cluster names. The resource type "k8s_container" must be available on the returned metrics type. This task is overriden in GKE clusters.
var AutocompleteMetricsK8sNodeTask = coretask.NewTask(googlecloudk8scommon_contract.AutocompleteMetricsK8sNodeTaskID, []taskid.UntypedTaskReference{}, func(ctx context.Context) (string, error) { return "kubernetes.io/anthos/up", nil })
var AutocompleteNamespacesTask = inspectiontaskbase.NewCachedTask(googlecloudk8scommon_contract.AutocompleteNamespacesTaskID, []taskid.UntypedTaskReference{ googlecloudk8scommon_contract.InputClusterNameTaskID.Ref(), googlecloudcommon_contract.InputProjectIdTaskID.Ref(), googlecloudcommon_contract.InputStartTimeTaskID.Ref(), googlecloudcommon_contract.InputEndTimeTaskID.Ref(), googlecloudcommon_contract.APIClientFactoryTaskID.Ref(), googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref(), googlecloudk8scommon_contract.AutocompleteMetricsK8sContainerTaskID.Ref(), }, func(ctx context.Context, prevValue inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]) (inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult], error) { projectID := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputProjectIdTaskID.Ref()) startTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputStartTimeTaskID.Ref()) endTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputEndTimeTaskID.Ref()) clusterName := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.InputClusterNameTaskID.Ref()) metricsType := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteMetricsK8sContainerTaskID.Ref()) cf := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientFactoryTaskID.Ref()) optionInjector := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref()) currentDigest := fmt.Sprintf("%s-%s-%d-%d", clusterName, projectID, startTime.Unix(), endTime.Unix()) if projectID != "" && currentDigest == prevValue.DependencyDigest { return prevValue, nil } errorString := "" hintString := "" if endTime.Before(time.Now().Add(-time.Hour * 24 * 30 * 24)) { hintString = "The end time is more than 24 months ago. Suggested namespace names may not be complete." } client, err := cf.MonitoringMetricClient(ctx, googlecloud.Project(projectID)) if err != nil { return prevValue, fmt.Errorf("failed to create monitoring metric client: %w", err) } defer client.Close() ctx = optionInjector.InjectToCallContext(ctx, googlecloud.Project(projectID)) filter := fmt.Sprintf(`metric.type="%s" AND resource.type="k8s_container" AND resource.label.cluster_name="%s"`, metricsType, clusterName) namespaces, err := googlecloud.QueryDistinctLabelValuesFromMetrics(ctx, client, projectID, filter, startTime, endTime, "resource.label.namespace_name", "namespace_name") if err != nil { errorString = err.Error() } if hintString == "" && errorString == "" && len(namespaces) == 0 { hintString = fmt.Sprintf("No namespace names found between %s and %s. It is highly likely that the time range is incorrect. Please verify the time range, or proceed by manually entering the namespace name.", startTime.Format(time.RFC3339), endTime.Format(time.RFC3339)) } return inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]{ DependencyDigest: currentDigest, Value: &googlecloudk8scommon_contract.AutocompleteResult{ Values: namespaces, Error: errorString, Hint: hintString, }, }, nil })
var AutocompleteNodeNamesTask = inspectiontaskbase.NewCachedTask(googlecloudk8scommon_contract.AutocompleteNodeNamesTaskID, []taskid.UntypedTaskReference{ googlecloudk8scommon_contract.InputClusterNameTaskID.Ref(), googlecloudcommon_contract.InputProjectIdTaskID.Ref(), googlecloudcommon_contract.InputStartTimeTaskID.Ref(), googlecloudcommon_contract.InputEndTimeTaskID.Ref(), googlecloudcommon_contract.APIClientFactoryTaskID.Ref(), googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref(), googlecloudk8scommon_contract.AutocompleteMetricsK8sNodeTaskID.Ref(), }, func(ctx context.Context, prevValue inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]) (inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult], error) { projectID := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputProjectIdTaskID.Ref()) startTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputStartTimeTaskID.Ref()) endTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputEndTimeTaskID.Ref()) clusterName := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.InputClusterNameTaskID.Ref()) metricsType := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteMetricsK8sNodeTaskID.Ref()) cf := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientFactoryTaskID.Ref()) optionInjector := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref()) currentDigest := fmt.Sprintf("%s-%s-%d-%d", clusterName, projectID, startTime.Unix(), endTime.Unix()) if projectID != "" && currentDigest == prevValue.DependencyDigest { return prevValue, nil } errorString := "" hintString := "" if endTime.Before(time.Now().Add(-time.Hour * 24 * 30 * 24)) { hintString = "The end time is more than 24 months ago. Suggested namespace names may not be complete." } client, err := cf.MonitoringMetricClient(ctx, googlecloud.Project(projectID)) if err != nil { return prevValue, fmt.Errorf("failed to create monitoring metric client: %w", err) } defer client.Close() ctx = optionInjector.InjectToCallContext(ctx, googlecloud.Project(projectID)) filter := fmt.Sprintf(`metric.type="%s" AND resource.type="k8s_node" AND resource.label.cluster_name="%s"`, metricsType, clusterName) nodes, err := googlecloud.QueryDistinctLabelValuesFromMetrics(ctx, client, projectID, filter, startTime, endTime, "resource.label.node_name", "node_name") if err != nil { errorString = err.Error() } if hintString == "" && errorString == "" && len(nodes) == 0 { hintString = fmt.Sprintf("No node names found between %s and %s. It is highly likely that the time range is incorrect. Please verify the time range, or proceed by manually entering the node name.", startTime.Format(time.RFC3339), endTime.Format(time.RFC3339)) } return inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]{ DependencyDigest: currentDigest, Value: &googlecloudk8scommon_contract.AutocompleteResult{ Values: nodes, Error: errorString, Hint: hintString, }, }, nil })
var AutocompletePodNamesTask = inspectiontaskbase.NewCachedTask(googlecloudk8scommon_contract.AutocompletePodNamesTaskID, []taskid.UntypedTaskReference{ googlecloudk8scommon_contract.InputClusterNameTaskID.Ref(), googlecloudcommon_contract.InputProjectIdTaskID.Ref(), googlecloudcommon_contract.InputStartTimeTaskID.Ref(), googlecloudcommon_contract.InputEndTimeTaskID.Ref(), googlecloudcommon_contract.APIClientFactoryTaskID.Ref(), googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref(), googlecloudk8scommon_contract.AutocompleteMetricsK8sContainerTaskID.Ref(), }, func(ctx context.Context, prevValue inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]) (inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult], error) { projectID := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputProjectIdTaskID.Ref()) startTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputStartTimeTaskID.Ref()) endTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputEndTimeTaskID.Ref()) clusterName := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.InputClusterNameTaskID.Ref()) metricsType := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteMetricsK8sContainerTaskID.Ref()) cf := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientFactoryTaskID.Ref()) optionInjector := coretask.GetTaskResult(ctx, googlecloudcommon_contract.APIClientCallOptionsInjectorTaskID.Ref()) currentDigest := fmt.Sprintf("%s-%s-%d-%d", clusterName, projectID, startTime.Unix(), endTime.Unix()) if projectID != "" && currentDigest == prevValue.DependencyDigest { return prevValue, nil } errorString := "" hintString := "" if endTime.Before(time.Now().Add(-time.Hour * 24 * 30 * 24)) { hintString = "The end time is more than 24 months ago. Suggested pod names may not be complete." } client, err := cf.MonitoringMetricClient(ctx, googlecloud.Project(projectID)) if err != nil { return prevValue, fmt.Errorf("failed to create monitoring metric client: %w", err) } defer client.Close() ctx = optionInjector.InjectToCallContext(ctx, googlecloud.Project(projectID)) filter := fmt.Sprintf(`metric.type="%s" AND resource.type="k8s_container" AND resource.label.cluster_name="%s"`, metricsType, clusterName) podNames, err := googlecloud.QueryDistinctLabelValuesFromMetrics(ctx, client, projectID, filter, startTime, endTime, "resource.label.pod_name", "pod_name") if err != nil { errorString = err.Error() } if hintString == "" && errorString == "" && len(podNames) == 0 { hintString = fmt.Sprintf("No pod names found between %s and %s. It is highly likely that the time range is incorrect. Please verify the time range, or proceed by manually entering the pod name.", startTime.Format(time.RFC3339), endTime.Format(time.RFC3339)) } return inspectiontaskbase.CacheableTaskResult[*googlecloudk8scommon_contract.AutocompleteResult]{ DependencyDigest: currentDigest, Value: &googlecloudk8scommon_contract.AutocompleteResult{ Values: podNames, Error: errorString, Hint: hintString, }, }, nil })
var DefaultK8sResourceMergeConfigTask = coretask.NewTask(googlecloudk8scommon_contract.K8sResourceMergeConfigTaskID, []taskid.UntypedTaskReference{}, func(ctx context.Context) (*k8s.K8sManifestMergeConfigRegistry, error) { return k8s.GenerateDefaultMergeConfig() })
DefaultK8sResourceMergeConfigTask return the default patch request merge config.
var HeaderSuggestedFileNameTask = inspectiontaskbase.NewInspectionTask(googlecloudk8scommon_contract.HeaderSuggestedFileNameTaskID, []taskid.UntypedTaskReference{ googlecloudcommon_contract.InputStartTimeTaskID.Ref(), googlecloudcommon_contract.InputEndTimeTaskID.Ref(), googlecloudk8scommon_contract.InputClusterNameTaskID.Ref(), }, func(ctx context.Context, taskMode inspectioncore_contract.InspectionTaskModeType) (struct{}, error) { metadataSet := khictx.MustGetValue(ctx, inspectioncore_contract.InspectionRunMetadata) header := typedmap.GetOrDefault(metadataSet, inspectionmetadata.HeaderMetadataKey, &inspectionmetadata.HeaderMetadata{}) clusterName := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.InputClusterNameTaskID.Ref()) endTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputEndTimeTaskID.Ref()) startTime := coretask.GetTaskResult(ctx, googlecloudcommon_contract.InputStartTimeTaskID.Ref()) header.SuggestedFileName = getSuggestedFileName(clusterName, startTime, endTime) return struct{}{}, nil }, coretask.NewRequiredTaskLabel(), inspectioncore_contract.InspectionTypeLabel(googlecloudinspectiontypegroup_contract.GCPK8sClusterInspectionTypes...))
HeaderSuggestedFileNameTask is a task to supply the suggested file name of the KHI file generated. This name is used in frontend to save the inspection data as a file.
var InputClusterNameTask = formtask.NewTextFormTaskBuilder(googlecloudk8scommon_contract.InputClusterNameTaskID, googlecloudcommon_contract.PriorityForResourceIdentifierGroup+4000, "Cluster name"). WithDependencies([]taskid.UntypedTaskReference{googlecloudk8scommon_contract.AutocompleteClusterNamesTaskID.Ref(), googlecloudk8scommon_contract.ClusterNamePrefixTaskRef}). WithDescription("The cluster name to gather logs."). WithDefaultValueFunc(func(ctx context.Context, previousValues []string) (string, error) { clusters := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteClusterNamesTaskID.Ref()) if len(previousValues) > 0 && slices.Index(clusters.Values, previousValues[0]) > -1 { return previousValues[0], nil } if len(clusters.Values) == 0 { return "", nil } return clusters.Values[0], nil }). WithSuggestionsFunc(func(ctx context.Context, value string, previousValues []string) ([]string, error) { clusters := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteClusterNamesTaskID.Ref()) return common.SortForAutocomplete(value, clusters.Values), nil }). WithHintFunc(func(ctx context.Context, value string, convertedValue any) (string, inspectionmetadata.ParameterHintType, error) { clusters := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteClusterNamesTaskID.Ref()) prefix := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.ClusterNamePrefixTaskRef) if clusters.Error != "" { return fmt.Sprintf("Failed to obtain the cluster list due to the error '%s'.\n The suggestion list won't popup", clusters.Error), inspectionmetadata.Warning, nil } if clusters.Hint != "" { return clusters.Hint, inspectionmetadata.Info, nil } convertedWithoutPrefix := strings.TrimPrefix(convertedValue.(string), prefix) for _, suggestedCluster := range clusters.Values { if suggestedCluster == convertedWithoutPrefix { return "", inspectionmetadata.Info, nil } } return fmt.Sprintf("Cluster `%s` was not found in the specified project at this time. It works for the clusters existed in the past but make sure the cluster name is right if you believe the cluster should be there.", value), inspectionmetadata.Warning, nil }). WithValidator(func(ctx context.Context, value string) (string, error) { if !clusterNameValidator.Match([]byte(value)) { return "Cluster name must match `^[0-9a-z:\\-]+$`", nil } return "", nil }). WithConverter(func(ctx context.Context, value string) (string, error) { prefix := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.ClusterNamePrefixTaskRef) return prefix + strings.TrimSpace(value), nil }). Build()
InputClusterNameTask is a form task receving cluster name from the user. This task return the cluster name with the prefixes defined from the cluster type. For example, a cluster named foo-cluster is `foo-cluster` in GKE but `awsCluster/foo-cluster` in GKE on AWS. This input also supports autocomplete cluster names from some task having ID for googlecloudk8scommon_contract.AutocompleteClusterNamesTaskID.
var InputKindFilterTask = formtask.NewSetFormTaskBuilder(googlecloudk8scommon_contract.InputKindFilterTaskID, googlecloudcommon_contract.PriorityForK8sResourceFilterGroup+5000, "Kind"). WithDefaultValueConstant([]string{"@default"}, true). WithDescription("The kinds of resources to gather logs. `@default` is a alias of set of kinds that frequently queried. Specify `@any` to query every kinds of resources"). WithAllowAddAll(false). WithAllowRemoveAll(false). WithAllowCustomValue(true). WithOptionsFunc(func(ctx context.Context, previousValues []string) ([]inspectionmetadata.SetParameterFormFieldOptionItem, error) { result := []inspectionmetadata.SetParameterFormFieldOptionItem{} result = append(result, inspectionmetadata.SetParameterFormFieldOptionItem{ID: "@any", Description: "[Alias]An alias matches any of the kinds"}) result = append(result, inspectionmetadata.SetParameterFormFieldOptionItem{ID: "@default", Description: "[Alias]An alias matches a set of kinds that frequently queried."}) return result, nil }). WithValidator(func(ctx context.Context, value []string) (string, error) { if len(value) == 0 { return "kind filter can't be empty", nil } filterInStr := strings.Join(value, " ") result, err := gcpqueryutil.ParseSetFilter(filterInStr, inputKindNameAliasMap, true, true, true) if err != nil { return "", err } return result.ValidationError, nil }). WithConverter(func(ctx context.Context, value []string) (*gcpqueryutil.SetFilterParseResult, error) { filterInStr := strings.Join(value, " ") result, err := gcpqueryutil.ParseSetFilter(filterInStr, inputKindNameAliasMap, true, true, true) if err != nil { return nil, err } return result, nil }). Build()
InputKindFilterTask is a form task for inputting the kind filter.
var InputNamespaceFilterTask = formtask.NewSetFormTaskBuilder(googlecloudk8scommon_contract.InputNamespaceFilterTaskID, googlecloudcommon_contract.PriorityForK8sResourceFilterGroup+4000, "Namespaces"). WithDependencies([]taskid.UntypedTaskReference{googlecloudk8scommon_contract.AutocompleteNamespacesTaskID.Ref()}). WithDefaultValueConstant([]string{"@all_cluster_scoped", "@all_namespaced"}, true). WithDescription("The namespace of resources to gather logs. Specify `@all_cluster_scoped` to gather logs for all non-namespaced resources. Specify `@all_namespaced` to gather logs for all namespaced resources."). WithAllowAddAll(false). WithAllowRemoveAll(false). WithAllowCustomValue(true). WithOptionsFunc(func(ctx context.Context, previousValues []string) ([]inspectionmetadata.SetParameterFormFieldOptionItem, error) { result := []inspectionmetadata.SetParameterFormFieldOptionItem{ {ID: "@all_cluster_scoped", Description: "[Alias] An alias matches any of the cluster scoped resources"}, {ID: "@all_namespaced", Description: "[Alias] An alias matches any of the namespaced resources"}, } namespaces := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteNamespacesTaskID.Ref()) for index, namespace := range namespaces.Values { if index >= maxNamespaceFilterOptions { break } result = append(result, inspectionmetadata.SetParameterFormFieldOptionItem{ID: namespace}) } return result, nil }). WithHintFunc(func(ctx context.Context, value []string, convertedValue any) (string, inspectionmetadata.ParameterHintType, error) { namespaces := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteNamespacesTaskID.Ref()) if len(namespaces.Values) > maxNamespaceFilterOptions { return fmt.Sprintf("Some namespaces are not shown on the suggestion list because the number of namespaces is %d, which is more than %d.", len(namespaces.Values), maxNamespaceFilterOptions), inspectionmetadata.Warning, nil } return "", inspectionmetadata.None, nil }). WithValidator(func(ctx context.Context, value []string) (string, error) { if len(value) == 0 { return "namespace filter can't be empty", nil } namespaceFilterInStr := strings.Join(value, " ") result, err := gcpqueryutil.ParseSetFilter(namespaceFilterInStr, inputNamespacesAliasMap, false, false, true) if err != nil { return "", err } return result.ValidationError, nil }). WithConverter(func(ctx context.Context, value []string) (*gcpqueryutil.SetFilterParseResult, error) { namespaceFilterInStr := strings.Join(value, " ") result, err := gcpqueryutil.ParseSetFilter(namespaceFilterInStr, inputNamespacesAliasMap, false, false, true) if err != nil { return nil, err } return result, nil }). Build()
InputNamespaceFilterTask is a form task for inputting the namespace filter.
var InputNodeNameFilterTask = formtask.NewSetFormTaskBuilder(googlecloudk8scommon_contract.InputNodeNameFilterTaskID, googlecloudcommon_contract.PriorityForK8sResourceFilterGroup+3000, "Node names"). WithDependencies([]taskid.UntypedTaskReference{googlecloudk8scommon_contract.AutocompleteNodeNamesTaskID.Ref()}). WithDefaultValueConstant([]string{}, true). WithDescription("A space-separated list of node name substrings used to collect node-related logs. If left blank, KHI gathers logs from all nodes in the cluster."). WithAllowAddAll(false). WithAllowRemoveAll(false). WithAllowCustomValue(true). WithValidator(func(ctx context.Context, value []string) (string, error) { for _, v := range value { if !nodeNameSubstringValidator.MatchString(v) { return fmt.Sprintf("invalid node name substring: %s", v), nil } } return "", nil }). WithOptionsFunc(func(ctx context.Context, prevValue []string) ([]inspectionmetadata.SetParameterFormFieldOptionItem, error) { result := []inspectionmetadata.SetParameterFormFieldOptionItem{} nodeNames := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteNodeNamesTaskID.Ref()) for i, v := range nodeNames.Values { if i >= maxNodeNameFilterOptions { break } result = append(result, inspectionmetadata.SetParameterFormFieldOptionItem{ID: v}) } return result, nil }). WithHintFunc(func(ctx context.Context, value []string, convertedValue any) (string, inspectionmetadata.ParameterHintType, error) { nodeNames := coretask.GetTaskResult(ctx, googlecloudk8scommon_contract.AutocompleteNodeNamesTaskID.Ref()) if len(nodeNames.Values) > maxNodeNameFilterOptions { return fmt.Sprintf("Some node names are not shown on the suggestion list because the number of node names is %d, which is more than %d.", len(nodeNames.Values), maxNodeNameFilterOptions), inspectionmetadata.Warning, nil } return "", inspectionmetadata.None, nil }). Build()
InputNodeNameFilterTask is a task to collect list of substrings of node names. This input value is used in querying k8s_node or serialport logs.
var NEGNamesDiscoveryTask = googlecloudk8scommon_contract.NEGNamesInventoryTaskBuilder.DiscoveryTask(googlecloudk8scommon_contract.NEGNamesDiscoveryTaskID, []taskid.UntypedTaskReference{ commonlogk8sauditv2_contract.ManifestGeneratorTaskID.Ref(), }, func(ctx context.Context, taskMode inspectioncore_contract.InspectionTaskModeType, progress *inspectionmetadata.TaskProgressMetadata) (googlecloudk8scommon_contract.NEGNameToResourceIdentityMap, error) { if taskMode == inspectioncore_contract.TaskModeDryRun { return nil, nil } result := googlecloudk8scommon_contract.NEGNameToResourceIdentityMap{} resourceLogs := coretask.GetTaskResult(ctx, commonlogk8sauditv2_contract.ManifestGeneratorTaskID.Ref()) for _, group := range resourceLogs { if group.Resource.Type() != commonlogk8sauditv2_contract.Resource { continue } if group.Resource.APIVersion != "networking.gke.io/v1beta1" || group.Resource.Kind != "servicenetworkendpointgroup" { continue } result[group.Resource.Name] = *group.Resource } return result, nil }, )
var NEGNamesInventoryTask = googlecloudk8scommon_contract.NEGNamesInventoryTaskBuilder.InventoryTask(&negNamesInventoryMergerStrategy{})
Functions ¶
func Register ¶
func Register(registry coreinspection.InspectionTaskRegistry) error
Register registers all googlecloudk8scommon inspection tasks to the registry.
Types ¶
This section is empty.