Added packages to support render/save/apply kubernetes manifests #85

swapnachagam · 2025-04-09T13:24:39Z

Overview

Github Issue: {LINK TO ISSUE}

As part of the Hackathon in Autodesk team, I have updated the existing shore render,save and exec functions to be able to generate the k8smanifests. This is a PoC only and still needs to be developed

Summary (required always)

shore render -k k

This function will be able to generate the kubernetes manifests based on main.pipeline.jsonnet in a json format which will be again converted to yaml file

**shore save -e d **

This function will be generate the kubernetes manifests in a yaml format and save them to folder called generated in the current directory.
All the different manifests(iampolicy, iam role) will be saved as separate yaml files, so we can apply them separately if requried

shore exec -e d

This function will fetch all the manifests in generated folder and apply them into kubernetes cluster using native k8sclient.
I am checking if the format generated is as expected and applying to the cluster
If a context is not defined, you will get an error and it will do an apply
Also added the capability to delete the manfiests both from the generated folder as well from the kubernetes cluster

shore delete -e d

This function will delete all the manifests from generated folder
This will also delete the manifests from the kubernetes cluster and returns an error if cluster config is not present

Tested the above scenarios from local using the unit tests which are present using a local kubernetes cluster and some sample files

kind: Namespace
metadata:
  name: example-namespace
  labels:
    environment: development
    team: devops

Test Results

shore render

Shore save

shore exec

shore delete

Notes

Checklist

My pull request title follows the format <username>/<gh-issue-#number>:<short-description>
My code passes existing unit tests
My code follows the code style set for the project
I have added at least one reviewer for this PR

github-actions · 2025-04-09T13:24:57Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

cmd/shore/shore.go

pkg/backend/kube/backend.go

swapnachagam · 2025-04-09T14:19:28Z

I have read the CLA Document and I hereby sign the CLA

dkirillov · 2025-04-09T15:37:09Z

pkg/backend/kube/backend.go

+func (s *SpinClient) ExecutePipeline(argsJSON string, stringify bool) (string, *http.Response, error) {
+
+	// Check if a valid Kubernetes context is set
+	cmd := exec.Command("kubectl", "config", "current-context")


Instead of relying on running a CLI command - let's use the native k8s client to do the apply (create) - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.19.0/pkg/client#example-Client-Create

dkirillov · 2025-04-09T15:38:51Z

pkg/backend/kube/backend.go

+	return "", nil, nil
+}
+
+func (s *SpinClient) DeletePipeline(pipelineJSON string) (*http.Response, error) {


Considering we're dropping files and applying a CR - lets also delete both, the dropped files and the CR that gets created on the cluster.

This is now done. I am deleting the folder, files and also CR from the kuberntes. I have tested the same from local

dkirillov · 2025-04-09T15:40:27Z

pkg/backend/kube/backend.go

+
+// GetPipeline - Dummy implementation for retrieving a pipeline.
+func (s *SpinClient) GetPipeline(application string, pipelineName string) (map[string]interface{}, *http.Response, error) {
+	s.log.Infof("Retrieving pipeline: application=%s, pipelineName=%s", application, pipelineName)


This might be getting a specific resource from the cluster or a specific file from the filesystem.

Will need to check it's usage and how it relates to decide which it should be getting.

I will work on this one later.

Added packages to support render/save/apply kubernetes manifests

138250a

swapnachagam requested a review from a team as a code owner April 9, 2025 13:24