Confluence - Made For UDS Badge

[corang]

Istio

• Must define any external interfaces under the expose key.
• Must deploy and operate successfully with Istio injection enabled in the namespace.
• Should avoid workarounds such as disabling strict mTLS peer authentication.

Network Policies

• Must define network policies under the allow key as required.
• Should minimize network policies to specific selectors needed for Ingress/Egress traffic. #7
• May template network policy keys to provide flexibility for delivery customers to configure. #8

Keycloak

• Must use and create a Keycloak client through the sso key if the application provides a user login.
• Should consider security options during implementation to provide the most secure default possible (i.e. SAML w/SCIM vs OIDC). #9
• Should name the client <App> Login (i.e. Mattermost Login) to provide login UX consistency. #10
• Should clearly mark the client id with the group and app name uds-<group>-<application> (i.e. uds-swf-mattermost) to provide consistency in the Keycloak UI. #11
• May end any generated secrets with -sso to easily locate them when querying the cluster.
• May template Keycloak fields to provide flexibility for delivery customers to configure. #13

Prometheus

• Must implement monitors for each application metrics endpoint using it's built-in chart monitors, the Package CR monitor key, or manual monitors in the config chart. #12

Exemptions

UDS Packages may make use of the UDS Exemption custom resource for exempting any Pepr policies, but in doing so they:

• Must minimize the scope and number of the exemptions to only what is absolutely required by the application
• Must have documented rationale for any exemptions present

Structure

Packages also follow structural guidelines to ensure consistency and flexibility for configuration, they:

• Should expose all configuration (uds.dev CRs, additional Secrets/ConfigMaps, etc) through a Helm chart (ideally in a chart or charts directory).

  This allows UDS bundles to override configuration with Helm overrides and enables downstream teams to fully control their bundle configurations.

• Should limit the use of Zarf variable templates and prioritize configuring packages via Helm value overrides #15

  This ensures that the package is configured the same way that the bundle would be and avoids any side effect issues of Zarf's ### templating

• Should implement or allow for multiple flavors (ideally with common definitions in a common directory) #14

  This allows for different images or configurations to be delivered consistently to customers.

Testing

A UDS Package will also have testing and quality checks to ensure that updates / changes to them result in minimal churn. Packages:

• Must implement Journey Testing to cover the basic user flows and features of the application, especially where an application interacts with an external service / interface. #16

  This can by something like Playwright / Cypress tests for services with a Web UI or something like Jest tests for headless services.

• Must implement Upgrade Testing to ensure that the current development package works when deployed over the previously released one.

• Should lint their configurations with appropriate tooling such as yamllint and zarf dev lint. #17

Maintenance

To help maintain a UDS Package, it:

• Must have a dependency management bot (such as renovate) configured to open PRs to update core package and support dependencies.

• Must release its package to the ghcr.io/defenseunicorns/packages/<group> namespace as the application's name (i.e. ghcr.io/defenseunicorns/packages/uds/mattermost)

General

And in addition to the above, packages generally:

• Must be capable of operating within an internet-disconnected (air-gapped) environment

• Must be maintained by a resourced team that is explicitly defined as maintaining the project (i.e. in CODEOWNERS) #18

[andrewg-xyz]

tracked elsewhere