spring-cloud / spring-cloud/spring-cloud-config
Update spring.io documentation regarding key decryption
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2k
- Forks
- 1.3k
- Avg merge
- 2d 59m
- Merged PRs (30d)
- 16
Description
Please update documentation https://cloud.spring.io/spring-cloud-config/reference/html/
Regarding key decryption, the RSA example does not work, because:
- the config changed from encrypt.keyStore to encryption.key-store,
- there are some required RsaProperties to run.
3.indentation in the documentation might suggest it should be with a prefix spring.cloud.config.server (i.e. spring.cloud.config.server.encrypt.key-store) where it actually is top level encryption.key-store parameter, its especially confusing since flag to enable/disable is "spring.cloud.config.server.encrypt.enabled"
To ease up on tracking, its about the class org.springframework.cloud.config.server.config.EncryptionAutoConfiguration
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the RSA example in the linked Spring Cloud Config reference documentation and compare it with org.springframework.cloud.config.server.config.EncryptionAutoConfiguration. Verify the current property names, required RsaProperties, and indentation or prefixes; done means the example accurately reflects the configuration needed to run key decryption.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring, spring-boot
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100