Rename Quantum Serverless to Qiskit Serverless (#1309)

* Rename Quantum Serverless to Qiskit Serverless * Fixed docker-compose for client tests * Use in the job old reference to quantum * This job requires old reference * Update configuration with proxy image
Qiskit · May 7, 2024 · 43d4ec8 · 43d4ec8
1 parent 510e1d4
commit 43d4ec8
Show file tree

Hide file tree

Showing 127 changed files with 386 additions and 382 deletions.
diff --git a/.github/workflows/client-pypi-release.yaml b/.github/workflows/client-pypi-release.yaml
@@ -26,9 +26,9 @@ jobs:
         shell: bash
       - uses: actions/upload-artifact@v3
         with:
-          path: ./client/dist/quantum_serverless*
+          path: ./client/dist/qiskit_serverless*
       - name: Publish to PyPi
         env:
           TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        run: twine upload client/dist/quantum_serverless*
+        run: twine upload client/dist/qiskit_serverless*
diff --git a/.github/workflows/docker-verify.yaml b/.github/workflows/docker-verify.yaml
@@ -55,22 +55,22 @@ jobs:
       matrix:
         image:
           [
-            "quantum-serverless-gateway:latest",
-            "quantum-serverless-proxy:latest",
-            "quantum-serverless-ray-node:latest-py39",
-            "quantum-serverless-ray-node:latest-py310",
+            "qiskit-serverless-gateway:latest",
+            "qiskit-serverless-proxy:latest",
+            "qiskit-serverless-ray-node:latest-py39",
+            "qiskit-serverless-ray-node:latest-py310",
           ]
         include:
-          - image: "quantum-serverless-gateway:latest"
+          - image: "qiskit-serverless-gateway:latest"
             dockerfile: "./gateway/Dockerfile"
             pyversion: "3.10"
-          - image: "quantum-serverless-proxy:latest"
+          - image: "qiskit-serverless-proxy:latest"
             dockerfile: "./proxy/Dockerfile"
             pyversion: "3.10"
-          - image: "quantum-serverless-ray-node:latest-py39"
+          - image: "qiskit-serverless-ray-node:latest-py39"
             dockerfile: "Dockerfile-ray-node"
             pyversion: "py39"
-          - image: "quantum-serverless-ray-node:latest-py310"
+          - image: "qiskit-serverless-ray-node:latest-py310"
             dockerfile: "Dockerfile-ray-node"
             pyversion: "py310"
     runs-on: ubuntu-latest

diff --git a/.github/workflows/icr-image-build-and-push.yaml b/.github/workflows/icr-image-build-and-push.yaml
@@ -15,19 +15,19 @@ jobs:
     strategy:
       matrix:
         include:
-          - imagename: quantum-serverless-ray-node
+          - imagename: qiskit-serverless-ray-node
             pythonversion: py39
             dockerfile: Dockerfile-ray-node
             platforms: linux/amd64,linux/arm64
-          - imagename: quantum-serverless-ray-node
+          - imagename: qiskit-serverless-ray-node
             pythonversion: py310
             dockerfile: Dockerfile-ray-node
             platforms: linux/amd64
-          - imagename: quantum-serverless-gateway
+          - imagename: qiskit-serverless-gateway
             pythonversion: ''
             dockerfile: ./gateway/Dockerfile
             platforms: linux/amd64,linux/arm64
-          - imagename: quantum-serverless-proxy
+          - imagename: qiskit-serverless-proxy
             pythonversion: ''
             dockerfile: ./proxy/Dockerfile
             platforms: linux/amd64,linux/arm64

diff --git a/.github/workflows/kubernetes-deploy.yaml b/.github/workflows/kubernetes-deploy.yaml
@@ -38,7 +38,7 @@ jobs:
           docker image rm proxy:test
       - name: Install helm chart
         run: |
-          cd charts/quantum-serverless
+          cd charts/qiskit-serverless
           helm repo add bitnami https://charts.bitnami.com/bitnami
           helm repo add kuberay https://ray-project.github.io/kuberay-helm
           helm dependency build

diff --git a/.github/workflows/publish-helm.yaml b/.github/workflows/publish-helm.yaml
@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         release:
-          - 'quantum-serverless'
+          - 'qiskit-serverless'
     steps:
       - name: Set up Helm
         uses: azure/setup-helm@v3

diff --git a/.github/workflows/release-pull-request.yaml b/.github/workflows/release-pull-request.yaml
@@ -11,20 +11,24 @@ jobs:
       matrix:
         image:
           [
-            "quantum-serverless-gateway:latest",
-            "quantum-serverless-ray-node:latest-py39",
-            "quantum-serverless-ray-node:latest-py310",
+            "qiskit-serverless-gateway:latest",
+            "qiskit-serverless-ray-node:latest-py39",
+            "qiskit-serverless-ray-node:latest-py310",
+            "qiskit-serverless-proxy:latest"
           ]
         include:
-          - image: "quantum-serverless-gateway:latest"
+          - image: "qiskit-serverless-gateway:latest"
             dockerfile: "./gateway/Dockerfile"
             pyversion: "3.10"
-          - image: "quantum-serverless-ray-node:latest-py39"
+          - image: "qiskit-serverless-ray-node:latest-py39"
             dockerfile: "Dockerfile-ray-node"
             pyversion: "py39"
-          - image: "quantum-serverless-ray-node:latest-py310"
+          - image: "qiskit-serverless-ray-node:latest-py310"
             dockerfile: "Dockerfile-ray-node"
             pyversion: "py310"
+          - image: "qiskit-serverless-proxy:latest-py310"
+            dockerfile: "./proxy/Dockerfile"
+            pyversion: "py310"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

diff --git a/.github/workflows/update-component-versions.yaml b/.github/workflows/update-component-versions.yaml
@@ -27,26 +27,26 @@ jobs:
           OLDNUM="${OLDTXT:1}"
           echo "NEWNUM=$NEWNUM" >> "$GITHUB_ENV"
           echo "OLDNUM=$OLDNUM" >> "$GITHUB_ENV"
-      - name: Update quantum-serverless chart
+      - name: Update qiskit-serverless chart
         shell: bash
         run: |
-          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/quantum-serverless/Chart.yaml
-          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/quantum-serverless/Chart.yaml
-          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/quantum-serverless/charts/gateway/Chart.yaml
-          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/quantum-serverless/charts/gateway/Chart.yaml
-          sed -i "s/ray-node:${OLDNUM}/ray-node:${NEWNUM}/" charts/quantum-serverless/charts/gateway/values.yaml
-          sed -i "s/quantum-serverless-proxy:${OLDNUM}/quantum-serverless-proxy:${NEWNUM}/" charts/quantum-serverless/charts/gateway/values.yaml
-          sed -i "s/tag: \"${OLDNUM}\"/tag: \"${NEWNUM}\"/" charts/quantum-serverless/values.yaml
-          sed -i "s/tag: \"${OLDNUM}-py39\"/tag: \"${NEWNUM}-py39\"/" charts/quantum-serverless/values.yaml
-          sed -i "s/ray-node:${OLDNUM}/ray-node:${NEWNUM}/" charts/quantum-serverless/values.yaml
-          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/quantum-serverless/values.yaml
-          cd charts/quantum-serverless
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/qiskit-serverless/Chart.yaml
+          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/qiskit-serverless/Chart.yaml
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/qiskit-serverless/charts/gateway/Chart.yaml
+          sed -i "s/appVersion: \"${OLDNUM}\"/appVersion: \"${NEWNUM}\"/" charts/qiskit-serverless/charts/gateway/Chart.yaml
+          sed -i "s/ray-node:${OLDNUM}/ray-node:${NEWNUM}/" charts/qiskit-serverless/charts/gateway/values.yaml
+          sed -i "s/qiskit-serverless-proxy:${OLDNUM}/qiskit-serverless-proxy:${NEWNUM}/" charts/qiskit-serverless/charts/gateway/values.yaml
+          sed -i "s/tag: \"${OLDNUM}\"/tag: \"${NEWNUM}\"/" charts/qiskit-serverless/values.yaml
+          sed -i "s/tag: \"${OLDNUM}-py39\"/tag: \"${NEWNUM}-py39\"/" charts/qiskit-serverless/values.yaml
+          sed -i "s/ray-node:${OLDNUM}/ray-node:${NEWNUM}/" charts/qiskit-serverless/values.yaml
+          sed -i "s/version: ${OLDNUM}/version: ${NEWNUM}/" charts/qiskit-serverless/values.yaml
+          cd charts/qiskit-serverless
           helm dependency update
           cd -
       - name: Update client version
         shell: bash
         run: |
-          sed -i "s/${OLDNUM}/${NEWNUM}/" client/quantum_serverless/VERSION.txt
+          sed -i "s/${OLDNUM}/${NEWNUM}/" client/qiskit_serverless/VERSION.txt
       - name: Update compose
         shell: bash
         run: |

diff --git a/CITATION.cff b/CITATION.cff
@@ -14,7 +14,7 @@ authors:
   given-names: "Paul"
 - family-names: "Kuroda"
   given-names: "Akihiko"
-title: "Quantum Serverless"
+title: "Qiskit Serverless"
 version: 0.0.3
 date-released: 2023-02-14
-url: "https://github.com/Qiskit-Extensions/quantum-serverless"
+url: "https://github.com/Qiskit-Extensions/qiskit-serverless"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,8 @@
 # Contributing
 
-Regardless if you are part of the core team or an external contributor, welcome and thank you for contributing to Quantum Serverless!
+Regardless if you are part of the core team or an external contributor, welcome and thank you for contributing to Qiskit Serverless!
 
-In Quantum Serverless, we aim at creating an excellent work-space where all of us can feel welcomed, useful, respected and valued. If you are thinking to contribute to this project, you agree to abide by our [code of conduct](CODE_OF_CONDUCT.md) which we strongly recommend you read before continuing.
+In Qiskit Serverless, we aim at creating an excellent work-space where all of us can feel welcomed, useful, respected and valued. If you are thinking to contribute to this project, you agree to abide by our [code of conduct](CODE_OF_CONDUCT.md) which we strongly recommend you read before continuing.
 
 Following these guidelines communicates you value the time and effort of the core contributors and maintainers of this site and so, thank you!
 
@@ -31,7 +31,7 @@ Following these guidelines communicates you value the time and effort of the cor
 
 ## Start contributing
 
-This repository is for developing and maintaining the Quantum Serverless project.
+This repository is for developing and maintaining the Qiskit Serverless project.
 
 There are many ways of contributing: from catching a typo to coming up with a way
 of improving performance or accessibility; you can open an issue, or you can prepare
@@ -41,7 +41,7 @@ submitting pull requests.
 
 ## Before you start
 
-Contributing to Quantum Serverless assumes you have some level
+Contributing to Qiskit Serverless assumes you have some level
 of [Git](https://git-scm.com) knowledge. For external contributors, a basic understanding
 of repositories, remotes, branches and commits is needed. For core contributors, you
 should know about resolving conflicts and rebasing too.
@@ -51,7 +51,7 @@ There are tons of useful resources about Git [out there](https://try.github.io/)
 
 ## Opening issues
 
-You can [open 3 types of issues](https://github.com/Qiskit-Extensions/quantum-serverless/issues/new/choose):
+You can [open 3 types of issues](https://github.com/Qiskit-Extensions/qiskit-serverless/issues/new/choose):
 
 * Bug reports: for reporting a misfunction. Provide steps to reproduce and expected behaviour.
 * Enhancement request: to suggest improvements to the current code.
@@ -70,17 +70,17 @@ Security vulnerabilities must be privately reported by following our [Security P
 
 You'll need to install these tools on your development environment:
 
-1. [python](https://www.python.org/): the language quantum-serverless is written in (Note that we currently support Python >=3.8,<3.11).
+1. [python](https://www.python.org/): the language qiskit-serverless is written in (Note that we currently support Python >=3.8,<3.11).
 1. [git](https://git-scm.com/): for source control
 1. [docker](https://docs.docker.com/engine/install/) or [podman](https://podman.io/): for building dev environment
 1. [kubectl](https://kubectl.docs.kubernetes.io/): for interacting with Kubernetes clusters
-1. [helm](https://helm.sh/): to install quantum-serverless on Kubernetes
+1. [helm](https://helm.sh/): to install qiskit-serverless on Kubernetes
 1. [tox](https://tox.wiki/en): to run tests and build the documentation
 
 Note: Installing the `pip` and `venv` python libraries will also be useful
 
 #### For non-Linux users
-To simplify the steps required to build and deploy quantum-serverless, we recommend the use of virtual machines for runtime containers.
+To simplify the steps required to build and deploy qiskit-serverless, we recommend the use of virtual machines for runtime containers.
 
 If you are on a Windows machine, it is recommended to use [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install).
 
@@ -109,10 +109,10 @@ nerdctl images
 ### Deciding what to work on
 
 To give our collaborators an idea of where the team needs help, we use the
-[help wanted](https://github.com/Qiskit-Extensions/quantum-serverless/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
+[help wanted](https://github.com/Qiskit-Extensions/qiskit-serverless/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
 label – this is appropriate for all contributors. In addition, for those who are relatively new to the open-source
 workflow or our codebase, feel free to view issues tagged with the
-[good first issue](https://github.com/Qiskit-Extensions/quantum-serverless/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+[good first issue](https://github.com/Qiskit-Extensions/qiskit-serverless/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
 label.
 
 
@@ -129,9 +129,9 @@ track this repository. A typical Git setup after
 
 ```sh
 # After forking the repository in GitHub
-git clone https://github.com/<your_username>/quantum-serverless.git
-cd quantum-serverless
-git remote add upstream https://github.com/Qiskit-Extensions/quantum-serverless.git
+git clone https://github.com/<your_username>/qiskit-serverless.git
+cd qiskit-serverless
+git remote add upstream https://github.com/Qiskit-Extensions/qiskit-serverless.git
 git remote set-url --push upstream no_push
 git remote update upstream
 git checkout main
@@ -150,7 +150,7 @@ This repository contains several projects with different technologies. Depending
 - `helm dependency build` for helm (Before running this command, make sure to check for helm configuration instructions specific to your selected project charts).
 -  `terraform init` for terraform.
 
-To set up a local development environment for the quantum-serverless components (including the gateway, repository, ray nodes, etc.) using the latest changes you've made, use `docker compose` or `podman-compose`.
+To set up a local development environment for the qiskit-serverless components (including the gateway, repository, ray nodes, etc.) using the latest changes you've made, use `docker compose` or `podman-compose`.
 
 To build the images, run the following command from the root directory:
 
@@ -220,7 +220,7 @@ git rebase main issue-1234-new-feature
 
 Our team upholds the philosophy that a healthy codebase will include the proper amount of testing.
 From the project you are working on, you can run tests with `tox -epy310`.
-Note if you run this command from quantum-serverless top directory, it will build the project documentation.
+Note if you run this command from qiskit-serverless top directory, it will build the project documentation.
 For detailed testing guidelines using tox environments, please refer to [this documentation](./client/tests/README.md).
 
 As a part of the development backlog planning, we have internal discussions to determine which scenarios should be

diff --git a/Makefile b/Makefile
@@ -10,9 +10,9 @@ else
 	arch="amd64"
 endif
 
-rayNodeImageName=$(repository)/quantum-serverless-ray-node
-gatewayImageName=$(repository)/quantum-serverless-gateway
-proxyImageName=$(repository)/quantum-serverless-proxy
+rayNodeImageName=$(repository)/qiskit-serverless-ray-node
+gatewayImageName=$(repository)/qiskit-serverless-gateway
+proxyImageName=$(repository)/qiskit-serverless-proxy
 
 # =============
 # Docker images