Initial commit

.gitignore

+.env
+.idea/
+examples/
+!examples/.gitkeep
\ No newline at end of file

.gitlab-ci.yml

+include:
+  - project: 'eclipsefdn/it/releng/gitlab-runner-service/gitlab-ci-templates'
+    file: 'jobs/buildkit.gitlab-ci.yml'
+  - project: 'eclipsefdn/it/releng/gitlab-runner-service/gitlab-ci-templates'
+    file: 'pipeline-autodevops.gitlab-ci.yml'
+
+stages:
+  - build
+  - test
+
+variables:
+  CI_REGISTRY_IMAGE: nemometaos/intent-api
+
+buildkit:
+  extends: .buildkit
+  
+unit-test:
+  stage: test
+  script:
+    - echo "Running unit tests... This will take about 10 seconds."
+    # - docker run $CI_REGISTRY_IMAGE:$CI_COMMIT_SHORT_SHA /script/to/run/tests
+    - sleep 10
+    - echo "Tests passed succesfully!"
+

CHANGELOG.md

+Intent API Changelog
+=
+
+v0.1.0 (22/03/2024)
+==
+- Added preliminary RabbitMQ integration ( see README.md)
+- Updated endpoint ```/workload/upload``` to return code=201 upon successful upload
+
+v0.1.1 (22/03/2024)
+==
+- Added missing pika library
\ No newline at end of file

Dockerfile

+FROM python:3.11.7-slim-bookworm as base
+
+# Generate virtualenv in project directory
+ENV PIPENV_VENV_IN_PROJECT=1
+
+# Project directory
+ENV PROJECT_ROOT=/opt/app
+
+WORKDIR $PROJECT_ROOT
+
+# Add tools & runtime dependencies
+RUN set -eux; \
+        apt-get update; \
+        apt-get install -y --no-install-recommends \
+            netcat-traditional \
+            vim \
+            tmux \
+            wget \
+            curl \
+            graphviz \
+            postgresql-client \
+            skopeo \
+            git \
+        ; \
+        curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash; \
+        curl -LO "https://dl.k8s.io/release/v1.29.1/bin/linux/amd64/kubectl"; \
+        rm -rf /var/lib/apt/lists/*
+
+# Copy Pipfile & lock
+COPY Pipfile* $PROJECT_ROOT/
+
+RUN mkdir $PROJECT_ROOT/wheels
+
+COPY wheels/* $PROJECT_ROOT/wheels/
+
+RUN set -eux; \
+    savedAptMark="$(apt-mark showmanual)"; \
+    apt-get update; \
+    apt-get install -y --no-install-recommends \
+        libgraphviz-dev \
+        build-essential \
+        cmake \
+        libffi-dev \
+        libpq-dev \
+    ; \
+    pip3 install "pipenv==2023.10.3"; \
+    pipenv install; \
+	apt-mark auto '.*' > /dev/null; \
+	apt-mark manual $savedAptMark; \
+    find /opt/app/.venv -type f -executable -exec ldd '{}' ';' 2>&1 \
+        | grep -v "not a dynamic executable" \
+        | awk '/=>/ { so = $(NF-1); if (index(so, "/opt/app/.venv") == 1) { next }; gsub("^/(usr/)?", "", so); printf "*%s\n", so }' \
+        | grep -v "*not" \
+        | xargs -r dpkg-query --search 2>&1 \
+        | grep -v "dpkg-query" \
+        | cut -d: -f1 \
+        | sort -u \
+        | xargs -r apt-mark manual \
+    ; \
+    apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false; \
+	rm -rf /var/lib/apt/lists/*; \
+    pipenv run pip3 freeze;
+
+FROM base as image
+
+# Copy the application code
+COPY . .
+
+# Setup
+RUN set -eux; \
+    pipenv run python3 manage.py collectstatic --noinput
+
+# Gunicorn configuration
+ENV GUNICORN_CMD_ARGS="-c core/gunicorn.py"
+
+#CMD bash config/scripts/bootstrap.sh
+RUN chmod +x /opt/app/config/scripts/bootstrap.sh
+ENTRYPOINT ["/opt/app/config/scripts/bootstrap.sh"]
+
+# Expose gunicorn port
+EXPOSE 8000

LICENSE

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
\ No newline at end of file

Pipfile

+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+django = "~=5.0.1"
+pyhelm3 = {path = "./wheels/pyhelm3-0.0.1-py3-none-any.whl"}
+psycopg = "~=3.1.17"
+celery = {version = "~=5.3.6", extras = ["redis"]}
+django-health-check = "~=3.17.0"
+djangorestframework = "~=3.14.0"
+sh = "~=2.0.6"
+kubernetes = "~=29.0.0"
+drf-yasg = "~=1.21.7"
+django-model-utils = "~=4.4.0"
+django-filter = "~=23.5"
+drf-yaml = "~=3.0.1"
+gunicorn = "~=21.2.0"
+whitenoise = "~=6.6.0"
+pika = "~=1.3.2"
+
+[dev-packages]
+
+[requires]
+python_version = "3.11"
+python_full_version = "3.11.7"

README.md

+Nemo Intent API
+=
+
+Prerequisites
+===
+
+* Docker
+* docker-compose
+* helm
+* skopeo
+* s3cmd (optional)
+
+Helm repository guide
+===
+
+Initialization
+=====
+Install s3 plugin:
+
+```bash
+helm plugin install https://github.com/hypnoglow/helm-s3.git
+```
+
+Export the necessary environmental variables:
+
+```bash
+export AWS_ENDPOINT=<s3 url>
+export AWS_ACCESS_KEY_ID=<s3 access key>
+export AWS_SECRET_ACCESS_KEY=<s3 secret key>
+export AWS_DEFAULT_REGION=<s3 region>
+export HELM_REPOSITORY_BUCKET=<bucket path with /charts ending>
+export HELM_REPOSITORY_NAME=<bucker repository name>
+```
+
+Initialize the helm repository:
+
+```bash
+helm s3 init --ignore-if-exists ${HELM_REPOSITORY_BUCKET}
+```
+
+Add the helm repository reference:
+
+```bash
+helm repo add ${HELM_REPOSITORY_NAME} ${HELM_REPOSITORY_BUCKET}
+```
+
+Listing stored charts
+=====
+
+Listing all uploaded charts:
+
+```bash
+s3cmd ls --host=${AWS_ENDPOINT} --access_key=${AWS_ACCESS_KEY_ID} --secret_key=${AWS_SECRET_ACCESS_KEY} --region=${AWS_DEFAULT_REGION} --host-bucket=  ${HELM_REPOSITORY_BUCKET}/
+```
+
+Retrieving repository index file:
+
+```bash
+s3cmd get ${HELM_REPOSITORY_BUCKET}/index.yaml --host=${AWS_ENDPOINT} --access_key=${AWS_ACCESS_KEY_ID} --secret_key=${AWS_SECRET_ACCESS_KEY} --region=${AWS_DEFAULT_REGION} --host-bucket= - | cat
+ ```
+
+Development
+===
+
+Launching local postgresql & redis instance:
+
+```bash
+docker-compose -up -d -f config/local/docker-compose.yml
+```
+
+Rabbitmq integration
+===
+
+The following table contains the integration effort of RabbitMQ component thus far:
+
+|   Exchange Name   | Exchange Type |          Queues         | Routing Key |  Message Type    | Message Example                                                                                                                                                                            | Publishing reason                                          |
+|:-----------------:|:-------------:|:-----------------------:|:-----------:|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
+| nemo.api.workload |     direct    | [upload (durable), ...] |    upload   | stringified JSON | '{"id": 4, "name": "echo-server", "version": "0.5.5", "type": "chart", "status": "accepted"}'                                                                                              | workload lifecycle status={onboarding, accepted, rejected} |
+| nemo.api.workload |     direct    |   [run (durable), ...]  |     run     | stringified JSON | '{"id": 6, "instance_id": "936623ae-8969-4d73-8c04-527d1cb815ac", "workload_document_id": 9, "release_name": "test-release", "status": "rendered", "manifests": [], "cluster_name": null}' | workload instance lifecycle status={rendered,}             |
\ No newline at end of file

api/apps.py

+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'api'

api/filters.py

+from django_filters import rest_framework as filters
+
+from nemo.models import WorkloadDocument
+from nemo.models.workload import WorkloadDocumentInstance
+
+
+class WorkloadDocumentFilter(filters.FilterSet):
+    name = filters.CharFilter(field_name='name', lookup_expr='icontains')
+
+    class Meta:
+        model = WorkloadDocument
+        fields = ('name', 'version')
+
+
+class WorkloadDocumentInstanceFilter(filters.FilterSet):
+    release_name = filters.CharFilter(field_name='release_name', lookup_expr='icontains')
+    cluster_name = filters.CharFilter(field_name='cluster_name', lookup_expr='icontains')
+
+    class Meta:
+        model = WorkloadDocumentInstance
+        fields = ('release_name', 'cluster_name', 'workload_document', 'status')
\ No newline at end of file