-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add NetworkPolicy Recommendation on Snowflake Backend
In this commit, we add the NetworkPolicy Recommendation Application on the Snowflake backend. NetworkPolicy Recommendation is implemented as Snowflake UDFs and could be running on Snowflake warehouses. Users could start it using command policy-recommendation in theia-sf CLI tool. NetworkPolicy Recommendation UDFs are written in Python and stored under udf/ directory. Signed-off-by: Yongming Ding <dyongming@vmware.com>
- Loading branch information
1 parent
b7bb772
commit 8f45932
Showing
23 changed files
with
2,563 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,285 @@ | ||
| // Copyright 2022 Antrea Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/google/uuid" | ||
| "github.com/spf13/cobra" | ||
|
|
||
| "antrea.io/theia/snowflake/pkg/infra" | ||
| "antrea.io/theia/snowflake/pkg/udfs" | ||
| "antrea.io/theia/snowflake/pkg/utils/timestamps" | ||
| ) | ||
|
|
||
| const ( | ||
| staticPolicyRecommendationFunctionName = "static_policy_recommendation" | ||
| preprocessingFunctionName = "preprocessing" | ||
| policyRecommendationFunctionName = "policy_recommendation" | ||
| defaultFunctionVersion = "v0.1.0" | ||
| defaultWaitTimeout = "10m" | ||
| // Limit the number of rows per partition to avoid hitting the 5 minutes end_partition() timeout. | ||
| partitionSizeLimit = 30000 | ||
| ) | ||
|
|
||
| func buildPolicyRecommendationUdfQuery(jobType string, limit uint, isolationMethod int, start string, end string, startTs string, endTs string, nsAllowList string, labelIgnoreList string, clusterUUID string, databaseName string, functionVersion string) (string, error) { | ||
| now := time.Now() | ||
| recommendationID := uuid.New().String() | ||
| functionName := udfs.GetFunctionName(staticPolicyRecommendationFunctionName, functionVersion) | ||
| query := fmt.Sprintf(`SELECT r.jobType, r.recommendationId, r.timeCreated, r.yamls FROM | ||
| TABLE(%s( | ||
| '%s', | ||
| '%s', | ||
| %d, | ||
| '%s' | ||
| ) over (partition by 1)) as r; | ||
| `, functionName, jobType, recommendationID, isolationMethod, nsAllowList) | ||
|
|
||
| query += `WITH filtered_flows AS ( | ||
| SELECT | ||
| sourcePodNamespace, | ||
| sourcePodLabels, | ||
| destinationIP, | ||
| destinationPodNamespace, | ||
| destinationPodLabels, | ||
| destinationServicePortName, | ||
| destinationTransportPort, | ||
| protocolIdentifier, | ||
| flowType | ||
| FROM | ||
| flows | ||
| ` | ||
|
|
||
| query += `WHERE | ||
| ingressNetworkPolicyName IS NULL | ||
| AND | ||
| egressNetworkPolicyName IS NULL | ||
| ` | ||
|
|
||
| var startTime string | ||
| if startTs != "" { | ||
| startTime = startTs | ||
| } else if start != "" { | ||
| var err error | ||
| startTime, err = timestamps.ParseTimestamp(start, now) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| } | ||
| if startTime != "" { | ||
| query += fmt.Sprintf(`AND | ||
| flowStartSeconds >= '%s' | ||
| `, startTime) | ||
| } | ||
|
|
||
| var endTime string | ||
| if endTs != "" { | ||
| endTime = endTs | ||
| } else if end != "" { | ||
| var err error | ||
| endTime, err = timestamps.ParseTimestamp(end, now) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| } | ||
| if endTime != "" { | ||
| query += fmt.Sprintf(`AND | ||
| flowEndSeconds >= '%s' | ||
| `, endTime) | ||
| } | ||
|
|
||
| if clusterUUID != "" { | ||
| _, err := uuid.Parse(clusterUUID) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| query += fmt.Sprintf(`AND | ||
| clusterUUID = '%s' | ||
| `, clusterUUID) | ||
| } else { | ||
| logger.Info("No clusterUUID input, all flows will be considered during policy recommendation.") | ||
| } | ||
|
|
||
| query += `GROUP BY | ||
| sourcePodNamespace, | ||
| sourcePodLabels, | ||
| destinationIP, | ||
| destinationPodNamespace, | ||
| destinationPodLabels, | ||
| destinationServicePortName, | ||
| destinationTransportPort, | ||
| protocolIdentifier, | ||
| flowType | ||
| ` | ||
|
|
||
| if limit > 0 { | ||
| query += fmt.Sprintf(` | ||
| LIMIT %d`, limit) | ||
| } else { | ||
| // limit the number unique flow records to 500k to avoid udf timeout | ||
| query += ` | ||
| LIMIT 500000` | ||
| } | ||
|
|
||
| // Choose the destinationIP as the partition field for the preprocessing | ||
| // UDTF because flow rows could be divided into the most subsets | ||
| functionName = udfs.GetFunctionName(preprocessingFunctionName, functionVersion) | ||
| query += fmt.Sprintf(`), processed_flows AS (SELECT r.appliedTo, r.ingress, r.egress FROM filtered_flows AS f, | ||
| TABLE(%s( | ||
| '%s', | ||
| %d, | ||
| '%s', | ||
| '%s', | ||
| f.sourcePodNamespace, | ||
| f.sourcePodLabels, | ||
| f.destinationIP, | ||
| f.destinationPodNamespace, | ||
| f.destinationPodLabels, | ||
| f.destinationServicePortName, | ||
| f.destinationTransportPort, | ||
| f.protocolIdentifier, | ||
| f.flowType | ||
| ) over (partition by f.destinationIP)) as r | ||
| `, functionName, jobType, isolationMethod, nsAllowList, labelIgnoreList) | ||
|
|
||
| // Scan the row number for each appliedTo group and divide the partitions | ||
| // larger than partitionSizeLimit. | ||
| query += fmt.Sprintf(`), pf_with_index AS ( | ||
| SELECT | ||
| pf.appliedTo, | ||
| pf.ingress, | ||
| pf.egress, | ||
| floor((Row_number() over (partition by pf.appliedTo order by egress))/%d) as row_index | ||
| FROM processed_flows as pf | ||
| `, partitionSizeLimit) | ||
|
|
||
| // Choose the appliedTo as the partition field for the policyRecommendation | ||
| // UDTF because each network policy is recommended based on all ingress and | ||
| // egress traffic related to an appliedTo group. | ||
| functionName = udfs.GetFunctionName(policyRecommendationFunctionName, functionVersion) | ||
| query += fmt.Sprintf(`) SELECT r.jobType, r.recommendationId, r.timeCreated, r.yamls FROM pf_with_index, | ||
| TABLE(%s( | ||
| '%s', | ||
| '%s', | ||
| %d, | ||
| '%s', | ||
| pf_with_index.appliedTo, | ||
| pf_with_index.ingress, | ||
| pf_with_index.egress | ||
| ) over (partition by pf_with_index.appliedTo, pf_with_index.row_index)) as r | ||
| `, functionName, jobType, recommendationID, isolationMethod, nsAllowList) | ||
|
|
||
| return query, nil | ||
| } | ||
|
|
||
| // policyRecommendationCmd represents the policy-recommendation command | ||
| var policyRecommendationCmd = &cobra.Command{ | ||
| Use: "policy-recommendation", | ||
| Short: "Run the policy recommendation UDF in Snowflake", | ||
| Long: `This command runs the policy recommendation UDF in Snowflake. | ||
| You need to bring your own Snowflake account and created the policy | ||
| recommendation UDF using the create-udfs command first. | ||
| Run policy recommendation with default configuration on database ANTREA_C9JR8KUKUIV4R72S: | ||
| "theia-sf policy-recommendation --database-name ANTREA_C9JR8KUKUIV4R72S" | ||
| The "policy-recommendation" command requires a Snowflake warehouse to run policy | ||
| recommendation UDFs in Snowflake. By default, it will create a temporary one. | ||
| You can also bring your own by using the "--warehouse-name" parameter. | ||
| `, | ||
| Args: cobra.NoArgs, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| jobType, _ := cmd.Flags().GetString("type") | ||
| if jobType != "initial" && jobType != "subsequent" { | ||
| return fmt.Errorf("invalid --type argument") | ||
| } | ||
| limit, _ := cmd.Flags().GetUint("limit") | ||
| isolationMethod, _ := cmd.Flags().GetInt("isolationMethod") | ||
| if isolationMethod < 1 && isolationMethod > 3 { | ||
| return fmt.Errorf("invalid -isolationMethod argument") | ||
| } | ||
| start, _ := cmd.Flags().GetString("start") | ||
| end, _ := cmd.Flags().GetString("end") | ||
| startTs, _ := cmd.Flags().GetString("start-ts") | ||
| endTs, _ := cmd.Flags().GetString("end-ts") | ||
| nsAllowList, _ := cmd.Flags().GetString("ns-allow") | ||
| labelIgnoreList, _ := cmd.Flags().GetString("label-ignore") | ||
| clusterUUID, _ := cmd.Flags().GetString("cluster-uuid") | ||
| databaseName, _ := cmd.Flags().GetString("database-name") | ||
| warehouseName, _ := cmd.Flags().GetString("warehouse-name") | ||
| functionVersion, _ := cmd.Flags().GetString("udf-version") | ||
| waitTimeout, _ := cmd.Flags().GetString("wait-timeout") | ||
| waitDuration, err := time.ParseDuration(waitTimeout) | ||
| if err != nil { | ||
| return fmt.Errorf("invalid --wait-timeout argument, err when parsing it as a duration: %v", err) | ||
| } | ||
| verbose := verbosity >= 2 | ||
| query, err := buildPolicyRecommendationUdfQuery(jobType, limit, isolationMethod, start, end, startTs, endTs, nsAllowList, labelIgnoreList, clusterUUID, databaseName, functionVersion) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| ctx, cancel := context.WithTimeout(context.Background(), waitDuration) | ||
| defer cancel() | ||
| // stackName, stateBackendURL, secretsProviderURL, region, workdir are not provided here | ||
| // because we only uses snowflake client in this command. | ||
| mgr := infra.NewManager(logger, "", "", "", "", warehouseName, "", verbose) | ||
| rows, err := mgr.RunUdf(ctx, query, databaseName) | ||
| if err != nil { | ||
| return fmt.Errorf("error when running policy recommendation UDF: %w", err) | ||
| } | ||
| defer rows.Close() | ||
|
|
||
| var recommendationID string | ||
| var timeCreated string | ||
| var yamls string | ||
| for cont := true; cont; cont = rows.NextResultSet() { | ||
| for rows.Next() { | ||
| if err := rows.Scan(&jobType, &recommendationID, &timeCreated, &yamls); err != nil { | ||
| return fmt.Errorf("invalid row: %w", err) | ||
| } | ||
| fmt.Printf("%s---\n", yamls) | ||
| } | ||
| } | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| func init() { | ||
| rootCmd.AddCommand(policyRecommendationCmd) | ||
|
|
||
| policyRecommendationCmd.Flags().String("type", "initial", "Type of recommendation job (initial|subsequent), we only support initial jobType for now") | ||
| policyRecommendationCmd.Flags().Uint("limit", 0, "Limit on the number of flows to read, default it 0 (no limit)") | ||
| policyRecommendationCmd.Flags().Int("isolationMethod", 1, `Network isolation preference. Currently we have 3 options: | ||
| 1: Recommending allow ANP/ACNP policies, with default deny rules only on Pods which have an allow rule applied | ||
| 2: Recommending allow ANP/ACNP policies, with default deny rules for whole cluster | ||
| 3: Recommending allow K8s NetworkPolicies only`) | ||
| policyRecommendationCmd.Flags().String("start", "", "Start time for flows, with reference to the current time (e.g., now-1h)") | ||
| policyRecommendationCmd.Flags().String("end", "", "End time for flows, with reference to the current timr (e.g., now)") | ||
| policyRecommendationCmd.Flags().String("start-ts", "", "Start time for flows, as a RFC3339 UTC timestamp (e.g., 2022-07-01T19:35:31Z)") | ||
| policyRecommendationCmd.Flags().String("end-ts", "", "End time for flows, as a RFC3339 UTC timestamp (e.g., 2022-07-01T19:35:31Z)") | ||
| policyRecommendationCmd.Flags().String("ns-allow", "kube-system,flow-aggregator,flow-visibility", "Namespaces with no restrictions") | ||
| policyRecommendationCmd.Flags().String("label-ignore", "pod-template-hash,controller-revision-hash,pod-template-generation", "Pod labels to be ignored when recommending NetworkPolicy") | ||
| policyRecommendationCmd.Flags().String("cluster-uuid", "", `UUID of the cluster for which policy recommendations will be generated | ||
| If no UUID is provided, all flows will be considered during policy recommendation`) | ||
| policyRecommendationCmd.Flags().String("database-name", "", "Snowflake database name to run policy recommendation, it can be found in the output of the onboard command") | ||
| policyRecommendationCmd.MarkFlagRequired("database-name") | ||
| policyRecommendationCmd.Flags().String("warehouse-name", "", "Snowflake Virtual Warehouse to use for running policy recommendation, by default we will use a temporary one") | ||
| policyRecommendationCmd.Flags().String("udf-version", defaultFunctionVersion, "Version of the UDF function to use") | ||
| policyRecommendationCmd.Flags().String("wait-timeout", defaultWaitTimeout, "Wait timeout of the recommendation job (e.g., 5m, 100s)") | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.