From c940b7f979da0e6b41ee9cbe7c345d4136d30c4d Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Tue, 5 Jul 2016 01:17:58 -0400 Subject: [PATCH] Document the repo plugin [ci skip] --- docs/advanced-usage/repository-management.md | 34 ++++++++++++++++++++ docs/deployment/methods/buildpacks.md | 13 +++----- docs/template.html | 1 + 3 files changed, 39 insertions(+), 9 deletions(-) create mode 100644 docs/advanced-usage/repository-management.md diff --git a/docs/advanced-usage/repository-management.md b/docs/advanced-usage/repository-management.md new file mode 100644 index 000000000..936eceb34 --- /dev/null +++ b/docs/advanced-usage/repository-management.md @@ -0,0 +1,34 @@ +# Repository Management + +> New as of 0.6.0 + +``` +repo:gc # Runs 'git gc --agressive' against the application's repo +repo:purge-cache # Deletes the contents of the build cache stored in the repository +``` + +The repository plugin is meant to allow users to perform management commands against a repository. + +# Git Garbage Collection + +This will run a git gc --agressive against the applications repo. This is performed on the Dokku host, and not within an application container. + +```shell +dokku repo:gc node-js-app +``` + +``` +Counting objects: 396, done. +Delta compression using up to 2 threads. +Compressing objects: 100% (365/365), done. +Writing objects: 100% (396/396), done. +Total 396 (delta 79), reused 315 (delta 0) +``` + +## Clearing Application cache + +Building containers with buildpacks currently results in a persistent `cache` directory between deploys. If you need to clear this cache directory for any reason, you may do so by running the following shell command: + +```shell +dokku repo:purge-cache node-js-app +``` diff --git a/docs/deployment/methods/buildpacks.md b/docs/deployment/methods/buildpacks.md index 44130b2c3..f6d38782f 100644 --- a/docs/deployment/methods/buildpacks.md +++ b/docs/deployment/methods/buildpacks.md @@ -82,15 +82,6 @@ importantworker: env QUEUE=important bundle exec rake resque:work The `web` process type holds some significance in that it is the only process type that is automatically scaled to `1` on the initial application deploy. See the [process scaling documentation](/dokku/deployment/process-management/) for more details around scaling individual processes. -## Clearing buildpack cache - -Building containers with buildpacks currently results in a persistent `cache` directory between deploys. If you need to clear this cache directory for any reason, you may do so by running the following shell command: - -```shell -# replace APP with the name of your application -sudo rm -rf /home/dokku/APP/cache/* -``` - ## Curl Build Timeouts Certain buildpacks may time out in retrieving dependencies via curl. This can happen when your network connection is poor or if there is significant network congestion. You may see a message similar to `gzip: stdin: unexpected end of file` after a curl command. @@ -101,3 +92,7 @@ If you see output similar this when deploying , you may need to override the cur dokku config:set --global CURL_TIMEOUT=600 dokku config:set --global CURL_CONNECT_TIMEOUT=30 ``` + +## Clearing buildpack cache + +See the [repository management documentation](/dokku/advanced-usage/repository-management/#clearing-app-cache). diff --git a/docs/template.html b/docs/template.html index f98fb94b6..6061f9ec7 100644 --- a/docs/template.html +++ b/docs/template.html @@ -161,6 +161,7 @@ Event Logs Persistent Storage Proxy Management + Repository Management Community Contributions