Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jobs:
echo "type=cli" >> $GITHUB_OUTPUT
echo "version=${TEST_TAG#cli-v}" >> $GITHUB_OUTPUT
elif [[ $TEST_TAG == peng-v* ]]; then
echo "type=controlplane" >> $GITHUB_OUTPUT
echo "type=planengine" >> $GITHUB_OUTPUT
echo "version=${TEST_TAG#peng-v}" >> $GITHUB_OUTPUT
elif [[ $TEST_TAG == sdk-v* ]]; then
echo "type=sdk" >> $GITHUB_OUTPUT
Expand All @@ -80,7 +80,7 @@ jobs:
echo "type=cli" >> $GITHUB_OUTPUT
echo "version=${TAG#cli-v}" >> $GITHUB_OUTPUT
elif [[ $TAG == peng-v* ]]; then
echo "type=controlplane" >> $GITHUB_OUTPUT
echo "type=planengine" >> $GITHUB_OUTPUT
echo "version=${TAG#peng-v}" >> $GITHUB_OUTPUT
elif [[ $TAG == sdk-v* ]]; then
echo "type=sdk" >> $GITHUB_OUTPUT
Expand Down Expand Up @@ -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_planengine }}" = "true" ] && add_component_notes "controlplane" "$VERSION" || echo "Skipping Plan Engine notes" # Fixed from control-plane to controlplane
[ "${{ needs.prepare-release.outputs.has_planengine }}" = "true" ] && add_component_notes "planengine" "$VERSION" || echo "Skipping Plan Engine notes"
[ "${{ needs.prepare-release.outputs.has_sdk }}" = "true" ] && add_component_notes "sdks" "$VERSION" || echo "Skipping SDK notes"
else
add_component_notes "$RELEASE_TYPE" "$VERSION"
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Orra coordinates tasks across your existing stack, agents and any tools run as s

### Prerequisites

- [Docker](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/install/) - For running the control plane server (powers the Plan Engine)
- [Docker](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/install/) - For running the Plan Engine
- Set up Reasoning and Embedding Models to power task planning and execution plan caching/validation

#### Setup Reasoning Models
Expand Down Expand Up @@ -95,15 +95,15 @@ orra version

→ [Full CLI documentation](docs/cli.md)

### 2. Get Orra Running
### 2. Get Orra Plan Engine Running

Clone the repository and start the control plane:
Clone the repository and start the Plan Engine:

```shell
git clone https://github.com/ezodude/orra.git
cd orra/controlplane
cd orra/planengine

# Start the control plane
# Start the Plan Engine
docker compose up --build
```

Expand Down
2 changes: 1 addition & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ orra version
# Create a new project
orra projects add my-ai-app

# Add a webhook to receive results (assumes the control plane is running with docker compose)
# Add a webhook to receive results (assumes the orra Plan Engine is running with docker compose)
orra webhooks add http://host.docker.internal:3000/webhooks/results

# Generate an API key for your services
Expand Down
2 changes: 1 addition & 1 deletion docs/compensations.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Compensations can have four outcomes:

3. **Handling failures**
- If a compensation fails, throw or raise the failure as an error from the revert handler.
- The Orra control plane will capture the error and deal with it accordingly.
- The orra Plan Engine will capture the error and deal with it accordingly.

4. **Monitoring**
- Track compensation attempts and failures
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/js-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ customerChatSvc.start(async (task) => {
return { response };
} catch (error) {
// Once you determine the task should fail, throw the error.
// Orra will handle failure propagation to the control plane.
// Orra will handle failure propagation to the Plan Engine.
throw error;
}
});
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/python-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ async def main():
return ChatOutput(response=response)
except Exception as e:
# Once you determine the task should fail, throw the error.
# Orra will handle failure propagation to the control plane.
# orra will handle failure propagation to the Plan Engine.
raise

await asyncio.gather(cust_chat_svc.start())
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Having deployed agent architectures in production, here's what to watch for:
## Quick Links

- [Documentation](../docs) - Everything you need to know
- [Control Plane Setup](../README.md#2-get-orra-running) - Required before running examples
- [Plan Engine Setup](../README.md#2-get-orra-plan-engine-running) - Required before running examples
- [CLI Reference](../docs/cli.md) - Essential commands for development

Need help? Join us on [GitHub Discussion](https://github.com/orra-dev/orra/discussions).
8 changes: 4 additions & 4 deletions examples/crewai-ghostwriters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ for `ORRA_API_KEY`.

## Running the Example

1. Ensure the control plane is running, then start the webhook server (in a separate terminal):
1. Ensure the orra Plan Engine is running, then start the webhook server (in a separate terminal):

```bash
# Start the webhook server using the verify subcommand
Expand Down Expand Up @@ -86,10 +86,10 @@ In this context the timeout was configured using the CLI's `verify` command usin
Sometimes the `writer` Crew get stuck writing and re-writing infinitely. This is a
known [ReACT prompt](https://www.promptingguide.ai/techniques/react) issue, where the prompt repetitively invokes the same function over and over.

Here, Orra is very patient because timeout has been increased to `5m`. But it does kill the orchestration after a while.
However, feel free to kill the Agent running process and start it again WITHOUT stopping the control plane.
Here, the Plan Engine is very patient because timeout has been increased to `5m`. But it does kill the orchestration after a while.
However, feel free to kill the Agent running process and start it again WITHOUT stopping the Plan Engine.

Generally, you can keep the control plane running, while you work and update the CrewAI Agent code. Then simply,
Generally, you can keep the Plan Engine running, while you work and update the CrewAI Agent code. Then simply,

- `ctrl+c` to stop the running agents
- Then, run the agents again using `poetry run python src/main.py`.
Expand Down
2 changes: 1 addition & 1 deletion examples/echo-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ You should see the result both in the webhook server terminal and through the in

```bash
# This curl command is equivalent to orra verify run performs internally
## Send an echo orchestration request to the control plane
## Send an echo orchestration request to the orra Plan Engine

curl -X POST http://localhost:8005/orchestrations \
-H "Authorization: Bearer $ORRA_API_KEY" \
Expand Down
Loading