Local APK cache: Difference between revisions

From Alpine Linux
(use Cmd template)
(cleaned up headlines organized content. removed information related to older versions ( already commented out))
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<!-- NOTE This page ([[Local_APK_cache]]) also gets included at [[Alpine_Linux_package_management#Local_Cache]] to avoid duplication. -->
<!-- NOTE This page ([[Local_APK_cache]]) also gets included at [[Alpine_Linux_package_management#Local_Cache]] to avoid duplication. -->
=== Overview ===
=== Overview ===


To have the packages available during boot, apk can keep a cache of installed packages on a local disk.
APK can keep a cache of installed packages on a local disk.  


Added packages can then be automatically (re-)installed from local media into RAM when booting, without requiring, and even before there is a network connection.
In [[Installation#Diskless_Mode|diskless]] installations, since these packages are available during boot, packages can then be automatically (re-)installed from local media into RAM when booting, without requiring, and even before there is a network connection. The cache can be stored on any writable media, or at the same location as the .apkovl file from the [[Alpine_local_backup| local backup utility <code>lbu</code>]].


The cache can be stored on any writable media, or at the same location as the .apkovl file from the [[Alpine_local_backup| local backup utility <code>lbu</code>]].
HDD or [[Installation#System_Disk_Mode|sys mode]] installs don't need an apk cache to maintain their state, it still allows to serve packages over the network, though, e.g. to get installed by other local machines.


=== Enabling Local Cache ===


=== Enabling Local Cache with current releases ===
Execute the script <code>setup-apkcache</code> will assist in enabling a local cache. The script creates a symlink named {{Path|/etc/apk/cache}} that points to the cache directory.
{{Cmd|setup-apkcache}}


Execute the script {{Cmd|setup-apkcache}} and it will assist in enabling a local cache.
Cache can also be manually enabled by creating a cache dir and then symlink it to {{Path|/etc/apk/cache}}:
{{Cmd|mkdir -p /var/cache/apk
ln -s /var/cache/apk /etc/apk/cache}}


The script creates a symlink named ''/etc/apk/cache'' that points to the cache directory.
On a [[Installation#Diskless_Mode|diskless]] installation, to make the disk where the cache directory is present be automatically mounted at boot create an empty file {{Path|.boot_repository}} inside the cache directory.
 
{{Tip|On a diskless installation, to make the disk where the cache directory is present be automatically mounted at boot you can create an empty file ''.boot_repository'' inside the cache directory.}}


=== Cache maintenance ===
=== Cache maintenance ===
Line 37: Line 37:


{{Cat|/etc/local.d/cache.stop|#!/bin/sh
{{Cat|/etc/local.d/cache.stop|#!/bin/sh


# verify the local cache on shutdown
# verify the local cache on shutdown
Line 48: Line 47:
{{Tip|Usually the only time you need to reboot is when things have gone horribly wrong; so this is a "best effort" to cover forgetting to sync the cache; It is much better to run '''sync''' immediately after adding or upgrading packages.}}
{{Tip|Usually the only time you need to reboot is when things have gone horribly wrong; so this is a "best effort" to cover forgetting to sync the cache; It is much better to run '''sync''' immediately after adding or upgrading packages.}}


{{Note|Custom shutdown commands were formerly added to a {{Path|/etc/conf.d/local}}; but that method is now deprecated.}}
=== Local Cache on tmpfs volumes ===
 
 
 
 
=== Special Caching Configurations ===
 
==== Enabling Local Cache on HDD installs ====
 
Note that HDD 'sys' installs don't need an apk cache to maintain their state, it allows to serve packages over the network, though, e.g. to get installed by other local machines.
 
Manually create a cache dir and then symlink it to ''/etc/apk/cache'':
{{Cmd|mkdir -p /var/cache/apk
ln -s /var/cache/apk /etc/apk/cache}}
 
==== Local Cache on tmpfs volumes ====


In some circumstances it might be useful to have the cache reside on tmpfs, for example if you only wish for it to last as long as the system is up.
In some circumstances it might be useful to have the cache reside on tmpfs, for example if you only wish for it to last as long as the system is up.
Line 69: Line 53:
NOTE: ''apk'' is coded to ignore tmpfs caches, and this is correct behaviour in most instances. Using tmpfs as a package cache can consume large amounts of system memory if you install a lot of packages, possibly resulting in a crashed system. You can limit this by restricting the size of your cache to a small number (128M in the example below).
NOTE: ''apk'' is coded to ignore tmpfs caches, and this is correct behaviour in most instances. Using tmpfs as a package cache can consume large amounts of system memory if you install a lot of packages, possibly resulting in a crashed system. You can limit this by restricting the size of your cache to a small number (128M in the example below).


To do it, you need to create an image inside which your cache can live. We do this by creating an image file, formatting it with ext2, and mounting it at ''/etc/apk/cache''.
To do it, you need to create an image inside which your cache can live. We do this by creating an image file, formatting it with ext2, and mounting it at {{Path|/etc/apk/cache}}.
{{Cmd|<nowiki>apk add e2fsprogs
{{Cmd|<nowiki>apk add e2fsprogs
dd if=/dev/zero of=/apkcache.img bs=1M count=128
dd if=/dev/zero of=/apkcache.img bs=1M count=128
Line 78: Line 62:


As usual, if you want to download currently installed packages into the cache, use ''apk cache sync''.
As usual, if you want to download currently installed packages into the cache, use ''apk cache sync''.
==== Manually Enabling Local Cache (required for releases prior to v2.3) ====
# Create a '''cache''' directory on the storage device where you keep the lbu backups (typically, <code>/dev/sda1</code>.)  {{Cmd| mkdir /media/sda1/cache }}
{{Tip|If you get an error that says "mkdir: can't create directory '/media/usbdisk/cache': Read-only file system", then you probably need to remount your disk read-write temporarily.  Try {{Cmd|mount -o remount,rw /media/sda1}} and then don't forget to run {{Cmd|mount -o remount,ro /media/sda1}} when you are done with the following commands}}
# Create a symlink to this directory from <code>/etc/apk/cache</code>.  {{Cmd|ln -s /media/sda1/cache /etc/apk/cache}}
# Run an lbu commit to save the change (<code>/etc/apk/cache</code> is in <code>/etc</code> and is automatically backed up.) {{Cmd|lbu commit}}
{{Tip|If you needed to remount your disk read-write before, run {{Cmd|mount -o remount,ro /media/sda1}} now that you are done with saving the changes}}
Now whenever you run an apk command that pulls a new package from a remote repository, the package is stored on your local media.  On startup, Alpine Linux will check the local cache for new packages, and will install them if available.
<!--
== Enabling Package Caching (Older) ==
{{Note|This document applies to Alpine 1.9 and later versions only}}
Package caching is useful when the need arises to upgrade packages on read-only media. Package caching allows you to store newer packages in a location on writable media, which Alpine checks for when loading packages on start-up.
This can be enabled either from the console or through the ACF.
{{Tip|For package upgrades, it is useful to point Alpine Package Manager to repositories on the internet, to easily obtain package upgrades when they become available.}}
{{:Include:Using_Internet_Repositories_for_apk-tools}}
== Enable caching from either console or ACF ==
Choose one of the two methods below to enable, either from the console or from the ACF web interface.
=== Option 1: Enable caching from the console ===
''Substitute 'sda1' in the example below for the actual device you will use to store the caching directory.''
First upgrade apk-tools:
{{Cmd|apk add –u apk-tools}}
Now enable package caching:
{{Cmd|mkdir –p /media/sda1/cache
ln –s /media/sda1/cache /etc/apk/cache}}
=== Option 2: From the ACF ===
Browse to '''System > Packages > Cache'''
''Edit Cache Settings:''
Tick '''Enable Cache'''
Specify the '''Cache Directory''', for example:
/media/sda1/cache
Click '''Save'''
-->


[[Category:Package Manager]]
[[Category:Package Manager]]

Latest revision as of 10:45, 12 October 2024

Overview

APK can keep a cache of installed packages on a local disk.

In diskless installations, since these packages are available during boot, packages can then be automatically (re-)installed from local media into RAM when booting, without requiring, and even before there is a network connection. The cache can be stored on any writable media, or at the same location as the .apkovl file from the local backup utility lbu.

HDD or sys mode installs don't need an apk cache to maintain their state, it still allows to serve packages over the network, though, e.g. to get installed by other local machines.

Enabling Local Cache

Execute the script setup-apkcache will assist in enabling a local cache. The script creates a symlink named /etc/apk/cache that points to the cache directory.

setup-apkcache

Cache can also be manually enabled by creating a cache dir and then symlink it to /etc/apk/cache:

mkdir -p /var/cache/apk ln -s /var/cache/apk /etc/apk/cache

On a diskless installation, to make the disk where the cache directory is present be automatically mounted at boot create an empty file .boot_repository inside the cache directory.

Cache maintenance

Removing older packages

When newer packages are added to the cache over time, the older versions of the packages default to remain in the cache directory.

The older versions of packages can be removed with the clean command.

apk cache clean

Or to see what is deleted include the verbose switch:

apk -v cache clean

Download missing packages

If you accidentally delete packages from the cache directory, you can make sure they are there with the download command,

apk cache download

Delete and download in one step

You can combine the two steps into one with the sync command - this cleans out old packages and downloads missing packages.

apk cache -v sync

Automatically Cleaning Cache on Reboot

To automatically attempt to validate your cache on reboot, you can add the above command to a /etc/local.d/*.stop file:

Contents of /etc/local.d/cache.stop

#!/bin/sh # verify the local cache on shutdown apk cache -v sync # We should always return 0 return 0
Tip: Usually the only time you need to reboot is when things have gone horribly wrong; so this is a "best effort" to cover forgetting to sync the cache; It is much better to run sync immediately after adding or upgrading packages.

Local Cache on tmpfs volumes

In some circumstances it might be useful to have the cache reside on tmpfs, for example if you only wish for it to last as long as the system is up.

NOTE: apk is coded to ignore tmpfs caches, and this is correct behaviour in most instances. Using tmpfs as a package cache can consume large amounts of system memory if you install a lot of packages, possibly resulting in a crashed system. You can limit this by restricting the size of your cache to a small number (128M in the example below).

To do it, you need to create an image inside which your cache can live. We do this by creating an image file, formatting it with ext2, and mounting it at /etc/apk/cache.

apk add e2fsprogs dd if=/dev/zero of=/apkcache.img bs=1M count=128 mkfs.ext2 -F /apkcache.img mkdir -p /etc/apk/cache mount -t ext2 /apkcache.img /etc/apk/cache apk update

As usual, if you want to download currently installed packages into the cache, use apk cache sync.

Retrieved from "https://wiki.alpinelinux.org/w/index.php?title=Local_APK_cache&oldid=27527"