Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/infiniteregrets/QiskitBot
Discord Bot that leverages the idea of nested containers using podman, runs untrusted user input, executes Quantum Circuits, allows users to refer to the Qiskit Documentation, and provides the ability to search questions on the Quantum Computing StackExchange.
https://github.com/infiniteregrets/QiskitBot
bot containers discord discord-py docker docker-compose ibm podman qiskit sandbox
Last synced: 3 months ago
JSON representation
Discord Bot that leverages the idea of nested containers using podman, runs untrusted user input, executes Quantum Circuits, allows users to refer to the Qiskit Documentation, and provides the ability to search questions on the Quantum Computing StackExchange.
- Host: GitHub
- URL: https://github.com/infiniteregrets/QiskitBot
- Owner: infiniteregrets
- License: mit
- Archived: true
- Created: 2021-05-15T15:50:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-19T06:00:43.000Z (over 3 years ago)
- Last Synced: 2024-06-14T01:26:26.737Z (5 months ago)
- Topics: bot, containers, discord, discord-py, docker, docker-compose, ibm, podman, qiskit, sandbox
- Language: Python
- Homepage:
- Size: 942 KB
- Stars: 24
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QiskitBot
A discord bot that allows you to execute [Quantum Circuits](https://qiskit.org/documentation/stubs/qiskit.circuit.QuantumCircuit.html), look up the [IBMQ Qiskit's Documentation](https://qiskit.org/documentation/), and search questions on the [Quantum Computing StackExchange](https://quantumcomputing.stackexchange.com/)
\
:two_hearts: Qiskit Community
This project is not affiliated with IBM in any way. But I would like to thank Brian Ingmanson (Education Community Manager at IBM) for being so encouraging and supportive towards this little project!
## Installation
- **Podman Version**
Using docker-compose:
```
docker-compose up --build
```
Manually from the Dockerfile
```
docker build -t qiskitbot .
docker run --privileged -i -t qiskitbot
```
On MacOs with deploy.sh
```
zsh deploy.sh
```
- **Docker Python SDK version**
```
python3 -B .
```
Make sure you have Docker [installed](https://www.docker.com/products/docker-desktop) and running on your machine.
## Disclaimer
Builds might fail on your machine. This is still under testing and there is a lot that needs to be fixed with the way the code is structured. Once everything is smooth, I will add docstrings and comments wherever neccessary. This was just a hobby project, but I do plan on extending it further.
## Versions
There are two versions that I have been working on. One that uses the [Docker Python SDK](https://docker-py.readthedocs.io/en/stable/) and one that launches containers using Podman inside a container controlled by Docker.
The Docker Python SDK version is much faster when it comes to rendering simple circuits, so that is what you should be probably looking at.
## Architecture of the sandbox (running untrusted code) [Podman]
### Goal
Spawn a container per user inside a container launched by docker, providing an isolated environment to run untrusted code. Save the state of the user using [CRIU](https://criu.org/Main_Page) (checkpoint and restore).
Checkpointing and restoring is easy with Podman:
```
podman container checkpoint
podman container restore
```
As of now this feature is unimplemented, but methods for checkpoint and restore are available in `cogs/circuit.py`
### Nested Containers
One of the main objectives of this project was to experiment with the idea of having containers inside of containers. Instead of mounting the unix socket and the spawning containers (the tradional way):
```
docker run -v /var/run/docker.sock:/var/run/docker.sock ...
```
I used podman inside of docker, which is a daemonless container engine used for developing, managing, and running OCI Containers. Podman is used with tools like Buildah and Skopeo, which not only makes managing images and containers easy but in my opinion much more powerful than docker!
### Initial Idea - Using NsJail With Podman
To use podman inside a container launched by docker with [nsjail](nsjail.dev) you need to use the `--privileged` flag while running your container. Running a container without this flag works just fine, but the problem arises, when using this flag, as the capabilities of podman and docker don't match. This means you can't run privileged podman containers inside of a docker container as required by NsJail.
`"CAP_PERFMON","CAP_BPF", "CAP_CHECKPOINT_RESTORE"` are not supported by docker.
See issue [#10282 on containers/podman](https://github.com/containers/podman/issues/10282)
Eventually after a lot of experimentation, I dropped this idea. (refer to the Dockerfile in the root directory)
## Usage
```
<@Qiskit>asciicircuit \`\`\` \`\`\`
```
```
<@Qiskit>mplcircuit \`\`\` \`\`\`
```
```
<@Qiskit>docs
```
```
<@Qiskit>mplplot \`\`\` \`\`\`
```
```
<@Qiskit>query
```
