Make sure all contents in readme is included for secret management module #802
Conversation
2. Fix indent error of list in yaml file. 2. Add contents about different authentication method.
2. Add content about special characters in property name. 3. Add content about case-sensitive setting.
|
Hi, @backwind1233 , @saragluna , please help to review this PR when you have time. |
| @@ -56,23 +57,25 @@ spring: | |||
| endpoint: ${AZURE_KEYVAULT_ENDPOINT} | |||
| ---- | |||
|
|
|||
| If your application is authenticated by other methods like Managed Identity or Azure CLI, properties like `tenant-id`, `client-id`, `client-secret` is not necessary. But if these properties are configured, then these properties have higher priority. Please refer to link:authentication.html[Authentication section] to get more information. | |||
There was a problem hiding this comment.
properties like tenant-id, client-id, client-secret is not necessary --> properties like tenant-id, client-id, client-secret are not necessary
| @@ -56,23 +57,25 @@ spring: | |||
| endpoint: ${AZURE_KEYVAULT_ENDPOINT} | |||
| ---- | |||
|
|
|||
| If your application is authenticated by other methods like Managed Identity or Azure CLI, properties like `tenant-id`, `client-id`, `client-secret` is not necessary. But if these properties are configured, then these properties have higher priority. Please refer to link:authentication.html[Authentication section] to get more information. | |||
|
|
|||
| ===== Java code | |||
|
|
|||
| [source,java] | |||
| ---- | |||
| @SpringBootApplication | |||
| public class KeyVaultSample implements CommandLineRunner { | |||
|
|
|||
There was a problem hiding this comment.
No, it's just code snippet, not project, no need to test, I think.
| spring.cloud.azure.keyvault.secret.property-sources[].case-sensitive=true | ||
| ---- | ||
|
|
||
|
|
||
| === Samples | ||
|
|
||
| Please refer to link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_4.0[azure-spring-boot-samples] for more details. |
There was a problem hiding this comment.
I think it's better to link the keyvault samples here.
| private String secretNameInKeyVault2; | ||
| @Value("${secret-name-in-key-vault-both}") | ||
| private String secretNameInKeyVaultBoth; | ||
| @Value("${sampleProperty1}") |
There was a problem hiding this comment.
Why do you change the names here, if you are willing to do this change, will you also update the names in samples？
There was a problem hiding this comment.
PR created: Azure-Samples/azure-spring-boot-samples#151
|
|
||
| `.` is not supported in secret name. If your application have property name which contain `.`, like `spring.datasource.url`, just replace `.` to `-` when save secret in Azure Key Vault. For example: Save `spring-datasource-url` in Azure Key Vault. In your application, you can still use `spring.datasource.url` to retrieve property value. | ||
|
|
||
| ===== Use property placeholders |
There was a problem hiding this comment.
An other question is,
I think ==== is for title, do you think we should use the same pattern(Style) for titles, refer here.
There was a problem hiding this comment.
Updated.
And I created an issue to update all titles: Azure/azure-sdk-for-java#26458
Resolve Azure/azure-sdk-for-java#25923