Skip to content

Commit 8243340

Browse files
authored
Updated mentions of control plane to plane engine. (#194)
1 parent e3a2755 commit 8243340

File tree

9 files changed

+18
-18
lines changed

9 files changed

+18
-18
lines changed

Diff for: .github/workflows/release.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
echo "type=cli" >> $GITHUB_OUTPUT
6565
echo "version=${TEST_TAG#cli-v}" >> $GITHUB_OUTPUT
6666
elif [[ $TEST_TAG == peng-v* ]]; then
67-
echo "type=controlplane" >> $GITHUB_OUTPUT
67+
echo "type=planengine" >> $GITHUB_OUTPUT
6868
echo "version=${TEST_TAG#peng-v}" >> $GITHUB_OUTPUT
6969
elif [[ $TEST_TAG == sdk-v* ]]; then
7070
echo "type=sdk" >> $GITHUB_OUTPUT
@@ -80,7 +80,7 @@ jobs:
8080
echo "type=cli" >> $GITHUB_OUTPUT
8181
echo "version=${TAG#cli-v}" >> $GITHUB_OUTPUT
8282
elif [[ $TAG == peng-v* ]]; then
83-
echo "type=controlplane" >> $GITHUB_OUTPUT
83+
echo "type=planengine" >> $GITHUB_OUTPUT
8484
echo "version=${TAG#peng-v}" >> $GITHUB_OUTPUT
8585
elif [[ $TAG == sdk-v* ]]; then
8686
echo "type=sdk" >> $GITHUB_OUTPUT
@@ -279,7 +279,7 @@ jobs:
279279
if [ "$RELEASE_TYPE" = "full" ]; then
280280
# Only add notes if the component has changes
281281
[ "${{ needs.prepare-release.outputs.has_cli }}" = "true" ] && add_component_notes "cli" "$VERSION" || echo "Skipping CLI notes"
282-
[ "${{ needs.prepare-release.outputs.has_planengine }}" = "true" ] && add_component_notes "controlplane" "$VERSION" || echo "Skipping Plan Engine notes" # Fixed from control-plane to controlplane
282+
[ "${{ needs.prepare-release.outputs.has_planengine }}" = "true" ] && add_component_notes "planengine" "$VERSION" || echo "Skipping Plan Engine notes"
283283
[ "${{ needs.prepare-release.outputs.has_sdk }}" = "true" ] && add_component_notes "sdks" "$VERSION" || echo "Skipping SDK notes"
284284
else
285285
add_component_notes "$RELEASE_TYPE" "$VERSION"

Diff for: README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Orra coordinates tasks across your existing stack, agents and any tools run as s
3535

3636
### Prerequisites
3737

38-
- [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)
38+
- [Docker](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/install/) - For running the Plan Engine
3939
- Set up Reasoning and Embedding Models to power task planning and execution plan caching/validation
4040

4141
#### Setup Reasoning Models
@@ -95,15 +95,15 @@ orra version
9595

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

98-
### 2. Get Orra Running
98+
### 2. Get Orra Plan Engine Running
9999

100-
Clone the repository and start the control plane:
100+
Clone the repository and start the Plan Engine:
101101

102102
```shell
103103
git clone https://github.com/ezodude/orra.git
104-
cd orra/controlplane
104+
cd orra/planengine
105105

106-
# Start the control plane
106+
# Start the Plan Engine
107107
docker compose up --build
108108
```
109109

Diff for: docs/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ orra version
5050
# Create a new project
5151
orra projects add my-ai-app
5252

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

5656
# Generate an API key for your services

Diff for: docs/compensations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Compensations can have four outcomes:
108108

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

113113
4. **Monitoring**
114114
- Track compensation attempts and failures

Diff for: docs/sdks/js-sdk.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ customerChatSvc.start(async (task) => {
6161
return { response };
6262
} catch (error) {
6363
// Once you determine the task should fail, throw the error.
64-
// Orra will handle failure propagation to the control plane.
64+
// Orra will handle failure propagation to the Plan Engine.
6565
throw error;
6666
}
6767
});

Diff for: docs/sdks/python-sdk.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ async def main():
6262
return ChatOutput(response=response)
6363
except Exception as e:
6464
# Once you determine the task should fail, throw the error.
65-
# Orra will handle failure propagation to the control plane.
65+
# orra will handle failure propagation to the Plan Engine.
6666
raise
6767

6868
await asyncio.gather(cust_chat_svc.start())

Diff for: examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Having deployed agent architectures in production, here's what to watch for:
3030
## Quick Links
3131

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

3636
Need help? Join us on [GitHub Discussion](https://github.com/orra-dev/orra/discussions).

Diff for: examples/crewai-ghostwriters/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ for `ORRA_API_KEY`.
4040

4141
## Running the Example
4242

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

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

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

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

9494
- `ctrl+c` to stop the running agents
9595
- Then, run the agents again using `poetry run python src/main.py`.

Diff for: examples/echo-python/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ You should see the result both in the webhook server terminal and through the in
8282

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

8787
curl -X POST http://localhost:8005/orchestrations \
8888
-H "Authorization: Bearer $ORRA_API_KEY" \

0 commit comments

Comments
 (0)