Skip to content

Commit b144118

Browse files
bschwedlerbschwedler
authored
Merge pull request #46 from posit-dev/push-readme-dockerhub
Push READMEs to Docker Hub, add image cross-links
2 parents db145f6 + 1dac494 commit b144118

File tree

6 files changed

+40
-9
lines changed

6 files changed

+40
-9
lines changed

‎.github/workflows/production.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ jobs:
4949
uses: "posit-dev/images-shared/.github/workflows/bakery-build.yml@main"
5050
secrets:
5151
DOCKER_HUB_ACCESS_TOKEN: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
52+
DOCKER_HUB_README_USERNAME: ${{ secrets.DOCKER_HUB_README_USERNAME }}
53+
DOCKER_HUB_README_PASSWORD: ${{ secrets.DOCKER_HUB_README_PASSWORD }}
5254
with:
5355
runs-on: ubuntu-latest-4x
5456
dev-versions: "exclude"

‎.github/workflows/session.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ jobs:
3333
uses: "posit-dev/images-shared/.github/workflows/bakery-build.yml@main"
3434
secrets:
3535
DOCKER_HUB_ACCESS_TOKEN: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
36+
DOCKER_HUB_README_USERNAME: ${{ secrets.DOCKER_HUB_README_USERNAME }}
37+
DOCKER_HUB_README_PASSWORD: ${{ secrets.DOCKER_HUB_README_PASSWORD }}
3638
with:
3739
runs-on: ubuntu-latest-4x
3840
matrix-versions: only

‎workbench-positron-init/README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,16 @@ This init container image provides the Positron IDE components for [Posit Workbe
77
88
## Overview
99

10-
This image is intended to be used as an init container in conjunction with:
10+
The `workbench-positron-init` container copies Positron IDE components to a shared volume, which is then mounted into the session container. It is used as a Kubernetes init container alongside `posit/workbench` and `posit/workbench-session`, or with custom session images.
1111

12-
- [Posit Workbench](https://hub.docker.com/r/posit/workbench) - The main Workbench server
13-
- Custom session images - Your own images extended with Positron IDE components
12+
| Image | Description | Docker Hub | GHCR |
13+
|:------|:------------|:-----------|:-----|
14+
| `workbench` | The Posit Workbench server | [posit/workbench](https://hub.docker.com/r/posit/workbench) | [posit-dev/workbench](https://github.com/posit-dev/images-workbench/pkgs/container/workbench) |
15+
| `workbench-session` | Session images for Kubernetes (R and Python version matrix) | [posit/workbench-session](https://hub.docker.com/r/posit/workbench-session) | [posit-dev/workbench-session](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session) |
16+
| `workbench-session-init` | Init container providing session runtime components | [posit/workbench-session-init](https://hub.docker.com/r/posit/workbench-session-init) | [posit-dev/workbench-session-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session-init) |
17+
| `workbench-positron-init` | Init container providing Positron IDE components | [posit/workbench-positron-init](https://hub.docker.com/r/posit/workbench-positron-init) | [posit-dev/workbench-positron-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-positron-init) |
1418

15-
The init container copies Positron components to a shared volume, which is then mounted into the session container.
19+
See the [repository README](https://github.com/posit-dev/images-workbench#deploying-on-kubernetes) for Helm configuration.
1620

1721
## Quick Start
1822

‎workbench-session-init/README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,16 @@ This init container image provides the session runtime components for [Posit Wor
77
88
## Overview
99

10-
This image is intended to be used as an init container in conjunction with:
10+
The `workbench-session-init` container copies session runtime components to a shared volume, which is then mounted into the session container. It is used as a Kubernetes init container alongside `posit/workbench` and `posit/workbench-session`, or with custom session images extended with Workbench session components.
1111

12-
- [Posit Workbench](https://hub.docker.com/r/posit/workbench) - The main Workbench server
13-
- Custom session images - Your own images extended with Workbench session components
12+
| Image | Description | Docker Hub | GHCR |
13+
|:------|:------------|:-----------|:-----|
14+
| `workbench` | The Posit Workbench server | [posit/workbench](https://hub.docker.com/r/posit/workbench) | [posit-dev/workbench](https://github.com/posit-dev/images-workbench/pkgs/container/workbench) |
15+
| `workbench-session` | Session images for Kubernetes (R and Python version matrix) | [posit/workbench-session](https://hub.docker.com/r/posit/workbench-session) | [posit-dev/workbench-session](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session) |
16+
| `workbench-session-init` | Init container providing session runtime components | [posit/workbench-session-init](https://hub.docker.com/r/posit/workbench-session-init) | [posit-dev/workbench-session-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session-init) |
17+
| `workbench-positron-init` | Init container providing Positron IDE components | [posit/workbench-positron-init](https://hub.docker.com/r/posit/workbench-positron-init) | [posit-dev/workbench-positron-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-positron-init) |
1418

15-
The init container copies the session runtime components to a shared volume, which is then mounted into the session container.
19+
See the [repository README](https://github.com/posit-dev/images-workbench#deploying-on-kubernetes) for Helm configuration.
1620

1721
## Quick Start
1822

‎workbench-session/README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,16 @@ These container images provide the session runtime environments for [Posit Workb
77
88
## Overview
99

10-
When Posit Workbench runs on Kubernetes with the Job Launcher, user sessions execute inside session containers. Each session image provides a specific R and Python version pair.
10+
When [Posit Workbench](https://docs.posit.co/ide/server-pro/) runs on Kubernetes with the Job Launcher, user sessions execute inside session containers. Each `workbench-session` image provides a specific R and Python version pair.
11+
12+
| Image | Description | Docker Hub | GHCR |
13+
|:------|:------------|:-----------|:-----|
14+
| `workbench` | The Posit Workbench server | [posit/workbench](https://hub.docker.com/r/posit/workbench) | [posit-dev/workbench](https://github.com/posit-dev/images-workbench/pkgs/container/workbench) |
15+
| `workbench-session` | Session images for Kubernetes | [posit/workbench-session](https://hub.docker.com/r/posit/workbench-session) | [posit-dev/workbench-session](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session) |
16+
| `workbench-session-init` | Init container providing session runtime components | [posit/workbench-session-init](https://hub.docker.com/r/posit/workbench-session-init) | [posit-dev/workbench-session-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session-init) |
17+
| `workbench-positron-init` | Init container providing Positron IDE components | [posit/workbench-positron-init](https://hub.docker.com/r/posit/workbench-positron-init) | [posit-dev/workbench-positron-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-positron-init) |
18+
19+
See the [repository README](https://github.com/posit-dev/images-workbench#deploying-on-kubernetes) for Helm configuration.
1120

1221
## Image Tags
1322

‎workbench/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ This container image provides [Posit Workbench](https://docs.posit.co/ide/server
55
> [!NOTE]
66
> These images are in preview as Posit migrates container images from [rstudio/rstudio-docker-products](https://github.com/rstudio/rstudio-docker-products). The existing images remain supported.
77
8+
## Related Images
9+
10+
For Kubernetes deployments, Workbench uses these images together. See the [repository README](https://github.com/posit-dev/images-workbench#deploying-on-kubernetes) for Helm configuration.
11+
12+
| Image | Description | Docker Hub | GHCR |
13+
|:------|:------------|:-----------|:-----|
14+
| `workbench-session` | Session images for Kubernetes (R and Python version matrix) | [posit/workbench-session](https://hub.docker.com/r/posit/workbench-session) | [posit-dev/workbench-session](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session) |
15+
| `workbench-session-init` | Init container providing session runtime components | [posit/workbench-session-init](https://hub.docker.com/r/posit/workbench-session-init) | [posit-dev/workbench-session-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-session-init) |
16+
| `workbench-positron-init` | Init container providing Positron IDE components | [posit/workbench-positron-init](https://hub.docker.com/r/posit/workbench-positron-init) | [posit-dev/workbench-positron-init](https://github.com/posit-dev/images-workbench/pkgs/container/workbench-positron-init) |
17+
818
## Quick Start
919

1020
```bash

0 commit comments

Comments
 (0)