Suseobs store #16
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,220 @@ | ||
| package report | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "crypto/tls" | ||
| "encoding/json" | ||
| "errors" | ||
| "net/http" | ||
| "net/url" | ||
| "strconv" | ||
| "strings" | ||
| "time" | ||
|
|
||
| // "github.com/google/uuid" | ||
| "github.com/rs/zerolog" | ||
| "github.com/rs/zerolog/log" | ||
| corev1 "k8s.io/api/core/v1" | ||
| wgpolicy "sigs.k8s.io/wg-policy-prototypes/policy-report/pkg/api/wgpolicyk8s.io/v1alpha2" | ||
| ) | ||
|
|
||
| // https://docs.stackstate.com/health/health-synchronization#consistency-models | ||
| const DEFAULT_CONSISTENCY_MODEL = "REPEAT_STATES" | ||
|
|
||
| // SuseObsStore is a store for PolicyReport and ClusterPolicyReport. | ||
| type SuseObsStore struct { | ||
| client *http.Client | ||
| apiKey string | ||
| internalHostname string | ||
| urn string | ||
| cluster string | ||
| repeatInterval string | ||
| expireInterval string | ||
| } | ||
|
|
||
| type SuseObsExpireConfiguration struct { | ||
| RepeatInterval string `json:"repeat_interval_s"` | ||
| ExpireInterval string `json:"expiry_interval_s"` | ||
| } | ||
|
|
||
| type SuseObsStream struct { | ||
| Urn string `json:"urn"` | ||
| } | ||
|
|
||
| type SuseObsCheckState struct { | ||
| CheckStateId string `json:"checkStateId"` | ||
| Message string `json:"message"` | ||
| Health string `json:"health"` | ||
| TopologyElementIdentifier string `json:"topologyElementIdentifier"` | ||
| Name string `json:"name"` | ||
| } | ||
|
|
||
| type SuseObsHealthCheck struct { | ||
| ConsistencyModel string `json:"consistency_model"` | ||
| Expire SuseObsExpireConfiguration `json:"expire"` | ||
| Stream SuseObsStream `json:"stream"` | ||
| CheckStates []SuseObsCheckState `json:"check_states"` | ||
| } | ||
|
|
||
| type SuseObsJsonPayload struct { | ||
| ApiKey string `json:"apiKey"` | ||
| CollectionTimestamp int64 `json:"collection_timestamp"` | ||
| InternalHostname string `json:"internalHostname"` | ||
| Events interface{} `json:"events,omitempty"` | ||
| Metrics []interface{} `json:"metrics"` | ||
| ServiceChecks []interface{} `json:"service_checks"` | ||
| Health []SuseObsHealthCheck `json:"health"` | ||
| Topologies []interface{} `json:"topoligies"` | ||
| } | ||
|
|
||
| // NewSuseObsStore creates a new SuseObsStore. | ||
| func NewSuseObsStore(apiKey, internalHostname, urn, cluster string, repeatInterval, expireInterval time.Duration) *SuseObsStore { | ||
| repeatIntervalStr := strconv.FormatFloat(repeatInterval.Seconds(), 'f', 0, 32) | ||
| expireIntervalStr := strconv.FormatFloat(expireInterval.Seconds(), 'f', 0, 32) | ||
| return &SuseObsStore{ | ||
| client: &http.Client{ | ||
| Transport: &http.Transport{ | ||
| // FIXME - configure certicates for a secure communication | ||
| TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, | ||
| }, | ||
| }, | ||
| apiKey: apiKey, | ||
| internalHostname: internalHostname, | ||
| urn: urn, | ||
| cluster: cluster, | ||
| repeatInterval: repeatIntervalStr, | ||
| expireInterval: expireIntervalStr, | ||
| } | ||
| } | ||
|
|
||
| func (s *SuseObsStore) generateCheckStates(policyReport *wgpolicy.PolicyReport) []SuseObsCheckState { | ||
| checkStates := []SuseObsCheckState{} | ||
| for _, result := range policyReport.Results { | ||
| healthCheckStatus := "Clear" | ||
| if result.Result == "fail" { | ||
| healthCheckStatus = "Deviating" | ||
| } | ||
| checkState := SuseObsCheckState{ | ||
| CheckStateId: generateCheckStateId(result.Policy, policyReport.Scope), | ||
| Message: result.Description, | ||
| Health: healthCheckStatus, | ||
| TopologyElementIdentifier: strings.ToLower("urn:kubernetes:/" + s.cluster + ":" + policyReport.Scope.Namespace + ":" + policyReport.Scope.Kind + "/" + policyReport.Scope.Name), | ||
| Name: result.Policy, | ||
| } | ||
| checkStates = append(checkStates, checkState) | ||
| } | ||
| return checkStates | ||
| } | ||
|
|
||
| func generateCheckStateId(policy string, scope *corev1.ObjectReference) string { | ||
| return strings.ToLower(policy + "-" + scope.Namespace + "-" + scope.Kind + "-" + scope.Name + "-" + policy) | ||
| } | ||
|
|
||
| func (s *SuseObsStore) generateCheckStatesFromClusterPolicyReport(policyReport *wgpolicy.ClusterPolicyReport) []SuseObsCheckState { | ||
| checkStates := []SuseObsCheckState{} | ||
| for _, result := range policyReport.Results { | ||
| healthCheckStatus := "Clear" | ||
| if result.Result == "fail" { | ||
| healthCheckStatus = "Deviating" | ||
| } | ||
| checkState := SuseObsCheckState{ | ||
| CheckStateId: generateCheckStateId(result.Policy, policyReport.Scope), | ||
| Message: result.Description, | ||
| Health: healthCheckStatus, | ||
| TopologyElementIdentifier: strings.ToLower("urn:kubernetes:/" + s.cluster + ":" + policyReport.Scope.Kind + "/" + policyReport.Scope.Name), | ||
| Name: result.Policy, | ||
| } | ||
| checkStates = append(checkStates, checkState) | ||
| } | ||
| return checkStates | ||
| } | ||
|
|
||
| func (s *SuseObsStore) generateSuseObsJsonPayload(checkStates []SuseObsCheckState) (*SuseObsJsonPayload, error) { | ||
| url, err := url.Parse(s.internalHostname) | ||
| if err != nil { | ||
| return nil, errors.New("failed to parse SUSE OBS URL") | ||
| } | ||
| payload := &SuseObsJsonPayload{ | ||
| ApiKey: s.apiKey, | ||
| InternalHostname: url.Hostname(), | ||
| CollectionTimestamp: time.Now().Unix(), | ||
| Events: nil, | ||
| Metrics: []interface{}{}, | ||
| ServiceChecks: []interface{}{}, | ||
| Topologies: []interface{}{}, | ||
| Health: []SuseObsHealthCheck{{ | ||
| ConsistencyModel: DEFAULT_CONSISTENCY_MODEL, | ||
| Expire: SuseObsExpireConfiguration{ | ||
| RepeatInterval: s.repeatInterval, | ||
| ExpireInterval: s.expireInterval, | ||
| }, | ||
| Stream: SuseObsStream{ | ||
| Urn: s.urn, | ||
| }, | ||
| CheckStates: checkStates, | ||
| }}, | ||
| } | ||
| return payload, nil | ||
| } | ||
|
|
||
| func (s *SuseObsStore) convertPolicyReportIntoSuseObsJsonPayload(policyReport *wgpolicy.PolicyReport) (*SuseObsJsonPayload, error) { | ||
| return s.generateSuseObsJsonPayload(s.generateCheckStates(policyReport)) | ||
| } | ||
|
|
||
| func (s *SuseObsStore) convertClusterPolicyReportIntoSuseObsJsonPayload(policyReport *wgpolicy.ClusterPolicyReport) (*SuseObsJsonPayload, error) { | ||
| return s.generateSuseObsJsonPayload(s.generateCheckStatesFromClusterPolicyReport(policyReport)) | ||
| } | ||
|
|
||
| // CreateOrPatchPolicyReport creates or patches a PolicyReport. | ||
| func (s *SuseObsStore) CreateOrPatchPolicyReport(ctx context.Context, policyReport *wgpolicy.PolicyReport) error { | ||
| payload, err := s.convertPolicyReportIntoSuseObsJsonPayload(policyReport) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return s.sendRequest(payload) | ||
| } | ||
|
|
||
| func (s *SuseObsStore) DeleteOldPolicyReports(ctx context.Context, scanRunID, namespace string) error { | ||
| // No need to delete SUSE Obs will remove the check states after the expiry interval | ||
| return nil | ||
| } | ||
|
|
||
| // CreateOrPatchClusterPolicyReport creates or patches a ClusterPolicyReport. | ||
| func (s *SuseObsStore) CreateOrPatchClusterPolicyReport(ctx context.Context, clusterPolicyReport *wgpolicy.ClusterPolicyReport) error { | ||
| payload, err := s.convertClusterPolicyReportIntoSuseObsJsonPayload(clusterPolicyReport) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return s.sendRequest(payload) | ||
| } | ||
|
|
||
| func (s *SuseObsStore) DeleteOldClusterPolicyReports(ctx context.Context, scanRunID string) error { | ||
| // No need to delete SUSE Obs will remove the check states after the expiry interval | ||
| return nil | ||
| } | ||
|
|
||
| func (s *SuseObsStore) sendRequest(payload *SuseObsJsonPayload) error { | ||
| if len(payload.Health) > 0 && len(payload.Health[0].CheckStates) == 0 { | ||
| return nil | ||
| } | ||
| jsonPayload, err := json.Marshal(payload) | ||
| if err != nil { | ||
| return errors.New("failed to marshal SUSE OBS payload") | ||
| } | ||
| url := s.internalHostname + "/receiver/stsAgent/intake?api_key=" | ||
| log.Debug().Dict("dict", zerolog.Dict()). | ||
| Str("SUSE Obs URL", url). | ||
| RawJSON("payload", jsonPayload). | ||
| Msg("Sending SUSE OBS healch check request") | ||
|
|
||
| response, err := s.client.Post(url+s.apiKey, "application/json", bytes.NewReader(jsonPayload)) | ||
| if err != nil { | ||
| return errors.Join(errors.New("failed to send SUSE OBS payload"), err) | ||
| } | ||
| if response.StatusCode != http.StatusOK { | ||
| return errors.New("SUSE Obs returned an error. Status code: " + response.Status) | ||
| } | ||
| return nil | ||
|
|
||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this is very ugly. And it needs to be refactored.
What do you think about having multiple stores? For example, the audit scanner could create policy reports and send the data to SUSE Obs.