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

Inconsistent service naming for App, Core and Support services in docker-compose #231

Closed
bnevis-i opened this issue Apr 19, 2022 · 2 comments · Fixed by #361
Closed

Inconsistent service naming for App, Core and Support services in docker-compose #231

bnevis-i opened this issue Apr 19, 2022 · 2 comments · Fixed by #361
Assignees
Labels
breaking-change tech-debt issue_type denoting refactoring to improve design or removal of temporary workarounds
Milestone

Comments

@bnevis-i
Copy link
Collaborator

bnevis-i commented Apr 19, 2022

Affected Services [REQUIRED]

All of the app services. Specifically, ones that in the docker-compose are named 'app-service-BLAH' but whose service keys are 'app-BLAH' (without -service).

Core and Support services for shour name for the service name and the long name for the service key, i.e. data and core-data

Is this a regression?

no

Description and Minimal Reproduction [REQUIRED]

The inconsistent service naming creates problems for the EdgeX delayed service start implementation. In particular, a workaround was added (edgexfoundry/edgex-go#3977) in order to accommodate the inconsistent naming.

In the failure scenario, an app service obtains its SPIFFE ID, and then fails at the edgex-spiffe-token-provider when trying to claim a secret store token. This is because the assigned SPIFFE ID, prior to the workaround, contained app-service-BLAH, but the service presented it service key as app-BLAH. Because of the mismatch, this was seen as an attempt to obtain the secret store token of another service and thus violating the security model.

After the workaround, the SPIFFE ID and the service key match. However, the correct long-term fix is for docker-compose to use 'app-BLAH', core-BLAH and support-BLAH for the service names.

There are TAF dependencies which make switching the service identifier very difficult at this time.

🌍 Your Environment

Deployment Environment: Ubuntu 21.04

EdgeX Version [REQUIRED]: Tip (Kamakura)

Anything else relevant?

@bnevis-i bnevis-i added the bug Something isn't working label Apr 19, 2022
@lenny-goodell lenny-goodell added tech-debt issue_type denoting refactoring to improve design or removal of temporary workarounds hold Intended for PRs we want to flag for ongoing review and removed bug Something isn't working labels Apr 21, 2022
@lenny-goodell lenny-goodell changed the title Inconsistent service naming for app-services in docker-compose Inconsistent service naming for App, Core and Support services in docker-compose Sep 19, 2022
@lenny-goodell
Copy link
Member

@bnevis-i , Are we ready to address this one?

@bnevis-i
Copy link
Collaborator Author

bnevis-i commented Apr 3, 2023

Yes. I think we're stable enough to start on this.

@lenny-goodell lenny-goodell removed the hold Intended for PRs we want to flag for ongoing review label Apr 3, 2023
@lenny-goodell lenny-goodell self-assigned this Apr 3, 2023
@github-project-automation github-project-automation bot moved this to New Issues in Technical WG Apr 3, 2023
@lenny-goodell lenny-goodell moved this from New Issues to In Progress in Technical WG Apr 3, 2023
@lenny-goodell lenny-goodell added this to the Minnesota milestone Apr 3, 2023
lenny-goodell pushed a commit to lenny-goodell/edgex-compose that referenced this issue Apr 3, 2023
BREAKING CHANGE: Many sevice names have changed in order to conform with core-, support-, app- and device- naming standard. Impact should be minimal
unless scripts have references to the old service names, rather than container names. Container name havent chnaged except for app-functional-tests' which is now edgex-app-functional-tests

closes edgexfoundry#231
Signed-off-by: Leonard Goodell <[email protected]>
lenny-goodell pushed a commit to lenny-goodell/edgex-compose that referenced this issue Apr 3, 2023
BREAKING CHANGE: Many sevice names have changed in order to conform with core-, support-, app- and device- naming standard. Impact should be minimal unless scripts have references to the old service names, rather than container names. Container name havent chnaged except for app-functional-tests' which is now edgex-app-functional-tests

closes edgexfoundry#231
Signed-off-by: Leonard Goodell <[email protected]>
@github-project-automation github-project-automation bot moved this from In Progress to Minnesota Done in Technical WG Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change tech-debt issue_type denoting refactoring to improve design or removal of temporary workarounds
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants