Merge pull request #287 from artemlive/feature/pingdom-api-migrate

ahmedwaleedmalik · web-flow · commit 221927f05e94 · 2020-10-22T09:57:59.000+05:00
IMC pingdom api v3.1 support with small improvements and documentation fixes
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -188,11 +188,11 @@ providers:
     username: <your-account-username>
     password: <your-account-password>
   - name: Pingdom
-    apiKey: <your-api-key>
+    apiToken: <your-api-token>
     apiURL: https://api.pingdom.com
-    username: <your-account-username>
-    password: <your-account-password>
-    accountEmail: <multi-auth-account-email>
+    alertIntegrations: "91166-10924"
+    alertContacts: "1234567_8_9-9876543_2_1,1234567_8_9-9876543_2_2"
+    teamAlertContacts: "1234567_8_9-9876543_2_1,1234567_8_9-9876543_2_2"
 enableMonitorDeletion: true
 monitorNameTemplate: "{{.Name}}-{{.Namespace}}"
 ```
diff --git a/cmd/manager/main.go b/cmd/manager/main.go
@@ -76,7 +76,7 @@ func main() {
 		os.Exit(1)
 	}
 	if len(namespace) == 0 {
-		log.Info("Warning: WATCH_NAMESPACE is set to empty string, will monitor ingresses in all namespaces.")
+		log.Info("Warning: WATCH_NAMESPACE is set to empty string, will check EndpointMonitors in all namespaces.")
 	} else {
 		log.Info("Watching Namespace: " + namespace)
 	}
diff --git a/deploy/crds/endpointmonitor.stakater.com_endpointmonitors_crd.yaml b/deploy/crds/endpointmonitor.stakater.com_endpointmonitors_crd.yaml
@@ -93,6 +93,9 @@ spec:
                   description: Comma separated set of tags to apply to check (e.g.
                     "testing,aws")
                   type: string
+                teamAlertContacts:
+                  description: '`-` separated team id''s (e.g. "1234567_8_9-9876543_2_1")'
+                  type: string
               type: object
             providers:
               description: Comma separated list of providers
diff --git a/deploy/olm-catalog/IngressMonitorController/2.0.5/ingressmonitorcontroller.v2.0.5.clusterserviceversion.yaml b/deploy/olm-catalog/IngressMonitorController/2.0.5/ingressmonitorcontroller.v2.0.5.clusterserviceversion.yaml
@@ -0,0 +1,144 @@
+apiVersion: operators.coreos.com/v1alpha1
+kind: ClusterServiceVersion
+metadata:
+  annotations:
+    alm-examples: '[]'
+    capabilities: Basic Install
+  name: ingressmonitorcontroller.v2.0.5
+  namespace: placeholder
+spec:
+  apiservicedefinitions: {}
+  customresourcedefinitions:
+    owned:
+    - description: EndpointMonitor is the Schema for the endpointmonitors API
+      kind: EndpointMonitor
+      name: endpointmonitors.endpointmonitor.stakater.com
+      version: v1alpha1
+  description: Placeholder description
+  displayName: Ingress Monitor Controller
+  install:
+    spec:
+      clusterPermissions:
+      - rules:
+        - apiGroups:
+          - ""
+          - extensions
+          - route.openshift.io
+          resources:
+          - ingresses
+          - routes
+          - secrets
+          verbs:
+          - list
+          - get
+        - apiGroups:
+          - ""
+          resources:
+          - events
+          - services
+          - configmaps
+          - services/finalizers
+          verbs:
+          - create
+          - delete
+          - get
+          - list
+          - patch
+          - update
+          - watch
+        - apiGroups:
+          - apps
+          resources:
+          - deployments
+          - daemonsets
+          - replicasets
+          - statefulsets
+          verbs:
+          - '*'
+        - apiGroups:
+          - monitoring.coreos.com
+          resources:
+          - servicemonitors
+          verbs:
+          - get
+          - create
+          - list
+        - apiGroups:
+          - apps
+          resourceNames:
+          - ingressmonitorcontroller
+          resources:
+          - deployments/finalizers
+          verbs:
+          - update
+        - apiGroups:
+          - ""
+          resources:
+          - pods
+          verbs:
+          - get
+        - apiGroups:
+          - endpointmonitor.stakater.com
+          resources:
+          - '*'
+          verbs:
+          - create
+          - delete
+          - get
+          - list
+          - patch
+          - update
+          - watch
+        serviceAccountName: ingressmonitorcontroller
+      deployments:
+      - name: ingressmonitorcontroller
+        spec:
+          replicas: 1
+          selector:
+            matchLabels:
+              name: ingressmonitorcontroller
+          strategy: {}
+          template:
+            metadata:
+              labels:
+                name: ingressmonitorcontroller
+            spec:
+              containers:
+              - command:
+                - IngressMonitorController
+                env:
+                - name: WATCH_NAMESPACE
+                  valueFrom:
+                    fieldRef:
+                      fieldPath: metadata.annotations['olm.targetNamespaces']
+                - name: POD_NAME
+                  valueFrom:
+                    fieldRef:
+                      fieldPath: metadata.name
+                - name: OPERATOR_NAME
+                  value: ingressmonitorcontroller
+                - name: CONFIG_SECRET_NAME
+                  value: imc-config
+                - name: LOG_LEVEL
+                  value: info
+                - name: LOG_FORMAT
+                  value: text
+                image: stakater/ingressmonitorcontroller:v2.0.5
+                imagePullPolicy: Always
+                name: ingressmonitorcontroller
+                resources: {}
+              serviceAccountName: ingressmonitorcontroller
+    strategy: deployment
+  installModes:
+  - supported: true
+    type: OwnNamespace
+  - supported: true
+    type: SingleNamespace
+  - supported: false
+    type: MultiNamespace
+  - supported: true
+    type: AllNamespaces
+  maturity: alpha
+  provider: {}
+  replaces: ingressmonitorcontroller.v0.0.0
+  version: 2.0.5
diff --git a/deploy/operator.yaml b/deploy/operator.yaml
@@ -15,7 +15,7 @@ spec:
       serviceAccountName: ingressmonitorcontroller
       containers:
         - name: ingressmonitorcontroller
-          image: stakater/ingressmonitorcontroller:v2.0.4
+          image: stakater/ingressmonitorcontroller:v2.0.5
           command:
             - IngressMonitorController
           imagePullPolicy: Always
diff --git a/docs/pingdom-configuration.md b/docs/pingdom-configuration.md
@@ -9,18 +9,17 @@ in the [Configuration section of the README](../README.md#configuration):
 
 | Key      | Description                                      |
 |----------|--------------------------------------------------|
-| username | Account username for authentication with Pingdom |
-| password | Account password for authentication with Pingdom |
+| apiToken | Pingdom API Token generated inside My Pingdom |
 
 ## Optional
-The following optional property can be included for Pingdom accounts which require multi-user authentication.
-More information can be found [Here](https://www.pingdom.com/api/2.1/#multi-user+authentication)
+The following optional properties can be included if you want to declare some default options, without re-declaring them for each EndpointMonitor.
+You are able to override any of them via EndpointMonitor specific options.
 
 | Key               | Description                                              |
 |-------------------|----------------------------------------------------------|
-| accountEmail      | Email account for multi-user authentication with Pingdom |
-| alertIntegrations | Comma separated list of integration ids                  |
-
+| alertIntegrations | `-` separated list of integration ids                  |
+| teamAlertContacts | `-` separated list of teams ids                  |
+| alertContacts     | `-` separated list of alert contacts ids                  |
 ## Advanced
 
 Currently additional pingdom configurations can be added through these fields:
@@ -37,7 +36,7 @@ Currently additional pingdom configurations can be added through these fields:
 | Tags                        | Comma separated set of tags to apply to check (e.g. "testing,aws") |
 | AlertIntegrations                | `-` separated set list of integrations ids (e.g. "91166-12168") |
 | AlertContacts                | `-` separated contact id's (e.g. "1234567_8_9-9876543_2_1") to override the [default alertContacts](https://github.com/stakater/IngressMonitorController/blob/master/README.md#usage)|
-
+| TeamAlertContacts            | Teams to alert.  `-` separated set list of teams ids (e.g. "1234567_8_9-9876543_2_1)|
 
 ### Basic Auth checks
 
@@ -67,4 +66,5 @@ spec:
     tags: "testing,aws"
     alertIntegrations: "91166-12168"
     alertContacts: "1234567_8_9-9876543_2_1,1234567_8_9-9876543_2_2"
+    teamAlertContacts: "1234567_8_9-9876543_2_1,1234567_8_9-9876543_2_2"
 ```
diff --git a/examples/configs/test-config-pingdom.yaml b/examples/configs/test-config-pingdom.yaml
@@ -1,10 +1,8 @@
 providers:
-  - name: PingdomMulti
-    apiURL: "https://api.pingdom.com/v2/"
-    apiKey: "657a68d9ashdyasjdklkskuasd"
-    username: "user@test.com"
-    password: "SuperSecret"
-    accountEmail: "multi@test.com"
+  - name: Pingdom
+    apiURL: "https://api.pingdom.com/api/3.1"
+    apiToken: "657a68d9ashdyasjdklkskuasd"
     alertContacts: "0544483_0_0-2628365_0_0-2633263_0_0"
-    alertIntegrations: "91166,10924"
+    teamAlertContacts: "1234567_0_0-2628365_0_0-2633263_0_0"
+    alertIntegrations: "91166-10924"
 enableMonitorDeletion: true
diff --git a/go.mod b/go.mod
@@ -12,7 +12,7 @@ require (
 	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/openshift/api v0.0.0-20200526144822-34f54f12813a
 	github.com/operator-framework/operator-sdk v0.19.0
-	github.com/russellcardullo/go-pingdom v1.0.0
+	github.com/russellcardullo/go-pingdom v1.3.0
 	github.com/sirupsen/logrus v1.6.0
 	github.com/stretchr/testify v1.5.1
 	google.golang.org/api v0.14.0
diff --git a/go.sum b/go.sum
@@ -761,6 +761,7 @@ github.com/rs/cors v1.6.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU=
 github.com/rubenv/sql-migrate v0.0.0-20200212082348-64f95ea68aa3/go.mod h1:rtQlpHw+eR6UrqaS3kX1VYeaCxzCVdimDS7g5Ln4pPc=
 github.com/russellcardullo/go-pingdom v1.0.0 h1:onhnHzECEQI1r1Oel6F9piZ2hI8L339IDBKAQdbUAO4=
 github.com/russellcardullo/go-pingdom v1.0.0/go.mod h1:MbP0xrebNTkKp7dUsxfOJF+MvJ6eNmvj5y6gqXFbOaw=
+github.com/russellcardullo/go-pingdom v1.3.0/go.mod h1:y9hd/6P97iuRFi6VPGgLxsRQaJQll298jZ/qPQPfcXw=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
diff --git a/pkg/apis/endpointmonitor/v1alpha1/endpointmonitor_types.go b/pkg/apis/endpointmonitor/v1alpha1/endpointmonitor_types.go
@@ -235,6 +235,10 @@ type PingdomConfig struct {
 	// `-` separated contact id's (e.g. "1234567_8_9-9876543_2_1")
 	// +optional
 	AlertContacts string `json:"alertContacts,omitempty"`
+
+	// `-` separated team id's (e.g. "1234567_8_9-9876543_2_1")
+	// +optional
+	TeamAlertContacts string `json:"teamAlertContacts,omitempty"`
 }
 
 // AppInsightsConfig defines the configuration for AppInsights Monitor Provider
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -54,9 +54,11 @@ func (c *Config) UnmarshalYAML(data []byte) error {
 type Provider struct {
 	Name              string      `yaml:"name"`
 	ApiKey            string      `yaml:"apiKey"`
+	ApiToken          string      `yaml:"apiToken"`
 	ApiURL            string      `yaml:"apiURL"`
 	AlertContacts     string      `yaml:"alertContacts"`
 	AlertIntegrations string      `yaml:"alertIntegrations"`
+	TeamAlertContacts string      `yaml:"teamAlertContacts"`
 	Username          string      `yaml:"username"`
 	Password          string      `yaml:"password"`
 	AccountEmail      string      `yaml:"accountEmail"`
diff --git a/pkg/config/config_test.go b/pkg/config/config_test.go
@@ -14,14 +14,12 @@ const (
 	correctTestEnableMonitorDeletion = true
 
 	configFilePathPingdom               = "../../examples/configs/test-config-pingdom.yaml"
-	correctTestPingdomConfigMulti       = "PingdomMulti"
-	correctTestPingdomUsername          = "user@test.com"
-	correctTestPingdomAPIURL            = "https://api.pingdom.com/v2/"
-	correctTestPingdomPassword          = "SuperSecret"
-	correctTestPingdomAccountEmail      = "multi@test.com"
+	correctTestPingdomConfigMulti       = "Pingdom"
+	correctTestPingdomAPIURL            = "https://api.pingdom.com/api/3.1"
 	correctTestPingdomAlertContacts     = "0544483_0_0-2628365_0_0-2633263_0_0"
-	correctTestPingdomAlertIntegrations = "91166,10924"
-	correctTestPingdomAPIKey            = "657a68d9ashdyasjdklkskuasd"
+	correctTestPingdomAlertIntegrations = "91166-10924"
+	correctTestPingdomAPIToken          = "657a68d9ashdyasjdklkskuasd"
+	correctTestPingdomTeamAlertContacts = "1234567_0_0-2628365_0_0-2633263_0_0"
 
 	configFilePathUptime           = "../../examples/configs/test-config-uptime.yaml"
 	correctTestUptimeConfigName    = "Uptime"
@@ -34,9 +32,8 @@ const (
 )
 
 func TestConfigWithCorrectValues(t *testing.T) {
-	correctConfig := Config{Providers: []Provider{{Name: correctTestPingdomConfigMulti, ApiKey: correctTestPingdomAPIKey, ApiURL: correctTestPingdomAPIURL,
-		AlertContacts: correctTestPingdomAlertContacts, AlertIntegrations: correctTestPingdomAlertIntegrations,
-		Username: correctTestPingdomUsername, Password: correctTestPingdomPassword, AccountEmail: correctTestPingdomAccountEmail}},
+	correctConfig := Config{Providers: []Provider{{Name: correctTestPingdomConfigMulti, ApiToken: correctTestPingdomAPIToken, ApiURL: correctTestPingdomAPIURL,
+		AlertContacts: correctTestPingdomAlertContacts, AlertIntegrations: correctTestPingdomAlertIntegrations, TeamAlertContacts: correctTestPingdomTeamAlertContacts}},
 		EnableMonitorDeletion: correctTestEnableMonitorDeletion, ResyncPeriod: 0}
 
 	config := ReadConfig(configFilePathPingdom)
@@ -73,18 +70,17 @@ func TestConfigWithoutProvider(t *testing.T) {
 }
 
 func TestConfigWithoutEnabledFlag(t *testing.T) {
-	incorrectConfig := Config{Providers: []Provider{{Name: correctTestConfigName, ApiKey: correctTestAPIKey, ApiURL: correctTestAPIURL, AlertContacts: correctTestAlertContacts}}}
+	incorrectConfig := Config{Providers: []Provider{{Name: correctTestConfigName, ApiKey: correctTestAPIKey, ApiURL: correctTestAPIURL, TeamAlertContacts: correctTestPingdomTeamAlertContacts, AlertContacts: correctTestAlertContacts}}}
 	config := ReadConfig(configFilePath)
 
 	if reflect.DeepEqual(config, incorrectConfig) {
 		t.Error("Marshalled config and incorrect config match, should not match")
 	}
 }
 
-func TestConfigWithPingdomMultiAuthEnabledFlag(t *testing.T) {
-	correctConfig := Config{Providers: []Provider{{Name: correctTestPingdomConfigMulti, ApiKey: correctTestPingdomAPIKey, ApiURL: correctTestPingdomAPIURL,
-		AlertContacts: correctTestPingdomAlertContacts, AlertIntegrations: correctTestPingdomAlertIntegrations,
-		Username: correctTestPingdomUsername, Password: correctTestPingdomPassword, AccountEmail: correctTestPingdomAccountEmail}},
+func TestConfigWithPingdom(t *testing.T) {
+	correctConfig := Config{Providers: []Provider{{Name: correctTestPingdomConfigMulti, ApiToken: correctTestPingdomAPIToken, ApiURL: correctTestPingdomAPIURL,
+		AlertContacts: correctTestPingdomAlertContacts, AlertIntegrations: correctTestPingdomAlertIntegrations, TeamAlertContacts: correctTestPingdomTeamAlertContacts}},
 		EnableMonitorDeletion: correctTestEnableMonitorDeletion}
 	config := ReadConfig(configFilePathPingdom)
 	if !reflect.DeepEqual(config, correctConfig) {
diff --git a/pkg/monitors/pingdom/pingdom-monitor.go b/pkg/monitors/pingdom/pingdom-monitor.go

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ func main() {`
`76`	`76`	`os.Exit(1)`
`77`	`77`	`}`
`78`	`78`	`if len(namespace) == 0 {`
`79`		`- log.Info("Warning: WATCH_NAMESPACE is set to empty string, will monitor ingresses in all namespaces.")`
	`79`	`+ log.Info("Warning: WATCH_NAMESPACE is set to empty string, will check EndpointMonitors in all namespaces.")`
`80`	`80`	`} else {`
`81`	`81`	`log.Info("Watching Namespace: " + namespace)`
`82`	`82`	`}`