Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding extra-spec SSH Keys #24

Merged
merged 1 commit into from
Jun 20, 2024

Conversation

fabi200123
Copy link
Contributor

Adding the extra-spec option for SSH Keys to allow users to add their own ssh-keys to the Garm instances

@fabi200123 fabi200123 force-pushed the add-ssh-keys branch 3 times, most recently from 8a7406f to 36ece9f Compare June 19, 2024 08:59
README.md Outdated
}
```

**NOTE**: The `custom_labels` and `network_tags` must meet the [GCP requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) and the [GCP requirements for network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags#restrictions)!

**NOTE**: The `ssh_keys` add the option to [connect to an instance via SSH](https://cloud.google.com/compute/docs/instances/ssh) (either Linux or Windows). After you added the key as `username:ssh_public_key`, you can use the `private_key` to connect to the Linux/Windows instance via `ssh -i private_rsa username@instance_ip`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do the images need any specific packages pre-installed? Is there a quick howto you can include in the README?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Afair, for Linux all images have ssh and for Windows the packages needed are already installed if there are any ssh keys sent as extra-specs -> https://github.com/cloudbase/garm-provider-gcp/pull/24/files#diff-fd6fb078945fce9b41e3aced4a0cb03cf47c4d318e2423733b23c741b30b7975R178

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered that if you want to use ssh keys on Windows, you want to have ssh enabled and installed on the instance

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's worth adding a note that this also works on Windows, if the needed packages are pre-installed in the image.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mentioned at the end of the NOTE that the provider installs on the instance google-compute-engine-ssh and enables ssh if a ssh key is sent as extra-spec

@gabriel-samfira gabriel-samfira merged commit eb6c0e5 into cloudbase:main Jun 20, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants