docs: explain package variants in install.md#95
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 36 minutes and 25 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a section to the installation documentation clarifying the differences between the orchestrator, orchestrator-cli, and orchestrator-client package variants. The review feedback suggests consolidating this new information with existing redundant text later in the document and adding curl as a documented dependency for the orchestrator-client package.
| The following assumes you will be using the same machine for both the `orchestrator` binary and the MySQL backend. | ||
| If not, replace `127.0.0.1` with appropriate host name. Replace `orch_backend_password` with your own super secret password. | ||
|
|
||
| #### Which package do I need? |
There was a problem hiding this comment.
This new section provides a clear explanation of the package variants. However, it introduces redundancy with the existing text at the end of the document (lines 93-95), which also describes the requirements for CLI vs. Web UI modes. To maintain a single source of truth and improve document flow, consider removing or consolidating the redundant text at the end of the file.
|
|
||
| - **`orchestrator`** — the full server install. Contains the `orchestrator` binary, the web UI resources, sample config files, and the systemd unit. This is what you want on the host(s) that will run the `orchestrator` service with the HTTP API and web interface. | ||
| - **`orchestrator-cli`** — the `orchestrator` binary only. Pick this when you want to run `orchestrator` from the command line (CLI mode) or as an HTTP API server without the web UI, and you do not need the sample configs or systemd unit. | ||
| - **`orchestrator-client`** — a thin bash wrapper around the HTTP API (see [orchestrator-client](orchestrator-client.md)). It is a single shell script that depends on `jq`; install it on ops/app boxes that need to talk to an already-running `orchestrator` service without shipping the Go binary. Because it is shell-only, the package is only a few KB — that is expected. |
There was a problem hiding this comment.
The orchestrator-client script relies on curl to interact with the orchestrator API, in addition to jq for parsing responses. Mentioning curl as a dependency ensures users are aware of all necessary tools for the client to function correctly.
| - **`orchestrator-client`** — a thin bash wrapper around the HTTP API (see [orchestrator-client](orchestrator-client.md)). It is a single shell script that depends on `jq`; install it on ops/app boxes that need to talk to an already-running `orchestrator` service without shipping the Go binary. Because it is shell-only, the package is only a few KB — that is expected. | |
| - **`orchestrator-client`** — a thin bash wrapper around the HTTP API (see [orchestrator-client](orchestrator-client.md)). It is a single shell script that depends on `jq` and `curl`; install it on ops/app boxes that need to talk to an already-running `orchestrator` service without shipping the Go binary. Because it is shell-only, the package is only a few KB — that is expected. |
1 participant
Summary
docs/install.mdcovering the three release package variants (orchestrator,orchestrator-cli,orchestrator-client), when each applies, and why theorchestrator-clientpackage is only a few KB (shell-only wrapper).Motivation
Each release ships three
.deb/.rpm/.tar.gzvariants per architecture, but the user-facing install guide only said "dpkg -i orchestrator_1.0_amd64.deb" without explaining the choice. The distinction was only documented in the developer-orienteddocs/release.md.Test plan
script/test-docspasses locally