1
0
mirror of https://gitlab.alpinelinux.org/alpine/cloud/tiny-cloud.git synced 2026-06-21 00:07:16 +03:00
tiny-cloud/docs/alpine-config.5.scd
2026-05-09 22:06:44 +00:00

90 lines
2.1 KiB
Markdown

ALPINE-CONFIG(5)
# NAME
alpine-config - Alpine-specific tiny-cloud user-data format
# DESCRIPTION
*alpine-config* extends the tiny-cloud-supported *cloud-config*(5) subset with
Alpine-specific package repository and autoinstall features.
The user-data document must begin with the header:
#alpine-config
All keys documented in *cloud-config*(5) are also supported in
*alpine-config*.
# ALPINE EXTENSIONS
*apk.cache*
Set the APK cache directory. tiny-cloud creates the directory and points
_/etc/apk/cache_ at it.
*apk.repositories*
Define repository entries to write to _/etc/apk/repositories_. Supported
fields are *base_url*, *repos*, and *version*.
If *version* is omitted, tiny-cloud derives it from the running Alpine
version when possible. When *apk* is absent and no repository file exists,
tiny-cloud falls back to *setup-apkrepos -1 -c*.
*autoinstall*
Control unattended Alpine installation.
If set to *true*, tiny-cloud selects the largest empty disk automatically and
reboots after installation.
When expressed as a mapping, supported keys are:
*disk*
Target disk path, or *auto*.
*reboot*
Whether to reboot after installation. Defaults to *true*.
*swapsize*
Swap size in megabytes or gigabytes using *M* or *G* suffixes.
*lvm*
When set to *true*, request LVM mode for *setup-disk*.
# NOTES
Because *alpine-config* includes the *cloud-config*(5) subset, you should use
*cloud-config*(5) for shared keys such as *users*, *write_files*, *packages*,
and *runcmd*, and this page for Alpine-specific additions.
# EXAMPLES
A more complete example:
```
#alpine-config
user:
name: alpine
ssh_authorized_keys:
- ssh-ed25519 AAAA... user@example.com
apk:
cache: /var/cache/apk
repositories:
- base_url: https://dl-cdn.alpinelinux.org/alpine
version: edge
repos: [ "main", "community" ]
package_update: true
packages:
- curl
- jq
autoinstall:
disk: auto
reboot: false
```
This example combines shared *cloud-config*(5) keys with Alpine-specific APK
repository configuration and unattended installation settings.
# SEE ALSO
*cloud-config*(5), *tiny-cloud*(8)