Skip to content

[patch] Support Opt-Out Metrics Reporting Flags in GitOps Automation #1857

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

Open
ashleytate614 wants to merge 12 commits into
base: master
Choose a base branch
from
Open

[patch] Support Opt-Out Metrics Reporting Flags in GitOps Automation #1857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
eb0f7e1
[patch] Add adoption metrics reporting flag for gitops
ashleytate614 Oct 29, 2025
33f24db
[patch] update .secrets.baseline
ashleytate614 Oct 30, 2025
04d04eb
[patch] Update again
ashleytate614 Oct 30, 2025
1a69f6b
Merge branch 'master' into mascore-9752
ashleytate614 Feb 10, 2026
7d62b93
[patch] add additional opt out flags
ashleytate614 Feb 10, 2026
59b53a7
[patch] update secrets baseline
ashleytate614 Feb 10, 2026
1f4f275
[patch] update secrets.baseline
ashleytate614 Feb 10, 2026
0cd8e0f
[patch] set flags to false
ashleytate614 Feb 11, 2026
db19e23
Merge branch 'master' into mascore-9752
ashleytate614 Feb 12, 2026
23acba7
[patch] upgrade buildx
ashleytate614 Feb 12, 2026
21f2524
[patch] update flag names
ashleytate614 Feb 12, 2026
daef5c0
Merge branch 'master' into mascore-9752
ashleytate614 Feb 13, 2026
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
6 changes: 3 additions & 3 deletions .secrets.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"files": "build/bin/config/oscap/ssg-rhel9-ds.xml|^.secrets.baseline$",
"lines": null
},
"generated_at": "2026-01-29T07:04:47Z",
"generated_at": "2026-02-10T22:36:12Z",
"plugins_used": [
{
"name": "AWSKeyDetector"
Expand Down Expand Up @@ -454,7 +454,7 @@
"hashed_secret": "b2817467154949a61f8e9ad31d1eeaf03221cbfa",
"is_secret": false,
"is_verified": false,
"line_number": 598,
"line_number": 618,
"type": "Secret Keyword",
"verified_result": null
}
Expand Down Expand Up @@ -690,7 +690,7 @@
"hashed_secret": "fee2d55ad9a49a95fc89abe8f414dad66704ebfd",
"is_secret": false,
"is_verified": false,
"line_number": 23,
"line_number": 26,
"type": "Secret Keyword",
"verified_result": null
}
Expand Down
20 changes: 20 additions & 0 deletions image/cli/mascli/functions/gitops_suite
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ IBM Maximo Application Suite:
--enhanced-dr ${COLOR_YELLOW}ENHANCED_DR${TEXT_RESET} To enable Enhanced Disaster Recovery
--disable-postdelete-hooks ${COLOR_YELLOW}USE_POSTDELETE_HOOKS${TEXT_RESET} Unless set (or USE_POSTDELETE_HOOKS exported and set to false), PostDelete hooks will be deployed to ensure addon CRs are properly cleaned up by ArgoCD on deletion
--is-non-shared-cluster ${COLOR_YELLOW}IS_NON_SHARED_CLUSTER${TEXT_RESET} To enable Non shared cluster
--mas-feature-usage ${COLOR_YELLOW}MAS_FEATURE_USAGE${TEXT_RESET} Flag to control feature adoption metrics used to understand feature usage and improve the product (optional, defaults to true)
--mas-deployment-progression ${COLOR_YELLOW}MAS_DEPLOYMENT_PROGRESSION${TEXT_RESET} Flag to control metrics used to understand progression of tasks and workflows within the product (optional, defaults to true)
--mas-usability-metrics ${COLOR_YELLOW}MAS_USABILITY_METRICS${TEXT_RESET} Flag to control user interface interaction metrics to improve usability (optional, defaults to true)
--suite-spec-additional-properties-yaml ${COLOR_YELLOW}SUITE_SPEC_ADDITIONAL_PROPERTIES_YAML${TEXT_RESET} Additional properties to be set in Suite CR spec
--suite-spec-settings-additional-properties-yaml ${COLOR_YELLOW}SUITE_SPEC_SETTINGS_ADDITIONAL_PROPERTIES_YAML${TEXT_RESET} Additional properties to be set in Suite CR spec.settings

Expand Down Expand Up @@ -141,6 +144,11 @@ function gitops_suite_noninteractive() {

# cert-manager namespace, in case redhat default value is cert-manager
export CERT_MANAGER_NAMESPACE=${CERT_MANAGER_NAMESPACE:-"cert-manager"}

# Enable adoption metrics reporting by default
export MAS_FEATURE_USAGE=${MAS_FEATURE_USAGE:-"true"}
export MAS_DEPLOYMENT_PROGRESSION=${MAS_DEPLOYMENT_PROGRESSION:-"true"}
export MAS_USABILITY_METRICS=${MAS_USABILITY_METRICS:-"true"}

#GenericAddon default
export EXTENSIONS=${EXTENSIONS:-"false"}
Expand Down Expand Up @@ -257,6 +265,15 @@ function gitops_suite_noninteractive() {
--mas-wipe-mongo-data)
export MAS_WIPE_MONGO_DATA=$1 && shift
;;
--mas-feature-usage)
export MAS_FEATURE_USAGE=$1 && shift
;;
--mas-deployment-progression)
export MAS_DEPLOYMENT_PROGRESSION=$1 && shift
;;
--mas-usability-metrics)
export MAS_USABILITY_METRICS=$1 && shift
;;
--suite-spec-additional-properties-yaml)
export SUITE_SPEC_ADDITIONAL_PROPERTIES_YAML=$1 && shift
;;
Expand Down Expand Up @@ -579,6 +596,9 @@ function gitops_suite() {
echo_reset_dim "Enhanced Disaster Recovery ................. ${COLOR_MAGENTA}${ENHANCED_DR}"
echo_reset_dim "Non shared cluster ......................... ${COLOR_MAGENTA}${IS_NON_SHARED_CLUSTER}"
echo_reset_dim "Java or 3rd Party Code Extensions .......... ${COLOR_MAGENTA}${EXTENSIONS}"
echo_reset_dim "Report feature use metrics ................. ${COLOR_MAGENTA}${MAS_FEATURE_USAGE}"
echo_reset_dim "Report deployment progression metrics ...... ${COLOR_MAGENTA}${MAS_DEPLOYMENT_PROGRESSION}"
echo_reset_dim "Report usability metrics ................... ${COLOR_MAGENTA}${MAS_USABILITY_METRICS}"
echo_reset_dim "Use PostDelete Hooks? ...................... ${COLOR_MAGENTA}${USE_POSTDELETE_HOOKS}"
echo_reset_dim "Suite Spec Additional Properties ........... ${COLOR_MAGENTA}${SUITE_SPEC_ADDITIONAL_PROPERTIES_YAML}"
echo_reset_dim "Suite Spec Settings Additional Properties .. ${COLOR_MAGENTA}${SUITE_SPEC_SETTINGS_ADDITIONAL_PROPERTIES_YAML}"
Expand Down
3 changes: 3 additions & 0 deletions image/cli/mascli/templates/gitops/appset-configs/cluster/instance/ibm-mas-suite.yaml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ ibm_mas_suite:
cert_manager_namespace: "{{ CERT_MANAGER_NAMESPACE }}"
ibm_entitlement_key: "<path:{{ SECRETS_PATH }}:{{ SECRET_KEY_IBM_ENTITLEMENT }}>"
domain: "{{ DOMAIN }}"
mas_feature_usage: "{{ MAS_FEATURE_USAGE }}"
mas_deployment_progression: "{{ MAS_DEPLOYMENT_PROGRESSION }}"
mas_usability_metrics: "{{ MAS_USABILITY_METRICS }}"

{%- if DNS_PROVIDER is defined and DNS_PROVIDER !='' %}
# suite dns
Expand Down
15 changes: 15 additions & 0 deletions tekton/src/pipelines/gitops/gitops-mas-instance.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,15 @@ spec:
- name: mas_wipe_mongo_data
type: string
default: "false"
- name: mas_feature_usage
type: string
default: "true"
- name: mas_deployment_progression
type: string
default: "true"
- name: mas_usability_metrics
type: string
default: "true"
- name: mas_pod_template_yaml
type: string
default: ""
Expand Down Expand Up @@ -454,6 +463,12 @@ spec:
value: $(params.mas_pod_template_yaml)
- name: mas_wipe_mongo_data
value: $(params.mas_wipe_mongo_data)
- name: mas_feature_usage
value: $(params.mas_feature_usage)
- name: mas_deployment_progression
value: $(params.mas_deployment_progression)
- name: mas_usability_metrics
value: $(params.mas_usability_metrics)
- name: suite_spec_additional_properties_yaml
value: $(params.suite_spec_additional_properties_yaml)
- name: suite_spec_settings_additional_properties_yaml
Expand Down
24 changes: 24 additions & 0 deletions tekton/src/tasks/gitops/gitops-suite.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,15 @@ spec:
- name: mas_wipe_mongo_data
type: string
default: "false"
- name: mas_feature_usage
type: string
default: "true"
- name: mas_deployment_progression
type: string
default: "true"
- name: mas_usability_metrics
type: string
default: "true"
- name: suite_spec_additional_properties_yaml
type: string
default: ""
Expand Down Expand Up @@ -244,6 +253,12 @@ spec:
value: $(params.mas_pod_template_yaml)
- name: MAS_WIPE_MONGO_DATA
value: $(params.mas_wipe_mongo_data)
- name: MAS_FEATURE_USAGE
value: $(params.mas_feature_usage)
- name: MAS_DEPLOYMENT_PROGRESSION
value: $(params.mas_deployment_progression)
- name: MAS_USABILITY_METRICS
value: $(params.mas_usability_metrics)
- name: SUITE_SPEC_ADDITIONAL_PROPERTIES_YAML
value: $(params.suite_spec_additional_properties_yaml)
- name: SUITE_SPEC_SETTINGS_ADDITIONAL_PROPERTIES_YAML
Expand Down Expand Up @@ -326,6 +341,15 @@ spec:
if [[ -z "${DELETE_WILDCARDS}" ]]; then
DELETE_WILDCARDS="false"
fi
if [[ -z "${MAS_FEATURE_USAGE}" ]]; then
MAS_FEATURE_USAGE="false"
Copy link
Contributor

@lokesh-sreedhara lokesh-sreedhara Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the flag is missing, i think we should set the default to true

Copy link
Contributor Author

@ashleytate614 ashleytate614 Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is by design. If the flag is set to false Tekton interprets that as an empty string. So we need to set the flag back to false if we get an empty string in Tekton. At this point the flag would be true if it wasn't set yet. I tested this behavior.
https://github.com/ibm-mas/cli/blob/mascore-9752/tekton/src/tasks/gitops/gitops-suite.yml.j2#L324
Screenshot 2026-02-16 at 8 50 55 AM

fi
if [[ -z "${MAS_DEPLOYMENT_PROGRESSION}" ]]; then
MAS_DEPLOYMENT_PROGRESSION="false"
Copy link
Contributor

@lokesh-sreedhara lokesh-sreedhara Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the flag is missing, i think we should set the default to true

fi
if [[ -z "${MAS_USABILITY_METRICS}" ]]; then
MAS_USABILITY_METRICS="false"
Copy link
Contributor

@lokesh-sreedhara lokesh-sreedhara Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the flag is missing, i think we should set the default to true

fi

sed -n -e 's/^.*api.fvtsaas.//p' | cut -d: -f1
mkdir -p /tmp/init-suite
Expand Down