mirror of
https://github.com/clearlinux/micro-config-drive.git
synced 2026-08-23 22:45:54 +00:00
Julio Montes
128 lines
3.8 KiB
Groff
128 lines
3.8 KiB
Groff
'\" t
|
|
.TH "CLOUDINIT" "1" "" "cloud-init 1" "cloud-init"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
cloud\-init \- Configures a cloud instance
|
|
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBcloud-init\fR\ 'u
|
|
\fBcloud-init\fR [OPTIONS...]
|
|
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBcloud-init\fR
|
|
has two services: cloud-init-firstboot and cloud-init.
|
|
cloud-init-fistboot service runs during first boot of a new cloud intance,
|
|
with the purpose of configuring the cloud instance for use of the end user.
|
|
cloud-init service runs in each boot after first boot, with the purpose of
|
|
maintaining the cloud instance in a right state (resize/fix partitions and/or
|
|
filesystems, reprocess user data and/or metadata, and more).
|
|
.PP
|
|
Various tasks can be performed, and all are optional. cloud-init can create
|
|
user accounts, user groups, register ssh keys, write content to files,
|
|
perform software update or install new software, and more.
|
|
.RE
|
|
|
|
.SH "OPTIONS"
|
|
.PP
|
|
The following options are understood:
|
|
.PP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
.RS 4
|
|
Prints a help message\&.
|
|
.RE
|
|
.PP
|
|
\fB\-u\fR FILE, \fB\-\-user\-data\-file\fR FILE
|
|
.RS 4
|
|
Path to a cloud-config user data file\&. If omitted, \fBcloud-init\fR will
|
|
attempt to fetch user-data from the openstack link-local connected data
|
|
service URL.
|
|
.RE
|
|
.PP
|
|
\fB\-\-openstack\-metadata\-file\fR FILE
|
|
.RS 4
|
|
Path to an openstack metadata file.
|
|
more information: \%http://docs.openstack.org/user-guide/cli_config_drive.html#openstack-metadata-format
|
|
.RE
|
|
.PP
|
|
\fB\-\-openstack\-config\-drive\fR PATH
|
|
.RS 4
|
|
Path to openstack config drive (iso9660 or vfat filesystem),
|
|
it will be used to process metadata and userdata.
|
|
more information:
|
|
\%http://docs.openstack.org/user-guide/cli_config_drive.html#configuration-drive-contents
|
|
.RE
|
|
.PP
|
|
\fB\-\-user\-data\fR
|
|
.RS 4
|
|
Get and process user data from data sources.
|
|
.RE
|
|
.PP
|
|
\fB\-\-user\-data\-once\fR
|
|
.RS 4
|
|
Only on first boot get and process user data from data sources.
|
|
Note this option is ignored if \fB\-\-user\-data\fR is enabled.
|
|
.RE
|
|
.PP
|
|
\fB\-\-metadata\fR
|
|
.RS 4
|
|
Get and process metadata from data sources.
|
|
.RE
|
|
.PP
|
|
\fB\-\-fix\-disk\fR
|
|
.RS 4
|
|
Fix disk and filesystem if it is needed.
|
|
.RE
|
|
.PP
|
|
\fB\-v\fR, \fB\-\-version\fR
|
|
.RS 4
|
|
Prints version information\&.
|
|
.RE
|
|
|
|
.SH "EXIT STATUS"
|
|
.PP
|
|
On success, 0 is returned, a non\-zero failure code otherwise\&.
|
|
|
|
.SH "COPYRIGHT"
|
|
.PP
|
|
Copyright 2015 Intel Corporation\&. License: Creative Commons
|
|
Attribution\-ShareAlike 3.0 Unported\s-2\u[1]\d\s+2\&.
|
|
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
This project is a limited-functionality implementation of the cloud-init
|
|
specification. The full documentation of the generic implementation is
|
|
available online and can be referenced here:
|
|
.RS 4
|
|
\fBhttps://cloudinit.readthedocs.org/en/latest/\fR
|
|
.RE
|
|
.PP
|
|
The cloud-config format that \fBcloud-init\fR(1) supports is documented
|
|
in \fBcloud-config\fR(5). This lists the options that are supported,
|
|
their structure and function.
|
|
|
|
.SH "NOTES"
|
|
.IP " 1." 4
|
|
Creative Commons Attribution\-ShareAlike 3.0 Unported
|
|
.RS 4
|
|
\%http://creativecommons.org/licenses/by-sa/3.0/
|
|
.RE
|