Update naming and comments (#3)

kination · web-flow · commit e1fa6ef4eeb5 · 2025-12-07T15:38:07.000+09:00
* Update naming

* Update comment for auto-generated files
diff --git a/api/v1/dag_types.go b/api/v1/dag_types.go
@@ -4,7 +4,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// TaskType은 지원할 Operator 종류를 정의합니다.
+// TaskType defines the type of task
 type TaskType string
 
 const (
@@ -13,24 +13,24 @@ const (
 	TaskTypeGo     TaskType = "Go"
 )
 
-// TaskSpec은 DAG 내부의 개별 작업 단위입니다.
+// TaskSpec defines the task spec
 type TaskSpec struct {
 	Name         string   `json:"name"`
 	Type         TaskType `json:"type"`
-	Dependencies []string `json:"dependencies,omitempty"` // 이 Task가 실행되기 위해 완료되어야 할 부모 Task들
+	Dependencies []string `json:"dependencies,omitempty"` // Parent tasks that must be completed before this task can run
 
-	// Operator별 실행 내용
-	Command string `json:"command,omitempty"` // Bash용
-	Script  string `json:"script,omitempty"`  // Python/Go 코드 본문
-	Image   string `json:"image,omitempty"`   // 커스텀 이미지 사용 시
+	// Execution details for each task type
+	Command string `json:"command,omitempty"` // For Bash tasks
+	Script  string `json:"script,omitempty"`  // For Python/Go code
+	Image   string `json:"image,omitempty"`   // Custom container image if needed
 }
 
-// DagSpec은 사용자가 정의하는 DAG의 전체 명세입니다.
+// DagSpec defines the complete specification of a DAG as defined by the user.
 type DagSpec struct {
 	Tasks []TaskSpec `json:"tasks"`
 }
 
-// TaskStatus는 개별 Task의 현재 상태입니다.
+// TaskState represents the current state of an individual task.
 type TaskState string
 
 const (
@@ -47,9 +47,9 @@ type TaskStatus struct {
 	Message string    `json:"message,omitempty"`
 }
 
-// DagStatus는 DAG 전체의 상태입니다.
+// DagStatus represents the overall status of the entire DAG.
 type DagStatus struct {
-	State        TaskState    `json:"state"` // DAG 전체 상태 (Running, Completed...)
+	State        TaskState    `json:"state"` // Overall DAG state (Running, Completed, etc.)
 	TaskStatuses []TaskStatus `json:"taskStatuses,omitempty"`
 }
 
diff --git a/api/v1/zz_generated.deepcopy.go b/api/v1/zz_generated.deepcopy.go
diff --git a/cmd/dag-cli/main.go b/cmd/dag-cli/main.go
@@ -9,16 +9,14 @@ import (
 )
 
 func main() {
-	// 플래그 설정
 	configPath := flag.String("config", "config.yaml", "Path to the configuration file")
 	outputDir := flag.String("out", "dist", "Directory to save generated JSON files")
 	flag.Parse()
 
-	fmt.Println("🚀 Starting Pequod DAG Compiler...")
+	fmt.Println("🚀 Starting Nautikus DAG Compiler...")
 	fmt.Printf("   - Config: %s\n", *configPath)
 	fmt.Printf("   - Output: %s\n", *outputDir)
 
-	// 컴파일 로직 실행
 	if err := compiler.CompileDags(*configPath, *outputDir); err != nil {
 		fmt.Printf("❌ Compilation failed: %v\n", err)
 		os.Exit(1)
diff --git a/cmd/main.go b/cmd/main.go
@@ -160,7 +160,7 @@ func main() {
 		WebhookServer:          webhookServer,
 		HealthProbeBindAddress: probeAddr,
 		LeaderElection:         enableLeaderElection,
-		LeaderElectionID:       "0403ed10.pequod.io",
+		LeaderElectionID:       "0403ed10.nautikus.io",
 		// LeaderElectionReleaseOnCancel defines if the leader should step down voluntarily
 		// when the Manager ends. This requires the binary to immediately end when the
 		// Manager is stopped, otherwise, this setting is unsafe. Setting this significantly
diff --git a/config/crd/bases/workflow.nautikus.io_dags.yaml b/config/crd/bases/workflow.nautikus.io_dags.yaml
@@ -1,3 +1,6 @@
+# This file is auto-generated by kubebuilder's controller-gen tool.
+# DO NOT EDIT manually - changes will be overwritten when 'make manifests' is run.
+# To modify the CRD, update api/v1/dag_types.go and run 'make manifests'.
 ---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
@@ -37,14 +40,15 @@ spec:
           metadata:
             type: object
           spec:
-            description: DagSpec은 사용자가 정의하는 DAG의 전체 명세입니다.
+            description: DagSpec defines the complete specification of a DAG as defined
+              by the user.
             properties:
               tasks:
                 items:
-                  description: TaskSpec은 DAG 내부의 개별 작업 단위입니다.
+                  description: TaskSpec defines the task spec
                   properties:
                     command:
-                      description: Operator별 실행 내용
+                      description: Execution details for each task type
                       type: string
                     dependencies:
                       items:
@@ -57,7 +61,7 @@ spec:
                     script:
                       type: string
                     type:
-                      description: TaskType은 지원할 Operator 종류를 정의합니다.
+                      description: TaskType defines the type of task
                       type: string
                   required:
                   - name
@@ -68,10 +72,11 @@ spec:
             - tasks
             type: object
           status:
-            description: DagStatus는 DAG 전체의 상태입니다.
+            description: DagStatus represents the overall status of the entire DAG.
             properties:
               state:
-                description: TaskStatus는 개별 Task의 현재 상태입니다.
+                description: TaskState represents the current state of an individual
+                  task.
                 type: string
               taskStatuses:
                 items:
@@ -83,7 +88,8 @@ spec:
                     podName:
                       type: string
                     state:
-                      description: TaskStatus는 개별 Task의 현재 상태입니다.
+                      description: TaskState represents the current state of an individual
+                        task.
                       type: string
                   required:
                   - name
diff --git a/config/rbac/dag_editor_role.yaml b/config/rbac/dag_editor_role.yaml
@@ -1,20 +1,20 @@
-# This rule is not used by the project pequod itself.
+# This rule is not used by the project nautikus itself.
 # It is provided to allow the cluster admin to help manage permissions for users.
 #
-# Grants permissions to create, update, and delete resources within the workflow.pequod.io.
+# Grants permissions to create, update, and delete resources within the workflow.nautikus.io.
 # This role is intended for users who need to manage these resources
 # but should not control RBAC or manage permissions for others.
 
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
   labels:
-    app.kubernetes.io/name: pequod
+    app.kubernetes.io/name: nautikus
     app.kubernetes.io/managed-by: kustomize
   name: dag-editor-role
 rules:
 - apiGroups:
-  - workflow.pequod.io
+  - workflow.nautikus.io
   resources:
   - dags
   verbs:
@@ -26,7 +26,7 @@ rules:
   - update
   - watch
 - apiGroups:
-  - workflow.pequod.io
+  - workflow.nautikus.io
   resources:
   - dags/status
   verbs:
diff --git a/config/rbac/kustomization.yaml b/config/rbac/kustomization.yaml
@@ -20,7 +20,7 @@ resources:
 - metrics_reader_role.yaml
 # For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the pequod itself. You can comment the following lines
+# not used by the nautikus itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
 - dag_admin_role.yaml
 - dag_editor_role.yaml
diff --git a/config/rbac/leader_election_role.yaml b/config/rbac/leader_election_role.yaml
@@ -3,7 +3,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   labels:
-    app.kubernetes.io/name: pequod
+    app.kubernetes.io/name: nautikus
     app.kubernetes.io/managed-by: kustomize
   name: leader-election-role
 rules:
diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -1,8 +1,11 @@
+# This file is auto-generated by kubebuilder's controller-gen tool.
+# DO NOT EDIT manually - changes will be overwritten when 'make manifests' is run.
+# To modify RBAC rules, update controller code with +kubebuilder:rbac markers and run 'make manifests'.
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
   labels:
-    app.kubernetes.io/name: pequod
+    app.kubernetes.io/name: nautikus
     app.kubernetes.io/managed-by: kustomize
   name: manager-role
 rules:
@@ -19,7 +22,7 @@ rules:
   - patch
   - delete
 - apiGroups:
-  - workflow.pequod.io
+  - workflow.nautikus.io
   resources:
   - dags
   verbs:
@@ -31,15 +34,15 @@ rules:
   - patch
   - delete
 - apiGroups:
-  - workflow.pequod.io
+  - workflow.nautikus.io
   resources:
   - dags/status
   verbs:
   - get
   - update
   - patch
 - apiGroups:
-  - workflow.pequod.io
+  - workflow.nautikus.io
   resources:
   - dags/finalizers
   verbs:
diff --git a/config/samples/workflow_v1_dag_test.yaml b/config/samples/workflow_v1_dag_test.yaml
@@ -6,4 +6,4 @@ spec:
   tasks:
     - name: hello-task
       type: Bash
-      command: "echo 'Hello from Pequod!'"
+      command: "echo 'Hello from Nautikus!'"
diff --git a/internal/compiler/compiler.go b/internal/compiler/compiler.go
@@ -29,7 +29,7 @@ func CompileDags(configPath string, outputDir string) error {
 		return fmt.Errorf("yaml parse error: %w", err)
 	}
 
-	// Output 디렉토리 초기화 (없으면 생성)
+	// Generate output directory if not exists
 	if err := os.MkdirAll(outputDir, 0755); err != nil {
 		return fmt.Errorf("failed to create output dir: %w", err)
 	}
@@ -45,13 +45,12 @@ func CompileDags(configPath string, outputDir string) error {
 				return nil
 			}
 
-			// 확장자에 따른 처리
+			// support python and go file
 			ext := filepath.Ext(d.Name())
 			switch ext {
 			case ".py":
 				return generateJSON("python3", []string{path}, path, outputDir)
 			case ".go":
-				// Go 파일은 'go run'으로 실행
 				return generateJSON("go", []string{"run", path}, path, outputDir)
 			}
 			return nil
@@ -64,15 +63,14 @@ func CompileDags(configPath string, outputDir string) error {
 	return nil
 }
 
-// generateJSON은 스크립트(py/go)를 실행하고 표준 출력을 파일로 저장합니다.
+// generateJSON is a helper function that runs a command and saves the standard output to a file.
 func generateJSON(cmdName string, cmdArgs []string, srcPath string, outputDir string) error {
 	cmd := exec.Command(cmdName, cmdArgs...)
 
 	var stdout, stderr bytes.Buffer
 	cmd.Stdout = &stdout
 	cmd.Stderr = &stderr
 
-	// 실행
 	if err := cmd.Run(); err != nil {
 		return fmt.Errorf("execution failed for %s\n[Stderr]: %s", srcPath, stderr.String())
 	}
@@ -83,7 +81,7 @@ func generateJSON(cmdName string, cmdArgs []string, srcPath string, outputDir st
 		return nil
 	}
 
-	// 파일 저장 (example.py -> example.json)
+	// convert output to file (blablabla.py -> blablabla.json)
 	baseName := filepath.Base(srcPath)
 	ext := filepath.Ext(baseName)
 	fileName := strings.TrimSuffix(baseName, ext) + ".json"
diff --git a/internal/controller/dag_controller.go b/internal/controller/dag_controller.go
@@ -18,9 +18,9 @@ import (
 )
 
 // DagReconciler reconciles a Dag object
-// +kubebuilder:rbac:groups=workflow.pequod.io,resources=dags,verbs=get;list;watch;create;update;patch;delete
-// +kubebuilder:rbac:groups=workflow.pequod.io,resources=dags/status,verbs=get;update;patch
-// +kubebuilder:rbac:groups=workflow.pequod.io,resources=dags/finalizers,verbs=update
+// +kubebuilder:rbac:groups=workflow.nautikus.io,resources=dags,verbs=get;list;watch;create;update;patch;delete
+// +kubebuilder:rbac:groups=workflow.nautikus.io,resources=dags/status,verbs=get;update;patch
+// +kubebuilder:rbac:groups=workflow.nautikus.io,resources=dags/finalizers,verbs=update
 // +kubebuilder:rbac:groups="",resources=pods,verbs=get;list;watch;create;update;patch;delete
 type DagReconciler struct {
 	client.Client
diff --git a/test/dags/go_dag.go b/test/dags/go_dag.go
@@ -31,7 +31,7 @@ func main() {
 	// Define DAG
 	dag := workflowv1.Dag{
 		TypeMeta: metav1.TypeMeta{
-			APIVersion: "workflow.pequod.io/v1",
+			APIVersion: "workflow.nautikus.io/v1",
 			Kind:       "Dag",
 		},
 		ObjectMeta: metav1.ObjectMeta{
diff --git a/test/dags/test_dag.py b/test/dags/test_dag.py
@@ -19,7 +19,7 @@ def to_dict(self):
         if self.script: d["script"] = self.script
         return d
 
-    # >> 연산자 오버로딩으로 의존성 설정 (Airflow 스타일)
+    # dependency with overloading
     def __rshift__(self, other):
         other.dependencies.append(self.name)
         return other
@@ -40,19 +40,18 @@ def generate_json(self):
         }
         return json.dumps(manifest, indent=2)
 
-# === 사용 예시 (User Code) ===
 if __name__ == "__main__":
-    # 1. Bash Task
+    # test bash task
     t1 = Task("print-date", "Bash", command="date")
 
-    # 2. Python Task
+    # test python task
     py_code = """
 import random
 print(f"Random number: {random.randint(1, 100)}")
 """
     t2 = Task("random-py", "Python", script=py_code)
 
-    # 3. Go Task
+    # test go task
     go_code = """
 package main
 import "fmt"
@@ -62,10 +61,8 @@ def generate_json(self):
 """
     t3 = Task("hello-go", "Go", script=go_code)
 
-    # 의존성 설정: t1 -> t2 -> t3
     t1 >> t2 >> t3
 
-    # JSON 생성
     my_dag = DAG("example-dag", [t1, t2, t3])
     print(my_dag.generate_json())
     
diff --git a/test/e2e/e2e_suite_test.go b/test/e2e/e2e_suite_test.go
@@ -42,7 +42,7 @@ var (
 
 	// projectImage is the name of the image which will be build and loaded
 	// with the code source changes to be tested.
-	projectImage = "example.com/pequod:v0.0.1"
+	projectImage = "example.com/nautikus:v0.0.1"
 )
 
 // TestE2E runs the end-to-end (e2e) test suite for the project. These tests execute in an isolated,
@@ -51,7 +51,7 @@ var (
 // CertManager.
 func TestE2E(t *testing.T) {
 	RegisterFailHandler(Fail)
-	_, _ = fmt.Fprintf(GinkgoWriter, "Starting pequod integration test suite\n")
+	_, _ = fmt.Fprintf(GinkgoWriter, "Starting nautikus integration test suite\n")
 	RunSpecs(t, "e2e suite")
 }
 
diff --git a/test/e2e/e2e_test.go b/test/e2e/e2e_test.go
