diff --git a/LICENSE b/LICENSE index 1bb9d71..29cbf33 100644 --- a/LICENSE +++ b/LICENSE @@ -1,10 +1,198 @@ -Copyright 2023 Department of Parks and Wildlife + 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 + 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, diff --git a/gunicorn.py b/gunicorn.py index 6dea2a5..f8fdc9d 100644 --- a/gunicorn.py +++ b/gunicorn.py @@ -3,7 +3,7 @@ bind = ":8080" # Don't start too many workers: -workers = min(multiprocessing.cpu_count() * 2 + 1, 16) +workers = min(multiprocessing.cpu_count(), 4) # Give workers an expiry: max_requests = 2048 max_requests_jitter = 256 diff --git a/kustomize/README.md b/kustomize/README.md new file mode 100644 index 0000000..7d57a95 --- /dev/null +++ b/kustomize/README.md @@ -0,0 +1,26 @@ +# Penguins Observations System Kubernetes Kustomize overlay configuration + +Declarative management of Penguins Observations System objects using Kustomize. + +# How to use + +Within an overlay directory, create a `.env` file to contain required secret +values in the format KEY=value (i.e. `overlays/uat/.env`). + +Review the built resource output using `kustomize`: + +```bash +kustomize build kustomize/overlays/uat/ | less +``` + +Run `kubectl` with the `-k` flag to generate resources for a given overlay: + +```bash +kubectl apply -k kustomize/overlays/uat --namespace penguins --dry-run=client +``` + +# References: + +* https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/ +* https://github.com/kubernetes-sigs/kustomize +* https://github.com/kubernetes-sigs/kustomize/tree/master/examples diff --git a/kustomize/base/cronjob_import.yaml b/kustomize/base/cronjob_import.yaml new file mode 100644 index 0000000..ca4e906 --- /dev/null +++ b/kustomize/base/cronjob_import.yaml @@ -0,0 +1,39 @@ +apiVersion: batch/v1 +kind: CronJob +metadata: + name: penguins-import-cronjob + labels: + app: penguins-import-cronjob +spec: + schedule: "" + concurrencyPolicy: Forbid + jobTemplate: + spec: + parallelism: 1 + activeDeadlineSeconds: 600 + template: + spec: + restartPolicy: Never + containers: + - name: penguins-import-cronjob + image: ghcr.io/dbca-wa/penguins + command: ["python"] + args: ["--version"] + env: + - name: TZ + value: "Australia/Perth" + securityContext: + #runAsNonRoot: true + privileged: false + allowPrivilegeEscalation: false + capabilities: + drop: + - ALL + readOnlyRootFilesystem: true + volumeMounts: + - mountPath: /tmp + name: tmpfs-ram + volumes: + - name: tmpfs-ram + emptyDir: + medium: "Memory" diff --git a/kustomize/base/deployment.yaml b/kustomize/base/deployment.yaml new file mode 100644 index 0000000..4f1a768 --- /dev/null +++ b/kustomize/base/deployment.yaml @@ -0,0 +1,66 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: penguins-deployment + labels: + app: penguins-deployment +spec: + selector: + matchLabels: + app: penguins-deployment + strategy: + type: RollingUpdate + template: + metadata: + labels: + app: penguins-deployment + spec: + containers: + - name: penguins + image: ghcr.io/dbca-wa/penguins + imagePullPolicy: Always + env: + - name: ALLOWED_DOMAINS + value: ".dbca.wa.gov.au" + - name: TZ + value: "Australia/Perth" + resources: + requests: + memory: "128Mi" + cpu: "10m" + limits: + memory: "4096Mi" + cpu: "1000m" + startupProbe: + tcpSocket: + port: 8080 + initialDelaySeconds: 0 + periodSeconds: 3 + timeoutSeconds: 1 + successThreshold: 1 + failureThreshold: 3 + livenessProbe: + tcpSocket: + port: 8080 + initialDelaySeconds: 0 + periodSeconds: 10 + timeoutSeconds: 1 + successThreshold: 1 + failureThreshold: 3 + securityContext: + runAsNonRoot: false + privileged: false + allowPrivilegeEscalation: false + capabilities: + drop: + - ALL + readOnlyRootFilesystem: true + volumeMounts: + - mountPath: /tmp + name: tmpfs-ram + volumes: + - name: tmpfs-ram + emptyDir: + medium: "Memory" + restartPolicy: Always + terminationGracePeriodSeconds: 180 diff --git a/kustomize/base/deployment_hpa.yaml b/kustomize/base/deployment_hpa.yaml new file mode 100644 index 0000000..a6c664f --- /dev/null +++ b/kustomize/base/deployment_hpa.yaml @@ -0,0 +1,17 @@ +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: penguins-deployment-hpa +spec: + minReplicas: 1 + maxReplicas: 3 + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + metrics: + - resource: + name: cpu + target: + type: Utilization + averageUtilization: 250 + type: Resource diff --git a/kustomize/base/kustomization.yaml b/kustomize/base/kustomization.yaml new file mode 100644 index 0000000..628c954 --- /dev/null +++ b/kustomize/base/kustomization.yaml @@ -0,0 +1,7 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization +resources: + - deployment.yaml + - deployment_hpa.yaml + - service.yaml + - cronjob_import.yaml diff --git a/kustomize/base/service.yaml b/kustomize/base/service.yaml new file mode 100644 index 0000000..dce3b5e --- /dev/null +++ b/kustomize/base/service.yaml @@ -0,0 +1,11 @@ +apiVersion: v1 +kind: Service +metadata: + name: penguins-clusterip +spec: + type: ClusterIP + ports: + - name: wsgi + port: 8080 + protocol: TCP + targetPort: 8080 diff --git a/kustomize/overlays/prod/cronjob_import_patch.yaml b/kustomize/overlays/prod/cronjob_import_patch.yaml new file mode 100644 index 0000000..1345f79 --- /dev/null +++ b/kustomize/overlays/prod/cronjob_import_patch.yaml @@ -0,0 +1,35 @@ +apiVersion: batch/v1 +kind: CronJob +metadata: + name: penguins-import-cronjob +spec: + # x minutes past the hour, every hour. + schedule: "5 * * * *" + jobTemplate: + spec: + template: + spec: + containers: + - name: penguins-import-cronjob + args: ["manage.py", "video_import"] + env: + - name: DATABASE_URL + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: DATABASE_URL + - name: AZURE_ACCOUNT_NAME + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: AZURE_ACCOUNT_NAME + - name: AZURE_ACCOUNT_KEY + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: AZURE_ACCOUNT_KEY + - name: AZURE_CONTAINER + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: AZURE_CONTAINER diff --git a/kustomize/overlays/prod/deployment_hpa_patch.yaml b/kustomize/overlays/prod/deployment_hpa_patch.yaml new file mode 100644 index 0000000..5de48f4 --- /dev/null +++ b/kustomize/overlays/prod/deployment_hpa_patch.yaml @@ -0,0 +1,7 @@ +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: penguins-deployment-hpa +spec: + scaleTargetRef: + name: penguins-deployment-prod diff --git a/kustomize/overlays/prod/deployment_patch.yaml b/kustomize/overlays/prod/deployment_patch.yaml new file mode 100644 index 0000000..5cfffb7 --- /dev/null +++ b/kustomize/overlays/prod/deployment_patch.yaml @@ -0,0 +1,37 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: penguins-deployment +spec: + template: + spec: + containers: + - name: penguins + env: + - name: SITE_URL + value: "penguins.dbca.wa.gov.au" + - name: DATABASE_URL + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: DATABASE_URL + - name: SECRET_KEY + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: SECRET_KEY + - name: AZURE_ACCOUNT_NAME + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: AZURE_ACCOUNT_NAME + - name: AZURE_ACCOUNT_KEY + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: AZURE_ACCOUNT_KEY + - name: AZURE_CONTAINER + valueFrom: + secretKeyRef: + name: penguins-env-prod + key: AZURE_CONTAINER diff --git a/kustomize/overlays/prod/ingress.yaml b/kustomize/overlays/prod/ingress.yaml new file mode 100644 index 0000000..22992a9 --- /dev/null +++ b/kustomize/overlays/prod/ingress.yaml @@ -0,0 +1,17 @@ +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: penguins-ingress +spec: + ingressClassName: nginx + rules: + - host: penguins.dbca.wa.gov.au + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: penguins-clusterip-prod + port: + number: 8080 diff --git a/kustomize/overlays/prod/kustomization.yaml b/kustomize/overlays/prod/kustomization.yaml new file mode 100644 index 0000000..43ab0cc --- /dev/null +++ b/kustomize/overlays/prod/kustomization.yaml @@ -0,0 +1,24 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization +nameSuffix: -prod +resources: + - ../../base + - ingress.yaml + - pdb.yaml +secretGenerator: + - name: penguins-env + type: Opaque + envs: + - .env +labels: + - includeSelectors: true + pairs: + variant: prod +patches: + - path: deployment_patch.yaml + - path: deployment_hpa_patch.yaml + - path: service_patch.yaml + - path: cronjob_import_patch.yaml +images: + - name: ghcr.io/dbca-wa/penguins + newTag: 1.2.0 diff --git a/kustomize/overlays/prod/pdb.yaml b/kustomize/overlays/prod/pdb.yaml new file mode 100644 index 0000000..0398e9f --- /dev/null +++ b/kustomize/overlays/prod/pdb.yaml @@ -0,0 +1,10 @@ +apiVersion: policy/v1 +kind: PodDisruptionBudget +metadata: + name: penguins-deployment-pdb +spec: + minAvailable: 1 + selector: + matchLabels: + app: penguins-deployment + variant: prod diff --git a/kustomize/overlays/prod/service_patch.yaml b/kustomize/overlays/prod/service_patch.yaml new file mode 100644 index 0000000..42caab7 --- /dev/null +++ b/kustomize/overlays/prod/service_patch.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: Service +metadata: + name: penguins-clusterip +spec: + type: ClusterIP + selector: + app: penguins-deployment + variant: prod diff --git a/kustomize/overlays/uat/cronjob_import_patch.yaml b/kustomize/overlays/uat/cronjob_import_patch.yaml new file mode 100644 index 0000000..bd707e3 --- /dev/null +++ b/kustomize/overlays/uat/cronjob_import_patch.yaml @@ -0,0 +1,35 @@ +apiVersion: batch/v1 +kind: CronJob +metadata: + name: penguins-import-cronjob +spec: + # x minutes past the hour, every hour. + schedule: "35 * * * *" + jobTemplate: + spec: + template: + spec: + containers: + - name: penguins-import-cronjob + args: ["manage.py", "video_import"] + env: + - name: DATABASE_URL + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: DATABASE_URL + - name: AZURE_ACCOUNT_NAME + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: AZURE_ACCOUNT_NAME + - name: AZURE_ACCOUNT_KEY + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: AZURE_ACCOUNT_KEY + - name: AZURE_CONTAINER + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: AZURE_CONTAINER diff --git a/kustomize/overlays/uat/deployment_hpa_patch.yaml b/kustomize/overlays/uat/deployment_hpa_patch.yaml new file mode 100644 index 0000000..164a7f6 --- /dev/null +++ b/kustomize/overlays/uat/deployment_hpa_patch.yaml @@ -0,0 +1,7 @@ +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: penguins-deployment-hpa +spec: + scaleTargetRef: + name: penguins-deployment-uat diff --git a/kustomize/overlays/uat/deployment_patch.yaml b/kustomize/overlays/uat/deployment_patch.yaml new file mode 100644 index 0000000..79efa55 --- /dev/null +++ b/kustomize/overlays/uat/deployment_patch.yaml @@ -0,0 +1,37 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: penguins-deployment +spec: + template: + spec: + containers: + - name: penguins + env: + - name: SITE_URL + value: "penguins-uat.dbca.wa.gov.au" + - name: DATABASE_URL + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: DATABASE_URL + - name: SECRET_KEY + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: SECRET_KEY + - name: AZURE_ACCOUNT_NAME + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: AZURE_ACCOUNT_NAME + - name: AZURE_ACCOUNT_KEY + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: AZURE_ACCOUNT_KEY + - name: AZURE_CONTAINER + valueFrom: + secretKeyRef: + name: penguins-env-uat + key: AZURE_CONTAINER diff --git a/kustomize/overlays/uat/ingress.yaml b/kustomize/overlays/uat/ingress.yaml new file mode 100644 index 0000000..c96c931 --- /dev/null +++ b/kustomize/overlays/uat/ingress.yaml @@ -0,0 +1,17 @@ +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: penguins-ingress +spec: + ingressClassName: nginx + rules: + - host: penguins-uat.dbca.wa.gov.au + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: penguins-clusterip-uat + port: + number: 8080 diff --git a/kustomize/overlays/uat/kustomization.yaml b/kustomize/overlays/uat/kustomization.yaml new file mode 100644 index 0000000..1cd6969 --- /dev/null +++ b/kustomize/overlays/uat/kustomization.yaml @@ -0,0 +1,21 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization +nameSuffix: -uat +resources: + - ../../base + - ingress.yaml + - pdb.yaml +secretGenerator: + - name: penguins-env + type: Opaque + envs: + - .env +labels: + - includeSelectors: true + pairs: + variant: uat +patches: + - path: deployment_patch.yaml + - path: deployment_hpa_patch.yaml + - path: service_patch.yaml + - path: cronjob_import_patch.yaml diff --git a/kustomize/overlays/uat/pdb.yaml b/kustomize/overlays/uat/pdb.yaml new file mode 100644 index 0000000..79d27fb --- /dev/null +++ b/kustomize/overlays/uat/pdb.yaml @@ -0,0 +1,10 @@ +apiVersion: policy/v1 +kind: PodDisruptionBudget +metadata: + name: penguins-deployment-pdb +spec: + minAvailable: 1 + selector: + matchLabels: + app: penguins-deployment + variant: uat diff --git a/kustomize/overlays/uat/service_patch.yaml b/kustomize/overlays/uat/service_patch.yaml new file mode 100644 index 0000000..1c42d8d --- /dev/null +++ b/kustomize/overlays/uat/service_patch.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: Service +metadata: + name: penguins-clusterip +spec: + type: ClusterIP + selector: + app: penguins-deployment + variant: uat