diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..92dc94f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + + + +### Prerequisites + +- [ ] Put an X between the brackets on this line if you have done all of the following: + - Checked the FAQs for common solutions: + - Checked that your issue isn't already filed: + +### Description + + + +### Steps to Reproduce + +1. +2. +3. + +**Expected behaviour:** + + + +**Actual behaviour:** + + + +**Reproduces how often:** + + + +### Versions + + + +### Additional Information + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..e59fec4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,29 @@ +--- +name: Feature request +about: Suggest an idea for this project +--- + + + +## Summary + + + +## Motivation + + + +## Describe alternatives you've considered + + + +## Additional context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..523887f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +βš›πŸ‘‹ Hello there! Welcome. Please follow the steps below to tell us about your contribution. + +1. Copy the correct template for your contribution + + - πŸ› Are you fixing a bug? Copy the template from + - πŸ’» Are you changing functionality? Copy the template from + +2. Replace this text with the contents of the template +3. Fill in all sections of the template +4. Click "Create pull request" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8dee6ff --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project, and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expressions, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behaviour that contributes to creating a positive environment include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behaviour by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=dsbd-github-baseimage). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team's obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct has been adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..34c87c9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,135 @@ +# Contributing to dsbd-github-baseimage + +Firstly, we would like to thank you for taking the time to contribute! + +The following is a set of guidelines for contributing to our packages, which are hosted on the [digicatapult](https://github.com/digicatapult) organisation on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request. + +#### Table Of Contents + +[Code of Conduct](#code-of-conduct) + +[FAQs](#FAQs) + +[How Can I Contribute?](#how-can-i-contribute) + +- [Reporting Bugs](#reporting-bugs) +- [Suggesting Enhancements](#suggesting-enhancements) +- [Your First Code Contribution](#your-first-code-contribution) +- [Pull Requests](#pull-requests) + +[Styleguides](#styleguides) + +- [Git Commit Messages](#git-commit-messages) +- [Pull Request Labels](#pull-request-labels) + +## Code of Conduct + +This project and all those participating in it are governed by the [Digital Catapult's Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=dsbd-github-baseimage). + +## FAQs + +We don't have any frequently asked questions yet. + +## How Can I Contribute? + +### Reporting Bugs + +This section guides you through submitting a bug report for dsbd-github-baseimage. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour :computer: :computer:, and find related reports :mag_right:. + +Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/digicatapult/dsbd-github-baseimage/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster. + +> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. + +#### Before Submitting A Bug Report + +- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Adsbd-github-baseimage)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. + +#### How Do I Submit A (Good) Bug Report? + +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/digicatapult/dsbd-github-baseimage/blob/main/.github/ISSUE_TEMPLATE/bug_report.md). + +Explain the problem and include additional details to help maintainers reproduce the problem: + +- **Use a clear and descriptive title** for the issue to identify the problem. +- **Describe the exact steps which reproduce the problem** in as many details as possible. +- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). +- **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour. +- **Explain which behaviour you expected to see instead and why.** +- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, \*\*record the GIF with the [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/Xaviju/byzanzUI) on Linux. +- **If you're reporting that dsbd-github-baseimage crashed**, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist. +- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. + +Provide more context by answering these questions: + +- **Did the problem start happening recently** (e.g. after updating to a new version of dsbd-github-baseimage) or was this always a problem? +- If the problem started happening recently, **can you reproduce the problem in an older version of dsbd-github-baseimage?** What's the most recent version in which the problem doesn't happen? You can checkout older versions of dsbd-github-baseimage from [the releases page](https://github.com/digicatapult/dsbd-github-baseimage/releases). +- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. + +Include details about your configuration and environment: + +- **Which version of dsbd-github-baseimage are you using?** You can get the exact version from the version attribute within package.json. +- **What's the name and version of the OS you've deployed dsbd-github-baseimage to**? +- **Are you running dsbd-github-baseimage in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest? + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for dsbd-github-baseimage, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. + +Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/digicatapult/dsbd-github-baseimage/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed. + +#### Before Submitting An Enhancement Suggestion + +- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Adsbd-github-baseimage)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. + +#### How Do I Submit A (Good) Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information: + +- **Use a clear and descriptive title** for the issue to identify the suggestion. +- **Provide a step-by-step description of the suggested enhancement** in as many details as possible. +- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). +- **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why. +- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of dsbd-github-baseimage which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. +- **Explain why this enhancement would be useful** to most dsbd-github-baseimage users. +- **List some other text editors or applications where this enhancement exists.** +- **Specify which version of dsbd-github-baseimage you're using.** You can get the exact version from the version attribute within package.json. +- **What's the name and version of the OS you've deployed dsbd-github-baseimage to**? + +### Pull Requests + +The process described here has several goals: + +- Maintain dsbd-github-baseimage's quality +- Fix problems that are important to users +- Enable a sustainable system for dsbd-github-baseimage's maintainers to review contributions + +Please follow these steps to have your contribution considered by the maintainers: + +1. Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE.md) +2. Follow the [styleguides](#styleguides) +3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
+ +While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. + +## Styleguides + +### Git Commit Messages + +- Use the present tense ("Add feature" not "Added feature") +- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +- Limit the first line to 72 characters or less +- Reference issues and pull requests liberally after the first line + +### Pull Request Labels + +| Label name | :mag_right: | Description | +| ----------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------ | +| `breaking-change` | [search][search-digicat-label-breaking-change] | Pull requests that add functionality with incompatible API changes (MAJOR SemVer) | +| `feature ` | [search][search-digicat-label-feature] | Pull requests that add functionality with backwards compatibility (MINOR SemVer) | +| `chore` | [search][search-digicat-label-chore] | Simple changes or improvements to the code base so it can be worked with more easily | +| `bug` | [search][search-digicat-label-bug] | Pull requests that fix bugs | + +[search-digicat-label-breaking-change]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Abreaking-change +[search-digicat-label-feature]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Afeature +[search-digicat-label-chore]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Achore +[search-digicat-label-bug]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Abug diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..079a34e --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + 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 + + Copyright 2024 Digital Catapult + + 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. diff --git a/README.md b/README.md index bfec1d5..5c01701 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,77 @@ # README.md +## Project Description +This is a packer project to build a CheriBSD Morello [QEMU](https://github.com/CTSRD-CHERI/qemu) environment with builtin support for [Github Actions](https://github.com/actions/runner) self-hosted runners. + ## Pre-requisites -packer -clone the repository +* packer -## Build the image +* Azure or AWS account -Login to Azure +### Development + +* shellCheck + +## Installation + +Begin by cloning the repository + +```sh +git clone https://github.com/digicatapult/dsbd-github-baseimage.git +``` +## Configuration +Depending on if you are using the Azure Builder or the AWS Builder you will need to set the following in a file called `secrets.auto.pkrvars.hcl` in the root of the repository. The file should contain the following variables: + +### Azure + +```sh +subscription_id = "" +image_resource_group_name = " +``` Prestage the SIG image definition (If it has not already been created) ``` -az sig image-definition create --resource-group dsbd-github-images --gallery-name arm64 \ - --gallery-image-definition dsbd-ubuntu-22.04-lts --publisher Canonical --offer 0001-com-ubuntu-server-jammy \ - --sku 22_04-lts-arm64 --os-type linux --hyper-v-generation V2 --architecture Arm64 +az sig image-definition create --resource-group --gallery-name \ + --gallery-image-definition --publisher Canonical --offer 0001-com-ubuntu-server-jammy \ + --sku --os-type linux --hyper-v-generation V2 --architecture ``` -You will need to provide some vars, namely, the resource group and the subscription id which have been purposefully omitted from the repo as they are considered secret, these can be loaded automatically from a file called `secrets.auto.pkrvars.hcl` in the root of the repo. You will also need to supply the AWS credentials in the same file, e.g. aws_access_key and aws_secret_key. +Run packer build +``` +packer build -only=azure-arm.ubuntu --var aws_access_key=blah --var aws_secret_key=blah . +``` +### AWS -Run using `packer build .` in the root of the repo. -To only run one of the sources e.g. the aws source, use `packer build -only=amazon-ebs.ubuntu .` ### Retrieving Github Actions PAT from Azure Key Vault or AWS Secrets Manager -The PAT is stored in Azure Key Vault or AWS Secrets Manager. The PAT is used to authenticate to Github and retrieve a token for registering a self served Github Actions runner. Using cloudInit please provide the following ENVARS for the `update_qemu_morello_config.sh` script to retrieve the PAT from the respective secret store. We suggest using cloudinit to write the environment variables to `/etc/environment` so that they are available to the `update_qemu_morello_config.sh` script. +The PAT is stored in Azure Key Vault or AWS Secrets Manager. The PAT is used to authenticate to Github and retrieve a token for registering a self served Github Actions runner. Using cloudInit please provide the following ENVARS for the `update_qemu_morello_config.sh` script to retrieve the PAT from the respective secret store. We suggest using cloudinit to write the environment variables to `/etc/sysconfig/update-qemu-morello-config.conf` so that they are available to the `update_qemu_morello_config.sh` script. ```yaml #cloud-config @@ -43,18 +87,15 @@ write_files: ### Accessing the QEMU guest -We recommend you access the QEMU guest by using ssh. Firstly you will need to establish a tunnel to the Ubuntu host via a bastion, in Azure this can be achieved with the following command: +We recommend you access the QEMU guest by using ssh, you will need to have the corresponding private key to the public key that you used when building the image. -```sh -az network bastion tunnel --resource-group --name --target-resource-id --resource-port 22 --port 2022 -``` -Secondly you will need to ssh to the ubuntu host using ssh-agent forwarding, this can be achieved with the following command: +You will need to use `ssh-agent` forwarding to pass the key to the QEMU guest. To do this you will need to add the key to your ssh-agent using the following command: ```sh -ssh -A -p 2022 @localhost +ssh -A @ ``` -Once you have access to the ubuntu host you can ssh to the QEMU guest using the following command: + Once you have access to the ubuntu host you can ssh to the QEMU guest using the following command: ```sh ssh -p 10005 root@localhost diff --git a/files/cheribuild-gmp-git.patch b/files/cheribuild-gmp-git.patch deleted file mode 100644 index 1aafb75..0000000 --- a/files/cheribuild-gmp-git.patch +++ /dev/null @@ -1,19 +0,0 @@ -diff --git a/pycheribuild/projects/cross/gmp.py b/pycheribuild/projects/cross/gmp.py -index 8c476339..9f81b2c1 100644 ---- a/pycheribuild/projects/cross/gmp.py -+++ b/pycheribuild/projects/cross/gmp.py -@@ -24,12 +24,12 @@ - # - - from .crosscompileproject import CrossCompileAutotoolsProject, DefaultInstallDir --from ..project import MercurialRepository -+from ..project import MercurialRepository, GitRepository - from ...config.compilation_targets import CompilationTargets - - - class BuildGmp(CrossCompileAutotoolsProject): -- repository = MercurialRepository("https://gmplib.org/repo/gmp") -+ repository = GitRepository("https://github.com/gmp-mirror/gmp") - supported_architectures = ( - CompilationTargets.ALL_CHERIBSD_TARGETS_WITH_HYBRID - + CompilationTargets.ALL_CHERIBSD_HYBRID_FOR_PURECAP_ROOTFS_TARGETS diff --git a/main.pkr.hcl b/main.pkr.hcl index ff48f39..b29a312 100644 --- a/main.pkr.hcl +++ b/main.pkr.hcl @@ -101,11 +101,6 @@ build { source = "./files/cheribuild.json" destination = "/tmp/cheribuild.json" } - # This is to deal with Azure being blacklisted by the gmp mercurial server, so we use a github mirror instead. - provisioner "file" { - source = "./files/cheribuild-gmp-git.patch" - destination = "/tmp/cheribuild-gmp-git.patch" - } provisioner "file" { source = "./files/qemu-morello.service" destination = "/tmp/qemu-morello.service" diff --git a/scripts/install-cheribuild.sh b/scripts/install-cheribuild.sh index 7333ef9..c0a253c 100644 --- a/scripts/install-cheribuild.sh +++ b/scripts/install-cheribuild.sh @@ -103,7 +103,6 @@ install_qemu() { install_cheribuild() { echo "Installing Cheribuild..." runuser -l "$CHERI_USER" -c "git clone \"$CHERIBUILD_REPO\" \"$CHERI_HOME/cheri/cheribuild\"" - runuser -l "$CHERI_USER" -c "pushd \"$CHERI_HOME/cheri/cheribuild\" && git apply /tmp/cheribuild-gmp-git.patch && popd" echo "Cheribuild installation complete." }