diff --git a/reference/html/index.html b/reference/html/index.html index f579437e..51868413 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -777,6 +777,25 @@ If you do not know where your ~/.git directory is, use git co +
+

JGit requires RSA keys in PEM format. Below is an example ssh-keygen (from openssh) command that will generate a key in the corect format:

+
+
+
+
ssh-keygen -m PEM -t rsa -b 4096 -f ~/config_server_deploy_key.rsa
+
+
+
+

Warning: When working with SSH keys, the expected ssh private-key must begin with -----BEGIN RSA PRIVATE KEY-----. If the key starts with -----BEGIN OPENSSH PRIVATE KEY----- then the RSA key will not load when spring-cloud-config server is started. The error looks like:

+
+
+
+
- Error in object 'spring.cloud.config.server.git': codes [PrivateKeyIsValid.spring.cloud.config.server.git,PrivateKeyIsValid]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [spring.cloud.config.server.git.,]; arguments []; default message []]; default message [Property 'spring.cloud.config.server.git.privateKey' is not a valid private key]
+
+
+
+

To correct the above error the RSA key must be converted to PEM format. An example using openssh is provided above for generating a new key in the appropriate format.

+
Authentication with AWS CodeCommit
diff --git a/reference/html/spring-cloud-config.html b/reference/html/spring-cloud-config.html index f579437e..51868413 100644 --- a/reference/html/spring-cloud-config.html +++ b/reference/html/spring-cloud-config.html @@ -777,6 +777,25 @@ If you do not know where your ~/.git directory is, use git co
+
+

JGit requires RSA keys in PEM format. Below is an example ssh-keygen (from openssh) command that will generate a key in the corect format:

+
+
+
+
ssh-keygen -m PEM -t rsa -b 4096 -f ~/config_server_deploy_key.rsa
+
+
+
+

Warning: When working with SSH keys, the expected ssh private-key must begin with -----BEGIN RSA PRIVATE KEY-----. If the key starts with -----BEGIN OPENSSH PRIVATE KEY----- then the RSA key will not load when spring-cloud-config server is started. The error looks like:

+
+
+
+
- Error in object 'spring.cloud.config.server.git': codes [PrivateKeyIsValid.spring.cloud.config.server.git,PrivateKeyIsValid]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [spring.cloud.config.server.git.,]; arguments []; default message []]; default message [Property 'spring.cloud.config.server.git.privateKey' is not a valid private key]
+
+
+
+

To correct the above error the RSA key must be converted to PEM format. An example using openssh is provided above for generating a new key in the appropriate format.

+