feat(ws): frontend Makefile to support deploy

[mkoushni]

Add standardized Makefile for workspaces/frontend in notebooks-v2
related #528

Description

Introduce a Makefile under workspaces/frontend in the notebooks-v2 branch to streamline common build and deployment workflows for the frontend service.

The Makefile should follow the same structure and conventions already established in the controller and backend components, providing consistency across the project. It should include targets for building, pushing, and deploying the frontend container image, as well as handling cross-platform builds and undeployment from remote clusters.

This enables developers to work with the frontend service in a uniform way without needing custom scripts, ensuring easier onboarding, fewer errors, and alignment with the broader project tooling.

Scope

Place Makefile at the root of workspaces/frontend.

Expose standardized targets:

docker-build: build local frontend image

docker-push: push frontend image to registry

docker-buildx: build/push cross-platform images with BuildKit

deploy: deploy frontend via kustomize into Kubernetes cluster

undeploy: remove frontend resources from the cluster

Include helper targets like help, clean, and dependency installation (e.g., kustomize).

Support overriding image name/tag, container tool, and Kustomize directory through environment variables.

[andyatmiami]

This line is wrong - should be $(KUBECTL)

As written - trying to run this commend results in:

/Users/astonebe/Development/Code/GitHub/kubeflow-notebooks/workspaces/frontend/bin/kustomize apply -k manifests/kustomize/overlays/istio
Error: unknown command "apply" for "kustomize"
Run 'kustomize --help' for usage.
gmake: *** [Makefile:62: deploy] Error 1

please test your changes before having PR ready for review 🙇

[andyatmiami]

see: https://github.com/kubeflow/notebooks/pull/534/files#r2311988436

[mkoushni]

fixed

mkoushni@mkoushni-thinkpadp14sgen2i:~/Applications/Notebook/notebooks/workspaces/frontend$ make deploy
cd manifests/kustomize/overlays/istio && /home/mkoushni/Applications/Notebook/notebooks/workspaces/frontend/bin/kustomize edit set image workspaces-frontend=nbv2-frontend:latest
kubectl apply -k manifests/kustomize/overlays/istio
namespace/kubeflow-workspaces unchanged
service/workspaces-frontend unchanged
deployment.apps/workspaces-frontend unchanged
destinationrule.networking.istio.io/workspaces-frontend created
virtualservice.networking.istio.io/workspaces-frontend created
authorizationpolicy.security.istio.io/workspaces-frontend created

mkoushni@mkoushni-thinkpadp14sgen2i:~/Applications/Notebook/notebooks/workspaces/frontend$ make undeploy
kubectl delete -k manifests/kustomize/overlays/istio --ignore-not-found=true
namespace "kubeflow-workspaces" deleted
service "workspaces-frontend" deleted
deployment.apps "workspaces-frontend" deleted
destinationrule.networking.istio.io "workspaces-frontend" deleted
virtualservice.networking.istio.io "workspaces-frontend" deleted
authorizationpolicy.security.istio.io "workspaces-frontend" deleted

[mkoushni]

istio crd installation for makefile testing :
helm repo add istio https://istio-release.storage.googleapis.com/charts
helm repo update
helm upgrade --install istio-base istio/base -n istio-system --create-namespace
helm upgrade --install istiod istio/istiod -n istio-system

[andyatmiami]

we should be modifying the .gitignore of the frontend directory for better co-locality.

its cleaner to use a relative reference as in the following so its not as sensitive to potential future renames of parent directories

[andyatmiami]

/ok-to-test
/lgtm

• Verified functionality in script is consistent with implementation in backend component
• Confirmed commands operate as expected

➜ frontend/ git:((HEAD detached at marina/makefile_528_cl)) $ DOCKER_BUILDKIT=0 gmake docker-build IMG=quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test

docker build -t quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test .
DEPRECATED: The legacy builder is deprecated and will be removed in a future release.
            BuildKit is currently disabled; enable it by removing the DOCKER_BUILDKIT=0
            environment-variable.

Sending build context to Docker daemon  27.46MB
...
[2/2] COMMIT quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test
--> 2fdeead2c878
Successfully tagged quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test
Successfully tagged quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:makefile-frontend-verify
2fdeead2c8789cbcebeb6b785d2c51f0508dfb0d85588252168f59a94decd528
Successfully built 2fdeead2c878
Successfully tagged quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test

➜ frontend/ git:((HEAD detached at marina/makefile_528_cl)) $ DOCKER_BUILDKIT=0 gmake docker-push IMG=quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test

docker push quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test
The push refers to repository [quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test]
frontend-makefile-test: digest: sha256:d8971cd0e2ba22749b63005ff57e68b40c8ad62eebdaa7bf377499b417015ef7 size: 2156

➜ frontend/ git:((HEAD detached at marina/makefile_528_cl)) $ DOCKER_BUILDKIT=0 gmake deploy IMG=quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test

cd manifests/kustomize/overlays/istio && /Users/astonebe/Development/Code/GitHub/kubeflow-notebooks/workspaces/frontend/bin/kustomize edit set image workspaces-frontend=quay.io/rh-ee-astonebe/kubeflow-notebooks-v2:frontend-makefile-test
kubectl apply -k manifests/kustomize/overlays/istio
namespace/kubeflow-workspaces unchanged
service/workspaces-frontend unchanged
deployment.apps/workspaces-frontend configured
destinationrule.networking.istio.io/workspaces-frontend unchanged
virtualservice.networking.istio.io/workspaces-frontend unchanged
authorizationpolicy.security.istio.io/workspaces-frontend unchanged

➜ frontend/ git:((HEAD detached at marina/makefile_528_cl)) $ gmake clean

rm -rf ./bin ./Dockerfile.cross

➜ frontend/ git:((HEAD detached at marina/makefile_528_cl)) $ gmake undeploy

mkdir -p /Users/astonebe/Development/Code/GitHub/kubeflow-notebooks/workspaces/frontend/bin
Downloading sigs.k8s.io/kustomize/kustomize/[email protected]
kubectl delete -k manifests/kustomize/overlays/istio --ignore-not-found=true
namespace "kubeflow-workspaces" deleted
service "workspaces-frontend" deleted
deployment.apps "workspaces-frontend" deleted
destinationrule.networking.istio.io "workspaces-frontend" deleted
virtualservice.networking.istio.io "workspaces-frontend" deleted
authorizationpolicy.security.istio.io "workspaces-frontend" deleted

• ℹ️ Note here because we currently deploy the namespace as part of both frontend and backend - calling undeploy has the effect of deleting the backend components. This behavior is currently also present in the backend (in which frontend resources would also get nuked as part of namespace deletion)
  • We should discuss how to handle this longer term outside the scope of this PR - but for now the benefits of this PR (imho) outweigh this edge case - particularly given it already exists in the backend component.

[thesuperzapper]

/ok-to-test

[thesuperzapper]

Thanks @mkoushni and @andyatmiami, next step is to use this in a CICD test?

/lgtm
/approve

[google-oss-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: thesuperzapper

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

The pull request process is described here

Needs approval from an approver in each of these files:

• workspaces/frontend/OWNERS [thesuperzapper]

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