From c0a43f94e6bcec464ab1677e6d1721da4ebbef3b Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 10:17:01 +0000 Subject: [PATCH 01/14] chore: prepare for open-sourcing and deployment --- .gitmodules | 4 ---- yggdrasil-web | 1 - 2 files changed, 5 deletions(-) delete mode 160000 yggdrasil-web diff --git a/.gitmodules b/.gitmodules index cf92bd8..e69de29 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,4 +0,0 @@ -[submodule "yggdrasil-web"] - path = yggdrasil-web - url = git@github.com:SoCSTech/yggdrasil-revamp.git - branch = asgard2 diff --git a/yggdrasil-web b/yggdrasil-web deleted file mode 160000 index a2d97e3..0000000 --- a/yggdrasil-web +++ /dev/null @@ -1 +0,0 @@ -Subproject commit a2d97e35e2dfe0eea08fac4dd172a3ed13132c30 From b959851b8354955466de8b5ae4171005e97b80e7 Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 10:17:18 +0000 Subject: [PATCH 02/14] chore: prepare for opensourcing and deployment --- .gitmodules | 0 LICENSE | 201 +++++++++++++++++++++++++++++++++++++ docker-compose.traefik.yml | 119 ---------------------- traefik/.env.example | 2 - traefik/.gitignore | 1 - traefik/README.md | 3 - traefik/docker-compose.yml | 36 ------- traefik/sampleapp.yml | 29 ------ traefik/traefik.yml | 42 -------- 9 files changed, 201 insertions(+), 232 deletions(-) delete mode 100644 .gitmodules create mode 100644 LICENSE delete mode 100644 docker-compose.traefik.yml delete mode 100644 traefik/.env.example delete mode 100644 traefik/.gitignore delete mode 100644 traefik/README.md delete mode 100644 traefik/docker-compose.yml delete mode 100644 traefik/sampleapp.yml delete mode 100644 traefik/traefik.yml diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index e69de29..0000000 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..63e2e96 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 [2024] [Computer Science Technical Services, University of Lincoln, UK] + + 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 diff --git a/docker-compose.traefik.yml b/docker-compose.traefik.yml deleted file mode 100644 index af13736..0000000 --- a/docker-compose.traefik.yml +++ /dev/null @@ -1,119 +0,0 @@ -version: "3" - -services: - asgard-jobs: - build: ./jobs - container_name: a2-asgard-jobs - restart: always - networks: - - asgard_internal - env_file: - - .env - depends_on: - - asgard-api - - asgard-api: - build: ./api - container_name: a2-asgard-api - restart: always - networks: - - asgard_internal - - proxy - env_file: - - .env - depends_on: - - db - - mqtt - labels: - - "traefik.enable=true" - - "traefik.http.routers.asgard-api.rule=Host(`asgard.localhost`) && PathPrefix(`/v2`)" - - "traefik.http.routers.asgard-api.entrypoints=https" - - "traefik.http.routers.asgard-api.tls=true" - - "traefik.http.services.asgard-api.loadbalancer.server.port=3000" - - - yggdrasil-web: - build: ./yggdrasil-web - container_name: a2-yggdrasil-web - restart: always - networks: - - asgard_internal - - proxy - env_file: - - .env - depends_on: - - asgard-api - labels: - - "traefik.enable=true" - - "traefik.http.routers.yggdrasil-web.rule=Host(`yggdrasil.localhost`)" - - "traefik.http.routers.yggdrasil-web.entrypoints=https" - - "traefik.http.routers.yggdrasil-web.tls=true" - - "traefik.http.services.yggdrasil-web.loadbalancer.server.scheme=http" - - "traefik.http.services.yggdrasil-web.loadbalancer.server.port=80" - - asgard-admin: - build: ./admin - container_name: a2-asgard-admin - restart: always - networks: - - asgard_internal - - proxy - depends_on: - - asgard-api - environment: - PUBLIC_API_URL: ${API_URL} - PUBLIC_Y2_URL: ${Y2_URL} - labels: - - "traefik.enable=true" - - "traefik.http.routers.asgard-admin.rule=Host(`asgard.localhost`)" - - "traefik.http.routers.asgard-admin.entrypoints=https" - - "traefik.http.routers.asgard-admin.tls=true" - - "traefik.http.services.asgard-admin.loadbalancer.server.scheme=http" - - "traefik.http.services.asgard-admin.loadbalancer.server.port=80" - - db: - container_name: a2-asgard-db - image: mysql:8.0 - command: --default-authentication-plugin=mysql_native_password --character-set-server=utf8 --collation-server=utf8_general_ci - restart: unless-stopped - volumes: - - mysql-data:/var/lib/mysql - networks: - - asgard_internal - environment: - MYSQL_ROOT_PASSWORD: ${DB_PASSWORD} - MYSQL_DATABASE: ${DB_DATABASE} - MYSQL_USER: ${DB_USERNAME} - MYSQL_PASSWORD: ${DB_PASSWORD} - - mqtt: - image: eclipse-mosquitto:2 - container_name: a2-asgard-mqtt - volumes: - - ./mosquitto.conf:/mosquitto/config/mosquitto.conf - - mqtt-data:/mosquitto/data - - mqtt-log:/mosquitto/log - stdin_open: true - tty: true - networks: - - asgard_internal - - proxy - ports: - - 1883:1883 - - 9001:9001 - labels: - - "traefik.enable=true" - - "traefik.http.routers.mqtt.rule=Host(`mqtt.localhost`)" - - "traefik.http.routers.mqtt.entrypoints=https" - - "traefik.http.routers.mqtt.tls.certresolver=letsencrypt" - - "traefik.http.services.mqtt.loadbalancer.server.port=9001" - -volumes: - mysql-data: - mqtt-data: - mqtt-log: - -networks: - asgard_internal: - proxy: - external: true diff --git a/traefik/.env.example b/traefik/.env.example deleted file mode 100644 index a435253..0000000 --- a/traefik/.env.example +++ /dev/null @@ -1,2 +0,0 @@ -# Username, socstech. Password, computing -TRAEFIK_DASHBOARD_CREDENTIALS=socstech:$$2y$$05$$CydTO0pHACHu48CrqMAxFubbFSm.iS6.1ZIN3CLMgJeME3F9WW7Pu \ No newline at end of file diff --git a/traefik/.gitignore b/traefik/.gitignore deleted file mode 100644 index a23708f..0000000 --- a/traefik/.gitignore +++ /dev/null @@ -1 +0,0 @@ -acme.json \ No newline at end of file diff --git a/traefik/README.md b/traefik/README.md deleted file mode 100644 index 031ad8f..0000000 --- a/traefik/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Traefik - -This is a sample traefik config for running the asgard stack, you will only have to deploy this if the web server isn't already configured for traefik. \ No newline at end of file diff --git a/traefik/docker-compose.yml b/traefik/docker-compose.yml deleted file mode 100644 index 8e8ceb1..0000000 --- a/traefik/docker-compose.yml +++ /dev/null @@ -1,36 +0,0 @@ -version: "3.8" - -services: - traefik: - image: traefik:v3.0 - container_name: traefik - restart: unless-stopped - networks: - - proxy - ports: - - 80:80 - - 443:443 - environment: - TRAEFIK_DASHBOARD_CREDENTIALS: ${TRAEFIK_DASHBOARD_CREDENTIALS} - env_file: .env - volumes: - - /var/run/docker.sock:/var/run/docker.sock:ro - - ./traefik.yml:/traefik.yml:ro - - ./acme.json:/acme.json - - ./config.yml:/config.yml:ro - labels: - - "traefik.enable=true" - - "traefik.http.middlewares.traefik-auth.basicauth.users=${TRAEFIK_DASHBOARD_CREDENTIALS}" - - "traefik.http.middlewares.sslheader.headers.customrequestheaders.X-Forwarded-Proto=https" - - "traefik.http.routers.traefik.entrypoints=https" - - "traefik.http.routers.traefik.rule=Host(`traefik.localhost`)" - - "traefik.http.routers.traefik.middlewares=traefik-auth" - - "traefik.http.routers.traefik.tls=true" - # - "traefik.http.routers.traefik.tls.certresolver=cloudflare" - - "traefik.http.routers.traefik.tls.domains[0].main=traefik.localhost" - - "traefik.http.routers.traefik.tls.domains[0].sans=*.localhost" - - "traefik.http.routers.traefik.service=api@internal" - -networks: - proxy: - name: proxy \ No newline at end of file diff --git a/traefik/sampleapp.yml b/traefik/sampleapp.yml deleted file mode 100644 index 6d1353d..0000000 --- a/traefik/sampleapp.yml +++ /dev/null @@ -1,29 +0,0 @@ -version: '3.8' -services: - frontend: - container_name: frontend - image: nginxdemos/nginx-hello - labels: - - "traefik.enable=true" - - "traefik.http.routers.frontend-app.rule=Host(`test.localhost`)" - - "traefik.http.routers.frontend-app.entrypoints=https" - - "traefik.http.routers.frontend-app.tls=true" - - "traefik.http.services.frontend-app.loadbalancer.server.port=8080" - networks: - - proxy - - api: - container_name: api - image: nginxdemos/nginx-hello - labels: - - "traefik.enable=true" - - "traefik.http.routers.backend-app.rule=Host(`test.localhost`) && PathPrefix(`/api`)" - - "traefik.http.routers.backend-app.entrypoints=https" - - "traefik.http.routers.backend-app.tls=true" - - "traefik.http.services.backend-app.loadbalancer.server.port=8080" - networks: - - proxy - -networks: - proxy: - external: true \ No newline at end of file diff --git a/traefik/traefik.yml b/traefik/traefik.yml deleted file mode 100644 index e48d664..0000000 --- a/traefik/traefik.yml +++ /dev/null @@ -1,42 +0,0 @@ -api: - dashboard: true - debug: true - -entryPoints: - http: - address: ":80" - http: - redirections: - entryPoint: - to: https - scheme: https - - https: - address: ":443" - -serversTransport: - insecureSkipVerify: true - -providers: - docker: - endpoint: "unix:///var/run/docker.sock" - exposedByDefault: false - network: proxy - -# certificatesResolvers: -# cloudflare: -# acme: -# email: youremail@email.com -# storage: acme.json -# # caServer: https://acme-v02.api.letsencrypt.org/directory # prod (default) -# caServer: https://acme-staging-v02.api.letsencrypt.org/directory # staging -# dnsChallenge: -# # provider: cloudflare -# #disablePropagationCheck: true # uncomment this if you have issues pulling certificates through cloudflare, By setting this flag to true disables the need to wait for the propagation of the TXT record to all authoritative name servers. -# #delayBeforeCheck: 60s # uncomment along with disablePropagationCheck if needed to ensure the TXT record is ready before verification is attempted -# # resolvers: -# # - "8.8.8.8:53" -# # - "1.0.0.1:53" - -# resolvers: -# - "[::1]:53" From 935bf8de588fea5b6686a7dfa03528ff20cabebb Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 10:37:01 +0000 Subject: [PATCH 03/14] chore: clean up the readme --- README.md | 35 ++++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0690d79..62a4e51 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,29 @@ -# asgard2 +# asgard -asgard2 is *currently in development* and will be the next generation of the [original asgard system](https://github.com/SoCSTech/asgard-system-stack) which is the [School of Computer Science's](https://lincoln.ac.uk/socs) timetabling and booking system. It manages the events that are running in each one of our computing labs (and other rooms too) to provide data to our [signage screens platform yggdrasil (y2)](https://github.com/SoCSTech/yggdrasil-revamp/tree/asgard2). +Asgard is the system designed for improving the experience of the Computing Labs at the [University of Lincoln](https://www.lincoln.ac.uk/studywithus/subjects/computerscienceandgamescomputing/). It is designed around managing aspects of the lab such as signage, timetabling and lab occupancy. Asgard provides the back of house management system for student facing projects such as [yggdrasil](https://github.com/SoCSTech/yggdrasil) which comes under the asgard family of projects. +This iteration (asgard2) has been built on the back of the work previously done by former technicians to improve the functionality and capability of the system. -## Deployment +## Getting started -This project is deployed to the SoCS internal web server using Docker. There is a [docker-compose.yml](docker-compose.yml) file which holds the configuration file to bring up the system. +No matter if you are developing or deploying you will need to use [Docker](https://docker.com) as the whole system is designed around it. -The server is expected to be running Ubuntu Server and have Docker and Docker Compose installed. With future versions (after [#18](https://github.com/SoCSTech/asgard2/issues/18) is closed) we may require the server to be configured with Traefik which will be documented here. +If you are developing, you should use a Code Editor such as [Visual Studio Code](https://code.visualstudio.com) which can support [Devcontainers](https://containers.dev/). You will then be able to open one of the 'sub-projects' and work inside of it and make changes, on your own branch or fork. -### Migrations on the Server +Or if you are wanting to deploy for production, you should use the [docker-compose.yml](docker-compose.yml) file, which holds the configuration file to bring up the system with all the different components. -You need to exec into the container - and run the command `npm run db:push` to ensure the data base is in sync with the schema. +Once you have brought up your environment, you will need to run some migrations against the database. To do this you will need to connect into the running `api` container. You can do that by running: +```bash +docker exec -it asgard-api bash +``` +You should then have a shell inside of the container, where you can run the following migration command: +```bash +npm run db:push +``` +This will ensure your version of the database matches what the stack is expecting! -## Documentation +## Top Guides | Document | Purpose | | -------- | ------- | @@ -40,14 +49,14 @@ You need to exec into the container - and run the command `npm run db:push` to e ## Credits -- Asgard2, [Josh Cooper](https://github.com/cooperj). -- Yggdrasil, [Benjamin Williams](https://github.com/blewert). -- A bit of design, and Dockerisation, [Ollie Grooby](https://github.com/Grooben). -- Original Asgard Microservice author [Thomas Reed](https://github.com/treed1104). +- [Josh Cooper](https://github.com/cooperj) +- [Benjamin Williams](https://github.com/blewert) +- [Ollie Grooby](https://github.com/Grooben) +- [Thomas Reed](https://github.com/treed1104) ## -SoCSTech @ University of Lincoln // INB1201 - 2024 \ No newline at end of file +Computer Science Technical Service @ University of Lincoln, UK // INB1201 - 2024 \ No newline at end of file From 546bd8808f39700f755f8e8690a27cc54d39c264 Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 11:01:13 +0000 Subject: [PATCH 04/14] ci: initial api docker workflow --- .github/workflows/build-docker-api.yml | 103 +++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 .github/workflows/build-docker-api.yml diff --git a/.github/workflows/build-docker-api.yml b/.github/workflows/build-docker-api.yml new file mode 100644 index 0000000..2853efb --- /dev/null +++ b/.github/workflows/build-docker-api.yml @@ -0,0 +1,103 @@ +name: API - Build and Publish Docker Image + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Cache Docker layers + uses: actions/cache@v3 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/socstech/asgard-api + + - name: Build and Push Production Docker Image + id: build-and-push + uses: docker/build-push-action@v5 + with: + context: . + file: ./api/Dockerfile + push: ${{ github.event_name != 'pull_request' }} + tags: | + ${{ steps.meta.outputs.tags }} + ghcr.io/socstech/asgard-api:latest + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + + pr-build: + runs-on: ubuntu-latest + if: github.event_name == 'pull_request' + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Cache Docker layers + uses: actions/cache@v3 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/socstech/asgard-api + + - name: Build and Push Pull Request Docker Image + id: build-and-push + uses: docker/build-push-action@v5 + with: + context: . + file: ./api/Dockerfile + push: true + tags: | + ghcr.io/socstech/asgard-api:${{ github.sha }} + ghcr.io/socstech/asgard-api:pr-${{ github.event.number }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + build-args: | + EXPIRE_AFTER=30d \ No newline at end of file From c343def30ac99748d5237fde28c9dc5d15e3bbd2 Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 11:03:13 +0000 Subject: [PATCH 05/14] chore: add modules file back --- .gitmodules | 4 ---- yggdrasil-web | 1 - 2 files changed, 5 deletions(-) delete mode 160000 yggdrasil-web diff --git a/.gitmodules b/.gitmodules index cf92bd8..e69de29 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,4 +0,0 @@ -[submodule "yggdrasil-web"] - path = yggdrasil-web - url = git@github.com:SoCSTech/yggdrasil-revamp.git - branch = asgard2 diff --git a/yggdrasil-web b/yggdrasil-web deleted file mode 160000 index b3fd40e..0000000 --- a/yggdrasil-web +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b3fd40e206b42f881f5adff693cdcdf7cd6f7f49 From 93c3a4965200cc8bc7a5e3eefa6d852a45a5c84d Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 10:17:18 +0000 Subject: [PATCH 06/14] chore: prepare for opensourcing and deployment --- .gitmodules | 0 LICENSE | 201 +++++++++++++++++++++++++++++++++++++ docker-compose.traefik.yml | 119 ---------------------- traefik/.env.example | 2 - traefik/.gitignore | 1 - traefik/README.md | 3 - traefik/docker-compose.yml | 36 ------- traefik/sampleapp.yml | 29 ------ traefik/traefik.yml | 42 -------- 9 files changed, 201 insertions(+), 232 deletions(-) delete mode 100644 .gitmodules create mode 100644 LICENSE delete mode 100644 docker-compose.traefik.yml delete mode 100644 traefik/.env.example delete mode 100644 traefik/.gitignore delete mode 100644 traefik/README.md delete mode 100644 traefik/docker-compose.yml delete mode 100644 traefik/sampleapp.yml delete mode 100644 traefik/traefik.yml diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index e69de29..0000000 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..63e2e96 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 [2024] [Computer Science Technical Services, University of Lincoln, UK] + + 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 diff --git a/docker-compose.traefik.yml b/docker-compose.traefik.yml deleted file mode 100644 index af13736..0000000 --- a/docker-compose.traefik.yml +++ /dev/null @@ -1,119 +0,0 @@ -version: "3" - -services: - asgard-jobs: - build: ./jobs - container_name: a2-asgard-jobs - restart: always - networks: - - asgard_internal - env_file: - - .env - depends_on: - - asgard-api - - asgard-api: - build: ./api - container_name: a2-asgard-api - restart: always - networks: - - asgard_internal - - proxy - env_file: - - .env - depends_on: - - db - - mqtt - labels: - - "traefik.enable=true" - - "traefik.http.routers.asgard-api.rule=Host(`asgard.localhost`) && PathPrefix(`/v2`)" - - "traefik.http.routers.asgard-api.entrypoints=https" - - "traefik.http.routers.asgard-api.tls=true" - - "traefik.http.services.asgard-api.loadbalancer.server.port=3000" - - - yggdrasil-web: - build: ./yggdrasil-web - container_name: a2-yggdrasil-web - restart: always - networks: - - asgard_internal - - proxy - env_file: - - .env - depends_on: - - asgard-api - labels: - - "traefik.enable=true" - - "traefik.http.routers.yggdrasil-web.rule=Host(`yggdrasil.localhost`)" - - "traefik.http.routers.yggdrasil-web.entrypoints=https" - - "traefik.http.routers.yggdrasil-web.tls=true" - - "traefik.http.services.yggdrasil-web.loadbalancer.server.scheme=http" - - "traefik.http.services.yggdrasil-web.loadbalancer.server.port=80" - - asgard-admin: - build: ./admin - container_name: a2-asgard-admin - restart: always - networks: - - asgard_internal - - proxy - depends_on: - - asgard-api - environment: - PUBLIC_API_URL: ${API_URL} - PUBLIC_Y2_URL: ${Y2_URL} - labels: - - "traefik.enable=true" - - "traefik.http.routers.asgard-admin.rule=Host(`asgard.localhost`)" - - "traefik.http.routers.asgard-admin.entrypoints=https" - - "traefik.http.routers.asgard-admin.tls=true" - - "traefik.http.services.asgard-admin.loadbalancer.server.scheme=http" - - "traefik.http.services.asgard-admin.loadbalancer.server.port=80" - - db: - container_name: a2-asgard-db - image: mysql:8.0 - command: --default-authentication-plugin=mysql_native_password --character-set-server=utf8 --collation-server=utf8_general_ci - restart: unless-stopped - volumes: - - mysql-data:/var/lib/mysql - networks: - - asgard_internal - environment: - MYSQL_ROOT_PASSWORD: ${DB_PASSWORD} - MYSQL_DATABASE: ${DB_DATABASE} - MYSQL_USER: ${DB_USERNAME} - MYSQL_PASSWORD: ${DB_PASSWORD} - - mqtt: - image: eclipse-mosquitto:2 - container_name: a2-asgard-mqtt - volumes: - - ./mosquitto.conf:/mosquitto/config/mosquitto.conf - - mqtt-data:/mosquitto/data - - mqtt-log:/mosquitto/log - stdin_open: true - tty: true - networks: - - asgard_internal - - proxy - ports: - - 1883:1883 - - 9001:9001 - labels: - - "traefik.enable=true" - - "traefik.http.routers.mqtt.rule=Host(`mqtt.localhost`)" - - "traefik.http.routers.mqtt.entrypoints=https" - - "traefik.http.routers.mqtt.tls.certresolver=letsencrypt" - - "traefik.http.services.mqtt.loadbalancer.server.port=9001" - -volumes: - mysql-data: - mqtt-data: - mqtt-log: - -networks: - asgard_internal: - proxy: - external: true diff --git a/traefik/.env.example b/traefik/.env.example deleted file mode 100644 index a435253..0000000 --- a/traefik/.env.example +++ /dev/null @@ -1,2 +0,0 @@ -# Username, socstech. Password, computing -TRAEFIK_DASHBOARD_CREDENTIALS=socstech:$$2y$$05$$CydTO0pHACHu48CrqMAxFubbFSm.iS6.1ZIN3CLMgJeME3F9WW7Pu \ No newline at end of file diff --git a/traefik/.gitignore b/traefik/.gitignore deleted file mode 100644 index a23708f..0000000 --- a/traefik/.gitignore +++ /dev/null @@ -1 +0,0 @@ -acme.json \ No newline at end of file diff --git a/traefik/README.md b/traefik/README.md deleted file mode 100644 index 031ad8f..0000000 --- a/traefik/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Traefik - -This is a sample traefik config for running the asgard stack, you will only have to deploy this if the web server isn't already configured for traefik. \ No newline at end of file diff --git a/traefik/docker-compose.yml b/traefik/docker-compose.yml deleted file mode 100644 index 8e8ceb1..0000000 --- a/traefik/docker-compose.yml +++ /dev/null @@ -1,36 +0,0 @@ -version: "3.8" - -services: - traefik: - image: traefik:v3.0 - container_name: traefik - restart: unless-stopped - networks: - - proxy - ports: - - 80:80 - - 443:443 - environment: - TRAEFIK_DASHBOARD_CREDENTIALS: ${TRAEFIK_DASHBOARD_CREDENTIALS} - env_file: .env - volumes: - - /var/run/docker.sock:/var/run/docker.sock:ro - - ./traefik.yml:/traefik.yml:ro - - ./acme.json:/acme.json - - ./config.yml:/config.yml:ro - labels: - - "traefik.enable=true" - - "traefik.http.middlewares.traefik-auth.basicauth.users=${TRAEFIK_DASHBOARD_CREDENTIALS}" - - "traefik.http.middlewares.sslheader.headers.customrequestheaders.X-Forwarded-Proto=https" - - "traefik.http.routers.traefik.entrypoints=https" - - "traefik.http.routers.traefik.rule=Host(`traefik.localhost`)" - - "traefik.http.routers.traefik.middlewares=traefik-auth" - - "traefik.http.routers.traefik.tls=true" - # - "traefik.http.routers.traefik.tls.certresolver=cloudflare" - - "traefik.http.routers.traefik.tls.domains[0].main=traefik.localhost" - - "traefik.http.routers.traefik.tls.domains[0].sans=*.localhost" - - "traefik.http.routers.traefik.service=api@internal" - -networks: - proxy: - name: proxy \ No newline at end of file diff --git a/traefik/sampleapp.yml b/traefik/sampleapp.yml deleted file mode 100644 index 6d1353d..0000000 --- a/traefik/sampleapp.yml +++ /dev/null @@ -1,29 +0,0 @@ -version: '3.8' -services: - frontend: - container_name: frontend - image: nginxdemos/nginx-hello - labels: - - "traefik.enable=true" - - "traefik.http.routers.frontend-app.rule=Host(`test.localhost`)" - - "traefik.http.routers.frontend-app.entrypoints=https" - - "traefik.http.routers.frontend-app.tls=true" - - "traefik.http.services.frontend-app.loadbalancer.server.port=8080" - networks: - - proxy - - api: - container_name: api - image: nginxdemos/nginx-hello - labels: - - "traefik.enable=true" - - "traefik.http.routers.backend-app.rule=Host(`test.localhost`) && PathPrefix(`/api`)" - - "traefik.http.routers.backend-app.entrypoints=https" - - "traefik.http.routers.backend-app.tls=true" - - "traefik.http.services.backend-app.loadbalancer.server.port=8080" - networks: - - proxy - -networks: - proxy: - external: true \ No newline at end of file diff --git a/traefik/traefik.yml b/traefik/traefik.yml deleted file mode 100644 index e48d664..0000000 --- a/traefik/traefik.yml +++ /dev/null @@ -1,42 +0,0 @@ -api: - dashboard: true - debug: true - -entryPoints: - http: - address: ":80" - http: - redirections: - entryPoint: - to: https - scheme: https - - https: - address: ":443" - -serversTransport: - insecureSkipVerify: true - -providers: - docker: - endpoint: "unix:///var/run/docker.sock" - exposedByDefault: false - network: proxy - -# certificatesResolvers: -# cloudflare: -# acme: -# email: youremail@email.com -# storage: acme.json -# # caServer: https://acme-v02.api.letsencrypt.org/directory # prod (default) -# caServer: https://acme-staging-v02.api.letsencrypt.org/directory # staging -# dnsChallenge: -# # provider: cloudflare -# #disablePropagationCheck: true # uncomment this if you have issues pulling certificates through cloudflare, By setting this flag to true disables the need to wait for the propagation of the TXT record to all authoritative name servers. -# #delayBeforeCheck: 60s # uncomment along with disablePropagationCheck if needed to ensure the TXT record is ready before verification is attempted -# # resolvers: -# # - "8.8.8.8:53" -# # - "1.0.0.1:53" - -# resolvers: -# - "[::1]:53" From 54adddbbc524fdaa9eb5106cdea5dadd3b12b49b Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 10:37:01 +0000 Subject: [PATCH 07/14] chore: clean up the readme --- README.md | 35 ++++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0690d79..62a4e51 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,29 @@ -# asgard2 +# asgard -asgard2 is *currently in development* and will be the next generation of the [original asgard system](https://github.com/SoCSTech/asgard-system-stack) which is the [School of Computer Science's](https://lincoln.ac.uk/socs) timetabling and booking system. It manages the events that are running in each one of our computing labs (and other rooms too) to provide data to our [signage screens platform yggdrasil (y2)](https://github.com/SoCSTech/yggdrasil-revamp/tree/asgard2). +Asgard is the system designed for improving the experience of the Computing Labs at the [University of Lincoln](https://www.lincoln.ac.uk/studywithus/subjects/computerscienceandgamescomputing/). It is designed around managing aspects of the lab such as signage, timetabling and lab occupancy. Asgard provides the back of house management system for student facing projects such as [yggdrasil](https://github.com/SoCSTech/yggdrasil) which comes under the asgard family of projects. +This iteration (asgard2) has been built on the back of the work previously done by former technicians to improve the functionality and capability of the system. -## Deployment +## Getting started -This project is deployed to the SoCS internal web server using Docker. There is a [docker-compose.yml](docker-compose.yml) file which holds the configuration file to bring up the system. +No matter if you are developing or deploying you will need to use [Docker](https://docker.com) as the whole system is designed around it. -The server is expected to be running Ubuntu Server and have Docker and Docker Compose installed. With future versions (after [#18](https://github.com/SoCSTech/asgard2/issues/18) is closed) we may require the server to be configured with Traefik which will be documented here. +If you are developing, you should use a Code Editor such as [Visual Studio Code](https://code.visualstudio.com) which can support [Devcontainers](https://containers.dev/). You will then be able to open one of the 'sub-projects' and work inside of it and make changes, on your own branch or fork. -### Migrations on the Server +Or if you are wanting to deploy for production, you should use the [docker-compose.yml](docker-compose.yml) file, which holds the configuration file to bring up the system with all the different components. -You need to exec into the container - and run the command `npm run db:push` to ensure the data base is in sync with the schema. +Once you have brought up your environment, you will need to run some migrations against the database. To do this you will need to connect into the running `api` container. You can do that by running: +```bash +docker exec -it asgard-api bash +``` +You should then have a shell inside of the container, where you can run the following migration command: +```bash +npm run db:push +``` +This will ensure your version of the database matches what the stack is expecting! -## Documentation +## Top Guides | Document | Purpose | | -------- | ------- | @@ -40,14 +49,14 @@ You need to exec into the container - and run the command `npm run db:push` to e ## Credits -- Asgard2, [Josh Cooper](https://github.com/cooperj). -- Yggdrasil, [Benjamin Williams](https://github.com/blewert). -- A bit of design, and Dockerisation, [Ollie Grooby](https://github.com/Grooben). -- Original Asgard Microservice author [Thomas Reed](https://github.com/treed1104). +- [Josh Cooper](https://github.com/cooperj) +- [Benjamin Williams](https://github.com/blewert) +- [Ollie Grooby](https://github.com/Grooben) +- [Thomas Reed](https://github.com/treed1104) ## -SoCSTech @ University of Lincoln // INB1201 - 2024 \ No newline at end of file +Computer Science Technical Service @ University of Lincoln, UK // INB1201 - 2024 \ No newline at end of file From ec98503ba4c2472b043ae6eb2d54aaeec1780a7a Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 11:01:13 +0000 Subject: [PATCH 08/14] ci: initial api docker workflow --- .github/workflows/build-docker-api.yml | 103 +++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 .github/workflows/build-docker-api.yml diff --git a/.github/workflows/build-docker-api.yml b/.github/workflows/build-docker-api.yml new file mode 100644 index 0000000..2853efb --- /dev/null +++ b/.github/workflows/build-docker-api.yml @@ -0,0 +1,103 @@ +name: API - Build and Publish Docker Image + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Cache Docker layers + uses: actions/cache@v3 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/socstech/asgard-api + + - name: Build and Push Production Docker Image + id: build-and-push + uses: docker/build-push-action@v5 + with: + context: . + file: ./api/Dockerfile + push: ${{ github.event_name != 'pull_request' }} + tags: | + ${{ steps.meta.outputs.tags }} + ghcr.io/socstech/asgard-api:latest + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + + pr-build: + runs-on: ubuntu-latest + if: github.event_name == 'pull_request' + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Cache Docker layers + uses: actions/cache@v3 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/socstech/asgard-api + + - name: Build and Push Pull Request Docker Image + id: build-and-push + uses: docker/build-push-action@v5 + with: + context: . + file: ./api/Dockerfile + push: true + tags: | + ghcr.io/socstech/asgard-api:${{ github.sha }} + ghcr.io/socstech/asgard-api:pr-${{ github.event.number }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + build-args: | + EXPIRE_AFTER=30d \ No newline at end of file From 7b75c4431bf8c6a22bfb653583c0171ca0b64c78 Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 11:11:50 +0000 Subject: [PATCH 09/14] ci: merge into one job and fix context --- .github/workflows/build-docker-api.yml | 43 ++++---------------------- 1 file changed, 6 insertions(+), 37 deletions(-) diff --git a/.github/workflows/build-docker-api.yml b/.github/workflows/build-docker-api.yml index 2853efb..c507dbc 100644 --- a/.github/workflows/build-docker-api.yml +++ b/.github/workflows/build-docker-api.yml @@ -9,7 +9,7 @@ on: - main jobs: - build: + api-build: runs-on: ubuntu-latest steps: @@ -44,7 +44,7 @@ jobs: id: build-and-push uses: docker/build-push-action@v5 with: - context: . + context: ./api file: ./api/Dockerfile push: ${{ github.event_name != 'pull_request' }} tags: | @@ -54,43 +54,12 @@ jobs: cache-from: type=gha cache-to: type=gha,mode=max - pr-build: - runs-on: ubuntu-latest - if: github.event_name == 'pull_request' - - steps: - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - - - name: Cache Docker layers - uses: actions/cache@v3 - with: - path: /tmp/.buildx-cache - key: ${{ runner.os }}-buildx-${{ github.sha }} - restore-keys: | - ${{ runner.os }}-buildx- - - - name: Login to GitHub Container Registry - uses: docker/login-action@v2 - with: - registry: ghcr.io - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Extract Metadata - id: meta - uses: docker/metadata-action@v5 - with: - images: ghcr.io/socstech/asgard-api - - name: Build and Push Pull Request Docker Image - id: build-and-push + if: ${{ github.event_name == 'pull_request' }} + id: pr-build-and-push uses: docker/build-push-action@v5 with: - context: . + context: ./api file: ./api/Dockerfile push: true tags: | @@ -100,4 +69,4 @@ jobs: cache-from: type=gha cache-to: type=gha,mode=max build-args: | - EXPIRE_AFTER=30d \ No newline at end of file + EXPIRE_AFTER=30d From a27ac2e4035f4602499bf9f17d6453ba8ccb01d3 Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 11:21:37 +0000 Subject: [PATCH 10/14] ci: target only amd64 --- .github/workflows/build-docker-api.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/build-docker-api.yml b/.github/workflows/build-docker-api.yml index c507dbc..941dae2 100644 --- a/.github/workflows/build-docker-api.yml +++ b/.github/workflows/build-docker-api.yml @@ -44,6 +44,7 @@ jobs: id: build-and-push uses: docker/build-push-action@v5 with: + platforms: linux/amd64 context: ./api file: ./api/Dockerfile push: ${{ github.event_name != 'pull_request' }} @@ -59,6 +60,7 @@ jobs: id: pr-build-and-push uses: docker/build-push-action@v5 with: + platforms: linux/amd64 context: ./api file: ./api/Dockerfile push: true From 94b6d79ca034e717d27ce09b396b27c3589faacc Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 12:22:18 +0000 Subject: [PATCH 11/14] ci: add container labels and upgrade ci version --- .github/workflows/build-docker-api.yml | 12 ++++++------ api/Dockerfile | 10 ++++++++-- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/.github/workflows/build-docker-api.yml b/.github/workflows/build-docker-api.yml index 941dae2..fb84eec 100644 --- a/.github/workflows/build-docker-api.yml +++ b/.github/workflows/build-docker-api.yml @@ -14,13 +14,13 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 + uses: docker/setup-buildx-action@v3 - name: Cache Docker layers - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: /tmp/.buildx-cache key: ${{ runner.os }}-buildx-${{ github.sha }} @@ -28,7 +28,7 @@ jobs: ${{ runner.os }}-buildx- - name: Login to GitHub Container Registry - uses: docker/login-action@v2 + uses: docker/login-action@v3 with: registry: ghcr.io username: ${{ github.actor }} @@ -42,7 +42,7 @@ jobs: - name: Build and Push Production Docker Image id: build-and-push - uses: docker/build-push-action@v5 + uses: docker/build-push-action@v6 with: platforms: linux/amd64 context: ./api @@ -58,7 +58,7 @@ jobs: - name: Build and Push Pull Request Docker Image if: ${{ github.event_name == 'pull_request' }} id: pr-build-and-push - uses: docker/build-push-action@v5 + uses: docker/build-push-action@v6 with: platforms: linux/amd64 context: ./api diff --git a/api/Dockerfile b/api/Dockerfile index ddcf91a..6bc4a71 100644 --- a/api/Dockerfile +++ b/api/Dockerfile @@ -1,6 +1,12 @@ -## Building FROM node:20-alpine as base +# Open Container Initiative (OCI) labels +LABEL org.opencontainers.image.title "Asgard API" +LABEL org.opencontainers.image.description "Main API for the Asgard System" +LABEL org.opencontainers.image.authors ["University of Lincoln - Computer Science Technical Services ","Josh Cooper "] +LABEL org.opencontainers.image.url "https://github.com/socstech/asgard" +LABEL org.opencontainers.image.licenses="Apache-2.0" + # Make things run as node user USER node @@ -23,7 +29,7 @@ RUN npm run build ENV NODE_PATH=./dist # # Add a healthcheck and a port forward -# HEALTHCHECK CMD curl --fail http://localhost:3000/ || exit 1 +# HEALTHCHECK CMD curl --fail http://localhost:3000/v2 || exit 1 EXPOSE 3000 CMD [ "node", "dist/server.js" ] \ No newline at end of file From 9c37a226e5697a491d4b73fe573022722103326c Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 12:30:12 +0000 Subject: [PATCH 12/14] ci: break the compose file into prod and build - fix api dockerfile --- .env.example | 3 ++ api/Dockerfile | 10 ++--- docker-compose.build.yml | 87 ++++++++++++++++++++++++++++++++++++++++ docker-compose.yml | 40 +++++++++--------- 4 files changed, 115 insertions(+), 25 deletions(-) create mode 100644 docker-compose.build.yml diff --git a/.env.example b/.env.example index 3215191..1ef94ad 100644 --- a/.env.example +++ b/.env.example @@ -1,3 +1,6 @@ +# Which tag should the compose file target? +TAG=latest + DB_HOSTNAME=db DB_DATABASE=asgard DB_USERNAME=asgard diff --git a/api/Dockerfile b/api/Dockerfile index 6bc4a71..64e6055 100644 --- a/api/Dockerfile +++ b/api/Dockerfile @@ -1,10 +1,10 @@ -FROM node:20-alpine as base +FROM node:20-alpine # Open Container Initiative (OCI) labels -LABEL org.opencontainers.image.title "Asgard API" -LABEL org.opencontainers.image.description "Main API for the Asgard System" -LABEL org.opencontainers.image.authors ["University of Lincoln - Computer Science Technical Services ","Josh Cooper "] -LABEL org.opencontainers.image.url "https://github.com/socstech/asgard" +LABEL org.opencontainers.image.title="Asgard API" +LABEL org.opencontainers.image.description="Main API for the Asgard System" +LABEL org.opencontainers.image.authors=["University of Lincoln - Computer Science Technical Services ","Josh Cooper "] +LABEL org.opencontainers.image.url="https://github.com/socstech/asgard" LABEL org.opencontainers.image.licenses="Apache-2.0" # Make things run as node user diff --git a/docker-compose.build.yml b/docker-compose.build.yml new file mode 100644 index 0000000..6a4134c --- /dev/null +++ b/docker-compose.build.yml @@ -0,0 +1,87 @@ +version: "3" + +services: + asgard-jobs: + build: ./jobs + container_name: asgard-jobs + restart: always + networks: + - asgard_internal + env_file: + - .env + environment: + API_URL: "http://asgard-api:3000" + MQTT_BROKER: "mqtt" + ACADEMIC_YEAR_START_DATE: ${ACADEMIC_YEAR_START_DATE} + BOT_USER: ${BOT_USER} + BOT_PASS: ${BOT_PASS} + volumes: + - ./jobs/data:/app/data + depends_on: + - asgard-api + - mqtt + + asgard-api: + build: ./api + container_name: asgard-api + restart: always + networks: + - asgard_internal + ports: + - 1305:3000 + env_file: + - .env + depends_on: + - db + - mqtt + + asgard-admin: + build: ./admin + container_name: asgard-admin + restart: always + networks: + - asgard_internal + depends_on: + - asgard-api + environment: + PUBLIC_API_URL: ${API_URL} + PUBLIC_Y2_URL: ${Y2_URL} + ports: + - 1102:80 + db: + container_name: asgard-db + image: mysql:8.0 + command: --default-authentication-plugin=mysql_native_password --character-set-server=utf8 --collation-server=utf8_general_ci + restart: unless-stopped + volumes: + - mysql-data:/var/lib/mysql + networks: + - asgard_internal + environment: + MYSQL_ROOT_PASSWORD: ${DB_PASSWORD} + MYSQL_DATABASE: ${DB_DATABASE} + MYSQL_USER: ${DB_USERNAME} + MYSQL_PASSWORD: ${DB_PASSWORD} + + mqtt: + image: eclipse-mosquitto:2 + container_name: asgard-mqtt + volumes: + - ./mosquitto.conf:/mosquitto/config/mosquitto.conf + - mqtt-data:/mosquitto/data + - mqtt-log:/mosquitto/log + stdin_open: true + tty: true + networks: + - asgard_internal + ports: + - 1883:1883 + - 9001:9001 + +volumes: + mysql-data: + mqtt-data: + mqtt-log: + +networks: + asgard_internal: \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index 7804801..ac9ddf7 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,8 +2,8 @@ version: "3" services: asgard-jobs: - build: ./jobs - container_name: a2-asgard-jobs + image: ghcr.io/socstech/asgard-jobs:${TAG} + container_name: asgard-jobs restart: always networks: - asgard_internal @@ -22,8 +22,8 @@ services: - mqtt asgard-api: - build: ./api - container_name: a2-asgard-api + image: ghcr.io/socstech/asgard-api + container_name: asgard-api restart: always networks: - asgard_internal @@ -35,22 +35,22 @@ services: - db - mqtt - yggdrasil-web: - build: ./yggdrasil-web - container_name: a2-yggdrasil-web - restart: always - networks: - - asgard_internal - env_file: - - .env - depends_on: - - asgard-api - ports: - - 2305:80 + # yggdrasil-web: + # build: ./yggdrasil-web + # container_name: a2-yggdrasil-web + # restart: always + # networks: + # - asgard_internal + # env_file: + # - .env + # depends_on: + # - asgard-api + # ports: + # - 2305:80 asgard-admin: - build: ./admin - container_name: a2-asgard-admin + image: ghcr.io/socstech/asgard-admin:${TAG} + container_name: asgard-admin restart: always networks: - asgard_internal @@ -62,7 +62,7 @@ services: ports: - 1102:80 db: - container_name: a2-asgard-db + container_name: asgard-db image: mysql:8.0 command: --default-authentication-plugin=mysql_native_password --character-set-server=utf8 --collation-server=utf8_general_ci restart: unless-stopped @@ -78,7 +78,7 @@ services: mqtt: image: eclipse-mosquitto:2 - container_name: a2-asgard-mqtt + container_name: asgard-mqtt volumes: - ./mosquitto.conf:/mosquitto/config/mosquitto.conf - mqtt-data:/mosquitto/data From 482b7888f5f1411ec5663c66e9f8b096fe6bd8a6 Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 12:48:14 +0000 Subject: [PATCH 13/14] ci: add jobs --- .github/workflows/build-docker-api.yml | 3 +- .github/workflows/build-docker-jobs.yml | 75 +++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/build-docker-jobs.yml diff --git a/.github/workflows/build-docker-api.yml b/.github/workflows/build-docker-api.yml index fb84eec..a19ed82 100644 --- a/.github/workflows/build-docker-api.yml +++ b/.github/workflows/build-docker-api.yml @@ -51,6 +51,7 @@ jobs: tags: | ${{ steps.meta.outputs.tags }} ghcr.io/socstech/asgard-api:latest + ghcr.io/socstech/asgard-api:${{ github.sha }} labels: ${{ steps.meta.outputs.labels }} cache-from: type=gha cache-to: type=gha,mode=max @@ -71,4 +72,4 @@ jobs: cache-from: type=gha cache-to: type=gha,mode=max build-args: | - EXPIRE_AFTER=30d + EXPIRE_AFTER=14d diff --git a/.github/workflows/build-docker-jobs.yml b/.github/workflows/build-docker-jobs.yml new file mode 100644 index 0000000..7ce94b1 --- /dev/null +++ b/.github/workflows/build-docker-jobs.yml @@ -0,0 +1,75 @@ +name: Jobs - Build and Publish Docker Image + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + jobs-build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Cache Docker layers + uses: actions/cache@v4 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/socstech/asgard-jobs + + - name: Build and Push Production Docker Image + id: build-and-push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64 + context: ./jobs + file: ./jobs/Dockerfile + push: ${{ github.event_name != 'pull_request' }} + tags: | + ${{ steps.meta.outputs.tags }} + ghcr.io/socstech/asgard-jobs:latest + ghcr.io/socstech/asgard-jobs:${{ github.sha }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + + - name: Build and Push Pull Request Docker Image + if: ${{ github.event_name == 'pull_request' }} + id: pr-build-and-push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64 + context: ./jobs + file: ./jobs/Dockerfile + push: true + tags: | + ghcr.io/socstech/asgard-jobs:${{ github.sha }} + ghcr.io/socstech/asgard-jobs:pr-${{ github.event.number }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + build-args: | + EXPIRE_AFTER=14d From 56c468da3612abe8010311b90fbe0302e22f712b Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Fri, 8 Nov 2024 12:49:04 +0000 Subject: [PATCH 14/14] ci: add admin workflow --- .github/workflows/build-docker-admin.yml | 75 ++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 .github/workflows/build-docker-admin.yml diff --git a/.github/workflows/build-docker-admin.yml b/.github/workflows/build-docker-admin.yml new file mode 100644 index 0000000..c55065a --- /dev/null +++ b/.github/workflows/build-docker-admin.yml @@ -0,0 +1,75 @@ +name: Admin - Build and Publish Docker Image + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + admin-build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Cache Docker layers + uses: actions/cache@v4 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/socstech/asgard-admin + + - name: Build and Push Production Docker Image + id: build-and-push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64 + context: ./admin + file: ./admin/Dockerfile + push: ${{ github.event_name != 'pull_request' }} + tags: | + ${{ steps.meta.outputs.tags }} + ghcr.io/socstech/asgard-admin:latest + ghcr.io/socstech/asgard-admin:${{ github.sha }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + + - name: Build and Push Pull Request Docker Image + if: ${{ github.event_name == 'pull_request' }} + id: pr-build-and-push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64 + context: ./admin + file: ./admin/Dockerfile + push: true + tags: | + ghcr.io/socstech/asgard-admin:${{ github.sha }} + ghcr.io/socstech/asgard-admin:pr-${{ github.event.number }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + build-args: | + EXPIRE_AFTER=14d