Skip to content
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.

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

chore: add Made for UDS badge to Mattermost #90

Merged
merged 1 commit into from
Jun 10, 2024
Merged

Conversation

Racer159
Copy link
Contributor

@Racer159 Racer159 commented Jun 6, 2024

Description

This adds the Made for UDS badge to Mattermost given it meets the following:

Integrations

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.
  • - May template network policy keys to provide flexibility for delivery customers to configure.

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).
  • - Should name the client <App> Login (i.e. Mattermost Login) to provide login UX consistency.
  • - 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.
  • - 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.

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.

Exemptions

  • - 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

  • - Should expose all configuration (uds.dev CRs, additional Secrets/ConfigMaps, etc) through a Helm chart (ideally in a chart or charts directory).
  • - Should limit the use of Zarf variable templates and prioritize configuring packages via Helm value overrides
  • - Should implement or allow for multiple flavors (ideally with common definitions in a common directory)

Testing

  • - 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.
  • - 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.

Maintenance

  • - 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

  • - 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)

Related Issue

Fixes #N/A

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@Racer159 Racer159 requested a review from a team as a code owner June 6, 2024 18:59
@Racer159 Racer159 merged commit fce7636 into main Jun 10, 2024
9 checks passed
@Racer159 Racer159 deleted the add-made-for-uds branch June 10, 2024 16:33
ericwyles pushed a commit that referenced this pull request Jun 20, 2024
🤖 I have created a release *beep* *boop*
---


##
[9.8.1-uds.1](v9.8.1-uds.0...v9.8.1-uds.1)
(2024-06-20)


### Features

* add wait for MM package CR readiness
([#88](#88))
([8c18d54](8c18d54))


### Miscellaneous

* add `Made for UDS` badge to Mattermost
([#90](#90))
([fce7636](fce7636))
* add testing on arm64 architecture using qemu
([#95](#95))
([ba4e8cc](ba4e8cc))
* add tests before publishing a release and remove arm64 architecture
([#91](#91))
([c136830](c136830))
* **deps:** update mattermost support dependencies
([#87](#87))
([c0e0ca9](c0e0ca9))
* **deps:** update mattermost support dependencies
([#94](#94))
([c4fecda](c4fecda))
* exclude registry1 arm64 architecture from matrix
([#97](#97))
([7c6199d](7c6199d))
* refactor to skip tests on arm64
([#96](#96))
([b337bdb](b337bdb))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants