Skip to content

Conversation

NoaheCampbell
Copy link
Contributor

What this PR does / why we need it:

Mirrors the recent support bundle analyzer into the host preflight to better and more clearly show interference from antivirus tools before installation issues occur. This emits warnings (not failures) and includes the list of detected tools plus guidance.

Which issue(s) this PR fixes:

https://app.shortcut.com/replicated/story/129800/add-complimentary-preflight-for-security-tools-detection

Does this PR require a test?

NONE

Does this PR require a release note?

NONE

Does this PR require documentation?

NONE

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

@NoaheCampbell NoaheCampbell changed the title Update host-preflight.yaml Add complimentary preflight for Security Tools detection Oct 6, 2025
Copy link

github-actions bot commented Oct 6, 2025

This PR has been released (on staging) and is available for download with a embedded-cluster-smoke-test-staging-app license ID.

Online Installer:

curl "https://staging.replicated.app/embedded/embedded-cluster-smoke-test-staging-app/ci/appver-dev-c81ee1c" -H "Authorization: $EC_SMOKE_TEST_LICENSE_ID" -o embedded-cluster-smoke-test-staging-app-ci.tgz

Airgap Installer (may take a few minutes before the airgap bundle is built):

curl "https://staging.replicated.app/embedded/embedded-cluster-smoke-test-staging-app/ci-airgap/appver-dev-c81ee1c?airgap=true" -H "Authorization: $EC_SMOKE_TEST_LICENSE_ID" -o embedded-cluster-smoke-test-staging-app-ci.tgz

Happy debugging!

{{ "{{" }} .Detected {{ "}}" }}
These types of tools have been known to interfere with Kubernetes operation in various ways. If you experience an installation problem, you may need to disable these tools temporarily as part of the troubleshooting process to identify if any system administrator exceptions may be required to maintain necessary internal Kubernetes operations.
- systemPackages:
Copy link
Member

Choose a reason for hiding this comment

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

I see the collector attempts to collect multiple system packages, would this analyzer exactly message look correct if the collector finds more than one?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah youre right, it looks like it would render that message for each tool it detects, I'll make a commit that should render it as a single message

The following antivirus or network security tools were detected:
{{ "{{" }} .Detected {{ "}}" }}
These types of tools have been known to interfere with Kubernetes operation in various ways. If you experience an installation problem, you may need to disable these tools temporarily as part of the troubleshooting process to identify if any system administrator exceptions may be required to maintain necessary internal Kubernetes operations.
Copy link
Member

Choose a reason for hiding this comment

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

@ajp-io should review the copy here.

outcomes:
- warn:
when: '{{ "{{" }} .IsInstalled {{ "}}" }}'
message: Package {{ "{{" }} .Name {{ "}}" }} is installed. This tool can interfere with kubernetes operation. Ensure the tool is either disabled or configured to not interfere with kubernetes operation.
Copy link
Member

Choose a reason for hiding this comment

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

@ajp-io should review the copy here.

cursor[bot]

This comment was marked as outdated.

@AmberAlston
Copy link
Member

@ajp-io I know you reviewed this copy in the original ticket but can you confirm here since Salah tagged you for review. Also @sgalsaleh it looks like this needs a rereview

@AmberAlston AmberAlston requested a review from sgalsaleh October 9, 2025 14:57
sgalsaleh
sgalsaleh previously approved these changes Oct 9, 2025
@NoaheCampbell
Copy link
Contributor Author

When installing microsoft defender on an Ubuntu VM and running the host-preflight.yaml, the analysis.json file will have the following section

  {
        "name": "detect.threat.management.and.network.security.tools",
        "labels": {
            "desiredPosition": "1",
            "iconKey": "kubernetes_text_analyze",
            "iconUri": "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg?w=13\u0026h=16"
        },
        "insight": {
            "name": "detect.threat.management.and.network.security.tools",
            "labels": {
                "iconKey": "kubernetes_text_analyze",
                "iconUri": "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg?w=13\u0026h=16"
            },
            "primary": "Detect Threat Management and Network Security Tools",
            "detail": "The following antivirus or network security tools were detected: wdavdaemon\n. These types of tools have been known to interfere with Kubernetes operation in various ways. If you experience an installation problem, you may need to disable these tools temporarily as part of the troubleshooting process to identify if any system administrator exceptions may be required to maintain necessary internal Kubernetes operations.",
            "severity": "warn"
        },
        "severity": "warn",
        "analyzerSpec": ""
    },

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants