Skip to content

Commit f2a5358

Browse files
authored
Merge pull request #15 from IBM/saikumar1607-patch-1
Update README.md
2 parents 0854c05 + 25a3ad6 commit f2a5358

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,15 @@ appConfiguration.SetContext(collectionId, environmentId, AppConfiguration.Contex
9191
```
9292

9393
* PersistentCacheDirectory: Absolute path to a directory which has read & write permission for the user. The SDK will
94-
create a file - `AppConfiguration.json` in the specified directory, and it will be used as the persistent cache to
94+
create a file - `appconfiguration.json` in the specified directory, and it will be used as the persistent cache to
9595
store the App Configuration service information.
9696

9797
When persistent cache is enabled, the SDK will keep the last known good configuration at the persistent cache. In the
9898
case of App Configuration server being unreachable, the latest configurations at the persistent cache is loaded to the
9999
application to continue working.
100100

101+
Please ensure that the cache file is not lost or deleted in any case. For example, consider the case when a kubernetes pod is restarted and the cache file (appconfiguration.json) was stored in ephemeral volume of the pod. As pod gets restarted, kubernetes destroys the ephermal volume in the pod, as a result the cache file gets deleted. So, make sure that the cache file created by the SDK is always stored in persistent volume by providing the correct absolute path of the persistent directory.
102+
101103
### (Optional)
102104

103105
The SDK is also designed to serve configurations, perform feature flag & property evaluations without being connected to

0 commit comments

Comments
 (0)