Skip to content

Commit

Permalink
docs: add support for new images in Orka (nodejs#3875)
Browse files Browse the repository at this point in the history
PR-URL: nodejs#3875
  • Loading branch information
UlisesGascon authored Aug 31, 2024
1 parent e0c73b4 commit dfb4ae4
Showing 1 changed file with 59 additions and 1 deletion.
60 changes: 59 additions & 1 deletion orka/templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,62 @@ packer build -var "orka_endpoint=$ORKA_ENDPOINT" -var "orka_auth_token=$ORKA_AUT

The templates are initialized and validated in the CI pipeline using GitHub Actions. The pipeline runs on every push to the repository that modifies the templates. You can find the pipeline in the `.github/workflows/orka-templates.yml` directory.

We don't plan to build the images in the CI pipeline. The images are built manually by the team once the PRs are merged or just before merged.
We don't plan to build the images in the CI pipeline. The images are built manually by the team once the PRs are merged or just before merged.
## Adding new images
Orka provides a base image that we need to customize to our needs.
1. find the image that you want to extend by running the following command:
```shell
orka3 remote-image list
```
2. pull the image by running the following command:
```shell
orka3 remote-image pull <image_name>
```
Note: this can take a while, use `orka3 image list <image_name>` to check the progress of the image. Wait until the image is in status `Ready`.
3. Create a new vm from the image by running the following command:
```shell
orka3 vm deploy -i <image_name>
```
4. Access the vm using vnc and then do the following manual steps (see setion below). The credentials can be found in the secrets repository.
5. Save the vm as a new image by running the following command:
```shell
orka3 vm save <vm_name> <new_image_name>
```
Note: Don't stop the vm and use this pattern: `macos13-intel-base.img` or `macos13-arm-base.orkasi` for the image name. The generation can take a while.
6. Delete the vm by running the following command:
```shell
orka3 vm delete <vm_name>
```
Note: Don't delete the vm until you have saved the image, check by running the command `orka3 image list`
**Manual Steps**
1. Update Sudoers file:
this requires `NOPASSWD` to be added to the sudoers file to enable elevation
`sudo visudo`
and change:
`%admin ALL = (ALL) ALL`
to
`%admin ALL = (ALL) NOPASSWD:ALL`
2. Allow ssh access
```bash
sudo systemsetup -setremotelogin on
```
3. Install xcode
```bash
sudo xcode-select --install
```
Do a an update using the UI. Check the available updates and install them (click in "more info"). Note that you don't want to update the OS, just the software.

0 comments on commit dfb4ae4

Please sign in to comment.