move from quay.io/kiwigrid/k8s-sidecar to omegavvweapon/kopf-k8s-side… (#302)

* move from quay.io/kiwigrid/k8s-sidecar to omegavvweapon/kopf-k8s-sidecar and update documentation

Signed-off-by: ShuzZzle <[email protected]>

* add changelog

Signed-off-by: ShuzZzle <[email protected]>

* use empty quotes instead of null
add resource var to values.yaml

Signed-off-by: ShuzZzle <[email protected]>

Author: nschad

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## master / unreleased
 
+* [CHANGE] move from quay.io/kiwigrid/k8s-sidecar to omegavvweapon/kopf-k8s-sidecar image #302
+
 ## 1.2.0 / 2021-12-29
 
 * [CHANGE] Use port number for prometheus port annotations. #288

README.md

@@ -135,8 +135,24 @@ Kubernetes: `^1.19.0-0`
 | alertmanager.​serviceMonitor.​extraEndpointSpec | object | `{}` | Additional endpoint configuration https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#endpoint |
 | alertmanager.​serviceMonitor.​metricRelabelings | list | `[]` |  |
 | alertmanager.​serviceMonitor.​relabelings | list | `[]` |  |
-| alertmanager.​sidecar | object | `{"containerSecurityContext":{"enabled":true,"readOnlyRootFilesystem":true},"defaultFolderName":null,"enableUniqueFilenames":false,"enabled":false,"folder":"/data","folderAnnotation":null,"image":{"repository":"quay.io/kiwigrid/k8s-sidecar","sha":"","tag":"1.10.7"},"imagePullPolicy":"IfNotPresent","label":"cortex_alertmanager","labelValue":null,"resources":{},"searchNamespace":null,"skipTlsVerify":false,"watchMethod":null}` | Sidecars that collect the configmaps with specified label and stores the included files them into the respective folders |
-| alertmanager.​sidecar.​skipTlsVerify | bool | `false` | skipTlsVerify Set to true to skip tls verification for kube api calls |
+| alertmanager.​sidecar.​containerSecurityContext.​enabled | bool | `true` |  |
+| alertmanager.​sidecar.​containerSecurityContext.​readOnlyRootFilesystem | bool | `true` |  |
+| alertmanager.​sidecar.​defaultFolderName | string | `""` | The default folder name, it will create a subfolder under the `folder` and put rules in there instead |
+| alertmanager.​sidecar.​enableUniqueFilenames | bool | `false` | A value of true will produce unique filenames to avoid issues when duplicate data keys exist between ConfigMaps and/or Secrets within the same or multiple Namespaces. |
+| alertmanager.​sidecar.​enabled | bool | `false` | Enable sidecar that collect the configmaps with specified label and stores the included files them into the respective folders |
+| alertmanager.​sidecar.​folder | string | `"/data"` | Folder where the files should be placed. |
+| alertmanager.​sidecar.​folderAnnotation | string | `"k8s-sidecar-target-directory"` | The annotation the sidecar will look for in ConfigMaps and/or Secrets to override the destination folder for files. If the value is a relative path, it will be relative to FOLDER |
+| alertmanager.​sidecar.​image.​repository | string | `"omegavveapon/kopf-k8s-sidecar"` |  |
+| alertmanager.​sidecar.​image.​sha | string | `""` |  |
+| alertmanager.​sidecar.​image.​tag | string | `"1.4.0"` |  |
+| alertmanager.​sidecar.​imagePullPolicy | string | `"IfNotPresent"` |  |
+| alertmanager.​sidecar.​label | string | `"cortex_alertmanager"` | Label that should be used for filtering |
+| alertmanager.​sidecar.​labelValue | string | `""` | The value for the label you want to filter your resources on. Don't set a value to filter by any value |
+| alertmanager.​sidecar.​resource | string | `"both"` | The resource type that the operator will filter for. Can be configmap, secret or both |
+| alertmanager.​sidecar.​resources | object | `{}` |  |
+| alertmanager.​sidecar.​searchNamespace | string | `""` | The Namespace(s) from which resources will be watched. For multiple namespaces, use a comma-separated string like "default,test". If not set or set to ALL, it will watch all Namespaces. |
+| alertmanager.​sidecar.​skipTlsVerify | bool | `false` | Set to true to skip tls verification for kube api calls |
+| alertmanager.​sidecar.​watchMethod | string | `""` | Determines how kopf-k8s-sidecar will run. If WATCH it will run like a normal operator forever. If LIST it will gather the matching configmaps and secrets currently present, write those files to the destination directory and die |
 | alertmanager.​startupProbe.​failureThreshold | int | `10` |  |
 | alertmanager.​startupProbe.​httpGet.​path | string | `"/ready"` |  |
 | alertmanager.​startupProbe.​httpGet.​port | string | `"http-metrics"` |  |
@@ -637,13 +653,24 @@ Kubernetes: `^1.19.0-0`
 | ruler.​serviceMonitor.​extraEndpointSpec | object | `{}` | Additional endpoint configuration https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#endpoint |
 | ruler.​serviceMonitor.​metricRelabelings | list | `[]` |  |
 | ruler.​serviceMonitor.​relabelings | list | `[]` |  |
-| ruler.​sidecar | object | `{"containerSecurityContext":{"enabled":true,"readOnlyRootFilesystem":true},"defaultFolderName":null,"enableUniqueFilenames":false,"enabled":false,"folder":"/tmp/rules","folderAnnotation":null,"image":{"repository":"quay.io/kiwigrid/k8s-sidecar","sha":"","tag":"1.10.7"},"imagePullPolicy":"IfNotPresent","label":"cortex_rules","labelValue":null,"resources":{},"searchNamespace":null,"watchMethod":null}` | Sidecars that collect the configmaps with specified label and stores the included files them into the respective folders |
-| ruler.​sidecar.​defaultFolderName | string | `nil` | The default folder name, it will create a subfolder under the `folder` and put rules in there instead |
-| ruler.​sidecar.​folder | string | `"/tmp/rules"` | folder in the pod that should hold the collected rules (unless `defaultFolderName` is set) |
-| ruler.​sidecar.​folderAnnotation | string | `nil` | If specified, the sidecar will look for annotation with this name to create folder and put graph here. You can use this parameter together with `provider.foldersFromFilesStructure`to annotate configmaps and create folder structure. |
+| ruler.​sidecar.​containerSecurityContext.​enabled | bool | `true` |  |
+| ruler.​sidecar.​containerSecurityContext.​readOnlyRootFilesystem | bool | `true` |  |
+| ruler.​sidecar.​defaultFolderName | string | `""` | The default folder name, it will create a subfolder under the `folder` and put rules in there instead |
+| ruler.​sidecar.​enableUniqueFilenames | bool | `false` | A value of true will produce unique filenames to avoid issues when duplicate data keys exist between ConfigMaps and/or Secrets within the same or multiple Namespaces. |
+| ruler.​sidecar.​enabled | bool | `false` | Enable sidecar that collect the configmaps with specified label and stores the included files them into the respective folders |
+| ruler.​sidecar.​folder | string | `"/tmp/rules"` | Folder where the files should be placed. |
+| ruler.​sidecar.​folderAnnotation | string | `"k8s-sidecar-target-directory"` | The annotation the sidecar will look for in ConfigMaps and/or Secrets to override the destination folder for files. If the value is a relative path, it will be relative to FOLDER |
+| ruler.​sidecar.​image.​repository | string | `"omegavveapon/kopf-k8s-sidecar"` |  |
+| ruler.​sidecar.​image.​sha | string | `""` |  |
+| ruler.​sidecar.​image.​tag | string | `"1.4.0"` |  |
+| ruler.​sidecar.​imagePullPolicy | string | `"IfNotPresent"` |  |
 | ruler.​sidecar.​label | string | `"cortex_rules"` | label that the configmaps with rules are marked with |
-| ruler.​sidecar.​labelValue | string | `nil` | value of label that the configmaps with rules are set to |
-| ruler.​sidecar.​searchNamespace | string | `nil` | If specified, the sidecar will search for rules config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces |
+| ruler.​sidecar.​labelValue | string | `""` | The value for the label you want to filter your resources on. Don't set a value to filter by any value |
+| ruler.​sidecar.​resource | string | `"both"` | The resource type that the operator will filter for. Can be configmap, secret or both |
+| ruler.​sidecar.​resources | object | `{}` |  |
+| ruler.​sidecar.​searchNamespace | string | `""` | The Namespace(s) from which resources will be watched. For multiple namespaces, use a comma-separated string like "default,test". If not set or set to ALL, it will watch all Namespaces. |
+| ruler.​sidecar.​skipTlsVerify | bool | `false` | Set to true to skip tls verification for kube api calls |
+| ruler.​sidecar.​watchMethod | string | `""` | Determines how kopf-k8s-sidecar will run. If WATCH it will run like a normal operator forever. If LIST it will gather the matching configmaps and secrets currently present, write those files to the destination directory and die |
 | ruler.​startupProbe.​failureThreshold | int | `10` |  |
 | ruler.​startupProbe.​httpGet.​path | string | `"/ready"` |  |
 | ruler.​startupProbe.​httpGet.​port | string | `"http-metrics"` |  |

docs/guides/configure_rules_via_sidecar.markdown

@@ -10,6 +10,14 @@ Cortex can be configured to use a sidecar container in the Ruler and AlertManage
 Put ConfigMaps into the specified namespace, and they are automatically detected and added as files to the Ruler and/or AlertManager containers, both of which are polling for changes on the filesystem and will make the new configurations go live dynamically.
 This feature is disabled by default. Here is a simple example:
 
+*Please not that this is only supported with the local or filesystem backend. Otherwise cortex will overwrite what the operator puts in the folder with what is in s3/gcs/azure/swift. Cortex does not 2-way sync the files*
+
+```yaml
+backend: "filesystem"
+```
+
+## Helm values config
+
 ```yaml
 ruler:
   sidecar:

templates/alertmanager/alertmanager-dep.yaml

@@ -68,8 +68,10 @@ spec:
             {{- end }}
             - name: FOLDER
               value: "{{ .Values.alertmanager.sidecar.folder }}{{- with .Values.alertmanager.sidecar.defaultFolderName }}/{{ . }}{{- end }}"
+            {{- if .Values.alertmanager.sidecar.resource}}
             - name: RESOURCE
-              value: "both"
+              value: {{ quote .Values.alertmanager.sidecar.resource }}
+            {{- end }}
             {{- if .Values.alertmanager.sidecar.enableUniqueFilenames }}
             - name: UNIQUE_FILENAMES
               value: "{{ .Values.alertmanager.sidecar.enableUniqueFilenames }}"
@@ -85,7 +87,7 @@ spec:
             {{- if .Values.alertmanager.sidecar.folderAnnotation }}
             - name: FOLDER_ANNOTATION
               value: "{{ .Values.alertmanager.sidecar.folderAnnotation }}"
-          {{- end }}
+            {{- end }}
           resources:
             {{- toYaml .Values.alertmanager.sidecar.resources | nindent 12 }}
           {{- if .Values.alertmanager.sidecar.containerSecurityContext.enabled }}

templates/alertmanager/alertmanager-statefulset.yaml

@@ -113,8 +113,10 @@ spec:
             {{- end }}
             - name: FOLDER
               value: "{{ .Values.alertmanager.sidecar.folder }}{{- with .Values.alertmanager.sidecar.defaultFolderName }}/{{ . }}{{- end }}"
+            {{- if .Values.alertmanager.sidecar.resource}}
             - name: RESOURCE
-              value: "both"
+              value: {{ quote .Values.alertmanager.sidecar.resource }}
+            {{- end }}
             {{- if .Values.alertmanager.sidecar.enableUniqueFilenames }}
             - name: UNIQUE_FILENAMES
               value: "{{ .Values.alertmanager.sidecar.enableUniqueFilenames }}"
@@ -130,7 +132,7 @@ spec:
             {{- if .Values.alertmanager.sidecar.folderAnnotation }}
             - name: FOLDER_ANNOTATION
               value: "{{ .Values.alertmanager.sidecar.folderAnnotation }}"
-          {{- end }}
+            {{- end }}
           resources:
             {{- toYaml .Values.alertmanager.sidecar.resources | nindent 12 }}
           {{- if .Values.alertmanager.sidecar.containerSecurityContext.enabled }}

templates/ruler/ruler-dep.yaml

@@ -67,8 +67,10 @@ spec:
             {{- end }}
             - name: FOLDER
               value: "{{ .Values.ruler.sidecar.folder }}{{- with .Values.ruler.sidecar.defaultFolderName }}/{{ . }}{{- end }}"
+            {{- if .Values.ruler.sidecar.resource}}
             - name: RESOURCE
-              value: "both"
+              value: {{ quote .Values.ruler.sidecar.resource }}
+            {{- end }}
             {{- if .Values.ruler.sidecar.enableUniqueFilenames }}
             - name: UNIQUE_FILENAMES
               value: "{{ .Values.ruler.sidecar.enableUniqueFilenames }}"
@@ -84,7 +86,7 @@ spec:
             {{- if .Values.ruler.sidecar.folderAnnotation }}
             - name: FOLDER_ANNOTATION
               value: "{{ .Values.ruler.sidecar.folderAnnotation }}"
-          {{- end }}
+            {{- end }}
           resources:
             {{- toYaml .Values.ruler.sidecar.resources | nindent 12 }}
           {{- if .Values.ruler.containerSecurityContext.enabled }}

values.yaml

@@ -292,25 +292,42 @@ alertmanager:
   # -- Extra env variables to pass to the cortex container
   env: []
 
-  # -- Sidecars that collect the configmaps with specified label and stores the included files them into the respective folders
   sidecar:
+    # -- Enable sidecar that collect the configmaps with specified label and stores the included files them into the respective folders
+    enabled: false
     image:
-      repository: quay.io/kiwigrid/k8s-sidecar
-      tag: 1.10.7
+      repository: omegavveapon/kopf-k8s-sidecar
+      tag: 1.4.0
       sha: ""
     imagePullPolicy: IfNotPresent
     resources: {}
-    # -- skipTlsVerify Set to true to skip tls verification for kube api calls
+    # -- Set to true to skip tls verification for kube api calls
     skipTlsVerify: false
+    # -- A value of true will produce unique filenames to avoid issues when duplicate data keys exist between ConfigMaps
+    # and/or Secrets within the same or multiple Namespaces.
     enableUniqueFilenames: false
-    enabled: false
+    # -- Label that should be used for filtering
     label: cortex_alertmanager
-    watchMethod: null
-    labelValue: null
+    # -- Determines how kopf-k8s-sidecar will run. If WATCH it will run like a normal operator forever.
+    # If LIST it will gather the matching configmaps and secrets currently present,
+    # write those files to the destination directory and die
+    watchMethod: ""
+    # -- The value for the label you want to filter your resources on.
+    # Don't set a value to filter by any value
+    labelValue: ""
+    # -- Folder where the files should be placed.
     folder: /data
-    defaultFolderName: null
-    searchNamespace: null
-    folderAnnotation: null
+    # -- The default folder name, it will create a subfolder under the `folder` and put rules in there instead
+    defaultFolderName: ""
+    # -- The Namespace(s) from which resources will be watched.
+    # For multiple namespaces, use a comma-separated string like "default,test".
+    # If not set or set to ALL, it will watch all Namespaces.
+    searchNamespace: ""
+    # -- The annotation the sidecar will look for in ConfigMaps and/or Secrets to override the destination folder for files.
+    # If the value is a relative path, it will be relative to FOLDER
+    folderAnnotation: "k8s-sidecar-target-directory"
+    # -- The resource type that the operator will filter for. Can be configmap, secret or both
+    resource: "both"
     containerSecurityContext:
       enabled: true
       readOnlyRootFilesystem: true
@@ -655,40 +672,42 @@ ruler:
   # -- allow configuring rules via configmap. ref: https://cortexproject.github.io/cortex-helm-chart/guides/configure_rules_via_configmap.html
   directories: {}
 
-  # -- Sidecars that collect the configmaps with specified label and stores the included files them into the respective folders
   sidecar:
+    # -- Enable sidecar that collect the configmaps with specified label and stores the included files them into the respective folders
+    enabled: false
     image:
-      repository: quay.io/kiwigrid/k8s-sidecar
-      tag: 1.10.7
+      repository: omegavveapon/kopf-k8s-sidecar
+      tag: 1.4.0
       sha: ""
     imagePullPolicy: IfNotPresent
     resources: {}
-    #   limits:
-    #     cpu: 100m
-    #     memory: 100Mi
-    #   requests:
-    #     cpu: 50m
-    #     memory: 50Mi
-    # skipTlsVerify Set to true to skip tls verification for kube api calls
-    # skipTlsVerify: true
+    # -- Set to true to skip tls verification for kube api calls
+    skipTlsVerify: false
+    # -- A value of true will produce unique filenames to avoid issues when duplicate data keys exist between ConfigMaps
+    # and/or Secrets within the same or multiple Namespaces.
     enableUniqueFilenames: false
-    enabled: false
     # -- label that the configmaps with rules are marked with
     label: cortex_rules
-    watchMethod: null
-    # -- value of label that the configmaps with rules are set to
-    labelValue: null
-    # -- folder in the pod that should hold the collected rules (unless `defaultFolderName` is set)
+    # -- Determines how kopf-k8s-sidecar will run. If WATCH it will run like a normal operator forever.
+    # If LIST it will gather the matching configmaps and secrets currently present,
+    # write those files to the destination directory and die
+    watchMethod: ""
+    # -- The value for the label you want to filter your resources on.
+    # Don't set a value to filter by any value
+    labelValue: ""
+    # -- Folder where the files should be placed.
     folder: /tmp/rules
     # -- The default folder name, it will create a subfolder under the `folder` and put rules in there instead
-    defaultFolderName: null
-    # -- If specified, the sidecar will search for rules config-maps inside this namespace.
-    # Otherwise the namespace in which the sidecar is running will be used.
-    # It's also possible to specify ALL to search in all namespaces
-    searchNamespace: null
-    # -- If specified, the sidecar will look for annotation with this name to create folder and put graph here.
-    # You can use this parameter together with `provider.foldersFromFilesStructure`to annotate configmaps and create folder structure.
-    folderAnnotation: null
+    defaultFolderName: ""
+    # -- The Namespace(s) from which resources will be watched.
+    # For multiple namespaces, use a comma-separated string like "default,test".
+    # If not set or set to ALL, it will watch all Namespaces.
+    searchNamespace: ""
+    # -- The annotation the sidecar will look for in ConfigMaps and/or Secrets to override the destination folder for files.
+    # If the value is a relative path, it will be relative to FOLDER
+    folderAnnotation: "k8s-sidecar-target-directory"
+    # -- The resource type that the operator will filter for. Can be configmap, secret or both
+    resource: "both"
     containerSecurityContext:
       enabled: true
       readOnlyRootFilesystem: true