add ssh support for private repos

canonical / cos-configuration-k8s-operator

This charmed operator for Kubernetes enables you to provide configurations to various components of the Canonical Observability Stack (COS) bundle.

https://charmhub.io/cos-configuration-k8s

Apache License 2.0

4 stars 6 forks source link

add ssh support for private repos #52

Closed lucabello closed 1 year ago

lucabello commented 1 year ago

Issue

Closes #31

Solution

Store the SSH key in the model as a configuration parameter, until we have Juju secrets.

TODO (documentation mainly):

[ ] document well that setting git_ssh_key means using it
[ ] explicitly state that the key will be saved in the model
[ ] recommend using a key with very limited scope

Testing Instructions

Try to sync a private repo and see if it succeeds!

Release Notes

Add SSH support so that private repositories can be used with the charm.

sed-i commented 1 year ago

Was this feature tested? Utests fail on something basic

    raise NonAbsolutePathError(path)
ops.testing.NonAbsolutePathError: cos-config-ssh-key.priv
...
ops.pebble.PathError: generic-file-error - paths must be absolute, got 'cos-config-ssh-key.priv'