Skip to content

feat(ws): Define k8s workload manifest for backend component #324 #455

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

Open
wants to merge 3 commits into
base: notebooks-v2
Choose a base branch
from

Conversation

liavweiss
Copy link

@liavweiss liavweiss commented Jul 1, 2025

closes: #324

In this PR I have created the manifest workload for the backend component.
Added 2 targets to the Makefile deploy and undeploy.

How to deploy the backed component:

cd workspaces/backend
make docker-build
make docker-push
make deploy
kubectl port-forward svc/nbv2-backend 4000:4000 -n backend-system

How to undeploy the backed component:

cd workspaces/backend
make undeploy

@andyatmiami, regarding this PR, I want to consult with you:

  1. I used type: NodePort in the service.yaml mainly because we dont have yet an nginx-ingress
    I can change it to be type: ClusterIP if needed
  2. Im not sure about the image/container names, do you think we need to chnage it to be just a backend or we can leave it as it is nbv2-backend?

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign thesuperzapper for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot added area/backend area - related to backend components area/v2 area - version - kubeflow notebooks v2 labels Jul 1, 2025
kind: Service
metadata:
name: nbv2-backend
namespace: backend-system
Copy link
Contributor

Choose a reason for hiding this comment

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

app.kubernetes.io/component: backend
app.kubernetes.io/managed-by: kustomize
name: nbv2-backend
namespace: backend-system
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

@andyatmiami andyatmiami left a comment

Choose a reason for hiding this comment

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

w.r.t the "directory structure" for these files - I would propose the following:

	workspaces/
	├── backend/
		├── api/
		├── cmd/
		├── internal/
		├── manifests/
		│   ├── kustomize/
		│   │   ├── base/
		│   │   ├── overlays/			# (not needed - including as merely an example of future-proofing)
		│   │   │   ├── dev/
		│   │   │   ├── staging/
		│   │   │   └── prod/
		│   │   └── options/            # (not needed - including as merely an example of future-proofing)
		│   └── helm/                   # (not needed - including as merely an example of future-proofing)
		├── openapi/
		├── Dockerfile
		├── Makefile
		├── README.md
		├── ...

I feel this aligns more (loosely) with "industry standards" and/or expectations.

livenessProbe:
httpGet:
path: /api/v1/healthcheck
port: 4000
Copy link
Contributor

Choose a reason for hiding this comment

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

@liavweiss liavweiss force-pushed the backend_deploy/#234 branch from 48d4a74 to d14d479 Compare July 17, 2025 08:24
@liavweiss liavweiss force-pushed the backend_deploy/#234 branch from 5135cf3 to 6d78b09 Compare July 17, 2025 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/backend area - related to backend components area/v2 area - version - kubeflow notebooks v2 size/L
Projects
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

2 participants