~smoser/curtin/yakkety.lp1666986

« back to all changes in this revision

Viewing changes to doc/topics/overview.rst

  • Committer: Ryan Harper
  • Date: 2016-09-29 18:31:02 UTC
  • mto: (58.1.1 pkg)
  • mto: This revision was merged to the branch mainline in revision 59.
  • Revision ID: ryan.harper@canonical.com-20160929183102-qwcn73t5h6o0ag3k
Tags: upstream-0.1.0~bzr425
ImportĀ upstreamĀ versionĀ 0.1.0~bzr425

Show diffs side-by-side

added added

removed removed

Lines of Context:
20
20
~~~~~~~~~~~~~~~~~~~~~~~~
21
21
At the moment, curtin doesn't address how the system that it is running on is booted.  It could be booted from a live-cd or from a pxe boot environment.  It could even be booted off a disk in the system (although installation to that disk would probably break things).
22
22
 
23
 
Curtin's assumption is that a fairly rich linux (Ubuntu) environment is booted.
 
23
Curtin's assumption is that a fairly rich Linux (Ubuntu) environment is booted.
24
24
 
25
25
Early Commands
26
26
~~~~~~~~~~~~~~
38
38
 
39
39
Partitioning
40
40
~~~~~~~~~~~~
41
 
Partitioning covers setting up filesystems on the system.  A series of commands are run serially in order.  At the end, a fstab formated file must be populated in ``OUTPUT_FSTAB`` that contains mount information, and the filesystems are expected to be mounted at the ``TARGET_MOUNT_POINT``.
 
41
Partitioning covers setting up filesystems on the system.  A series of commands are run serially in order.  At the end, a fstab formatted file must be populated in ``OUTPUT_FSTAB`` that contains mount information, and the filesystems are expected to be mounted at the ``TARGET_MOUNT_POINT``.
42
42
 
43
43
Any commands can be used to create this filesystem, but curtin contains some tools to facilitate with this process.
44
44
 
45
45
**Config Example**::
46
46
 
47
 
 paritioning_commands:
 
47
 partitioning_commands:
48
48
  10_wipe_filesystems: curtin wipe --quick --all-unused-disks
49
49
  50_setup_raid: curtin disk-setup --all-disks raid0 /
50
50
 
53
53
Partitioning commands have the following environment variables available to them:
54
54
 
55
55
- ``WORKING_DIR``: This is simply for some sort of inter-command state.  It will be the same directory for each command run and will only be deleted at the end of all partitioning_commands.
56
 
- ``OUTPUT_FSTAB``: This is the target path for a fstab file.  After all partitioning commands have been run, a file should exist, formated per fstab(5) that describes how the filesystems should be mounted.
 
56
- ``OUTPUT_FSTAB``: This is the target path for a fstab file.  After all partitioning commands have been run, a file should exist, formatted per fstab(5) that describes how the filesystems should be mounted.
57
57
- ``TARGET_MOUNT_POINT``:
58
58
 
59
59
 
61
61
~~~~~~~~~~~~~~~~~~~~~~~~~~~
62
62
Networking is done in a similar fashion to partitioning.  A series of commands, specified in the config are run.  At the end of these commands, a interfaces(5) style file is expected to be written to ``OUTPUT_INTERFACES``.
63
63
 
64
 
Note, that as with fstab, this file is not copied verbatum to the target filesystem, but rather made availble to the OS customization stage.  That stage may just copy the file verbatum, but may also parse it, and use that as input.
 
64
Note, that as with fstab, this file is not copied verbatim to the target filesystem, but rather made available to the OS customization stage.  That stage may just copy the file verbatim, but may also parse it, and use that as input.
65
65
 
66
66
**Config Example**::
67
67
 
73
73
Networking commands have the following environment variables available to them:
74
74
 
75
75
- ``WORKING_DIR``: This is simply for some sort of inter-command state.  It will be the same directory for each command run and will only be deleted at the end of all network_commands.
76
 
- ``OUTPUT_INTERFACES``: This is the target path for an interfaces style file. After all commands have been run, a file should exist, formated per interfaces(5) that describes the systems network setup.
 
76
- ``OUTPUT_INTERFACES``: This is the target path for an interfaces style file. After all commands have been run, a file should exist, formatted per interfaces(5) that describes the systems network setup.
77
77
 
78
78
Extraction of sources
79
79
~~~~~~~~~~~~~~~~~~~~~
84
84
 sources:
85
85
  05_primary: http://cloud-images.ubuntu.com/releases/precise/release/ubuntu-12.04-server-cloudimg-amd64-root.tar.gz
86
86
 
87
 
Given the source above, curtin will essentiall do a::
 
87
Given the source above, curtin will essentially do a::
88
88
 
89
89
 wget $URL | tar -Sxvzf 
90
90