Added run_container.sh script, formatted README by glisignoli · Pull Request #250 · pulp/pulp-ui

glisignoli · 2025-07-25T07:25:28Z

This commit adds the tests/run_container.sh script from: https://github.com/pulp/squeezer/blob/develop/tests/run_container.sh

It provides an easy way to start a pulp oci container.

himdel

I'm not sure a change like this is desirable here.

Pulp already has good docs on how to run their containers, and those already include the UI.

For local development, my goal is to provide instructions on how to get things working on a linux and a mac, so that people can do development without knowing anything about how to set up pulp ... but I feel like providing scripts for all the possible docker/podman/rancher configs is out of scope for me.

(At least, this still won't work on macs if you just brew install podman and don't run the VM by default. And rancher may do things yet differently.)

But, if you're willing to consistently maintain it, it does look like a good thing to have 👍 :)

himdel · 2025-07-25T16:19:23Z

tests/run_container.sh

+if [ "${CONTAINER_FILE:+x}" ]
+then
+  IMAGE_TAG="ephemeral-build"
+  "${CONTAINER_RUNTIME}" build --file "${BASEPATH}/assets/${CONTAINER_FILE}" --build-arg FROM_TAG="${FROM_TAG}" --tag ghcr.io/pulp/pulp:"${IMAGE_TAG}" .


--tag ghcr.io/pulp/pulp:"${IMAGE_TAG}"

This looks wrong, nothing in this repo should be building a pulp/pulp image.

And it very clearly doesn't come from ghcr.io, so maybe not that either? Just name it pulp-ui or something?

Removed from run_container.sh script.

himdel · 2025-07-25T16:23:08Z

tests/run_container.sh

+if [ "${CONTAINER_FILE:+x}" ]
+then
+  IMAGE_TAG="ephemeral-build"
+  "${CONTAINER_RUNTIME}" build --file "${BASEPATH}/assets/${CONTAINER_FILE}" --build-arg FROM_TAG="${FROM_TAG}" --tag ghcr.io/pulp/pulp:"${IMAGE_TAG}" .


BASEPATH points to pulp-ui/tests/, which is empty except for run_container.sh

Which /assets/ are we talking about?

Removed from run_container.sh script.

himdel · 2025-07-25T16:23:32Z

tests/run_container.sh

+  ${PULP_API_ROOT:+--env PULP_API_ROOT} \
+  --detach \
+  --name "pulp-ephemeral" \
+  --volume "${BASEPATH}/settings:/etc/pulp${SELINUX:+:Z}" \


(and here, there is no pulp-ui/tests/settings)

That was my mistake, I've added settings.py and changed .gitignore to exclude the tests/settings/certs/ directory.

himdel · 2025-07-25T16:25:43Z

tests/run_container.sh

+  --volume "${BASEPATH}/settings:/etc/pulp${SELINUX:+:Z}" \
+  --publish "8080:80" \
+  --network "bridge" \
+  "ghcr.io/pulp/pulp:${IMAGE_TAG}"


(and here, ghcr.io/pulp/pulp is not the right name)

I've changed this to docker.io

himdel · 2025-07-25T16:27:14Z

tests/run_container.sh

+  "${CONTAINER_RUNTIME}" build --file "${BASEPATH}/assets/${CONTAINER_FILE}" --build-arg FROM_TAG="${FROM_TAG}" --tag ghcr.io/pulp/pulp:"${IMAGE_TAG}" .
+fi
+
+if [ "$(getenforce)" = "Enforcing" ]; then


bash: getenforce: command not found

you will need to check for its existence first

Add a check to determine if getenforce is present

himdel · 2025-07-25T16:28:59Z

tests/run_container.sh

+# Set admin password
+"${CONTAINER_RUNTIME}" exec "pulp-ephemeral" pulpcore-manager reset-admin-password --password password
+
+if [ -d "${BASEPATH}/container_setup.d/" ]


(and here, there is no pulp-ui/tests/container_setup.d/)

Removed from run_container.sh script.

himdel · 2025-07-25T16:30:21Z

tests/run_container.sh

@@ -0,0 +1,97 @@
+#!/bin/sh


Suggested change

#!/bin/sh

#!/bin/bash

given the rest of the script, this has to be bash not sh - at least $() won't work in plain sh, and I'm not sure about all those ${:+} either.

I suspect the original author wrote this with sh as a symlink to bash. Have updated it point directly to bash.

himdel · 2025-07-25T16:32:43Z

README.md

-#### change password:
-
-```sh
-podman exec -it pulp pulpcore-manager reset-admin-password --password admin
-```
-```sh
-docker exec -it compose-pulp_api-1 pulpcore-manager reset-admin-password --password admin
-```
-


Keep this please. This is where I look when I need to change the backend password, it's not so useful when hidden inside a script.

Added back to readme

himdel · 2025-07-25T16:33:33Z

README.md


-You can follow the [pulp-oci-images quickstart](https://pulpproject.org/pulp-oci-images/docs/admin/tutorials/quickstart/),
-TLDR:
+The `tests/run_container.sh` script is provided and allows you to run a command with a [Pulp in one](https://pulpproject.org/pulp-in-one-container/) container active.


Your link does not work. Keep the one that does please.

Have re-added original setup documentation

himdel · 2025-07-25T16:34:19Z

README.md

-#### setup:
-
-```sh
-mkdir -p ~/pulp-backend-oci/{settings/certs,pulp_storage,pgsql,containers}
-cd ~/pulp-backend-oci/
-echo "
-CONTENT_ORIGIN='http://$(hostname):8080'
-ANSIBLE_API_HOSTNAME='http://$(hostname):8080'
-ANSIBLE_CONTENT_HOSTNAME='http://$(hostname):8080/pulp/content'
-" >> settings/settings.py
 ```
-
-#### run:
-
-```sh
-cd ~/pulp-backend-oci/
-podman run --publish 8080:80 \
-           --replace --name pulp \
-           --volume "$(pwd)/settings":/etc/pulp \
-           --volume "$(pwd)/pulp_storage":/var/lib/pulp \
-           --volume "$(pwd)/pgsql":/var/lib/pgsql \
-           --volume "$(pwd)/containers":/var/lib/containers \
-           docker.io/pulp/pulp


keep the minimal setup documented please

It's more useful as 20 lines of docs, than 100 lines of script.

Have re-added original setup documentation

himdel · 2025-07-25T16:55:27Z

tests/run_container.sh

+  run-parts --regex '^[0-9]+-[-_[:alnum:]]*\.sh$' "${BASEPATH}/container_setup.d/"
+fi
+
+PULP_LOGGING="${CONTAINER_RUNTIME}" "$@"


Suggested change

PULP_LOGGING="${CONTAINER_RUNTIME}" "$@"

echo Press ^C to stop the container 1>&2

sleep inf

and we don't need to document any params for it :)

I did think of this. But one way this script can be use is running it with test software, Squeezer (ansible module) does it like this:

./tests/run_container.sh make livetest

This allows a user to start a pulp oci container, run tests against it and automatically have it remove itself when complete.

This script could be used in the same way for this repository in the future.

himdel · 2025-07-25T16:56:47Z

.gitignore

 dist/
 node_modules/
 npm-debug.log*
+tests/settings


squeezer does actually have tests/settings, which are NOT gitignored .. sounds like a meaningful difference given https://github.com/pulp/pulp-ui/pull/250/files#r2231553649

That was my mistake, I've added tests/testtings/settings.py and changed .gitignore to exclude the tests/settings/certs/ directory.

glisignoli · 2025-07-26T07:09:06Z

Going to address a bunch of the script questions here.

Originally, I was looking for a easy way to start a consistent pulp environment while working on this project. I ended up using the run_container.sh script from the squeezer repository and it seemed like a good fit here.

Initially I was reluctant to make any changes to the contents because I assumed that run_containers.sh was keep up-to-date across all repositories listed in it's header.

However, I've compared the script against the other repositories listed in it's header and there are differences between them. So I'll update/rewrite this script to make it more compatible with this repository.

… container, fix .gitignore

Added run_container.sh script, formatted README

34b7cfd

glisignoli force-pushed the container-and-formatting branch from d0bcd1b to 34b7cfd Compare July 25, 2025 07:30

himdel reviewed Jul 25, 2025

View reviewed changes

glisignoli added 4 commits July 26, 2025 19:12

Rewrite run_containers script, add back documentation on how to start…

e67ee06

… container, fix .gitignore

Add back instuctions to change password

2293cf1

Change ghcr.io to docker.io

7157aae

Change password to match cypress

8db5407

	PULP_LOGGING="${CONTAINER_RUNTIME}" "$@"
	echo Press ^C to stop the container 1>&2
	sleep inf

Conversation

glisignoli commented Jul 25, 2025

Uh oh!

himdel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

glisignoli Jul 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

himdel Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

himdel Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

himdel Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

himdel Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

glisignoli commented Jul 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

glisignoli Jul 26, 2025 •

edited

Loading

himdel Jul 25, 2025 •

edited

Loading

himdel Jul 25, 2025 •

edited

Loading

himdel Jul 25, 2025 •

edited

Loading

himdel Jul 25, 2025 •

edited

Loading