Merge pull request #17 from SciCatProject/production-prep

Add docker automation and CI workflow needed for production deployments

Author: nitrosx

.github/workflows/docker_release.yml

@@ -0,0 +1,56 @@
+name: Docker Release
+
+on:
+  push:
+    branches:
+      - release
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Bump version and push tag
+        id: tag_version
+        uses: mathieudutour/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          release_branches: release
+
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ steps.tag_version.outputs.new_tag }}
+          name: Release ${{ steps.tag_version.outputs.new_tag }}
+          body: ${{ steps.tag_version.outputs.changelog }}
+
+      - name: Create Docker Metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/scicatproject/sciwyrm
+          flavor: latest=true # adds :latest tag to outputs.tags
+          tags: | # adds :<sha> tag to outputs.tags
+            type=sha,format=long,prefix=
+            type=raw,value=${{ steps.tag_version.outputs.new_tag }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build Docker Image
+        uses: docker/build-push-action@v4
+        with:
+          platforms: linux/amd64,linux/arm64
+          context: ./
+          file: ./docker/Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

.gitignore

@@ -160,4 +160,8 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+#
+#
+# local files
+local/

README.md

@@ -21,3 +21,53 @@ access:
 navigate browser to:
 http://localhost:8000/docs
 ```
+
+In order to test, you can submit the following POST request , once you have the service running locally:
+```
+curl \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "template_id" : "b32f6992-0355-4759-b780-ececd4957c23",
+    "parameters" : {
+      "dataset_pids" : [ "dataset_pid_1" ,"dataset_pid_2" ],
+      "file_server_host" : "this_file_server",
+      "file_server_port" : 22,
+      "scicat_url" : "my.scicat.instance",
+      "scicat_token" : "my.scicat.token"
+    }
+  }' \
+  -X POST \
+  http://localhost:8000/notebook
+```
+as a one liner, ready to be run, it looks like:
+```
+curl -H 'Content-Type: application/json' -d '{ "template_id" : "b32f6992-0355-4759-b780-ececd4957c23", "parameters" : {"dataset_pids":["dataset_pid_1","dataset_pid_2"],"file_server_host": "this_file_server","file_server_port" : 22, "scicat_url":"my.scicat.instance", "scicat_token" : "my.scicat.token"}}' -X POST http://localhost:8000/notebook
+```
+
+This request should result in an populated instance of the template b32f6992-0355-4759-b780-ececd4957c23.ipynb included in the repository.
+
+## Docker Image
+A docker image is created by a dedicated workflow every time there is a new release by merging a PR in the `release` branch.
+
+In case a users or developer has the need to create locally a docker image and deploy the container, the following commands can be used, assuming that image name `sciwyrm` and the container name is `scijug`:
+
+Docker image creation
+```
+docker build -f docker/Dockerfile . -t sciwyrm
+
+```
+
+Docker container instantiation
+```
+docker create --name scijug -p 8000:8000 sciwyrm
+```
+
+The Jupyter creation service will be available on http://localhost:8000
+
+## Contribution
+All contributors should create a branch dedicated branch to develop their feature and [performing their work.
+Once the code is in a ready, the contribution should be done through a PR to the main branch, where maintainers can review, provide feedback and approve it.
+
+## Releases
+Release are managed by maintainers by creating PRs from the main branch to the release branch.
+Merging a PR in release trigger a git workflow that creates a release in the repository and also the creation of a docker image with the version of the service released.

docker/Dockerfile

@@ -0,0 +1,15 @@
+# Use the official Python image from the Docker Hub
+FROM python:3.12
+
+# Set the working directory in the container
+WORKDIR /code
+
+# Copy the requirements file into the container
+COPY . .
+
+# Install the dependencies
+RUN pip install "uvicorn[standard]"
+RUN pip install -e .
+
+# command to run
+CMD ["uvicorn", "sciwyrm.main:app", "--host", "0.0.0.0"]

templates/notebook/b32f6992-0355-4759-b780-ececd4957c23.ipynb

@@ -154,7 +154,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.12.9"
   }
  },
  "nbformat": 4,