Skip to content

Commit a349d20

Browse files
docs(slugbuilder-cache): add usage documentation
1 parent 0ef84bc commit a349d20

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

src/applications/managing-app-configuration.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,32 @@ the application to an external PostgreSQL database.
5252
Detachments can be performed with `deis config:unset`.
5353

5454

55+
## Slugbuilder Cache
56+
57+
By default, apps using the [Slugbuilder][] will have caching turned on. This means that Deis will
58+
persist all data being written to `CACHE_DIR` inside the buildpack will be persisted between
59+
deploys. When deploying applications that depend on third-party libraries that have to be fetched,
60+
this could speed up deployments a lot. In order to make use of this, the buildpack must implement
61+
the cache by writing to the cache directory. Most buildpacks already implement this, but when using
62+
custom buildpacks, it might need to be changed to make full use of the cache.
63+
64+
### Disabling and re-enabling the cache
65+
66+
In some cases, cache might not speed up your application. To disable caching, you can set the
67+
`DEIS_DISABLE_CACHE` variable with `deis config:set DEIS_DISABLE_CACHE=1`. When you disable the
68+
cache, Deis will clear up files it created to store the cache. After having it turned off, run
69+
`deis config:unset DEIS_DISABLE_CACHE` to re-enable the cache.
70+
71+
### Clearing the cache
72+
73+
Use the following procedure to clear the cache:
74+
75+
$ deis config:set DEIS_DISABLE_CACHE=1
76+
$ git commit --allow-empty -m "Clearing Deis cache"
77+
$ git push deis # (if you use a different remote, you should use your remote name)
78+
$ deis config:unset DEIS_DISABLE_CACHE
79+
80+
5581
## Custom Health Checks
5682

5783
By default, Workflow only checks that the application starts in their Container. If it is preferred
@@ -179,7 +205,7 @@ TCP Socket Probe: N/A
179205
Configured health checks also modify the default application deploy behavior. When starting a new
180206
Pod, Workflow will wait for the health check to pass before moving onto the next Pod.
181207

182-
208+
[Slugbuilder]: ../understanding-workflow/components.md#builder-builder-slugbuilder-and-dockerbuilder
183209
[attached resources]: http://12factor.net/backing-services
184210
[stores config in environment variables]: http://12factor.net/config
185211
[release]: ../reference-guide/terms.md#release

0 commit comments

Comments
 (0)