http://edurange.org/wiki/api.php?action=feedcontributions&feedformat=atom&user=Jack
EDURange - User contributions [en]
2026-04-04T00:30:30Z
User contributions
MediaWiki 1.43.0
http://edurange.org/wiki/index.php?title=Podman_API&diff=883
Podman API
2025-07-19T18:14:37Z
<p>Jack: </p>
<hr />
<div>[[Category:Demonstrations]]<br />
In reference to: <br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
Testing instructions can be found [https://github.com/edurange/demo-podman-api-extra/blob/main/TESTING.md here], or run the demo script.<br />
<br />
== Overview ==<br />
<br />
* Container lifecycle management (create, start, stop, remove)<br />
* Container listing and monitoring<br />
* Log retrieval<br />
* User management within containers<br />
* File operations<br />
* Command execution<br />
* Health checks and metrics<br />
<br />
=== Prerequisites ===<br />
<br />
<ul><br />
<li><p>Python 3.7+</p></li><br />
<li><p>Podman installed and configured</p></li><br />
<li><p>Required Python packages:</p><br />
<p>pip install flask flask-cors podman</p></li></ul><br />
<br />
=== Running the API ===<br />
<br />
<pre>python3 demo-podman-api.py</pre><br />
The API will start on http://localhost:5000 by default.<br />
<br />
== Configuration ==<br />
<br />
Configure the API using environment variables:<br />
<br />
Example:<br />
<br />
<pre>export MAX_WORKERS=20<br />
export DEBUG=true<br />
export REQUEST_TIMEOUT=60<br />
python3 demo-podman-api.py</pre><br />
== API Endpoints ==<br />
<br />
=== Base URL ===<br />
<br />
All endpoints are prefixed with /api/v1<br />
<br />
=== Container Management ===<br />
<br />
==== Create Container ====<br />
<br />
'''POST''' /containers<br />
<br />
Creates and starts a new container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;image&quot;: &quot;alpine:latest&quot;,<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;command&quot;: &quot;sleep 300&quot;,<br />
&quot;environment&quot;: {&quot;ENV_VAR&quot;: &quot;value&quot;},<br />
&quot;ports&quot;: {&quot;8080&quot;: &quot;80&quot;},<br />
&quot;volumes&quot;: {&quot;/host/path&quot;: &quot;/container/path&quot;},<br />
&quot;user&quot;: &quot;root&quot;<br />
}</pre><br />
'''Required Fields:''' image, name<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;id&quot;: &quot;abc123def456&quot;,<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;running&quot;<br />
}<br />
}</pre><br />
==== List Containers ====<br />
<br />
'''GET''' /containers<br />
<br />
Lists all containers (running and stopped).<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;containers&quot;: [<br />
{<br />
&quot;id&quot;: &quot;abc123def456&quot;,<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;running&quot;,<br />
&quot;image&quot;: &quot;alpine:latest&quot;<br />
}<br />
]<br />
}</pre><br />
==== Start Container ====<br />
<br />
'''POST''' /containers/{name}/start<br />
<br />
Starts a stopped container.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;started&quot;<br />
}<br />
}</pre><br />
==== Stop Container ====<br />
<br />
'''POST''' /containers/{name}/stop<br />
<br />
Stops a running container.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;stopped&quot;<br />
}<br />
}</pre><br />
==== Remove Container ====<br />
<br />
'''DELETE''' /containers/{name}<br />
<br />
Removes a container.<br />
<br />
'''Query Parameters:''' - force (boolean): Force removal of running container<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;removed&quot;: true<br />
}<br />
}</pre><br />
==== Get Container Logs ====<br />
<br />
'''GET''' /containers/{name}/logs<br />
<br />
Retrieves container logs.<br />
<br />
'''Query Parameters:''' - tail (integer): Number of lines to retrieve (default: 100)<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;logs&quot;: &quot;Container log output here...&quot;<br />
}<br />
}</pre><br />
=== Container Operations ===<br />
<br />
==== Execute Command ====<br />
<br />
'''POST''' /containers/{name}/exec<br />
<br />
Executes a command inside a container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;command&quot;: &quot;ls -la /tmp&quot;,<br />
&quot;user&quot;: &quot;root&quot;<br />
}</pre><br />
'''Required Fields:''' command<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;execution&quot;: {<br />
&quot;exit_code&quot;: 0,<br />
&quot;output&quot;: &quot;total 4\ndrwxrwxrwt 2 root root 4096 Jan 1 00:00 .\n&quot;,<br />
&quot;success&quot;: true<br />
}<br />
}</pre><br />
==== Add User ====<br />
<br />
'''POST''' /containers/{name}/users<br />
<br />
Creates a new user inside a container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;username&quot;: &quot;newuser&quot;,<br />
&quot;password&quot;: &quot;password123&quot;,<br />
&quot;shell&quot;: &quot;/bin/bash&quot;<br />
}</pre><br />
'''Required Fields:''' username<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;user&quot;: {<br />
&quot;username&quot;: &quot;newuser&quot;,<br />
&quot;created&quot;: true<br />
}<br />
}</pre><br />
==== Add File ====<br />
<br />
'''POST''' /containers/{name}/files<br />
<br />
Creates a file inside a container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;dest_path&quot;: &quot;/tmp/myfile.txt&quot;,<br />
&quot;content&quot;: &quot;Hello, World!\nThis is file content.&quot;<br />
}</pre><br />
'''Required Fields:''' dest_path, content<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;file&quot;: {<br />
&quot;dest_path&quot;: &quot;/tmp/myfile.txt&quot;,<br />
&quot;size&quot;: 32<br />
}<br />
}</pre><br />
=== System Endpoints ===<br />
<br />
==== Health Check ====<br />
<br />
'''GET''' /health<br />
<br />
Checks API and Podman connectivity.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;status&quot;: &quot;healthy&quot;,<br />
&quot;podman&quot;: &quot;connected&quot;,<br />
&quot;timestamp&quot;: &quot;2025-01-19T15:47:19.123456&quot;<br />
}</pre><br />
==== Metrics ====<br />
<br />
'''GET''' /metrics<br />
<br />
Returns API performance metrics.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;uptime_seconds&quot;: 3600,<br />
&quot;uptime_human&quot;: &quot;1:00:00&quot;,<br />
&quot;active_threads&quot;: 2,<br />
&quot;max_workers&quot;: 10,<br />
&quot;timestamp&quot;: &quot;2025-01-19T15:47:19.123456&quot;<br />
}</pre><br />
== Error Handling ==<br />
<br />
=== Error Response Format ===<br />
<br />
All errors follow a consistent format:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 404,<br />
&quot;type&quot;: &quot;PodmanAPIError&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;2025-01-19T15:47:19.123456&quot;<br />
}</pre><br />
=== HTTP Status Codes ===<br />
<br />
{|<br />
! Code<br />
! Description<br />
|-<br />
| 200<br />
| Success<br />
|-<br />
| 400<br />
| Bad Request (missing required fields)<br />
|-<br />
| 404<br />
| Resource not found (container, image, etc.)<br />
|-<br />
| 408<br />
| Request timeout<br />
|-<br />
| 500<br />
| Internal server error<br />
|-<br />
| 503<br />
| Service unavailable (Podman connection issues)<br />
|}<br />
<br />
=== Common Error Types ===<br />
<br />
* '''PodmanAPIError''': Podman-related errors<br />
* '''InternalError''': Server-side errors<br />
* '''ValidationError''': Request validation failures<br />
<br />
== Examples ==<br />
<br />
=== Complete Container Workflow ===<br />
<br />
<pre># 1. Check API health<br />
curl -X GET http://localhost:5000/api/v1/health | jq<br />
<br />
# 2. Create and start container<br />
curl -X POST http://localhost:5000/api/v1/containers \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{<br />
&quot;image&quot;: &quot;alpine:latest&quot;,<br />
&quot;name&quot;: &quot;demo-container&quot;,<br />
&quot;command&quot;: &quot;sleep 300&quot;<br />
}' | jq<br />
<br />
# 3. Add a user<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/users \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{<br />
&quot;username&quot;: &quot;testuser&quot;,<br />
&quot;password&quot;: &quot;testpass&quot;,<br />
&quot;shell&quot;: &quot;/bin/sh&quot;<br />
}' | jq<br />
<br />
# 4. Create a file<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/files \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{<br />
&quot;dest_path&quot;: &quot;/tmp/demo.txt&quot;,<br />
&quot;content&quot;: &quot;Hello from the API!&quot;<br />
}' | jq<br />
<br />
# 5. Execute commands<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/exec \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{&quot;command&quot;: &quot;cat /tmp/demo.txt&quot;}' | jq<br />
<br />
# 6. Check logs<br />
curl -X GET &quot;http://localhost:5000/api/v1/containers/demo-container/logs?tail=20&quot; | jq<br />
<br />
# 7. Stop and remove container<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/stop | jq<br />
curl -X DELETE &quot;http://localhost:5000/api/v1/containers/demo-container?force=true&quot; | jq</pre><br />
=== Python Client Example ===<br />
<br />
<pre>import requests<br />
import json<br />
<br />
class PodmanAPIClient:<br />
def __init__(self, base_url=&quot;http://localhost:5000/api/v1&quot;):<br />
self.base_url = base_url<br />
<br />
def create_container(self, image, name, **kwargs):<br />
data = {&quot;image&quot;: image, &quot;name&quot;: name, **kwargs}<br />
response = requests.post(f&quot;{self.base_url}/containers&quot;, json=data)<br />
return response.json()<br />
<br />
def execute_command(self, container_name, command, user=None):<br />
data = {&quot;command&quot;: command}<br />
if user:<br />
data[&quot;user&quot;] = user<br />
response = requests.post(<br />
f&quot;{self.base_url}/containers/{container_name}/exec&quot;, <br />
json=data<br />
)<br />
return response.json()<br />
<br />
# Usage<br />
client = PodmanAPIClient()<br />
result = client.create_container(&quot;alpine:latest&quot;, &quot;test-container&quot;)<br />
print(json.dumps(result, indent=2))</pre><br />
== Security Considerations ==<br />
<br />
* The API runs without authentication by default<br />
* Container commands are executed with full privileges<br />
* File operations can write anywhere in the container filesystem<br />
* Consider implementing authentication and authorization for production use<br />
* Validate and sanitize all user inputs<br />
* Consider running the API behind a reverse proxy with rate limiting<br />
<br />
== Troubleshooting ==<br />
<br />
=== Common Issues ===<br />
<br />
# '''“Container not found” errors''': <br />
Ensure the container name is correct and the container exists<br />
<br />
# '''“Image not found” errors''': <br />
Pull the image with <code>podman pull &lt;image&gt;</code> first<br />
<br />
# '''Permission errors''': <br />
Ensure Podman is properly configured for your user<br />
<br />
# '''Connection errors''': <br />
Check that Podman service is running<br />
<br />
=== Debug Mode ===<br />
Enable debug mode for detailed logging:<br />
<pre>export DEBUG=true<br />
python3 demo-podman-api.py</pre><br />
<br />
=== Logs ===<br />
The API logs all operations. Check the console output for detailed error information.</div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=882
Podman API
2025-07-19T15:12:30Z
<p>Jack: </p>
<hr />
<div>[[Category:Demonstrations]]<br />
In reference to: <br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
Testing instructions can be found [https://github.com/edurange/demo-podman-api-extra/blob/main/TESTING.md here], or run the demo script.<br />
<br />
== Table of Contents ==<br />
<br />
* Overview<br />
* Configuration<br />
* API Endpoints<br />
* Error Handling<br />
* Examples<br />
* Testing<br />
<br />
== Overview ==<br />
<br />
* Container lifecycle management (create, start, stop, remove)<br />
* Container listing and monitoring<br />
* Log retrieval<br />
* User management within containers<br />
* File operations<br />
* Command execution<br />
* Health checks and metrics<br />
<br />
=== Prerequisites ===<br />
<br />
<ul><br />
<li><p>Python 3.7+</p></li><br />
<li><p>Podman installed and configured</p></li><br />
<li><p>Required Python packages:</p><br />
<p>pip install flask flask-cors podman</p></li></ul><br />
<br />
=== Running the API ===<br />
<br />
<pre>python3 demo-podman-api.py</pre><br />
The API will start on http://localhost:5000 by default.<br />
<br />
== Configuration ==<br />
<br />
Configure the API using environment variables:<br />
<br />
Example:<br />
<br />
<pre>export MAX_WORKERS=20<br />
export DEBUG=true<br />
export REQUEST_TIMEOUT=60<br />
python3 demo-podman-api.py</pre><br />
== API Endpoints ==<br />
<br />
=== Base URL ===<br />
<br />
All endpoints are prefixed with /api/v1<br />
<br />
=== Container Management ===<br />
<br />
==== Create Container ====<br />
<br />
'''POST''' /containers<br />
<br />
Creates and starts a new container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;image&quot;: &quot;alpine:latest&quot;,<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;command&quot;: &quot;sleep 300&quot;,<br />
&quot;environment&quot;: {&quot;ENV_VAR&quot;: &quot;value&quot;},<br />
&quot;ports&quot;: {&quot;8080&quot;: &quot;80&quot;},<br />
&quot;volumes&quot;: {&quot;/host/path&quot;: &quot;/container/path&quot;},<br />
&quot;user&quot;: &quot;root&quot;<br />
}</pre><br />
'''Required Fields:''' image, name<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;id&quot;: &quot;abc123def456&quot;,<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;running&quot;<br />
}<br />
}</pre><br />
==== List Containers ====<br />
<br />
'''GET''' /containers<br />
<br />
Lists all containers (running and stopped).<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;containers&quot;: [<br />
{<br />
&quot;id&quot;: &quot;abc123def456&quot;,<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;running&quot;,<br />
&quot;image&quot;: &quot;alpine:latest&quot;<br />
}<br />
]<br />
}</pre><br />
==== Start Container ====<br />
<br />
'''POST''' /containers/{name}/start<br />
<br />
Starts a stopped container.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;started&quot;<br />
}<br />
}</pre><br />
==== Stop Container ====<br />
<br />
'''POST''' /containers/{name}/stop<br />
<br />
Stops a running container.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;status&quot;: &quot;stopped&quot;<br />
}<br />
}</pre><br />
==== Remove Container ====<br />
<br />
'''DELETE''' /containers/{name}<br />
<br />
Removes a container.<br />
<br />
'''Query Parameters:''' - force (boolean): Force removal of running container<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;name&quot;: &quot;my-container&quot;,<br />
&quot;removed&quot;: true<br />
}<br />
}</pre><br />
==== Get Container Logs ====<br />
<br />
'''GET''' /containers/{name}/logs<br />
<br />
Retrieves container logs.<br />
<br />
'''Query Parameters:''' - tail (integer): Number of lines to retrieve (default: 100)<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container&quot;: {<br />
&quot;logs&quot;: &quot;Container log output here...&quot;<br />
}<br />
}</pre><br />
=== Container Operations ===<br />
<br />
==== Execute Command ====<br />
<br />
'''POST''' /containers/{name}/exec<br />
<br />
Executes a command inside a container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;command&quot;: &quot;ls -la /tmp&quot;,<br />
&quot;user&quot;: &quot;root&quot;<br />
}</pre><br />
'''Required Fields:''' command<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;execution&quot;: {<br />
&quot;exit_code&quot;: 0,<br />
&quot;output&quot;: &quot;total 4\ndrwxrwxrwt 2 root root 4096 Jan 1 00:00 .\n&quot;,<br />
&quot;success&quot;: true<br />
}<br />
}</pre><br />
==== Add User ====<br />
<br />
'''POST''' /containers/{name}/users<br />
<br />
Creates a new user inside a container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;username&quot;: &quot;newuser&quot;,<br />
&quot;password&quot;: &quot;password123&quot;,<br />
&quot;shell&quot;: &quot;/bin/bash&quot;<br />
}</pre><br />
'''Required Fields:''' username<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;user&quot;: {<br />
&quot;username&quot;: &quot;newuser&quot;,<br />
&quot;created&quot;: true<br />
}<br />
}</pre><br />
==== Add File ====<br />
<br />
'''POST''' /containers/{name}/files<br />
<br />
Creates a file inside a container.<br />
<br />
'''Request Body:'''<br />
<br />
<pre>{<br />
&quot;dest_path&quot;: &quot;/tmp/myfile.txt&quot;,<br />
&quot;content&quot;: &quot;Hello, World!\nThis is file content.&quot;<br />
}</pre><br />
'''Required Fields:''' dest_path, content<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;file&quot;: {<br />
&quot;dest_path&quot;: &quot;/tmp/myfile.txt&quot;,<br />
&quot;size&quot;: 32<br />
}<br />
}</pre><br />
=== System Endpoints ===<br />
<br />
==== Health Check ====<br />
<br />
'''GET''' /health<br />
<br />
Checks API and Podman connectivity.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;status&quot;: &quot;healthy&quot;,<br />
&quot;podman&quot;: &quot;connected&quot;,<br />
&quot;timestamp&quot;: &quot;2025-01-19T15:47:19.123456&quot;<br />
}</pre><br />
==== Metrics ====<br />
<br />
'''GET''' /metrics<br />
<br />
Returns API performance metrics.<br />
<br />
'''Response:'''<br />
<br />
<pre>{<br />
&quot;uptime_seconds&quot;: 3600,<br />
&quot;uptime_human&quot;: &quot;1:00:00&quot;,<br />
&quot;active_threads&quot;: 2,<br />
&quot;max_workers&quot;: 10,<br />
&quot;timestamp&quot;: &quot;2025-01-19T15:47:19.123456&quot;<br />
}</pre><br />
== Error Handling ==<br />
<br />
=== Error Response Format ===<br />
<br />
All errors follow a consistent format:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 404,<br />
&quot;type&quot;: &quot;PodmanAPIError&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;2025-01-19T15:47:19.123456&quot;<br />
}</pre><br />
=== HTTP Status Codes ===<br />
<br />
{|<br />
! Code<br />
! Description<br />
|-<br />
| 200<br />
| Success<br />
|-<br />
| 400<br />
| Bad Request (missing required fields)<br />
|-<br />
| 404<br />
| Resource not found (container, image, etc.)<br />
|-<br />
| 408<br />
| Request timeout<br />
|-<br />
| 500<br />
| Internal server error<br />
|-<br />
| 503<br />
| Service unavailable (Podman connection issues)<br />
|}<br />
<br />
=== Common Error Types ===<br />
<br />
* '''PodmanAPIError''': Podman-related errors<br />
* '''InternalError''': Server-side errors<br />
* '''ValidationError''': Request validation failures<br />
<br />
== Examples ==<br />
<br />
=== Complete Container Workflow ===<br />
<br />
<pre># 1. Check API health<br />
curl -X GET http://localhost:5000/api/v1/health | jq<br />
<br />
# 2. Create and start container<br />
curl -X POST http://localhost:5000/api/v1/containers \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{<br />
&quot;image&quot;: &quot;alpine:latest&quot;,<br />
&quot;name&quot;: &quot;demo-container&quot;,<br />
&quot;command&quot;: &quot;sleep 300&quot;<br />
}' | jq<br />
<br />
# 3. Add a user<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/users \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{<br />
&quot;username&quot;: &quot;testuser&quot;,<br />
&quot;password&quot;: &quot;testpass&quot;,<br />
&quot;shell&quot;: &quot;/bin/sh&quot;<br />
}' | jq<br />
<br />
# 4. Create a file<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/files \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{<br />
&quot;dest_path&quot;: &quot;/tmp/demo.txt&quot;,<br />
&quot;content&quot;: &quot;Hello from the API!&quot;<br />
}' | jq<br />
<br />
# 5. Execute commands<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/exec \<br />
-H &quot;Content-Type: application/json&quot; \<br />
-d '{&quot;command&quot;: &quot;cat /tmp/demo.txt&quot;}' | jq<br />
<br />
# 6. Check logs<br />
curl -X GET &quot;http://localhost:5000/api/v1/containers/demo-container/logs?tail=20&quot; | jq<br />
<br />
# 7. Stop and remove container<br />
curl -X POST http://localhost:5000/api/v1/containers/demo-container/stop | jq<br />
curl -X DELETE &quot;http://localhost:5000/api/v1/containers/demo-container?force=true&quot; | jq</pre><br />
=== Python Client Example ===<br />
<br />
<pre>import requests<br />
import json<br />
<br />
class PodmanAPIClient:<br />
def __init__(self, base_url=&quot;http://localhost:5000/api/v1&quot;):<br />
self.base_url = base_url<br />
<br />
def create_container(self, image, name, **kwargs):<br />
data = {&quot;image&quot;: image, &quot;name&quot;: name, **kwargs}<br />
response = requests.post(f&quot;{self.base_url}/containers&quot;, json=data)<br />
return response.json()<br />
<br />
def execute_command(self, container_name, command, user=None):<br />
data = {&quot;command&quot;: command}<br />
if user:<br />
data[&quot;user&quot;] = user<br />
response = requests.post(<br />
f&quot;{self.base_url}/containers/{container_name}/exec&quot;, <br />
json=data<br />
)<br />
return response.json()<br />
<br />
# Usage<br />
client = PodmanAPIClient()<br />
result = client.create_container(&quot;alpine:latest&quot;, &quot;test-container&quot;)<br />
print(json.dumps(result, indent=2))</pre><br />
== Security Considerations ==<br />
<br />
* The API runs without authentication by default<br />
* Container commands are executed with full privileges<br />
* File operations can write anywhere in the container filesystem<br />
* Consider implementing authentication and authorization for production use<br />
* Validate and sanitize all user inputs<br />
* Consider running the API behind a reverse proxy with rate limiting<br />
<br />
== Troubleshooting ==<br />
<br />
=== Common Issues ===<br />
<br />
# '''“Container not found” errors''': <br />
Ensure the container name is correct and the container exists<br />
<br />
# '''“Image not found” errors''': <br />
Pull the image with <code>podman pull &lt;image&gt;</code> first<br />
<br />
# '''Permission errors''': <br />
Ensure Podman is properly configured for your user<br />
<br />
# '''Connection errors''': <br />
Check that Podman service is running<br />
<br />
=== Debug Mode ===<br />
Enable debug mode for detailed logging:<br />
<pre>export DEBUG=true<br />
python3 demo-podman-api.py</pre><br />
<br />
=== Logs ===<br />
The API logs all operations. Check the console output for detailed error information.</div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=881
Podman API
2025-07-19T14:12:25Z
<p>Jack: </p>
<hr />
<div>[[Category:Demonstrations]]<br />
In reference to: <br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
Testing instructions can be found [https://github.com/edurange/demo-podman-api-extra/blob/main/TESTING.md here], or run the demo script.<br />
== Configuration ==<br />
<br />
===== Config =====<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' <br />
<br />
Flask error handler for PodmanAPIError exceptions. <br />
<br />
* - Returns structured JSON error response with timestamp<br />
<br />
<br />
'''handle_internal_error(error)''' <br />
<br />
Flask error handler for 500 Internal Server Error. <br />
<br />
* - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=880
Podman API
2025-07-19T13:50:18Z
<p>Jack: </p>
<hr />
<div>[[Category:Demonstrations]]<br />
In reference to: <br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
===== Config =====<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' <br />
<br />
Flask error handler for PodmanAPIError exceptions. <br />
<br />
* - Returns structured JSON error response with timestamp<br />
<br />
<br />
'''handle_internal_error(error)''' <br />
<br />
Flask error handler for 500 Internal Server Error. <br />
<br />
* - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=879
Podman API
2025-07-19T13:47:59Z
<p>Jack: </p>
<hr />
<div>[[Category:Demonstrations]]<br />
In reference to: <br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' <br />
<br />
Flask error handler for PodmanAPIError exceptions. <br />
<br />
* - Returns structured JSON error response with timestamp<br />
<br />
<br />
'''handle_internal_error(error)''' <br />
<br />
Flask error handler for 500 Internal Server Error. <br />
<br />
* - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=878
Podman API
2025-07-19T13:44:18Z
<p>Jack: </p>
<hr />
<div>[[Category:Demonstrations]]<br />
In reference to: <br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' Flask error handler for PodmanAPIError exceptions. - Returns structured JSON error response with timestamp<br />
<br />
'''handle_internal_error(error)''' Flask error handler for 500 Internal Server Error. - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=877
Podman API
2025-07-19T13:43:52Z
<p>Jack: </p>
<hr />
<div><br />
[Category:Demonstrations]]<br />
In reference to: <br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' Flask error handler for PodmanAPIError exceptions. - Returns structured JSON error response with timestamp<br />
<br />
'''handle_internal_error(error)''' Flask error handler for 500 Internal Server Error. - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=876
Podman API
2025-07-19T13:42:46Z
<p>Jack: </p>
<hr />
<div><br />
<nowiki>[[Category:Demonstrations]]</nowiki> <br />
<br />
In reference to: <br />
<br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' Flask error handler for PodmanAPIError exceptions. - Returns structured JSON error response with timestamp<br />
<br />
'''handle_internal_error(error)''' Flask error handler for 500 Internal Server Error. - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=875
Podman API
2025-07-19T13:38:27Z
<p>Jack: </p>
<hr />
<div><br />
In reference to: <br />
<br />
https://github.com/edurange/demo-podman-api-extra<br />
<br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' Flask error handler for PodmanAPIError exceptions. - Returns structured JSON error response with timestamp<br />
<br />
'''handle_internal_error(error)''' Flask error handler for 500 Internal Server Error. - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=874
Podman API
2025-07-19T13:37:08Z
<p>Jack: </p>
<hr />
<div><br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. <br />
<br />
* - MAX_WORKERS: Thread pool size (default: 10) <br />
* - DEBUG: Enable debug mode (default: False) <br />
* - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' <br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' <br />
<br />
* Decorator that catches exceptions and converts them to PodmanAPIError: <br />
* - Catches asyncio.TimeoutError → 408 Timeout <br />
* - Catches “not found” errors → 404 Not Found <br />
* - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' <br />
<br />
Decorator that validates JSON request data: <br />
<br />
* - Ensures request contains valid JSON <br />
* - Checks for required fields <br />
* - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
===== PodmanAPI.__init__() =====<br />
Initializes the API with a thread pool executor.<br />
<br />
<br />
'''PodmanAPI._get_client()''' <br />
<br />
Returns a new Podman client instance.<br />
<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' <br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' <br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' <br />
<br />
Creates and starts a new container. <br />
<br />
* - Input: {image, name, command?, environment?, ports?, volumes?, user?} <br />
* - Returns: {id, name, status}<br />
<br />
<br />
'''start_container(name)''' <br />
<br />
Starts an existing container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''stop_container(name)''' <br />
<br />
Stops a running container. <br />
<br />
* - Input: Container name <br />
* - Returns: {name, status}<br />
<br />
<br />
'''remove_container(name, force=False)'''<br />
<br />
Removes a container. <br />
<br />
* - Input: Container name, force flag <br />
* - Returns: {name, removed}<br />
<br />
<br />
'''list_containers()'''<br />
<br />
Lists all containers (running and stopped). <br />
<br />
* - Returns: Array of {id, name, status, image}<br />
<br />
<br />
'''get_container_logs(name, tail=100)''' <br />
<br />
Retrieves container logs. <br />
<br />
* - Input: Container name, number of lines <br />
* - Returns: {logs}<br />
<br />
<br />
'''Host Operations'''<br />
<br />
'''add_user(container_name, user_config)''' <br />
<br />
Creates a user inside a container. <br />
<br />
* - Input: Container name, {username, password?, shell?} <br />
* - Returns: {username, created}<br />
<br />
<br />
'''add_file(container_name, file_config)''' <br />
<br />
Creates a file inside a container. <br />
<br />
* - Input: Container name, {dest_path, content} <br />
* - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' <br />
<br />
Executes a command inside a container. <br />
<br />
* - Input: Container name, command string, optional user <br />
* - Returns: {exit_code, output, success}<br />
<br />
<br />
'''shutdown()''' <br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' Flask error handler for PodmanAPIError exceptions. - Returns structured JSON error response with timestamp<br />
<br />
'''handle_internal_error(error)''' Flask error handler for 500 Internal Server Error. - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' <br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/start''' <br />
<br />
Starts the specified container.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/stop''' <br />
<br />
Stops the specified container.<br />
<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' <br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<br />
'''GET /api/v1/containers''' <br />
<br />
Lists all containers.<br />
<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' <br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<br />
'''POST /api/v1/containers/<name>/users''' <br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/files''' <br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<br />
'''POST /api/v1/containers/<name>/exec''' <br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<br />
'''GET /api/v1/health''' <br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<br />
'''GET /api/v1/metrics''' <br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' <br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown. <br />
<br />
* - Logs signal details including source file and line number <br />
* - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=873
Podman API
2025-07-19T13:31:25Z
<p>Jack: </p>
<hr />
<div><br />
<br />
More design thoughts and justifications to be added later, these are just the protocol specs.<br />
<br />
This design is not meant to be followed, it's just my first sketch at listing everything we might need.<br />
<br />
[TODO: Add the curl scripts I used for testing]<br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. - MAX_WORKERS: Thread pool size (default: 10) - DEBUG: Enable debug mode (default: False) - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' Decorator that catches exceptions and converts them to PodmanAPIError: - Catches asyncio.TimeoutError → 408 Timeout - Catches “not found” errors → 404 Not Found - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' Decorator that validates JSON request data: - Ensures request contains valid JSON - Checks for required fields - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
**PodmanAPI.__init__()** Initializes the API with a thread pool executor.<br />
<br />
'''PodmanAPI._get_client()''' Returns a new Podman client instance.<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' Executes a function asynchronously in the thread pool with timeout.<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' Creates and starts a new container. - Input: {image, name, command?, environment?, ports?, volumes?, user?} - Returns: {id, name, status}<br />
<br />
'''start_container(name)''' Starts an existing container. - Input: Container name - Returns: {name, status}<br />
<br />
'''stop_container(name)''' Stops a running container. - Input: Container name - Returns: {name, status}<br />
<br />
'''remove_container(name, force=False)''' Removes a container. - Input: Container name, force flag - Returns: {name, removed}<br />
<br />
'''list_containers()''' Lists all containers (running and stopped). - Returns: Array of {id, name, status, image}<br />
<br />
'''get_container_logs(name, tail=100)''' Retrieves container logs. - Input: Container name, number of lines - Returns: {logs}<br />
<br />
Host Operations<br />
<br />
'''add_user(container_name, user_config)''' Creates a user inside a container. - Input: Container name, {username, password?, shell?} - Returns: {username, created}<br />
<br />
'''add_file(container_name, file_config)''' Creates a file inside a container. - Input: Container name, {dest_path, content} - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' Executes a command inside a container. - Input: Container name, command string, optional user - Returns: {exit_code, output, success}<br />
<br />
'''shutdown()''' Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' Flask error handler for PodmanAPIError exceptions. - Returns structured JSON error response with timestamp<br />
<br />
'''handle_internal_error(error)''' Flask error handler for 500 Internal Server Error. - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' Creates a new container. Requires image and name fields.<br />
<br />
'''POST /api/v1/containers/<name>/start''' Starts the specified container.<br />
<br />
'''POST /api/v1/containers/<name>/stop''' Stops the specified container.<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' Removes the specified container. Optional force parameter.<br />
<br />
'''GET /api/v1/containers''' Lists all containers.<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' Gets container logs. Optional tail parameter (default: 100).<br />
<br />
'''POST /api/v1/containers/<name>/users''' Adds a user to the container. Requires username field.<br />
<br />
'''POST /api/v1/containers/<name>/files''' Adds a file to the container. Requires dest_path and content fields.<br />
<br />
'''POST /api/v1/containers/<name>/exec''' Executes a command in the container. Requires command field.<br />
<br />
'''GET /api/v1/health''' Health check endpoint. Returns Podman connection status.<br />
<br />
'''GET /api/v1/metrics''' Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' Handles SIGINT and SIGTERM signals for graceful shutdown. - Logs signal details including source file and line number - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=872
Podman API
2025-07-19T13:28:57Z
<p>Jack: </p>
<hr />
<div><span id="configuration"></span><br />
== Configuration ==<br />
<br />
<span id="config"></span><br />
=== Config ===<br />
<br />
Configuration class that loads settings from environment variables. - MAX_WORKERS: Thread pool size (default: 10) - DEBUG: Enable debug mode (default: False) - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<span id="custom-exceptions"></span><br />
== Custom Exceptions ==<br />
<br />
'''PodmanAPIError(message, status_code=500)''' Custom exception for API errors with HTTP status codes.<br />
<br />
<span id="decorators"></span><br />
== Decorators ==<br />
<br />
'''@handle_errors''' Decorator that catches exceptions and converts them to PodmanAPIError: - Catches asyncio.TimeoutError → 408 Timeout - Catches “not found” errors → 404 Not Found - Catches other exceptions → 500 Internal Server Error<br />
<br />
'''@validate_json(required_fields=None)''' Decorator that validates JSON request data: - Ensures request contains valid JSON - Checks for required fields - Returns 400 Bad Request if validation fails<br />
<br />
<span id="core-api-class"></span><br />
=== Core API Class ===<br />
<br />
**PodmanAPI.__init__()** Initializes the API with a thread pool executor.<br />
<br />
'''PodmanAPI._get_client()''' Returns a new Podman client instance.<br />
<br />
'''PodmanAPI._run_async(func, timeout=30)''' Executes a function asynchronously in the thread pool with timeout.<br />
<br />
'''PodmanAPI._handle_exec_result(result)''' Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<span id="container-management"></span><br />
== Container Management ==<br />
<br />
'''create_container(config)''' Creates and starts a new container. - Input: {image, name, command?, environment?, ports?, volumes?, user?} - Returns: {id, name, status}<br />
<br />
'''start_container(name)''' Starts an existing container. - Input: Container name - Returns: {name, status}<br />
<br />
'''stop_container(name)''' Stops a running container. - Input: Container name - Returns: {name, status}<br />
<br />
'''remove_container(name, force=False)''' Removes a container. - Input: Container name, force flag - Returns: {name, removed}<br />
<br />
'''list_containers()''' Lists all containers (running and stopped). - Returns: Array of {id, name, status, image}<br />
<br />
'''get_container_logs(name, tail=100)''' Retrieves container logs. - Input: Container name, number of lines - Returns: {logs}<br />
<br />
Host Operations<br />
<br />
'''add_user(container_name, user_config)''' Creates a user inside a container. - Input: Container name, {username, password?, shell?} - Returns: {username, created}<br />
<br />
'''add_file(container_name, file_config)''' Creates a file inside a container. - Input: Container name, {dest_path, content} - Returns: {dest_path, size}<br />
<br />
'''execute_command(container_name, command, user=None)''' Executes a command inside a container. - Input: Container name, command string, optional user - Returns: {exit_code, output, success}<br />
<br />
'''shutdown()''' Gracefully shuts down the thread pool executor.<br />
<br />
<span id="error-handlers"></span><br />
== Error Handlers ==<br />
<br />
'''handle_podman_error(error)''' Flask error handler for PodmanAPIError exceptions. - Returns structured JSON error response with timestamp<br />
<br />
'''handle_internal_error(error)''' Flask error handler for 500 Internal Server Error. - Logs error and returns generic error response<br />
<br />
<span id="api-routes"></span><br />
== API Routes ==<br />
<br />
'''POST /api/v1/containers''' Creates a new container. Requires image and name fields.<br />
<br />
'''POST /api/v1/containers/<name>/start''' Starts the specified container.<br />
<br />
'''POST /api/v1/containers/<name>/stop''' Stops the specified container.<br />
<br />
'''DELETE /api/v1/containers/<name>?force=bool''' Removes the specified container. Optional force parameter.<br />
<br />
'''GET /api/v1/containers''' Lists all containers.<br />
<br />
'''GET /api/v1/containers/<name>/logs?tail=int''' Gets container logs. Optional tail parameter (default: 100).<br />
<br />
'''POST /api/v1/containers/<name>/users''' Adds a user to the container. Requires username field.<br />
<br />
'''POST /api/v1/containers/<name>/files''' Adds a file to the container. Requires dest_path and content fields.<br />
<br />
'''POST /api/v1/containers/<name>/exec''' Executes a command in the container. Requires command field.<br />
<br />
'''GET /api/v1/health''' Health check endpoint. Returns Podman connection status.<br />
<br />
'''GET /api/v1/metrics''' Returns API metrics including uptime and thread pool status.<br />
<br />
<span id="signal-handlers"></span><br />
== Signal Handlers ==<br />
<br />
'''shutdown_handler(sig, frame)''' Handles SIGINT and SIGTERM signals for graceful shutdown. - Logs signal details including source file and line number - Shuts down thread pool and exits cleanly<br />
<br />
<span id="response-format"></span><br />
== Response Format ==<br />
<br />
Successful requests will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: true,<br />
&quot;container|user|file|execution&quot;: { ... },<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre><br />
Errors will look like this:<br />
<br />
<pre>{<br />
&quot;success&quot;: false,<br />
&quot;error&quot;: {<br />
&quot;message&quot;: &quot;Error description&quot;,<br />
&quot;code&quot;: 400,<br />
&quot;type&quot;: &quot;ErrorType&quot;<br />
},<br />
&quot;timestamp&quot;: &quot;ISO-8601-timestamp&quot;<br />
}</pre></div>
Jack
http://edurange.org/wiki/index.php?title=Podman_API&diff=871
Podman API
2025-07-19T13:26:07Z
<p>Jack: Created page with "<nowiki>##</nowiki> Configuration <nowiki>###</nowiki> Config Configuration class that loads settings from environment variables. - MAX_WORKERS: Thread pool size (default: 10) - DEBUG: Enable debug mode (default: False) - REQUEST_TIMEOUT: Operation timeout in seconds (default: 30) <nowiki>##</nowiki> Custom Exceptions <nowiki>**</nowiki>PodmanAPIError(message, status_code=500)** Custom exception for API errors with HTTP status codes. <nowiki>##</nowiki> Decorato..."</p>
<hr />
<div><nowiki>##</nowiki> Configuration<br />
<br />
<nowiki>###</nowiki> Config<br />
<br />
Configuration class that loads settings from environment variables.<br />
<br />
- MAX_WORKERS: Thread pool size (default: 10)<br />
<br />
- DEBUG: Enable debug mode (default: False)<br />
<br />
- REQUEST_TIMEOUT: Operation timeout in seconds (default: 30)<br />
<br />
<nowiki>##</nowiki> Custom Exceptions<br />
<br />
<nowiki>**</nowiki>PodmanAPIError(message, status_code=500)**<br />
<br />
Custom exception for API errors with HTTP status codes.<br />
<br />
<nowiki>##</nowiki> Decorators<br />
<br />
<nowiki>**</nowiki>@handle_errors**<br />
<br />
Decorator that catches exceptions and converts them to PodmanAPIError:<br />
<br />
- Catches asyncio.TimeoutError → 408 Timeout<br />
<br />
- Catches "not found" errors → 404 Not Found<br />
<br />
- Catches other exceptions → 500 Internal Server Error<br />
<br />
<nowiki>**</nowiki>@validate_json(required_fields=None)**<br />
<br />
Decorator that validates JSON request data:<br />
<br />
- Ensures request contains valid JSON<br />
<br />
- Checks for required fields<br />
<br />
- Returns 400 Bad Request if validation fails<br />
<br />
<nowiki>###</nowiki> Core API Class<br />
<br />
<nowiki>**</nowiki>PodmanAPI.__init__()**<br />
<br />
Initializes the API with a thread pool executor.<br />
<br />
<nowiki>**</nowiki>PodmanAPI._get_client()**<br />
<br />
Returns a new Podman client instance.<br />
<br />
<nowiki>**</nowiki>PodmanAPI._run_async(func, timeout=30)**<br />
<br />
Executes a function asynchronously in the thread pool with timeout.<br />
<br />
<nowiki>**</nowiki>PodmanAPI._handle_exec_result(result)**<br />
<br />
Helper that normalizes exec_run results to (exit_code, output_string).<br />
<br />
<nowiki>##</nowiki> Container Management<br />
<br />
<nowiki>**</nowiki>create_container(config)**<br />
<br />
Creates and starts a new container.<br />
<br />
- Input: {image, name, command?, environment?, ports?, volumes?, user?}<br />
<br />
- Returns: {id, name, status}<br />
<br />
<nowiki>**</nowiki>start_container(name)**<br />
<br />
Starts an existing container.<br />
<br />
- Input: Container name<br />
<br />
- Returns: {name, status}<br />
<br />
<nowiki>**</nowiki>stop_container(name)**<br />
<br />
Stops a running container.<br />
<br />
- Input: Container name<br />
<br />
- Returns: {name, status}<br />
<br />
<nowiki>**</nowiki>remove_container(name, force=False)**<br />
<br />
Removes a container.<br />
<br />
- Input: Container name, force flag<br />
<br />
- Returns: {name, removed}<br />
<br />
<nowiki>**</nowiki>list_containers()**<br />
<br />
Lists all containers (running and stopped).<br />
<br />
- Returns: Array of {id, name, status, image}<br />
<br />
<nowiki>**</nowiki>get_container_logs(name, tail=100)**<br />
<br />
Retrieves container logs.<br />
<br />
- Input: Container name, number of lines<br />
<br />
- Returns: {logs}<br />
<br />
Host Operations<br />
<br />
<nowiki>**</nowiki>add_user(container_name, user_config)**<br />
<br />
Creates a user inside a container.<br />
<br />
- Input: Container name, {username, password?, shell?}<br />
<br />
- Returns: {username, created}<br />
<br />
<nowiki>**</nowiki>add_file(container_name, file_config)**<br />
<br />
Creates a file inside a container.<br />
<br />
- Input: Container name, {dest_path, content}<br />
<br />
- Returns: {dest_path, size}<br />
<br />
<nowiki>**</nowiki>execute_command(container_name, command, user=None)**<br />
<br />
Executes a command inside a container.<br />
<br />
- Input: Container name, command string, optional user<br />
<br />
- Returns: {exit_code, output, success}<br />
<br />
<nowiki>**</nowiki>shutdown()**<br />
<br />
Gracefully shuts down the thread pool executor.<br />
<br />
<nowiki>##</nowiki> Error Handlers<br />
<br />
<nowiki>**</nowiki>handle_podman_error(error)**<br />
<br />
Flask error handler for PodmanAPIError exceptions.<br />
<br />
- Returns structured JSON error response with timestamp<br />
<br />
<nowiki>**</nowiki>handle_internal_error(error)**<br />
<br />
Flask error handler for 500 Internal Server Error.<br />
<br />
- Logs error and returns generic error response<br />
<br />
<nowiki>##</nowiki> API Routes<br />
<br />
<nowiki>**</nowiki>POST /api/v1/containers**<br />
<br />
Creates a new container. Requires image and name fields.<br />
<br />
<nowiki>**</nowiki>POST /api/v1/containers/<name>/start**<br />
<br />
Starts the specified container.<br />
<br />
<nowiki>**</nowiki>POST /api/v1/containers/<name>/stop**<br />
<br />
Stops the specified container.<br />
<br />
<nowiki>**</nowiki>DELETE /api/v1/containers/<name>?force=bool**<br />
<br />
Removes the specified container. Optional force parameter.<br />
<br />
<nowiki>**</nowiki>GET /api/v1/containers**<br />
<br />
Lists all containers.<br />
<br />
<nowiki>**</nowiki>GET /api/v1/containers/<name>/logs?tail=int**<br />
<br />
Gets container logs. Optional tail parameter (default: 100).<br />
<br />
<nowiki>**</nowiki>POST /api/v1/containers/<name>/users**<br />
<br />
Adds a user to the container. Requires username field.<br />
<br />
<nowiki>**</nowiki>POST /api/v1/containers/<name>/files**<br />
<br />
Adds a file to the container. Requires dest_path and content fields.<br />
<br />
<nowiki>**</nowiki>POST /api/v1/containers/<name>/exec**<br />
<br />
Executes a command in the container. Requires command field.<br />
<br />
<nowiki>**</nowiki>GET /api/v1/health**<br />
<br />
Health check endpoint. Returns Podman connection status.<br />
<br />
<nowiki>**</nowiki>GET /api/v1/metrics**<br />
<br />
Returns API metrics including uptime and thread pool status.<br />
<br />
<nowiki>##</nowiki> Signal Handlers<br />
<br />
<nowiki>**</nowiki>shutdown_handler(sig, frame)**<br />
<br />
Handles SIGINT and SIGTERM signals for graceful shutdown.<br />
<br />
- Logs signal details including source file and line number<br />
<br />
- Shuts down thread pool and exits cleanly<br />
<br />
<nowiki>##</nowiki> Response Format<br />
<br />
Successful requests will look like this:<br />
<br />
```<br />
<br />
{<br />
<br />
"success": true,<br />
<br />
"container|user|file|execution": { ... },<br />
<br />
"timestamp": "ISO-8601-timestamp"<br />
<br />
}<br />
<br />
```<br />
<br />
Errors will look like this:<br />
<br />
```<br />
<br />
{<br />
<br />
"success": false,<br />
<br />
"error": {<br />
<br />
"message": "Error description",<br />
<br />
"code": 400,<br />
<br />
"type": "ErrorType"<br />
<br />
},<br />
<br />
"timestamp": "ISO-8601-timestamp"<br />
<br />
}<br />
<br />
```</div>
Jack
http://edurange.org/wiki/index.php?title=Category:Demonstrations&diff=870
Category:Demonstrations
2025-07-19T13:25:33Z
<p>Jack: add my podman API demo</p>
<hr />
<div>Let's collect self-contained examples and demos here. I'm imagining this to be a space for demos that don't link to the main software stack, and focus on implementing a single feature or concept at a time.<br />
<br />
Preferably, they should use no external dependencies, or have only a single external dependency. They should be easy to install and run without extra knowledge - the main usage method should be readily apparent and the code should follow documentation conventions.<br />
<br />
Most importantly, these should be short and easy to read, because their purpose is to teach the group. It would be great if we could demonstrate, discuss and come to understand these projects within one or two group meetings.<br />
<br />
== Demo Projects ==<br />
These demonstrate or introduce new concepts, conventions, libraries, patterns, etc.<br />
<br />
* [[Namedpipe Log Writer]] - https://github.com/edurange/demo-namedpipe-log-writer<br />
* [[Keystroke Observers]] - https://github.com/edurange/demo-keystroke-observers<br />
* [[TTY Logging with BPF]] - https://github.com/edurange/demo-bpf-tty-logger/<br />
* [[Podman API]]- [https://github.com/edurange/demo-podman-api-extra/tree/main https://github.com/edurange/demo-podman-api-extra]</div>
Jack
http://edurange.org/wiki/index.php?title=Main_Page&diff=95
Main Page
2025-06-20T20:19:17Z
<p>Jack: /* Developer Links */</p>
<hr />
<div>Welcome to the EDURange Wiki. This is less of a formal documentation as it is a living document.<br />
<br />
I think that if it's a choice between losing track of people's contributions and having a messy wiki, I'd much prefer a messy wiki. It's my hope that we can gather all of our notes, thoughts, and loosely related ephemera here, rather than having it scattered across correspondence and various sharing platforms.<br />
<br />
We don't have many conventions yet. Please follow the Golden Rule and treat others as you would be treated. Put your name on your changes. Consider posting to the discussion tab or appending to a page rather than overwriting it. Try not to overwrite the personal work of others.<br />
<br />
If it's installable/runnable/code of any sort, put it on GitHub as well - preferably under the edurange organization so that our future contributors will have seamless access to it too.<br />
<br />
Thanks for your time.<br />
<br />
~Joe G<br />
<br />
== Developer Links ==<br />
[[Style Guidelines and Developer Tools]]<br />
<br />
[[Reference Materials]]<br />
<br />
[[Design Stories (OLD)]]<br />
<br />
[[:Category:Demonstrations|Demonstrations]]<br />
<br />
[[Interface Design]]<br />
<br />
[[Scenario Creation Guide]]<br />
<br />
[[Terraform Design]]<br />
<br />
[[Hosting Requirements]]<br />
<br />
[[Domain Modeling]]<br />
<br />
== Orphaned Default Media Wiki Content ==<br />
<strong>Welcome to the EDURange Wiki</strong><br />
<br />
Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.<br />
<br />
== Getting started with Media Wiki ==<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]<br />
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]</div>
Jack
http://edurange.org/wiki/index.php?title=Design_Stories_(OLD)&diff=94
Design Stories (OLD)
2025-06-20T20:17:06Z
<p>Jack: </p>
<hr />
<div>The EDURange Design<br />
<br />
<br />
The guiding principles:<br />
1. EDURange is flexible for creating new exercises, so that it supports polymorphism.<br />
2. Solving the exercises should require analytical skills and abilities.<br />
3. EDURange allows the instructor to see what individual students are doing, so that they can provide real-time feedback.<br />
4. Easy to use<br />
<br />
'''For the instructor'''<br />
<br />
* Seeing what individual students are doing<br />
* The instructor should be able to clone an exercise and add students or groups and start the exercise easily<br />
* The instructor should see the status of a scenario and re-start if necessary<br />
* The instructor should be able to see the sequence of commands (including their time) that a student typed, what the context was (host and directory) and what the resulting shell output was. This needs to be presented in such a way that the instructor can quickly determine if the student is making progress.<br />
* The instructor should be able to see the answers that students gave to the questions.<br />
* The instructor should be able to be able to offer a hint, after seeing that a student has a question or wants a hint and interact with the student via chat.<br />
* The instructor should see a ranked list of students who need help. ML should rank the students.<br />
<br />
'''For the student''' <br />
<br />
* The student should be able to register for an exercise that the instructor created.<br />
* The student should be able to run/use the exercise (once started) from any computer with a browser.<br />
* The Guide should be clear, in particular, the questions should be auto-graded unless they are essay questions.<br />
* The students should see which questions they have answered correctly<br />
* The tasks should follow a logical sequence<br />
<br />
'''For the researcher/developer'''<br />
<br />
* The scripts that analyze the data should be easy to run.<br />
* The final data should be collected in a single location at least for each single instance of a scenario.<br />
* It should be possible to pool data from multiple runs of the same scenario. Any data that is exported should be anonymized It should be possible to verify functionality, e.g. that a scenario will start without error, that a question will be graded correctly, that a system will usable by n users simultaneously, etc.<br />
<br />
'''ML'''<br />
<br />
* The ML system should be able to use multiple models for predicting student challenges and should be milestone-specific<br />
* It should be possible to run a trained model and make predictions during a scenario Author The author should be able to make changes to the Guide.<br />
* The author should be able to specify host and network information<br />
* The author should be able to specify learning objectives for each task in a scenario<br />
* The author should be able to specify milestones, i.e. indicators that a learning objective has been met.</div>
Jack
http://edurange.org/wiki/index.php?title=Design_Stories_(OLD)&diff=93
Design Stories (OLD)
2025-06-20T20:15:04Z
<p>Jack: Created page with "# The EduRange design ## The guiding principles: 1. EDURange is flexible for creating new exercises, so that it supports polymorphism. 2. Solving the exercises should require analytical skills and abilities. 3. EDURange allows the instructor to see what individual students are doing, so that they can provide real-time feedback. 4. Easy to use '''For the instructor''' Seeing what individual students are doing The instructor should be able to clone an e..."</p>
<hr />
<div># The EduRange design<br />
<br />
## The guiding principles:<br />
1. EDURange is flexible for creating new exercises, so that it supports polymorphism.<br />
2. Solving the exercises should require analytical skills and abilities.<br />
3. EDURange allows the instructor to see what individual students are doing, so that they can provide real-time feedback.<br />
4. Easy to use<br />
<br />
'''For the instructor'''<br />
<br />
Seeing what individual students are doing<br />
<br />
The instructor should be able to clone an exercise and add students or groups and start the exercise easily<br />
<br />
The instructor should see the status of a scenario and re-start if necessary<br />
<br />
The instructor should be able to see the sequence of commands (including their time) that a student typed, what the context was (host and directory) and what the resulting shell output was. This needs to be presented in such a way that the instructor can quickly determine if the student is making progress. <br />
<br />
The instructor should be able to see the answers that students gave to the questions.<br />
<br />
The instructor should be able to be able to offer a hint, after seeing that a student has a question or wants a hint and interact with the student via chat.<br />
<br />
The instructor should see a ranked list of students who need help. ML should rank the students.<br />
<br />
'''For the student''' <br />
The student should be able to register for an exercise that the instructor created. <br />
<br />
The student should be able to run/use the exercise (once started) from any computer with a browser.<br />
<br />
The Guide should be clear, in particular, the questions should be auto-graded unless they are essay questions.<br />
<br />
The students should see which questions they have answered correctly<br />
<br />
The tasks should follow a logical sequence<br />
<br />
'''<br />
For the researcher/developer'''<br />
<br />
The scripts that analyze the data should be easy to run.<br />
<br />
The final data should be collected in a single location at least for each single instance of a scenario. <br />
<br />
It should be possible to pool data from multiple runs of the same scenario.<br />
Any data that is exported should be anonymized<br />
It should be possible to verify functionality, e.g. that a scenario will start without error, that a question will be graded correctly, that a system will usable by n users simultaneously, etc.<br />
'''<br />
ML'''<br />
The ML system should be able to use multiple models for predicting student challenges and should be milestone-specific<br />
<br />
It should be possible to run a trained model and make predictions during a scenario<br />
'''<br />
Author'''<br />
The author should be able to make changes to the Guide.<br />
<br />
The author should be able to specify host and network information<br />
<br />
The author should be able to specify learning objectives for each task in a scenario<br />
<br />
The author should be able to specify milestones, i.e. indicators that a learning objective has been met.</div>
Jack
http://edurange.org/wiki/index.php?title=Main_Page&diff=78
Main Page
2025-06-07T16:56:27Z
<p>Jack: Undo revision 76 by Jack (talk)</p>
<hr />
<div>Welcome to the EDURange Wiki. This is less of a formal documentation as it is a living document.<br />
<br />
I think that if it's a choice between losing track of people's contributions and having a messy wiki, I'd much prefer a messy wiki. It's my hope that we can gather all of our notes, thoughts, and loosely related ephemera here, rather than having it scattered across correspondence and various sharing platforms.<br />
<br />
We don't have many conventions yet. Please follow the Golden Rule and treat others as you would be treated. Put your name on your changes. Consider posting to the discussion tab or appending to a page rather than overwriting it. Try not to overwrite the personal work of others.<br />
<br />
If it's installable/runnable/code of any sort, put it on GitHub as well - preferably under the edurange organization so that our future contributors will have seamless access to it too.<br />
<br />
Thanks for your time.<br />
<br />
~Joe G<br />
<br />
== Developer Links ==<br />
[[Style Guidelines and Developer Tools]]<br />
<br />
[[Reference Materials]]<br />
<br />
[[:Category:Demonstrations|Demonstrations]]<br />
<br />
[[Interface Design]]<br />
<br />
[[Scenario Creation Guide]]<br />
<br />
[[Terraform Design]]<br />
<br />
[[Hosting Requirements]]<br />
<br />
[[Domain Modeling]]<br />
<br />
== Orphaned Default Media Wiki Content ==<br />
<strong>Welcome to the EDURange Wiki</strong><br />
<br />
Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.<br />
<br />
== Getting started with Media Wiki ==<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]<br />
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]</div>
Jack
http://edurange.org/wiki/index.php?title=Main_Page&diff=76
Main Page
2025-06-06T00:08:33Z
<p>Jack: Reverted edits by Jwgranville (talk) to last revision by Edurange weiss</p>
<hr />
<div><strong>Welcome to the EDURange Wiki</strong><br />
<br />
Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.<br />
<br />
== Getting started with Media Wiki ==<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]<br />
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]<br />
<br />
== Developer Links ==<br />
[[Style Guidelines and Developer Tools]]<br />
<br />
[[Interface Design]]<br />
<br />
[[Scenario Creation Guide]]<br />
<br />
[[Terraform Design]]<br />
<br />
[[Hosting Requirements]]<br />
<br />
[[Domain Modeling]]</div>
Jack
http://edurange.org/wiki/index.php?title=Thread:Talk:Main_Page/Thread_number_two/reply_(2)&diff=40
Thread:Talk:Main Page/Thread number two/reply (2)
2025-04-04T20:31:07Z
<p>Jack: Reply to Thread number two</p>
<hr />
<div>Double Reply</div>
Jack
http://edurange.org/wiki/index.php?title=Thread:Talk:Main_Page/Thread_number_two/reply&diff=39
Thread:Talk:Main Page/Thread number two/reply
2025-04-04T20:24:48Z
<p>Jack: Reply to Thread number two</p>
<hr />
<div>Test2</div>
Jack
http://edurange.org/wiki/index.php?title=Thread:Talk:Main_Page/Thread_number_two&diff=38
Thread:Talk:Main Page/Thread number two
2025-04-04T20:24:19Z
<p>Jack: New thread: Thread number two</p>
<hr />
<div>Test</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=37
Talk:Main Page
2025-04-04T19:53:13Z
<p>Jack: /* Discussion Board -- Jack (talk) 19:30, 4 April 2025 (UTC) */</p>
<hr />
<div></div>
Jack
http://edurange.org/wiki/index.php?title=Thread:Talk:Main_Page/This_is_a_new_thread/reply&diff=36
Thread:Talk:Main Page/This is a new thread/reply
2025-04-04T19:52:25Z
<p>Jack: Reply to This is a new thread</p>
<hr />
<div>This looks way better</div>
Jack
http://edurange.org/wiki/index.php?title=Thread:Talk:Main_Page/This_is_a_new_thread&diff=35
Thread:Talk:Main Page/This is a new thread
2025-04-04T19:52:12Z
<p>Jack: New thread: This is a new thread</p>
<hr />
<div>Testing a new extension</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=33
Talk:Main Page
2025-04-04T19:30:26Z
<p>Jack: /* Discussion Board */ new section</p>
<hr />
<div>== Discussion Board -- [[User:Jack|Jack]] ([[User talk:Jack|talk]]) 19:30, 4 April 2025 (UTC) ==<br />
<br />
Notes go here</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=32
Talk:Main Page
2025-04-04T19:29:54Z
<p>Jack: Blanked the page</p>
<hr />
<div></div>
Jack
http://edurange.org/wiki/index.php?title=Style_Guidelines_and_Developer_Tools&diff=31
Style Guidelines and Developer Tools
2025-04-04T19:28:49Z
<p>Jack: </p>
<hr />
<div>Style Guidelines go here</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=29
Talk:Main Page
2025-04-04T19:27:25Z
<p>Jack: /* Section */</p>
<hr />
<div>Fresh Start Test<br />
<br />
== Test ==<br />
<br />
Hello again<br />
<br />
=== Header2 ===<br />
<br />
Test Again<br />
<br />
====Re: Header2 -- [[User:Jwgranville|&#126;Joe]] ([[User talk:Jwgranville|talk]]) 19:25, 4 April 2025 (UTC)====<br />
<br />
:: Replace this text with your reply<br />
<br />
== Section T. -- [[User:T.mccoy|T.mccoy]] ([[User talk:T.mccoy|talk]]) 19:25, 4 April 2025 (UTC) ==<br />
<br />
--[[User:T.mccoy|T.mccoy]] ([[User talk:T.mccoy|talk]]) 19:25, 4 April 2025 (UTC)<br />
Welcome to the T Show<br />
<br />
== Test ==<br />
<br />
[[User:Jack|Jack]] ([[User talk:Jack|talk]])<br />
<br />
== Section ==<br />
<br />
No Signature :(<br />
<br />
===Re: Section -- [[User:Jack|Jack]] ([[User talk:Jack|talk]]) 19:27, 4 April 2025 (UTC)===<br />
<br />
: Hello There</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=28
Talk:Main Page
2025-04-04T19:26:28Z
<p>Jack: /* Section */ new section</p>
<hr />
<div>Fresh Start Test<br />
<br />
== Test ==<br />
<br />
Hello again<br />
<br />
=== Header2 ===<br />
<br />
Test Again<br />
<br />
====Re: Header2 -- [[User:Jwgranville|&#126;Joe]] ([[User talk:Jwgranville|talk]]) 19:25, 4 April 2025 (UTC)====<br />
<br />
:: Replace this text with your reply<br />
<br />
== Section T. -- [[User:T.mccoy|T.mccoy]] ([[User talk:T.mccoy|talk]]) 19:25, 4 April 2025 (UTC) ==<br />
<br />
--[[User:T.mccoy|T.mccoy]] ([[User talk:T.mccoy|talk]]) 19:25, 4 April 2025 (UTC)<br />
Welcome to the T Show<br />
<br />
== Test ==<br />
<br />
[[User:Jack|Jack]] ([[User talk:Jack|talk]])<br />
<br />
== Section ==<br />
<br />
No Signature :(</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=27
Talk:Main Page
2025-04-04T19:25:34Z
<p>Jack: /* Test */ new section</p>
<hr />
<div>Fresh Start Test<br />
<br />
== Test ==<br />
<br />
Hello again<br />
<br />
=== Header2 ===<br />
<br />
Test Again<br />
<br />
====Re: Header2 -- [[User:Jwgranville|&#126;Joe]] ([[User talk:Jwgranville|talk]]) 19:25, 4 April 2025 (UTC)====<br />
<br />
:: Replace this text with your reply<br />
<br />
== Section T. -- [[User:T.mccoy|T.mccoy]] ([[User talk:T.mccoy|talk]]) 19:25, 4 April 2025 (UTC) ==<br />
<br />
--[[User:T.mccoy|T.mccoy]] ([[User talk:T.mccoy|talk]]) 19:25, 4 April 2025 (UTC)<br />
Welcome to the T Show<br />
<br />
== Test ==<br />
<br />
[[User:Jack|Jack]] ([[User talk:Jack|talk]])</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=24
Talk:Main Page
2025-04-04T19:24:57Z
<p>Jack: /* Test */</p>
<hr />
<div>Fresh Start Test<br />
<br />
== Test ==<br />
<br />
Hello again<br />
<br />
=== Header2 ===<br />
<br />
Test Again</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=23
Talk:Main Page
2025-04-04T19:24:28Z
<p>Jack: /* Test */ new section</p>
<hr />
<div>Fresh Start Test<br />
<br />
== Test ==<br />
<br />
Hello again</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=22
Talk:Main Page
2025-04-04T19:23:41Z
<p>Jack: Replaced content with "Fresh Start Test"</p>
<hr />
<div>Fresh Start Test</div>
Jack
http://edurange.org/wiki/index.php?title=Talk:Main_Page&diff=21
Talk:Main Page
2025-04-04T19:20:56Z
<p>Jack: /* -- T.mccoy (talk) 19:20, 4 April 2025 (UTC) */</p>
<hr />
<div>Let's talk about the main page - Jack<br />
===================================<br />
<br />
===================-- [[User:T.mccoy|T.mccoy]] ([[User talk:T.mccoy|talk]]) 19:20, 4 April 2025 (UTC)===================<br />
<br />
::::::::::::::::: Hello</div>
Jack
http://edurange.org/wiki/index.php?title=User:Jack&diff=3
User:Jack
2025-04-04T13:11:07Z
<p>Jack: created page</p>
<hr />
<div>Hey woah it's me</div>
Jack
http://edurange.org/wiki/index.php?title=Main_Page&diff=2
Main Page
2025-04-04T13:10:39Z
<p>Jack: made placeholders to see how adding new pages works</p>
<hr />
<div><strong>Welcome to the EDURange Wiki</strong><br />
<br />
Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.<br />
<br />
== Getting started ==<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]<br />
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]<br />
<br />
== Developer Links ==<br />
[[Scenario Creation Guide]]<br />
<br />
[[Domain Modeling]]</div>
Jack