From 4a18cf26e437fef35592e443ae59f29ce0236de9 Mon Sep 17 00:00:00 2001 From: Clemens Zagler Date: Wed, 14 Aug 2024 16:31:06 +0200 Subject: [PATCH] scaffolding setup, CICD first try --- .github/workflows/cicd.yml | 34 +++++++ .github/workflows/reuse.yml | 14 +++ .pre-commit-config.yaml | 5 + .reuse/dep5 | 8 ++ LICENSES/CC0-1.0.txt | 121 ++++++++++++++++++++++++ README.md | 21 ++++ infrastructure/ansible/ansible.cfg | 4 + infrastructure/ansible/deploy.yml | 19 ++++ infrastructure/ansible/hosts | 2 + infrastructure/ansible/requirements.yml | 6 ++ infrastructure/ansible/roles/.gitignore | 2 + infrastructure/docker-compose.run.yml | 7 ++ 12 files changed, 243 insertions(+) create mode 100644 .github/workflows/cicd.yml create mode 100644 .github/workflows/reuse.yml create mode 100644 .pre-commit-config.yaml create mode 100644 .reuse/dep5 create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 infrastructure/ansible/ansible.cfg create mode 100644 infrastructure/ansible/deploy.yml create mode 100644 infrastructure/ansible/hosts create mode 100644 infrastructure/ansible/requirements.yml create mode 100644 infrastructure/ansible/roles/.gitignore create mode 100644 infrastructure/docker-compose.run.yml diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml new file mode 100644 index 0000000..7bc2eae --- /dev/null +++ b/.github/workflows/cicd.yml @@ -0,0 +1,34 @@ +name: CI/CD + +on: + push: + paths: + - "infrastructure/**" + - ".github/workflows/cicd.yml" + +jobs: + deploy-test: + runs-on: ubuntu-22.04 + if: github.ref == 'refs/heads/main' + concurrency: + group: deploy-test + cancel-in-progress: true + env: + PROJECT_NAME: c3nav-test + steps: + - name: Checkout source code + uses: actions/checkout@v2 + + - name: Create .env file + uses: noi-techpark/github-actions/env-file@v2 + env: + X_SERVER_PORT: 8001 + + - name: Deploy application + uses: noi-techpark/github-actions/docker-deploy@v2 + with: + hosts: 'maps.sfscon.it' + ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }} + docker-username: 'noi-techpark-bot' + docker-password: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }} + project-name: ${{ env.PROJECT_NAME }} diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml new file mode 100644 index 0000000..f7337b3 --- /dev/null +++ b/.github/workflows/reuse.yml @@ -0,0 +1,14 @@ +name: REUSE Compliance Check + +on: + - push + - pull_request + +jobs: + test: + runs-on: ubuntu-22.04 + steps: + - name: Checkout source code + uses: actions/checkout@v2 + - name: REUSE Compliance Check + uses: fsfe/reuse-action@v3 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..35e1eb1 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,5 @@ +repos: +- repo: https://github.com/fsfe/reuse-tool + rev: v3.0.0 + hooks: + - id: reuse \ No newline at end of file diff --git a/.reuse/dep5 b/.reuse/dep5 new file mode 100644 index 0000000..d5978f4 --- /dev/null +++ b/.reuse/dep5 @@ -0,0 +1,8 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: sfscon-maps +Upstream-Contact: NOI Techpark +Source: https://github.com/noi-techpark/sfscon-maps + +Files: .github/* infrastructure .gitignore .gitmodules .pre-commit-config.yaml LICENSE.md +Copyright: (c) NOI Techpark +License: CC0-1.0 diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md index d4a03b2..132b4b4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ + + # sfscon-maps c3nav navigation / maps.sfscon.it + +## REUSE + +This project is [REUSE](https://reuse.software) compliant, more information about the usage of REUSE in NOI Techpark repositories can be found [here](https://github.com/noi-techpark/odh-docs/wiki/Guidelines-for-developers-and-licenses#guidelines-for-contributors-and-new-developers). + +Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The [pre-commit-config](.pre-commit-config.yaml) file in the repository root is already configured to check for REUSE compliance with help of the [pre-commit](https://pre-commit.com) tool. + +Install the tool by running: +```bash +pip install pre-commit +``` +Then install the pre-commit hook via the config file by running: +```bash +pre-commit install +``` diff --git a/infrastructure/ansible/ansible.cfg b/infrastructure/ansible/ansible.cfg new file mode 100644 index 0000000..bec5ce0 --- /dev/null +++ b/infrastructure/ansible/ansible.cfg @@ -0,0 +1,4 @@ +[defaults] +inventory = ./hosts +roles_path = ./roles +retry_files_enabled = False diff --git a/infrastructure/ansible/deploy.yml b/infrastructure/ansible/deploy.yml new file mode 100644 index 0000000..c01d4fe --- /dev/null +++ b/infrastructure/ansible/deploy.yml @@ -0,0 +1,19 @@ +--- +- hosts: all + vars: + ansible_python_interpreter: /usr/bin/python3 + tasks: + - name: Login to GitHub Container Registry + ansible.builtin.shell: + cmd: echo "{{ docker_password }}" | docker login "{{ docker_host }}" --username "{{ docker_username }}" --password-stdin + - name: Execute Docker deployment + ansible.builtin.include_role: + name: ansible-docker-deployment + vars: + docker_deployment_project_name: '{{ project_name }}' + docker_deployment_release_name: '{{ release_name }}' + docker_deployment_release_files: + - local: ../docker-compose.run.yml + remote: docker-compose.yml + - local: ../../.env + remote: .env diff --git a/infrastructure/ansible/hosts b/infrastructure/ansible/hosts new file mode 100644 index 0000000..3f410e4 --- /dev/null +++ b/infrastructure/ansible/hosts @@ -0,0 +1,2 @@ +maps.sfscon.it ansible_host=54.229.77.113 ansible_user='noi-techpark-bot' ansible_ssh_common_args='-o StrictHostKeyChecking=no' + diff --git a/infrastructure/ansible/requirements.yml b/infrastructure/ansible/requirements.yml new file mode 100644 index 0000000..e9ff2f4 --- /dev/null +++ b/infrastructure/ansible/requirements.yml @@ -0,0 +1,6 @@ +roles: + - src: git+https://github.com/noi-techpark/ansible-docker-deployment.git + version: "2.0" +collections: + - name: community.docker + version: 3.10.4 \ No newline at end of file diff --git a/infrastructure/ansible/roles/.gitignore b/infrastructure/ansible/roles/.gitignore new file mode 100644 index 0000000..d6b7ef3 --- /dev/null +++ b/infrastructure/ansible/roles/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore diff --git a/infrastructure/docker-compose.run.yml b/infrastructure/docker-compose.run.yml new file mode 100644 index 0000000..7243945 --- /dev/null +++ b/infrastructure/docker-compose.run.yml @@ -0,0 +1,7 @@ +services: + app: + image: nginxdemos/hello + restart: unless-stopped + env_file: .env + ports: + - ${SERVER_PORT}:80