Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Extracted fetching clusters logic and added API error handling #117

Merged
merged 3 commits into from
Aug 17, 2022
+467 −261
Merged

Extracted fetching clusters logic and added API error handling #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40f2101
Extracted fetching clusters logic and added API error handling
mikouaj Aug 8, 2022
3a7fd06
Merge branch 'main' into cluster-404-fix
mikouaj Aug 9, 2022
a3cc5a0
Merge branch 'main' into cluster-404-fix
mikouaj Aug 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 0 additions & 138 deletions internal/app/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,79 +215,6 @@ func (p *PolicyAutomationApp) CheckScalability() error {
return p.evaluateClusters([]string{regoPackageBaseScalability})
}

func (p *PolicyAutomationApp) evaluateClusters(regoPackageBases []string) error {
log.Info("Cluster review starting")
files, err := p.loadPolicyFiles()
if err != nil {
return err
}
if len(files) == 0 {
p.out.ColorPrintf("[yellow][bold]No policies to check against\n")
log.Errorf("No policies to check against")
return errNoPolicies
}
// create a PolicyAgent client instance
pa := policy.NewPolicyAgent(p.ctx)
p.out.ColorPrintf("%s [light_gray][bold]Parsing REGO policies...\n", outputs.ICON_INFO)
log.Info("Parsing rego policies")
// parsing policies before running checks
if err := pa.WithFiles(files, p.config.PolicyExclusions); err != nil {
p.out.ErrorPrint("could not parse policy files", err)
log.Errorf("could not parse policy files: %s", err)
return err
}

clusterIds, err := p.getClusters()
if err != nil {
p.out.ErrorPrint("could not get clusters", err)
log.Errorf("could not get clusters: %s", err)
return err
}
evalResults := &evaluationResults{}
for _, clusterId := range clusterIds {
log.Infof("Fetching GKE cluster %s", clusterId)
p.out.ColorPrintf("%s [light_gray][bold]Fetching GKE cluster details... [%s]\n", outputs.ICON_INFO, clusterId)
cluster, err := p.gke.GetCluster(clusterId)
if err != nil {
p.out.ErrorPrint("could not fetch the cluster details", err)
log.Errorf("could not fetch cluster details: %s", err)
return err
}
p.out.ColorPrintf("%s [light_gray][bold]Evaluating policies against GKE cluster... [%s]\n",
outputs.ICON_INFO, clusterId)
log.Infof("Evaluating policies against GKE cluster %s", clusterId)
for _, pkgBase := range regoPackageBases {
evalResult, err := pa.Evaluate(cluster, pkgBase)
if err != nil {
p.out.ErrorPrint("failed to evaluate policies", err)
log.Errorf("could not evaluate rego policies on cluster %s: %s", cluster.Id, err)
return err
}
evalResult.ClusterID = clusterId
evalResults.Add(evalResult)
}
}

for _, c := range p.collectors {
log.Infof("Collector %s registering the results", c.Name())
p.out.ColorPrintf("%s [light_gray][bold]Writing evaluation results ... [%s]\n", outputs.ICON_INFO, c.Name())
if err = c.RegisterResult(evalResults.List()); err != nil {
p.out.ErrorPrint("failed to register evaluation results", err)
log.Errorf("could not register evaluation results: %s", err)
return err
}
if err = c.Close(); err != nil {
p.out.ErrorPrint("failed to close results registration", err)
log.Errorf("could not finalize registering evaluation results: %s", err)
return err
}
log.Infof("Collector %s processing closed", c.Name())
}
log.Info("Cluster review finished")
p.out.ColorPrintf("\u2139 [light_gray][bold]Cluster review finished\n")
return nil
}

func (p *PolicyAutomationApp) ClusterJSONData() error {
clusterIds, err := p.getClusters()
if err != nil {
Expand Down Expand Up @@ -400,71 +327,6 @@ func (p *PolicyAutomationApp) loadPolicyFiles() ([]*policy.PolicyFile, error) {
return policyFiles, nil
}

//getClusters retrieves lists of a clusters for further processing
//from the sources that are defined in a configuration.
func (p *PolicyAutomationApp) getClusters() ([]string, error) {
if p.config.DumpFile != "" {
log.Debugf("using local cluster discovery client on a file %s", p.config.DumpFile)
dc := gke.NewLocalDiscoveryClient(p.config.DumpFile)
return dc.GetClustersInOrg("doesn't-matter-for-local-discovery")
}
if p.config.ClusterDiscovery.Enabled {
var dc gke.DiscoveryClient
var err error
if p.config.CredentialsFile != "" {
log.Debugf("instantiating cluster discovery client with a credentials file")
dc, err = gke.NewDiscoveryClientWithCredentialsFile(p.ctx, p.config.CredentialsFile)
} else {
log.Debugf("instantiating cluster discovery client")
dc, err = gke.NewDiscoveryClient(p.ctx)
}
if err != nil {
return nil, err
}
p.discovery = dc
return p.discoverClusters()
}
clusters := make([]string, 0, len(p.config.Clusters))
for _, configCluster := range p.config.Clusters {
clusterName, err := getClusterName(configCluster)
if err != nil {
return nil, err
}
clusters = append(clusters, clusterName)
}
return clusters, nil
}

//discoverClusters discovers clusters according to the cluster discovery configuration.
func (p *PolicyAutomationApp) discoverClusters() ([]string, error) {
if p.config.ClusterDiscovery.Organization != "" {
log.Infof("Discovering clusters in organization %s", p.config.ClusterDiscovery.Organization)
p.out.ColorPrintf("%s [light_gray][bold]Discovering clusters in for organization... [%s]\n", outputs.ICON_INFO, p.config.ClusterDiscovery.Organization)
return p.discovery.GetClustersInOrg(p.config.ClusterDiscovery.Organization)
}
clusters := make([]string, 0)
for _, folder := range p.config.ClusterDiscovery.Folders {
log.Infof("Discovering clusters in folder %s", folder)
p.out.ColorPrintf("%s [light_gray][bold]Discovering clusters in folder... [%s]\n", outputs.ICON_INFO, folder)
results, err := p.discovery.GetClustersInFolder(folder)
if err != nil {
return nil, err
}
clusters = append(clusters, results...)
}
for _, project := range p.config.ClusterDiscovery.Projects {
log.Infof("Discovering clusters in project %s", project)
p.out.ColorPrintf("%s [light_gray][bold]Discovering clusters in project... [%s]\n", outputs.ICON_INFO, project)
results, err := p.discovery.GetClustersInProject(project)
if err != nil {
return nil, err
}
clusters = append(clusters, results...)
}
log.Debugf("discovered %v clusters in projects and folders", len(clusters))
return clusters, nil
}

func (p *PolicyAutomationApp) configureSccOutput(config cfg.SecurityCommandCenterOutput, credsFile string) error {
if config.OrganizationNumber == "" {
return nil
Expand Down
186 changes: 186 additions & 0 deletions internal/app/app_check_clusters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
// Copyright 2022 Google LLC
//
// 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
//
// https://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 app

import (
"errors"

"github.com/google/gke-policy-automation/internal/gke"
"github.com/google/gke-policy-automation/internal/log"
"github.com/google/gke-policy-automation/internal/outputs"
"github.com/google/gke-policy-automation/internal/policy"
"github.com/googleapis/gax-go/v2/apierror"
apiCodes "google.golang.org/grpc/codes"
)

//getClusters retrieves lists of a clusters for further processing
//from the sources that are defined in a configuration.
func (p *PolicyAutomationApp) getClusters() ([]string, error) {
if p.config.DumpFile != "" {
log.Debugf("using local cluster discovery client on a file %s", p.config.DumpFile)
dc := gke.NewLocalDiscoveryClient(p.config.DumpFile)
return dc.GetClustersInOrg("doesn't-matter-for-local-discovery")
}
if p.config.ClusterDiscovery.Enabled {
var dc gke.DiscoveryClient
var err error
if p.config.CredentialsFile != "" {
log.Debugf("instantiating cluster discovery client with a credentials file")
dc, err = gke.NewDiscoveryClientWithCredentialsFile(p.ctx, p.config.CredentialsFile)
} else {
log.Debugf("instantiating cluster discovery client")
dc, err = gke.NewDiscoveryClient(p.ctx)
}
if err != nil {
return nil, err
}
p.discovery = dc
return p.discoverClusters()
}
clusters := make([]string, 0, len(p.config.Clusters))
for _, configCluster := range p.config.Clusters {
clusterName, err := getClusterName(configCluster)
if err != nil {
return nil, err
}
clusters = append(clusters, clusterName)
}
return clusters, nil
}

//discoverClusters discovers clusters according to the cluster discovery configuration.
func (p *PolicyAutomationApp) discoverClusters() ([]string, error) {
if p.config.ClusterDiscovery.Organization != "" {
log.Infof("Discovering clusters in organization %s", p.config.ClusterDiscovery.Organization)
p.out.ColorPrintf("%s [light_gray][bold]Discovering clusters in for organization... [%s]\n", outputs.ICON_INFO, p.config.ClusterDiscovery.Organization)
return p.discovery.GetClustersInOrg(p.config.ClusterDiscovery.Organization)
}
clusters := make([]string, 0)
for _, folder := range p.config.ClusterDiscovery.Folders {
log.Infof("Discovering clusters in folder %s", folder)
p.out.ColorPrintf("%s [light_gray][bold]Discovering clusters in folder... [%s]\n", outputs.ICON_INFO, folder)
results, err := p.discovery.GetClustersInFolder(folder)
if err != nil {
return nil, err
}
clusters = append(clusters, results...)
}
for _, project := range p.config.ClusterDiscovery.Projects {
log.Infof("Discovering clusters in project %s", project)
p.out.ColorPrintf("%s [light_gray][bold]Discovering clusters in project... [%s]\n", outputs.ICON_INFO, project)
results, err := p.discovery.GetClustersInProject(project)
if err != nil {
return nil, err
}
clusters = append(clusters, results...)
}
log.Debugf("discovered %v clusters in projects and folders", len(clusters))
return clusters, nil
}

func (p *PolicyAutomationApp) evaluateClusters(regoPackageBases []string) error {
log.Info("Cluster review starting")
files, err := p.loadPolicyFiles()
if err != nil {
return err
}
if len(files) == 0 {
p.out.ColorPrintf("[yellow][bold]No policies to check against\n")
log.Errorf("No policies to check against")
return errNoPolicies
}
// create a PolicyAgent client instance
pa := policy.NewPolicyAgent(p.ctx)
p.out.ColorPrintf("%s [light_gray][bold]Parsing REGO policies...\n", outputs.ICON_INFO)
log.Info("Parsing rego policies")
// parsing policies before running checks
if err := pa.WithFiles(files, p.config.PolicyExclusions); err != nil {
p.out.ErrorPrint("could not parse policy files", err)
log.Errorf("could not parse policy files: %s", err)
return err
}

clusterIds, err := p.getClusters()
if err != nil {
p.out.ErrorPrint("could not identify clusters", err)
log.Errorf("could not identify clusters: %s", err)
return err
}
clusterData, err := p.getClusterData(clusterIds)
if err != nil {
p.out.ErrorPrint("could not fetch the cluster details", err)
log.Errorf("could not fetch cluster details: %s", err)
return err
}

evalResults := &evaluationResults{}
for _, cluster := range clusterData {
clusterId := cluster.ReadableId()
p.out.ColorPrintf("%s [light_gray][bold]Evaluating policies against GKE cluster... [%s]\n",
outputs.ICON_INFO, clusterId)
log.Infof("Evaluating policies against GKE cluster %s", clusterId)
for _, pkgBase := range regoPackageBases {
evalResult, err := pa.Evaluate(cluster, pkgBase)
if err != nil {
p.out.ErrorPrint("failed to evaluate policies", err)
log.Errorf("could not evaluate rego policies on cluster %s: %s", clusterId, err)
return err
}
evalResult.ClusterID = clusterId
evalResults.Add(evalResult)
}
}

for _, c := range p.collectors {
log.Infof("Collector %s registering the results", c.Name())
p.out.ColorPrintf("%s [light_gray][bold]Writing evaluation results ... [%s]\n", outputs.ICON_INFO, c.Name())
if err = c.RegisterResult(evalResults.List()); err != nil {
p.out.ErrorPrint("failed to register evaluation results", err)
log.Errorf("could not register evaluation results: %s", err)
return err
}
if err = c.Close(); err != nil {
p.out.ErrorPrint("failed to close results registration", err)
log.Errorf("could not finalize registering evaluation results: %s", err)
return err
}
log.Infof("Collector %s processing closed", c.Name())
}
log.Info("Cluster review finished")
p.out.ColorPrintf("\u2139 [light_gray][bold]Cluster review finished\n")
return nil
}

func (p *PolicyAutomationApp) getClusterData(ids []string) ([]*gke.Cluster, error) {
results := make([]*gke.Cluster, 0)
for _, clusterId := range ids {
log.Infof("Fetching GKE cluster %s", clusterId)
p.out.ColorPrintf("%s [light_gray][bold]Fetching GKE cluster details... [%s]\n", outputs.ICON_INFO, clusterId)
cluster, err := p.gke.GetCluster(clusterId)
if err != nil {
var apiErr *apierror.APIError
if errors.As(err, &apiErr) {
if apiErr.GRPCStatus().Code() == apiCodes.NotFound {
p.out.ColorPrintf("%s [yellow][bold]Could not fetch cluster: cluster not found [%s]\n", outputs.ICON_INFO, clusterId)
log.Warnf("could not fetch cluster details: %s", err)
continue
}
}
return nil, err
}
results = append(results, cluster)
}
return results, nil
}
Loading