Migrating towards the Plan Engine concept away from Control Plane (#184)

* Migrate "control plane" to "plan engine" and simplify related messaging.
* Bumped Orra JS and Python to version 0.2.1 and updated READMEs plus related details.
* Updated the examples to match the latest from the Plan Engine.
* Updated the conformance suite to match the latest from the Plan Engine.
* Added release docs.
* Dockerfile now refers to plan-engine binary.
* modules now refer to planengine.

Author: ezodude

.github/workflows/pr-checks.yml

@@ -5,7 +5,6 @@ on:
     types: [opened, synchronize, reopened]
     branches:
       - main
-      - manta-ray
 
 jobs:
   test:
@@ -18,28 +17,28 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.21'
+        go-version: '1.22'
         check-latest: true
         cache: true
 
     - name: Install dependencies
       run: |
-        cd controlplane
+        cd planengine
         go mod download
         
     - name: Run tests
       run: |
-        cd controlplane
+        cd planengine
         make test
         
     - name: Run static analysis
       run: |
-        cd controlplane
+        cd planengine
         make vet
         
     - name: Check formatting
       run: |
-        cd controlplane
+        cd planengine
         make fmt
         if [ -n "$(git status --porcelain)" ]; then
           echo "Code is not properly formatted. Please run 'make fmt' locally and commit changes."
@@ -56,12 +55,12 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.21'
+        go-version: '1.22'
         cache: true
 
     - name: golangci-lint
       run: |
-        cd controlplane
+        cd planengine
         make lint
 
   build:
@@ -75,10 +74,10 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.21'
+        go-version: '1.22'
         cache: true
 
     - name: Build
       run: |
-        cd controlplane
+        cd planengine
         make build

.github/workflows/release.yml

@@ -3,17 +3,17 @@ name: Release Management
 on:
   push:
     tags:
-      - 'cli-v*.*.*-*'      # e.g. cli-v0.1.0-narwhal
-      - 'cp-v*.*.*-*'       # e.g. cp-v0.1.0-narwhal
-      - 'sdk-v*.*.*-*'      # e.g. sdk-v0.1.0-narwhal
-      - 'v*.*.*-*'         # e.g. v0.1.0-narwhal
+      - 'cli-v*.*.*-*'      # e.g. cli-v0.1.0
+      - 'peng-v*.*.*-*'       # e.g. peng-v0.1.0
+      - 'sdk-v*.*.*-*'      # e.g. sdk-v0.1.0
+      - 'v*.*.*-*'         # e.g. v0.1.0
 
   workflow_dispatch: # This is crucial for manual runs
     inputs:
       test_tag:
-        description: 'Tag to simulate (e.g., v0.1.0-narwhal)'
+        description: 'Tag to simulate (e.g., v0.1.0)'
         required: true
-        default: 'v0.1.0-narwhal'
+        default: 'v0.1.0'
       debug:
         description: 'Enable debug logging'
         required: false
@@ -27,7 +27,7 @@ jobs:
       release_type: ${{ steps.release_type.outputs.type }}
       version: ${{ steps.release_type.outputs.version }}  # Make sure this matches
       has_cli: ${{ steps.check_changelog.outputs.has_cli }}
-      has_controlplane: ${{ steps.check_changelog.outputs.has_controlplane }}
+      has_planengine: ${{ steps.check_changelog.outputs.has_planengine }}
       has_sdk: ${{ steps.check_changelog.outputs.has_sdk }}
     steps:
       - uses: actions/checkout@v4
@@ -63,9 +63,9 @@ jobs:
             if [[ $TEST_TAG == cli-v* ]]; then
               echo "type=cli" >> $GITHUB_OUTPUT
               echo "version=${TEST_TAG#cli-v}" >> $GITHUB_OUTPUT
-            elif [[ $TEST_TAG == cp-v* ]]; then
+            elif [[ $TEST_TAG == peng-v* ]]; then
               echo "type=controlplane" >> $GITHUB_OUTPUT
-              echo "version=${TEST_TAG#cp-v}" >> $GITHUB_OUTPUT
+              echo "version=${TEST_TAG#peng-v}" >> $GITHUB_OUTPUT
             elif [[ $TEST_TAG == sdk-v* ]]; then
               echo "type=sdk" >> $GITHUB_OUTPUT
               echo "version=${TEST_TAG#sdk-v}" >> $GITHUB_OUTPUT
@@ -79,9 +79,9 @@ jobs:
             if [[ $TAG == cli-v* ]]; then
               echo "type=cli" >> $GITHUB_OUTPUT
               echo "version=${TAG#cli-v}" >> $GITHUB_OUTPUT
-            elif [[ $TAG == cp-v* ]]; then
+            elif [[ $TAG == peng-v* ]]; then
               echo "type=controlplane" >> $GITHUB_OUTPUT
-              echo "version=${TAG#cp-v}" >> $GITHUB_OUTPUT
+              echo "version=${TAG#peng-v}" >> $GITHUB_OUTPUT
             elif [[ $TAG == sdk-v* ]]; then
               echo "type=sdk" >> $GITHUB_OUTPUT
               echo "version=${TAG#sdk-v}" >> $GITHUB_OUTPUT
@@ -116,16 +116,16 @@ jobs:
             echo "No CLI changelog found"
           fi
           
-          # Check Control Plane changelog
-          echo "Checking for Control Plane changelog at: releases/controlplane/versions/${VERSION}.md"
-          if [ -f "releases/controlplane/versions/${VERSION}.md" ]; then
-            echo "has_controlplane=true" >> $GITHUB_OUTPUT
-            echo "Found Control Plane changelog"
+          # Check Plan Engine changelog
+          echo "Checking for Plan Engine changelog at: releases/planengine/versions/${VERSION}.md"
+          if [ -f "releases/planengine/versions/${VERSION}.md" ]; then
+            echo "has_planengine=true" >> $GITHUB_OUTPUT
+            echo "Found Plan Engine changelog"
             echo "Content:"
-            cat "releases/controlplane/versions/${VERSION}.md"
+            cat "releases/planengine/versions/${VERSION}.md"
           else
-            echo "has_controlplane=false" >> $GITHUB_OUTPUT
-            echo "No Control Plane changelog found"
+            echo "has_planengine=false" >> $GITHUB_OUTPUT
+            echo "No Plan Engine changelog found"
           fi
           
           # Check SDK changelog
@@ -143,7 +143,7 @@ jobs:
           # Debug output all flags
           echo "Final output flags:"
           echo "has_cli: $(cat $GITHUB_OUTPUT | grep has_cli || echo 'not set')"
-          echo "has_controlplane: $(cat $GITHUB_OUTPUT | grep has_controlplane || echo 'not set')"
+          echo "has_planengine: $(cat $GITHUB_OUTPUT | grep has_planengine || echo 'not set')"
           echo "has_sdk: $(cat $GITHUB_OUTPUT | grep has_sdk || echo 'not set')"
 
   build-cli:
@@ -279,7 +279,7 @@ jobs:
           if [ "$RELEASE_TYPE" = "full" ]; then
             # Only add notes if the component has changes
             [ "${{ needs.prepare-release.outputs.has_cli }}" = "true" ] && add_component_notes "cli" "$VERSION" || echo "Skipping CLI notes"
-            [ "${{ needs.prepare-release.outputs.has_controlplane }}" = "true" ] && add_component_notes "controlplane" "$VERSION" || echo "Skipping Control Plane notes"  # Fixed from control-plane to controlplane
+            [ "${{ needs.prepare-release.outputs.has_planengine }}" = "true" ] && add_component_notes "controlplane" "$VERSION" || echo "Skipping Plan Engine notes"  # Fixed from control-plane to controlplane
             [ "${{ needs.prepare-release.outputs.has_sdk }}" = "true" ] && add_component_notes "sdks" "$VERSION" || echo "Skipping SDK notes"
           else
             add_component_notes "$RELEASE_TYPE" "$VERSION"
@@ -333,7 +333,7 @@ jobs:
         run: |
           # Create all changelog directories
           mkdir -p releases/cli
-          mkdir -p releases/controlplane
+          mkdir -p releases/planengine
           mkdir -p releases/sdks
       
           # CLI Changelog
@@ -342,10 +342,10 @@ jobs:
           find "releases/cli/versions" -name "*.md" -type f -print0 | sort -zr | xargs -0 -I {} bash -c 'cat {} >> releases/cli/CHANGELOG.md; echo "" >> releases/cli/CHANGELOG.md'
           fi
 
-          # Control Plane Changelog
-          echo "# Control Plane Changelog" > releases/controlplane/CHANGELOG.md
-          if [ -d "releases/controlplane/versions" ]; then
-          find "releases/controlplane/versions" -name "*.md" -type f -print0 | sort -zr | xargs -0 -I {} bash -c 'cat {} >> releases/controlplane/CHANGELOG.md; echo "" >> releases/controlplane/CHANGELOG.md'
+          # Plan Engine Changelog
+          echo "# Plan Engine Changelog" > releases/planengine/CHANGELOG.md
+          if [ -d "releases/planengine/versions" ]; then
+          find "releases/planengine/versions" -name "*.md" -type f -print0 | sort -zr | xargs -0 -I {} bash -c 'cat {} >> releases/planengine/CHANGELOG.md; echo "" >> releases/planengine/CHANGELOG.md'
           fi
 
           # SDK Changelog

CONTRIBUTING.md

@@ -8,12 +8,6 @@ If you are a first-time contributor and want some help getting started, feel fre
 
 * Ezo Saleh - [e@orra.dev](mailto:e@orra.dev?subject=Orra Contribution Help)
 
-## Temporary Guide for Contributions in Private Alpha
-
-* Contributions are by invitation only as determined by the core maintainers.
-* Write access to the repo will be made available temporarily and removed after the PR is merged.
-* Aside from the Fork+Pull model, please follow the [normal contributions guide](#guide-for-contributions). 
-
 ## Guide for Contributions
 
 * We use the usual Fork+Pull model (more info here: [https://help.github.com/articles/using-pull-requests/](https://help.github.com/articles/using-pull-requests/))

README.md

@@ -224,8 +224,8 @@ The Plan Engine ensures:
 
 - 🛒 [E-commerce AI Assistant (JavaScript)](examples/ecommerce-agent-app) - E-commerce customer service with a delivery specialized agent
 - 👻 [Ghostwriters (Python)](examples/crewai-ghostwriters) - Content generation example showcasing how to use Orra with [CrewAI](https://www.crewai.com) 🆕🎉
-- 📣 [Echo Service (JavaScript)](examples/echo-js) - Simple example showing core concepts using JS
-- 📣 [Echo Service (Python)](examples/echo-python) - Simple example showing core concepts using Python
+- 📣 [Echo Tools as Service (JavaScript)](examples/echo-js) - Simple example showing core concepts using JS
+- 📣 [Echo Tools as Service (Python)](examples/echo-python) - Simple example showing core concepts using Python
 
 ### Docs and Guides
 
@@ -252,7 +252,7 @@ The Plan Engine ensures:
 **Connect With Us:**
 
 - [GitHub Discussions](https://github.com/orra-dev/orra/discussions) - Share your experience and ideas
-- Office Hours - Weekly calls with the team
+- [Office Hours](https://cal.com/orra-dev/office-hours) - Weekly calls with the team every Friday
 
 ## License
 

cli/cmd/config.go

@@ -30,8 +30,8 @@ func newConfigCmd(opts *CliOpts) *cobra.Command {
 func newResetConfigCmd(opts *CliOpts) *cobra.Command {
 	return &cobra.Command{
 		Use:   "reset",
-		Short: "Reset existing config",
-		Long:  "Reset config after control plane restart",
+		Short: "Reset existing orra config",
+		Long:  "Hard reset of all orra config",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if err := config.ResetConfig(opts.ConfigPath); err != nil {
 				return fmt.Errorf("failed to save config: %w", err)

cli/cmd/projects.go

@@ -35,7 +35,7 @@ func newProjectCreateCmd(opts *CliOpts) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "add [name]",
 		Short: "Add a new project",
-		Long:  `Add a new project so the control plane can orchestrate your app.`,
+		Long:  `Add a new project so the Plan Engine can coordinate your multi-agent application.`,
 		Args:  cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			projectName := args[0]
@@ -44,29 +44,29 @@ func newProjectCreateCmd(opts *CliOpts) *cobra.Command {
 			}
 
 			if serverAddr == "" {
-				serverAddr = DefaultControlPlaneServerAddr
+				serverAddr = DefaultPlanEngineServerAddr
 			}
 
 			if _, exists := opts.Config.Projects[projectName]; exists {
 				return fmt.Errorf("project name %s already exists", projectName)
 			}
 
-			// Create project in control plane (includes initial API key)
+			// Add project to Plan Engine (includes initial API key)
 			client := opts.ApiClient.SetBaseUrl(serverAddr)
 			ctx, cancel := context.WithTimeout(cmd.Context(), client.GetTimeout())
 			defer cancel()
 
-			project, err := client.CreateProject(ctx, projectName)
+			project, err := client.AddProject(ctx, projectName)
 			if err != nil {
-				return fmt.Errorf("failed to create project - %w", err)
+				return fmt.Errorf("failed to add project - %w", err)
 			}
 
-			if err := config.SaveNewProject(opts.ConfigPath, projectName, project.ID, project.CliAPIKey, serverAddr); err != nil {
+			if err := config.AddNewProject(opts.ConfigPath, projectName, project.ID, project.CliAPIKey, serverAddr); err != nil {
 				return fmt.Errorf("failed to save new project config: %w", err)
 			}
 
-			fmt.Printf("Project %s created successfully\n\n", projectName)
-			fmt.Println("To orchestrate your app:")
+			fmt.Printf("Project %s added successfully\n\n", projectName)
+			fmt.Println("To coordinate your project:")
 			fmt.Println("  orra webhooks add [valid webhook url]")
 			fmt.Println("  orra api-keys gen [api key name]")
 			return nil

cli/cmd/root.go

@@ -17,9 +17,9 @@ import (
 )
 
 const (
-	DefaultControlPlaneServerAddr = "http://localhost:8005"
-	CurrentMarker                 = "*"
-	ListMarker                    = "-"
+	DefaultPlanEngineServerAddr = "http://localhost:8005"
+	CurrentMarker               = "*"
+	ListMarker                  = "-"
 )
 
 type CliOpts struct {

cli/cmd/version.go

@@ -17,7 +17,7 @@ func newVersionCmd(_ *CliOpts) *cobra.Command {
 		Use:   "version",
 		Short: "Print the client and server version information",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			fmt.Println("Client Version: v0.2.1")
+			fmt.Println("Client Version: v0.2.2")
 			// TODO: Implement server version check
 			return nil
 		},

cli/internal/api/api.go

@@ -30,7 +30,7 @@ type Webhook struct {
 	Url string `json:"url"`
 }
 
-// Client manages communication with the control plane API
+// Client manages communication with the plan engine API
 type Client struct {
 	baseURL    string
 	apiKey     string
@@ -260,7 +260,7 @@ func (c *Client) GetTimeout() time.Duration {
 	return c.httpClient.Timeout
 }
 
-func (c *Client) CreateProject(ctx context.Context, name string) (*Project, error) {
+func (c *Client) AddProject(ctx context.Context, name string) (*Project, error) {
 	var project Project
 	var apiErr ErrorResponse
 

cli/internal/config/config.go

@@ -27,11 +27,11 @@ type Config struct {
 }
 
 const (
-	defaultControlPlaneServer = "http://localhost:8005"
-	defaultConfigDir          = ".orra"
-	defaultConfigFile         = "config.json"
-	dirPerm                   = 0755 // rwxr-xr-x
-	filePerm                  = 0666
+	defaultPlanEngineServer = "http://localhost:8005"
+	defaultConfigDir        = ".orra"
+	defaultConfigFile       = "config.json"
+	dirPerm                 = 0755 // rwxr-xr-x
+	filePerm                = 0666
 )
 
 func getDefaultConfigPath() (string, error) {
@@ -99,7 +99,7 @@ func GetProject(config *Config, projectName string) (*ProjectConfig, string, err
 	return nil, "", fmt.Errorf("current project %s not found", config.CurrentProject)
 }
 
-func SaveNewProject(configPath, projectName, projectID, cliAPIKey, serverAddr string) error {
+func AddNewProject(configPath, projectName, projectID, cliAPIKey, serverAddr string) error {
 	if configPath == "" {
 		var err error
 		configPath, err = getDefaultConfigPath()
@@ -114,7 +114,7 @@ func SaveNewProject(configPath, projectName, projectID, cliAPIKey, serverAddr st
 	}
 
 	if serverAddr == "" {
-		serverAddr = defaultControlPlaneServer
+		serverAddr = defaultPlanEngineServer
 	}
 
 	config.Projects[projectName] = ProjectConfig{

docs/actions.md

@@ -2,7 +2,7 @@
 
 ## Understanding Actions
 
-Actions are high-level instructions that Orra's control plane decomposes into tasks that execute against selected services and agents to complete a job. Think of actions as user/machine jobs that need to be fulfilled by your system.
+Actions are high-level instructions that Orra's Plan Engine decomposes into tasks that execute against selected services, tools as services and agents to complete a job. Think of actions as user/machine jobs that need to be fulfilled by your system.
 
 ## Submitting Actions
 
@@ -19,7 +19,7 @@ orra verify run "Estimate order delivery and notify customer" \
   -d orderId:ORD456 \
   -d customerId:ABC123
 
-# Specify webhook for results (assumes the control plane is running with docker compose)
+# Specify webhook for results (assumes the Plane Engine is running with docker compose)
 orra verify run "Process refund request ensuring it is not fraudulent" \
   -w http://host.docker.internal:3000/webhooks/results \ 
   -d orderId:ORD789
@@ -199,10 +199,10 @@ orra inspect o_fdhdhjhashah
 }
 ```
 
-This orchestration might involve multiple services:
+This orchestration might involve multiple services, tools as services and agents:
 - Payment processing service
-- Inventory management service
+- Inventory management tool as a service
 - Delivery scheduling agent
-- Customer notification service
+- Customer notification tool as a service
 
-Orra handles the complexity of coordinating these services while you focus on implementing their core logic.
+Orra handles the complexity of coordinating these components while you focus on implementing their core logic.