Skip to content

Add which-image guide and update extending links#115

Open
bschwedler wants to merge 5 commits into
mainfrom
extend-by-image
Open

Add which-image guide and update extending links#115
bschwedler wants to merge 5 commits into
mainfrom
extend-by-image

Conversation

@bschwedler

Copy link
Copy Markdown
Contributor

Adds a "Customizing images" section to the repo root README with a goal-to-image mapping table. Connect has three images (server, content runtime, init container) that serve distinct roles in Kubernetes deployments.

Updates the per-image extending-example links to point at the relevant images-examples/extending/connect/... subfolder rather than the generic extending/ root.

Depends on (must land first):

Add a "Customizing images" section to the repo root README with a
table mapping admin goals to the right image and a concrete example
link. Connect has three images (server, content runtime, init
container) that serve distinct roles in Kubernetes deployments.

Update the per-image extending-examples links to point directly to
the relevant subfolder in images-examples rather than the generic
extending/ root.
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
…docs

- common/R and common/python replace deleted connect/server/R and
  connect/content/r-python-packages examples
- common/system-dependencies replaces connect/content/system-dependencies
- pip-conf row replaced with a link to Connect Python package index
  admin docs
@bschwedler bschwedler requested a review from kmasiello June 5, 2026 16:15
Co-authored-by: Katie Masiello <32964481+kmasiello@users.noreply.github.com>
Comment thread connect/README.md
![Docker Image Size](https://img.shields.io/docker/image-size/posit/connect/latest)

> [!TIP]
> Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>!

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
> Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>!

Comment thread README.md
## Running the images

For local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for Kubernetes deployments, where published content runs in separate pods from the Connect server.
or local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for [Off-Host Execution (OHE) deployments](https://docs.posit.co/connect/admin/appendix/off-host/arch-overview/#off-host-execution) on Kubernetes, where published content runs in separate pods from the Connect server.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
or local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for [Off-Host Execution (OHE) deployments](https://docs.posit.co/connect/admin/appendix/off-host/arch-overview/#off-host-execution) on Kubernetes, where published content runs in separate pods from the Connect server.
For local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for [Off-Host Execution (OHE) deployments](https://docs.posit.co/connect/admin/appendix/off-host/arch-overview/#off-host-execution) on Kubernetes, where published content runs in separate pods from the Connect server.

![Docker Image Size](https://img.shields.io/docker/image-size/posit/connect-content-init/latest)

> [!TIP]
> Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>, which uses this image by default.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
> Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>, which uses this image by default.

Comment thread connect-content/README.md
![Docker Image Size](https://img.shields.io/docker/image-size/posit/connect-content/latest)

> [!TIP]
> Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>!

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
> Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>!

Comment thread README.md
| Install specific versions of R, Python, or Quarto (Kubernetes) | `connect-content` | [common/R](https://github.com/posit-dev/images-examples/tree/main/extending/common/R) · [common/python](https://github.com/posit-dev/images-examples/tree/main/extending/common/python) |
| Add system libraries that content packages need (Kubernetes) | `connect-content` | [common/system-dependencies](https://github.com/posit-dev/images-examples/tree/main/extending/common/system-dependencies) |
| Install R on the Connect server (local Docker) | `connect` (Minimal) | [common/R](https://github.com/posit-dev/images-examples/tree/main/extending/common/R) |
| Install Quarto on the Connect server | `connect` (Minimal) | [server/quarto](https://github.com/posit-dev/images-examples/tree/main/extending/connect/server/quarto) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
| Install Quarto on the Connect server | `connect` (Minimal) | [server/quarto](https://github.com/posit-dev/images-examples/tree/main/extending/connect/server/quarto) |
| Install Quarto on the Connect server (local Docker) | `connect` (Minimal) | [server/quarto](https://github.com/posit-dev/images-examples/tree/main/extending/connect/server/quarto) |

Comment thread README.md

## Customizing images

Each image serves a different role. The right image to customize depends on what you want to change.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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