BCDevOps / developer-experience

This repository is used to track all work for the BCGov Platform Services Team (This includes work for: 1. Platform Experience, 2. Developer Experience 3. Platform Operations/OCP 3)
Apache License 2.0
8 stars 17 forks source link

Document UI/UX improvements for the Assessment App #2043

Closed ShovelHand closed 2 years ago

ShovelHand commented 2 years ago

Martha says:

DOD Note that one item on this ticket was pushed off, so the "1,2,3" below may not make total sense.

ShovelHand commented 2 years ago

@mitovskaol What do you think of this, Olena? The AppAssessment tool conducts a suite of tests on pods operating within the namespace that it is installed on, and provides feedback on configurations considered to be best practice. Checks are performed through API calls to OpenShift, and compared to expected values. Documentation on application health checks can be found here <link to https://docs.openshift.com/container-platform/4.9/applications/application-health.html>_

Too much? Too little? I aimed to be concise.

mitovskaol commented 2 years ago

The AppAssessment tool assesses configuration of pods within a specific Openshift namespace and identifies the misconfigured or missing settings based on what is considered best practices by RedHat and the Platform Services Team. Checks are performed through the calls to Openshift API, and compared to expected values. Documentation on application health checks can be found here <link to https://docs.openshift.com/container-platform/4.9/applications/application-health.html>. If your team is aware of additional checks that can be added to the list, please, ping us in #devops-operations channel in Rocketchat. Configuring applications pods in acccordance with best practices improves the resiliency, performance and security posture of the application.

Note: The report produced by the AppAssessment tool provides recommendations only, it is the responsibility of the product team to review the recommendations and implement as necessary.

How about this one?

ShovelHand commented 2 years ago

Oh, that's way better!