al/tiny-cloud
al/tiny-cloud
1
0
Fork 0
mirror of https://gitlab.alpinelinux.org/alpine/cloud/tiny-cloud.git synced 2025-12-14 19:02:45 +03:00
Code Packages Wiki

Update/Tweak Docs

Browse Source
This commit is contained in:
Jake Buchholz Göktürk 2024-11-04 17:47:30 +00:00
parent b8218bd1f0
commit 1ea16dc7b3
4 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CHANGELOG.md
View File

@ -1,20 +1,31 @@
# CHANGELOG # CHANGELOG
## 2024-10-XX - Tiny Cloud v3.0.8 ## 2024-11-04 - Tiny Cloud v3.0.8
* Officially add Makefile targets and flesh out tests for newer cloud modules: * Officially add Makefile targets and flesh out tests for newer cloud modules:
`hetzner` (@hmrodrigues), `incus` (@ncopa), and `scaleway` (@hmrodrigues). `hetzner` (@hmrodrigues), `incus` (@ncopa), and `scaleway` (@hmrodrigues).
* `cloud-config` user-data handler has been fleshed out with a ***subset*** of
functionality, allowing the use of some common `#cloud-config` user-data
configuration.
* `alpine-config` user-data handler has been reimplemented as an extension of
`cloud-config`, adding management of APK repositories and Alpine autoinstall.
* Remove deprecated hotplug modules. `nvme-ebs-symlinks` has been deprecated * Remove deprecated hotplug modules. `nvme-ebs-symlinks` has been deprecated
since v3.0.0, and `imds-net-sync` hasn't been supported for AWS since since v3.0.0, and `imds-net-sync` hasn't been supported for AWS since
tiny-cloud-network-2.2.2-r0 in Alpine Linux 3.17. tiny-cloud-network-2.2.2-r0 in Alpine Linux 3.17.
* Remove code related to the installation/testing of hotplug modules. * Remove code related to the installation/testing of hotplug modules.
## 2023-09-25 - Tiny Cloud v3.0.2 ## 2023-09-25 - Tiny Cloud v3.0.2
* Replace non-functioning `tiny-cloud --setup` with working `--enable` and * Replace non-functioning `tiny-cloud --setup` with working `--enable` and
`--disable` to enable/disable the set of Tiny Cloud init scripts. `--disable` to enable/disable the set of Tiny Cloud init scripts.
* Reload user-data if bootstrap is incomplete, even if previous user-data file * Reload user-data if bootstrap is incomplete, even if previous user-data file
exists. exists.
* Init actions that fail should cause `tiny-cloud` to also terminate with an * Init actions that fail should cause `tiny-cloud` to also terminate with an
error. error.

2
LICENSE.txt
View File

@ -1,4 +1,4 @@
Copyright (c) 2017-2023 Jake Buchholz Göktürk, Michael Crute Copyright (c) 2017-2024 Jake Buchholz Göktürk, Michael Crute
Permission is hereby granted, free of charge, to any person obtaining a copy of Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in this software and associated documentation files (the "Software"), to deal in

14
README.md
View File

@ -15,7 +15,7 @@ works with multiple cloud providers. Currently, the following are supported:
* [Incus](https://linuxcontainers.org/incus) - Incus Containers and Virtual Machines * [Incus](https://linuxcontainers.org/incus) - Incus Containers and Virtual Machines
* [NoCloud]( * [NoCloud](
https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html
) - cloud-init's NoCloud AWS-compatible user provided data source ) - cloud-init's NoCloud provider (AWS-compatible metadata)
* [OCI](https://cloud.oracle.com) - Oracle Cloud Infrastructure * [OCI](https://cloud.oracle.com) - Oracle Cloud Infrastructure
[Scaleway](https://www.scaleway.com) - Scaleway Cloud [Scaleway](https://www.scaleway.com) - Scaleway Cloud
@ -37,7 +37,7 @@ instance:
runlevel runlevel
* mark the bootstrap of the instance as "complete" * mark the bootstrap of the instance as "complete"
Other cloud- and user-data-specific actions may also occur. Other cloud specific and user-data handler specific actions may also occur.
Also included is a handy `imds` client script for easy access to an instance's Also included is a handy `imds` client script for easy access to an instance's
IMDS data. IMDS data.
@ -84,7 +84,7 @@ That's it! On the next boot, Tiny Cloud will bootstrap the instance.
## Configuration ## Configuration
By default, Tiny Cloud expects configuration at `/etc/tiny-cloud.conf`, By default, Tiny Cloud expects configuration at `/etc/tiny-cloud.conf`,
The stock [lib/tiny-cloud/tiny-cloud.conf`](lib/tiny-cloud/tiny-cloud.conf) The stock [`lib/tiny-cloud/tiny-cloud.conf`](lib/tiny-cloud/tiny-cloud.conf)
file contains details of all tuneable settings. file contains details of all tuneable settings.
_Because Tiny Cloud does not universally do auto-detection, you may need to set _Because Tiny Cloud does not universally do auto-detection, you may need to set
@ -103,9 +103,9 @@ instance in four phases...
### Boot Phase ### Boot Phase
This phase does not depend on the cloud provider's Instance Meta-Data Service This phase does not depend on the cloud provider's Instance Meta-Data Service
(IMDS), and does not require networking to be up. `mdev` hotplug modules are (IMDS), and does not require networking to be up. Default networking
installed (if any), default networking confinguration is set up, `sshd` is confinguration is set up, `sshd` is enabled (but not started), and the root
enabled (but not started), and the root partition is expanded. partition is expanded.
### Early Phase ### Early Phase
@ -133,7 +133,7 @@ phase.
The very last thing to be run in the **default** runlevel this phase will The very last thing to be run in the **default** runlevel this phase will
execute the saved User-Data, if it is a script starting with `#!`; its output execute the saved User-Data, if it is a script starting with `#!`; its output
(combined STDOUT and STDER) and exit code are saved to `/var/log/user-data.log` (combined STDOUT and STDERR) and exit code are saved to `/var/log/user-data.log`
and `/var/log/user-data.exit`. and `/var/log/user-data.exit`.
Additional final phase actions may be taken if there is a User-Data handler Additional final phase actions may be taken if there is a User-Data handler

4
TODO.md
View File

@ -2,8 +2,12 @@
## SOON-ish ## SOON-ish
* Move things around a little for the "/usr merge" project.
* Support cloud auto-detection, where it's possible to do so. * Support cloud auto-detection, where it's possible to do so.
* Test improvements - each user-data handler should be tested with each cloud.
## FUTURE ## FUTURE
* Support additional features of `#cloud-config` as needed * Support additional features of `#cloud-config` as needed