-
Notifications
You must be signed in to change notification settings - Fork 5
chore: remove optional backend-api service from tower-svc.yml default manifest #843
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: remove optional backend-api service from tower-svc.yml default manifest #843
Conversation
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Asked in ticket, but I'll ask here too: "What was the benefit of exposing this API endpoint publicly in the first place? (beyond just specific subdomain control)" |
gwright99
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO there should be placeholder text explaining that we used to have a service there but it was removed (with a link to this issue), along with some guidance on why sites might wish to keep it around (if at all).
Let's do a favour to future us and any client doing an upgrade to help explain within the manifests why something is different rather than having to answer it one-off via support tickets.
|
@markpanganiban I would prefer not to remove this and instead add notes into the manifest explaining why it exists. The historic documentation and deployment configuration should not change for customers, as they may use these manifests to restore their environment and these changes may not be transparent for them. Complementing and explaining the configuration feels like a more appropriate approach. Adding something like. Along with something like the following. Note - we are reworking some of these aspects and looking to add appropriate warnings and disclaimers for the examples. |
Added documentation comments for the backend API service in the tower-svc.yml file, explaining its purpose and configuration requirements. Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
An issue has been created for this work as it's out of scope for this PR.
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
|
@bebosudo, the pre-commit is failing because of this: https://yaml.dev/doc/ruamel.yaml/api/#Duplicate_keys. The PR was opened before we introduced pre-commit and although it's not a blocker and we can merge, is there something we can do to mitigate the failing check? |
| - containerPort: 80 | ||
| restartPolicy: Always | ||
| --- | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@justinegeffen pre-commit is reporting an issue because this triple dash was removed, causing the two separate YAML documents (frontend deployment document and backend service document) to become a single one
while constructing a mapping
in "platform-enterprise_versioned_docs/version-25.3/enterprise/_templates/k8s/tower-svc.yml", line 74, column 1
found duplicate key "apiVersion" with value "v1" (original value: "apps/v1")
in "platform-enterprise_versioned_docs/version-25.3/enterprise/_templates/k8s/tower-svc.yml", line 100, column 1
unrelated to the error: if the backend API service is optional, shouldn't we comment it out?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary
The backend-api Service was included by default even though it’s only needed when a deployment intentionally exposes the backend to API/CLI users via a dedicated subdomain. Keeping it enabled by default caused confusion and could conflict with the frontend’s wildcard routing.
What changed
Rationale
Impact / Compatibility
Security