Skip to content

feat(cluster-scanner,sysdig-deploy): add logic to make it possible to disable platform services if needed. #1596

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 9, 2024
Merged

feat(cluster-scanner,sysdig-deploy): add logic to make it possible to disable platform services if needed. #1596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db6ca64
add logic to make it possible to disable platform services if needed.
maratsal Feb 7, 2024
6afba9e
update readme
maratsal Feb 7, 2024
da5efe5
update the name of option to make it similar to registry scanner
maratsal Feb 8, 2024
3ed456f
Merge branch 'main' into feat-add-switch-to-enable-platform-services
maratsal Feb 9, 2024
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
2 changes: 1 addition & 1 deletion charts/cluster-scanner/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: cluster-scanner
description: Sysdig Cluster Scanner

type: application
version: 0.8.8
version: 0.8.9
appVersion: "0.1.0"
home: https://www.sysdig.com/

Expand Down
9 changes: 5 additions & 4 deletions charts/cluster-scanner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ pre-commit run -a
$ helm repo add sysdig https://charts.sysdig.com
$ helm repo update
$ helm upgrade --install sysdig-cluster-scanner sysdig/cluster-scanner \
--create-namespace -n sysdig --version=0.8.8 \
--create-namespace -n sysdig --version=0.8.9 \
--set global.clusterConfig.name=CLUSTER_NAME \
--set global.sysdig.region=SYSDIG_REGION \
--set global.sysdig.accessKey=YOUR-KEY-HERE
Expand Down Expand Up @@ -55,7 +55,7 @@ To install the chart with the release name `cluster-scanner`, run:

```console
$ helm upgrade --install sysdig-cluster-scanner sysdig/cluster-scanner \
--create-namespace -n sysdig --version=0.8.8 \
--create-namespace -n sysdig --version=0.8.9 \
--set global.clusterConfig.name=CLUSTER_NAME \
--set global.sysdig.region=SYSDIG_REGION \
--set global.sysdig.accessKey=YOUR-KEY-HERE
Expand Down Expand Up @@ -156,13 +156,14 @@ The following table lists the configurable parameters of the `cluster-scanner` c
| ssl.ca.existingCaSecretKeyName | Provide the filename that is defined inside the existing Secret | <code></code> |
| ssl.ca.existingCaConfigMap | Provide the name of an existing ConfigMap that contains the CA required | <code></code> |
| ssl.ca.existingCaConfigMapKeyName | Provide the filename that is defined inside the existing ConfigMap | <code></code> |
| disablePlatformScanning | Option to make it possible to disable platform services | <code>false</code> |


Specify each parameter using the **`--set key=value[,key=value]`** argument to `helm upgrade --install`. For example:

```console
$ helm upgrade --install sysdig-cluster-scanner sysdig/cluster-scanner \
--create-namespace -n sysdig --version=0.8.8 \
--create-namespace -n sysdig --version=0.8.9 \
--set global.sysdig.region="us1"
```

Expand All @@ -171,7 +172,7 @@ installing the chart. For example:

```console
$ helm upgrade --install sysdig-cluster-scanner sysdig/cluster-scanner \
--create-namespace -n sysdig --version=0.8.8 \
--create-namespace -n sysdig --version=0.8.9 \
--values values.yaml
```

Expand Down
2 changes: 1 addition & 1 deletion charts/cluster-scanner/templates/_helpers.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ It also makes sure that the platform services are enabled in regions which suppo
{{- define "cluster-scanner.enablePlatformServicesConfig" -}}
{{- if ( semverCompare ">= 7.0.0" (.Values.onPremCompatibilityVersion | default "7.0.0" )) -}}
{{- $regionsPlatformEnabled := list "us1" "us2" "us3" "us4" "au1" "eu1" -}}
{{- if or (has .Values.global.sysdig.region $regionsPlatformEnabled) .Values.onPremCompatibilityVersion -}}
{{- if and (not .Values.disablePlatformScanning) (or (has .Values.global.sysdig.region $regionsPlatformEnabled) .Values.onPremCompatibilityVersion) -}}
enable_platform_services: "true"
{{- end -}}
{{- end -}}
Expand Down
19 changes: 19 additions & 0 deletions charts/cluster-scanner/tests/configmap_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,25 @@ tests:
path: data.enable_platform_services
value: "true"

- it: "has correct platform services value when enablePlatformServicesConfig is set to false provided and region supports platform services"
set:
global.sysdig.apiHost: "http://test.com"
global.sysdig.region: "us1"
disablePlatformScanning: true
asserts:
- isNull:
path: data.enable_platform_services

- it: "has correct platform services value when onPremCompatibilityVersion is = 7.0.0, region does NOT support platform services and enablePlatformServicesConfig set to false"
set:
global.sysdig.apiHost: "http://test.com"
onPremCompatibilityVersion: "7.0.0"
global.sysdig.region: ""
disablePlatformScanning: true
asserts:
- isNull:
path: data.enable_platform_services

- it: "fails if onPremCompatibilityVersion is not a valid semver"
set:
global.sysdig.apiHost: "http://test.com"
Expand Down
3 changes: 3 additions & 0 deletions charts/cluster-scanner/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,3 +322,6 @@ ssl:
existingCaConfigMap:
# Provide the filename that is defined inside the existing ConfigMap
existingCaConfigMapKeyName:

# Option to make it possible to disable platform services
disablePlatformScanning: false