Skip to content

Conversation

@AstraBert
Copy link
Member

Adding docs for Github Action (they were not included when we migrated the documentation here) and docs for the pkg command

@coveralls
Copy link

coveralls commented Oct 29, 2025

Pull Request Test Coverage Report for Build 18910559281

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 89.235%

Totals Coverage Status
Change from base Build 18886095289: 0.0%
Covered Lines: 2553
Relevant Lines: 2861

💛 - Coveralls

Copy link
Contributor

@adrianlyjak adrianlyjak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested some changes to keep the docs lean. There's a whole eco system of OCI builders/runtimes etc. so doesn't seem useful to call out Podman over and over, and its a standard format, so IMO seems better to keep general.

Aside, for later, this kind of calls out a need to provide guidelines on architecture and limitations (e.g. no replicas at the moment, persistence is minimally configurable between sqlite and agent data).

---

:::caution
This command is currently limited to **agent workflows**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this isn’t very clear to a newcomer what it means. Maybe just add the word “python” would help?

Frontend packaging is **not yet supported**.
:::

The `pkg` command lets you package your application in different formats.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if we really want to go hard on lots of different formats, so maybe let's not sell it that way. Docker/OCI basically covers 99% of packaging use cases.

Suggest instead

The `pkg` command group lets you package and export your application for custom deployments.
Currently it supports exporting a Dockerfile that can be built into an image with any OCI compliant image builder, such as `docker` or `podman`.

Comment on lines 15 to 18
It generates minimal, customizable build files from a deployment configuration, enabling you to easily package and deploy your application using container platforms.

For details on configuring your deployment file, see the [Deployment Config Reference](/python/cloud/llamaagents/configuration-reference).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit maybe delete. Seems unnecessary.

Suggested change
It generates minimal, customizable build files from a deployment configuration, enabling you to easily package and deploy your application using container platforms.
For details on configuring your deployment file, see the [Deployment Config Reference](/python/cloud/llamaagents/configuration-reference).


### Available Commands

- `container` – Generate a minimal, build-ready container file (e.g., `Dockerfile`) for your workflows using Docker or Podman.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `container` – Generate a minimal, build-ready container file (e.g., `Dockerfile`) for your workflows using Docker or Podman.
- `container` – Generate a minimal, build-ready container file (e.g., `Dockerfile`) for your workflows.

llamactl pkg container [DEPLOYMENT_FILE] [options]
```

Generates a container build file compatible with **Docker** and **Podman** from a given deployment file and user-specified options.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Generates a container build file compatible with **Docker** and **Podman** from a given deployment file and user-specified options.
Generates a container build file from a given deployment file and user-specified options.


## Alternative Ways to Deploy

If you prefer a self-hosted deployments, `llamactl` provides the possibility of exporting your workflows as minimal and customizable container files compatible with Docker and Podman, so that you can easily containerize and deploy your agent workflow anywhere.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you prefer a self-hosted deployments, `llamactl` provides the possibility of exporting your workflows as minimal and customizable container files compatible with Docker and Podman, so that you can easily containerize and deploy your agent workflow anywhere.
If you prefer a self-hosted deployments, `llamactl` has utilities to export your workflows to container files, so that you can easily build images and deploy your agent workflow anywhere.

Comment on lines 141 to 145

:::caution
This command is currently limited to **agent workflows**.
Frontend packaging is **not yet supported**.
:::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Seems repetitive to warn here too. We can add this soon

Suggested change
:::caution
This command is currently limited to **agent workflows**.
Frontend packaging is **not yet supported**.
:::

@AstraBert
Copy link
Member Author

Suggested some changes to keep the docs lean. There's a whole eco system of OCI builders/runtimes etc. so doesn't seem useful to call out Podman over and over, and its a standard format, so IMO seems better to keep general.

Aside, for later, this kind of calls out a need to provide guidelines on architecture and limitations (e.g. no replicas at the moment, persistence is minimally configurable between sqlite and agent data).

Thanks for the review @adrianlyjak, I applied the changes :))

Are you saying that we should provide the guidelines later on because you want to "battle-test" this more and try and fix the limitations?

@adrianlyjak
Copy link
Contributor

Are you saying that we should provide the guidelines later on because you want to "battle-test" this more and try and fix the limitations?

Just seems separate from this change. No need to do everything here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants