javacore-analyser 2.2.0.dev79__tar.gz → 2.2.0.dev91__tar.gz

{javacore_analyser-2.2.0.dev79 → javacore_analyser-2.2.0.dev91}/.travis.yml

@@ -29,5 +29,5 @@ deploy:
    file: dist/*
    on:
     # all_branches: true # uncomment for testing purposes
-    branch: main # uncomment on production
-    tags: true # We need to consider if we want to publish all versions or every build (which should not be an issue
+    # branch: main # uncomment on production
+    tags: true # We need to consider if we want to publish all versions or every build

{javacore_analyser-2.2.0.dev79 → javacore_analyser-2.2.0.dev91}/CONTRIBUTING.md

@@ -94,7 +94,7 @@ To run web application:
 
 ## Build pip package 
 Follow the steps from [Packaging projects](https://packaging.python.org/en/latest/tutorials/packaging-projects/).
-Currently Chris has an API keys for test and production pypi
+Currently Chris and Tad have an API keys for test and production pypi
 
 ## Build container localy  
 To build a container:  
@@ -115,6 +115,43 @@ or
 `-p` specifies port mapping. The application in container is running on port 5000. You can map it to another port on 
 your machine (5001 in this example).
 
+
+## Publish the container to ghcr.io/ibm/javacore-analyser
+Once you built the container locally, you might need to publish it on ghcr.io/ibm/javacore-analyser.
+Here are the instructions: 
+https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry.  
+Steps:
+1. Generate the token by navigating to https://github.com/settings/tokens/new?scopes=write:packages. 
+   * Select the read:packages scope to download container images and read their metadata.
+   * Select the write:packages scope to download and upload container images and read and write their metadata.
+   * Select the delete:packages scope to delete container images.  
+   NOTE: you can use the same token for multiple pushes until it does not expire.
+2. Tag image:
+   ```commandline
+   podman image tag localhost/javacore-analyser ghcr.io/ibm/javacore-analyser:latest
+   podman image tag localhost/javacore-analyser ghcr.io/ibm/javacore-analyser:2.1
+   ```
+3. Push the image:
+   ```commandline
+   export CR_PAT=<token-id generated in step 1>
+   echo $CR_PAT | podman login ghcr.io -u USERNAME --password-stdin  
+   podman push ghcr.io/ibm/javacore-analyser:2.1
+   podman push ghcr.io/ibm/javacore-analyser:latest
+   ```
+  
+## Build and Publish multiplatform image 
+To publish the image for multiple platforms, follow these instructions:
+https://developers.redhat.com/articles/2023/11/03/how-build-multi-architecture-container-images#benefits_of_multi_architecture_containers
+```commandline
+<Generate token if you do not have it yet>
+export CR_PAT=<token-id generated in step 1>
+echo $CR_PAT | podman login ghcr.io -u USERNAME --password-stdin  
+podman manifest create javacore-analyser:2.1
+podman build --platform linux/amd64,linux/arm64,linux/i386  --manifest javacore-analyser:2.1  .
+podman manifest push javacore-analyser:2.1 docker://ghcr.io/ibm/javacore-analyser:2.1
+podman manifest push javacore-analyser:2.1 docker://ghcr.io/ibm/javacore-analyser:latest
+```
+
 ## Releasing a new version
 Release a new version is partially automated by Travis. Here are the steps:  
 1. Make sure you are on `main` branch in your repository.
@@ -162,6 +199,7 @@ https://github.com/settings/tokens/new
 6. Publish release.
 7. Copy release notes to [CHANGELOG.md](CHANGELOG.md) file.
 
+
 ## Testing
 As default the tests in Pycharm are ran in the current selected directory. However we want to run them in main 
 directory of the tool (**javacore-analyser** directory, not **test** directory). 

javacore_analyser-2.2.0.dev91/Dockerfile

@@ -0,0 +1,17 @@
+#
+# Copyright IBM Corp. 2024 - 2024
+# SPDX-License-Identifier: Apache-2.0
+#
+
+FROM python:3
+
+LABEL org.opencontainers.image.source="https://github.com/IBM/javacore-analyser"
+LABEL org.opencontainers.image.description="This is a tool to analyse IBM Javacore files and provide the report used to analyse hang/outage and performance issues."
+LABEL org.opencontainers.image.licenses="Apache-2.0"
+
+EXPOSE 5000/tcp
+RUN mkdir /reports
+VOLUME ["/reports"]
+
+RUN ["pip", "install", "--no-cache-dir", "javacore-analyser"]
+CMD ["javacore_analyser_web", "--port=5000", "--reports-dir=/reports"]

{javacore_analyser-2.2.0.dev79 → javacore_analyser-2.2.0.dev91}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: javacore_analyser
-Version: 2.2.0.dev79
+Version: 2.2.0.dev91
 Summary: The tool to review IBM Javacore files
 Project-URL: Homepage, https://github.com/IBM/javacore-analyser
 Project-URL: Issues, https://github.com/IBM/javacore-analyser/issues
@@ -312,19 +312,20 @@ You can type the following command to obtain the help:
      or  
   `python -m javacore_analyser web --port=5000 --reports-dir=/data/reports_dir`  
 
+
    The first parameter set the port to use by application. If not specified, 5000 will be used.  
    The second parameter sets where the reports need to be stored. If not set, then the `reports` dir will be created in current location.  
 
 Now you can type (http://localhost:5000/).  
 
 ### Running container image
-There is an unofficial Docker/Podman container managed by one of projects developers. Use the following command 
+There is a Docker/Podman container managed by one of projects developers. Use the following command 
 to start it:
 
-`podman run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`
+`podman run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/ibm/javacore-analyser:latest`
 
 or  
-`docker run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`  
+`docker run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/ibm/javacore-analyser:latest`  
 
 The `mount` option specifies where you want locally to store the reports. The reports in the container are stored in 
 `/reports` directory. If you remove mount option, the application will work but the reports will not persist after 

{javacore_analyser-2.2.0.dev79 → javacore_analyser-2.2.0.dev91}/README.md

@@ -73,19 +73,20 @@ You can type the following command to obtain the help:
      or  
   `python -m javacore_analyser web --port=5000 --reports-dir=/data/reports_dir`  
 
+
    The first parameter set the port to use by application. If not specified, 5000 will be used.  
    The second parameter sets where the reports need to be stored. If not set, then the `reports` dir will be created in current location.  
 
 Now you can type (http://localhost:5000/).  
 
 ### Running container image
-There is an unofficial Docker/Podman container managed by one of projects developers. Use the following command 
+There is a Docker/Podman container managed by one of projects developers. Use the following command 
 to start it:
 
-`podman run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`
+`podman run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/ibm/javacore-analyser:latest`
 
 or  
-`docker run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`  
+`docker run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/ibm/javacore-analyser:latest`  
 
 The `mount` option specifies where you want locally to store the reports. The reports in the container are stored in 
 `/reports` directory. If you remove mount option, the application will work but the reports will not persist after 

javacore_analyser-2.2.0.dev79/Dockerfile

@@ -1,15 +0,0 @@
-#
-# Copyright IBM Corp. 2024 - 2024
-# SPDX-License-Identifier: Apache-2.0
-#
-
-FROM python:3
-
-EXPOSE 5000/tcp
-ENV REPORTS_DIR=/reports
-RUN mkdir /reports
-VOLUME ["/reports"]
-
-RUN pip install --no-cache-dir --root-user-action ignore javacore-analyser
-
-CMD [ "javacore_analyser_web" ]