diff --git a/.github/workflows/code.yml b/.github/workflows/code.yml index 9f2f5c5..dd6d0ed 100644 --- a/.github/workflows/code.yml +++ b/.github/workflows/code.yml @@ -1,19 +1,6 @@ name: Code CI -on: - push: - branches: - # Restricting to these branches and tags stops duplicate jobs on internal - # PRs but stops CI running on internal branches without a PR. Delete the - # next 5 lines to restore the original behaviour - - master - - main - tags: - - "*" - pull_request: - schedule: - # Run every Monday at 8am to check latest versions of dependencies - - cron: "0 8 * * MON" +on: [push] jobs: lint: @@ -117,8 +104,3 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Publish to PyPI - env: - TWINE_USERNAME: __token__ - TWINE_PASSWORD: ${{ secrets.pypi_token }} - run: pipx run twine upload dist/* diff --git a/.github/workflows/container.yml b/.github/workflows/container.yml new file mode 100644 index 0000000..a7d3d4b --- /dev/null +++ b/.github/workflows/container.yml @@ -0,0 +1,39 @@ +name: Container CI + +on: ['push'] + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build-and-push-image: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Log in to the Container registry + uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + + - name: Build and push Docker image + uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} \ No newline at end of file diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 7931e25..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Docs CI - -on: - push: - branches: - # Add more branches here to publish docs from other branches - - master - - main - tags: - - "*" - pull_request: - -# jobs: -# docs: -# runs-on: ubuntu-latest - -# steps: -# - name: Avoid git conflicts when tag and branch pushed at same time -# if: startsWith(github.ref, 'refs/tags') -# run: sleep 60 - -# - name: Install Packages -# # Can delete this if you don't use graphviz in your docs -# run: sudo apt-get install graphviz - - # - name: Build docs - # uses: dls-controls/pipenv-run-action@v1 - # with: - # pipenv-run: docs diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml deleted file mode 100644 index e9384c9..0000000 --- a/.github/workflows/linkcheck.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: Link Check - -on: - schedule: - # Run every Monday at 8am to check URL links still resolve - - cron: "0 8 * * MON" - -jobs: - docs: - runs-on: ubuntu-latest - - steps: - - name: Build docs - uses: dls-controls/pipenv-run-action@v1 - with: - pipenv-run: docs -b linkcheck diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d081700..8f98aa9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,6 +4,7 @@ repos: hooks: - id: check-added-large-files - id: check-yaml + exclude: ^helm\/diffcalc-api\/templates\/.* - id: check-merge-conflict - repo: local diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..03e3b00 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,17 @@ +#Install python and copy over repo files +FROM python:3.8 + +ENV ENV_DIR /diffcalc_API +WORKDIR ${ENV_DIR} + +COPY . ${ENV_DIR} + +#Install dependencies +RUN pip install pipenv; \ + pipenv install --system --python 3.8; \ + pip uninstall diffcalc-core -y; \ + pip install git+https://github.com/DiamondLightSource/diffcalc-core.git + + +#Run the API +CMD ["uvicorn", "src.diffcalc_API.server:app", "--host", "0.0.0.0"] \ No newline at end of file diff --git a/helm/diffcalc-api/.helmignore b/helm/diffcalc-api/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/helm/diffcalc-api/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/helm/diffcalc-api/Chart.yaml b/helm/diffcalc-api/Chart.yaml new file mode 100644 index 0000000..1ae266d --- /dev/null +++ b/helm/diffcalc-api/Chart.yaml @@ -0,0 +1,18 @@ +apiVersion: v2 +name: diffcalc-api +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 0.1.0 diff --git a/helm/diffcalc-api/templates/NOTES.txt b/helm/diffcalc-api/templates/NOTES.txt new file mode 100644 index 0000000..984f35a --- /dev/null +++ b/helm/diffcalc-api/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "diffcalc-api.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "diffcalc-api.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "diffcalc-api.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "diffcalc-api.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/helm/diffcalc-api/templates/_helpers.tpl b/helm/diffcalc-api/templates/_helpers.tpl new file mode 100644 index 0000000..6aa10d8 --- /dev/null +++ b/helm/diffcalc-api/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "diffcalc-api.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "diffcalc-api.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "diffcalc-api.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "diffcalc-api.labels" -}} +helm.sh/chart: {{ include "diffcalc-api.chart" . }} +{{ include "diffcalc-api.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "diffcalc-api.selectorLabels" -}} +app.kubernetes.io/name: {{ include "diffcalc-api.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "diffcalc-api.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "diffcalc-api.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/helm/diffcalc-api/templates/deployment.yaml b/helm/diffcalc-api/templates/deployment.yaml new file mode 100644 index 0000000..017d44c --- /dev/null +++ b/helm/diffcalc-api/templates/deployment.yaml @@ -0,0 +1,64 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "diffcalc-api.fullname" . }} + labels: + {{- include "diffcalc-api.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "diffcalc-api.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "diffcalc-api.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "diffcalc-api.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + env: + - name: mongo_url + value: {{ .Values.mongoUrl }} + ports: + - name: http + containerPort: 8000 + protocol: TCP + # livenessProbe: + # httpGet: + # path: / + # port: http + # readinessProbe: + # httpGet: + # path: / + # port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/helm/diffcalc-api/templates/hpa.yaml b/helm/diffcalc-api/templates/hpa.yaml new file mode 100644 index 0000000..8b31fc7 --- /dev/null +++ b/helm/diffcalc-api/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "diffcalc-api.fullname" . }} + labels: + {{- include "diffcalc-api.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "diffcalc-api.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/helm/diffcalc-api/templates/ingress.yaml b/helm/diffcalc-api/templates/ingress.yaml new file mode 100644 index 0000000..2d8e64b --- /dev/null +++ b/helm/diffcalc-api/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "diffcalc-api.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}} + {{- end }} +{{- end }} +{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "diffcalc-api.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} + pathType: {{ .pathType }} + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} diff --git a/helm/diffcalc-api/templates/service.yaml b/helm/diffcalc-api/templates/service.yaml new file mode 100644 index 0000000..339b2d4 --- /dev/null +++ b/helm/diffcalc-api/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "diffcalc-api.fullname" . }} + labels: + {{- include "diffcalc-api.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "diffcalc-api.selectorLabels" . | nindent 4 }} diff --git a/helm/diffcalc-api/templates/serviceaccount.yaml b/helm/diffcalc-api/templates/serviceaccount.yaml new file mode 100644 index 0000000..f8e7298 --- /dev/null +++ b/helm/diffcalc-api/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "diffcalc-api.serviceAccountName" . }} + labels: + {{- include "diffcalc-api.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/helm/diffcalc-api/templates/tests/test-connection.yaml b/helm/diffcalc-api/templates/tests/test-connection.yaml new file mode 100644 index 0000000..7908c90 --- /dev/null +++ b/helm/diffcalc-api/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "diffcalc-api.fullname" . }}-test-connection" + labels: + {{- include "diffcalc-api.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "diffcalc-api.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/helm/diffcalc-api/values.yaml b/helm/diffcalc-api/values.yaml new file mode 100644 index 0000000..b25e61e --- /dev/null +++ b/helm/diffcalc-api/values.yaml @@ -0,0 +1,84 @@ +# Default values for diffcalc-api. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +mongoUrl: mongodb:27017 + +image: + repository: gcr.io/diamond-pubreg/diffcalc/api + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: latest + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: false + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: LoadBalancer + port: 80 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {} diff --git a/src/diffcalc_API/database.py b/src/diffcalc_API/database.py index b455bad..ca32a02 100644 --- a/src/diffcalc_API/database.py +++ b/src/diffcalc_API/database.py @@ -1,7 +1,13 @@ import motor.motor_asyncio from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase +from pydantic import BaseSettings -client: AsyncIOMotorClient = motor.motor_asyncio.AsyncIOMotorClient( - "172.23.169.16:27017" -) + +class Settings(BaseSettings): + mongo_url: str = "localhost:27017" + + +settings = Settings() + +client: AsyncIOMotorClient = motor.motor_asyncio.AsyncIOMotorClient(settings.mongo_url) database: AsyncIOMotorDatabase = client.test_db