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

Extend allInstances with the component names of instantiated components #5

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

simu
Copy link
Member

@simu simu commented Jan 8, 2025

The design doc (SDD-0030) specifies that entries in syn.<team>.instances must be component instances.

However, Commodore doesn't require that instance-aware components generate an ArgoCD application per instance, and some existing components generate a single ArgoCD application for all their instances.

For such components, individual instances can't be assigned to a team, but the whole component can be assigned.

To accommodate this design choice, we keep both the instance and component names in allInstances for instantiated components. This ensures that library consumers can correctly look up the team for a component which generates a single ArgoCD application for all instances.

Checklist

  • The PR has a meaningful title. It will be used to auto-generate the
    changelog.
    The PR has a meaningful description that sums up the change. It will be
    linked in the changelog.
  • PR contains a single logical change (to build a better changelog).
  • Update the documentation.
  • Categorize the PR by adding one of the labels:
    bug, enhancement, documentation, change, breaking, dependency
    as they show up in the changelog.

@simu simu added the enhancement New feature or request label Jan 8, 2025
@simu simu requested a review from a team January 8, 2025 10:16
@simu simu changed the title Extend allInstances with the component names for instantiated components Extend allInstances with the component names of instantiated components Jan 8, 2025
…ents

The design doc (SDD-0030) specifies that entries in `syn.<team>.instances`
must be component instances.

However, Commodore doesn't require that instance-aware components generate
an ArgoCD application per instance, and some existing components generate a
single ArgoCD application for all their instances.

For such components, individual instances can't be assigned to a team, but
the whole component can be assigned.

To accommodate this design choice, we keep both the instance and
component names in `allInstances` for instantiated components. This
ensures that library consumers can correctly look up the team for a
component which generates a single ArgoCD application for all instances.
@simu simu force-pushed the feat/component-team-assignment branch from b7cd6f4 to 2ad079a Compare January 8, 2025 10:23
Copy link

@HappyTetrahedron HappyTetrahedron left a comment

Choose a reason for hiding this comment

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

LGTM

@simu simu merged commit f8c56c7 into main Jan 9, 2025
4 checks passed
@simu simu deleted the feat/component-team-assignment branch January 9, 2025 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants