mirror of
https://github.com/katanemo/plano.git
synced 2026-07-05 15:52:12 +02:00
feat(docs): refresh deployment page
This commit is contained in:
parent
a381bd46bb
commit
217048fabc
1 changed files with 18 additions and 18 deletions
|
|
@ -3,17 +3,17 @@
|
||||||
Deployment
|
Deployment
|
||||||
==========
|
==========
|
||||||
|
|
||||||
This guide shows how to deploy Plano directly using Docker without the archgw CLI, including basic runtime checks for routing and health monitoring.
|
This guide shows how to deploy Plano directly using Docker without the ``plano`` CLI, including basic runtime checks for routing and health monitoring.
|
||||||
|
|
||||||
Docker Deployment
|
Docker Deployment
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
Below is a minimal, production-ready example showing how to deploy the Plano Docker image directly and run basic runtime checks. Adjust image names, tags, and the ``arch_config.yaml`` path to match your environment.
|
Below is a minimal, production-ready example showing how to deploy the Plano Docker image directly and run basic runtime checks. Adjust image names, tags, and the ``plano_config.yaml`` path to match your environment.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
You will need to pass all required environment variables that are referenced in your ``arch_config.yaml`` file.
|
You will need to pass all required environment variables that are referenced in your ``plano_config.yaml`` file.
|
||||||
|
|
||||||
For ``arch_config.yaml``, you can use any sample configuration defined earlier in the documentation. For example, you can try the :ref:`LLM Routing <llm_router>` sample config.
|
For ``plano_config.yaml``, you can use any sample configuration defined earlier in the documentation. For example, you can try the :ref:`LLM Routing <llm_router>` sample config.
|
||||||
|
|
||||||
Docker Compose Setup
|
Docker Compose Setup
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
@ -24,14 +24,14 @@ Create a ``docker-compose.yml`` file with the following configuration:
|
||||||
|
|
||||||
# docker-compose.yml
|
# docker-compose.yml
|
||||||
services:
|
services:
|
||||||
archgw:
|
plano:
|
||||||
image: katanemo/archgw:0.3.22
|
image: katanemo/plano:0.4.0
|
||||||
container_name: archgw
|
container_name: plano
|
||||||
ports:
|
ports:
|
||||||
- "10000:10000" # ingress (client -> arch)
|
- "10000:10000" # ingress (client -> plano)
|
||||||
- "12000:12000" # egress (arch -> upstream/llm proxy)
|
- "12000:12000" # egress (plano -> upstream/llm proxy)
|
||||||
volumes:
|
volumes:
|
||||||
- ./arch_config.yaml:/app/arch_config.yaml:ro
|
- ./plano_config.yaml:/app/plano_config.yaml:ro
|
||||||
environment:
|
environment:
|
||||||
- OPENAI_API_KEY=${OPENAI_API_KEY:?error}
|
- OPENAI_API_KEY=${OPENAI_API_KEY:?error}
|
||||||
- ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY:?error}
|
- ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY:?error}
|
||||||
|
|
@ -39,7 +39,7 @@ Create a ``docker-compose.yml`` file with the following configuration:
|
||||||
Starting the Stack
|
Starting the Stack
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Start the services from the directory containing ``docker-compose.yml`` and ``arch_config.yaml``:
|
Start the services from the directory containing ``docker-compose.yml`` and ``plano_config.yaml``:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
|
@ -51,7 +51,7 @@ Check container health and logs:
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
docker compose ps
|
docker compose ps
|
||||||
docker compose logs -f archgw
|
docker compose logs -f plano
|
||||||
|
|
||||||
Runtime Tests
|
Runtime Tests
|
||||||
-------------
|
-------------
|
||||||
|
|
@ -74,7 +74,7 @@ Expected output:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: json
|
||||||
|
|
||||||
"gpt-4o-2024-08-06"
|
"gpt-5.2"
|
||||||
|
|
||||||
Model-Based Routing
|
Model-Based Routing
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
@ -84,14 +84,14 @@ Test explicit provider and model routing:
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
curl -s -H "Content-Type: application/json" \
|
curl -s -H "Content-Type: application/json" \
|
||||||
-d '{"messages":[{"role":"user","content":"Explain quantum computing"}], "model":"anthropic/claude-3-5-sonnet-20241022"}' \
|
-d '{"messages":[{"role":"user","content":"Explain quantum computing"}], "model":"anthropic/claude-sonnet-4-5"}' \
|
||||||
http://localhost:12000/v1/chat/completions | jq .model
|
http://localhost:12000/v1/chat/completions | jq .model
|
||||||
|
|
||||||
Expected output:
|
Expected output:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: json
|
||||||
|
|
||||||
"claude-3-5-sonnet-20241022"
|
"claude-sonnet-4-5"
|
||||||
|
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
---------------
|
---------------
|
||||||
|
|
@ -100,19 +100,19 @@ Common Issues and Solutions
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
**Environment Variables**
|
**Environment Variables**
|
||||||
Ensure all environment variables (``OPENAI_API_KEY``, ``ANTHROPIC_API_KEY``, etc.) used by ``arch_config.yaml`` are set before starting services.
|
Ensure all environment variables (``OPENAI_API_KEY``, ``ANTHROPIC_API_KEY``, etc.) used by ``plano_config.yaml`` are set before starting services.
|
||||||
|
|
||||||
**TLS/Connection Errors**
|
**TLS/Connection Errors**
|
||||||
If you encounter TLS or connection errors to upstream providers:
|
If you encounter TLS or connection errors to upstream providers:
|
||||||
|
|
||||||
- Check DNS resolution
|
- Check DNS resolution
|
||||||
- Verify proxy settings
|
- Verify proxy settings
|
||||||
- Confirm correct protocol and port in your ``arch_config`` endpoints
|
- Confirm correct protocol and port in your ``plano_config`` endpoints
|
||||||
|
|
||||||
**Verbose Logging**
|
**Verbose Logging**
|
||||||
To enable more detailed logs for debugging:
|
To enable more detailed logs for debugging:
|
||||||
|
|
||||||
- Run archgw with a higher component log level
|
- Run plano with a higher component log level
|
||||||
- See the :ref:`Observability <observability>` guide for logging and monitoring details
|
- See the :ref:`Observability <observability>` guide for logging and monitoring details
|
||||||
- Rebuild the image if required with updated log configuration
|
- Rebuild the image if required with updated log configuration
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue