Commit Graph

87 Commits

Author SHA1 Message Date
Marcus Schäfer
44a1d78e96
Added new image type: wsl
Support for building appx container images for
Windows Subsystem Linux (WSL). This Fixes #1235
2020-03-26 19:42:25 +01:00
Marcus Schäfer
f6f77b3162
Fixup documentation for consistency
There is the legacy kiwi version and there is this kiwi(next generation).
From a documentation perspective there are several inconsistencies that
could confuse users. This commit makes the name for KIWI-NG consistent
across the entire documentation. At places where we point to older
documentation we use the term Legacy KIWI and a link to the documentation
that covers this part. All this is needed in preparation to cleanup the
documentation situation for the SUSE documentation but with respect to
the upstream doc sources, their layout and markup.
2020-02-19 18:01:14 +01:00
Marcus Schäfer
89226abd46
Addded doc_suse tox target to build docbook target
SUSE documentation is based on docbook or asciidoc. The kiwi
documentation is maintained along with the code and uses the
sphinx system and therefore ReST as markup language. We would
like to keep one source and don't want to move to another markup
language. Thus the sources needs to be structured in a way that
allows translation into sphinx supported targets as well as
into SUSE docbook style. This commit changes the documentation
structure in a way that both is possible. With the use of Sphinx
XML and rstxml2docbook the ReST docs are converted into docbook.
From there the SUSE daps tool can create SUSE documentation
2020-02-14 15:14:30 +01:00
Marcus Schäfer
e35a0356a8
Make PXE oem deployment genericly useable
When deploying a disk image via PXE the initrd contained a config
file which connects it to a certain image. This has the disadvantage
that no other image could be deployed with it. This commit changes the
deployment code in a way that the config file is read from the
network if the disk is deployed via PXE. The tarball created by
kiwi provides the image connected config file but users now have
the opportunity to create their own boot configurations which allows
deployment of different images with the same kiwi built deployment
initrd. This Fixes #1298 and is one first step into a more generic
PXE support offered by kiwi.
2020-01-21 12:10:33 +01:00
Marcus Schäfer
0aa2ff0052
Update documentation
Link paths to the integration tests has changed
2019-10-23 12:22:14 +02:00
Marcus Schäfer
498b73b147
Merge pull request #1207 from OSInside/rename_pxe_install_files
Add information in PXE install files
2019-09-25 15:24:03 +02:00
Marcus Schäfer
7d55280751
Update kiwi live ISO chapter
Compare overlay vs.dmsquash live ISO modules by their
features to allow customers a proper selection of the
module. This Fixes #1158
2019-09-25 10:29:45 +02:00
David Cassany
f4bd52df39
Update documentation to the PXE install file names 2019-09-23 16:26:34 +02:00
Marcus Schäfer
7d3f169865
Update documentation regarding fstab adaptions 2019-08-26 17:58:33 +02:00
Marcus Schäfer
f030880cc6
Extended LUKS encryption support
We supported luks encrypted images with the exception of the
boot partition because grub was not able to read from an
encrypted device at that time. Since some time grub is able
to read from an encrypted partition and this commit add
support for it. With this patch luks encrypted images will
no longer create an extra boot partition and the entire
system will be encrypted. The opening of the luks container
happens on the grub level only once. Customers can still
specify to use an unencrypted extra boot partition with the
bootpartition="true" flag. In this case the opening of the
luks containers happens on the systemd level as before.
This is related to Issue #1162
2019-08-19 16:10:09 +02:00
Marcus Schäfer
70bc4fdda1
Update documentation
The kiwi-descriptions repository has been moved into the
OSInside organisation
2019-07-10 15:15:58 +02:00
Dan Čermák
df5ebd2f70
[doc] Add user documentation about the usage of the embedded Vagrantfile
- Document the usage of the `vagrantconfig.embedded_vagrantfile` attribute
- Remove the suggestion to generate the ssh keys during image creation (this
  results in **all** boxes having the same ssh host keys, which is pretty
  dangerous if someone would use a vagrant box in a production environment.)
- Stop recommending veewee, this project is dead
- Replace forgotten hard coded number with {schema_version}
2019-07-05 11:23:02 +02:00
Marcus Schäfer
1d3b9a077f
Update documentation for consistency
Instead of hard coded names for example images and their
versions a prolog map including placeholders has been
added.
2019-05-27 18:04:47 +02:00
Dan Čermák
8046087c96
Split overview/workflow.rst into multiple files
Co-Authored-By: Thomas Schraitle <tom_schr@web.de>
2019-05-24 08:50:09 +02:00
Marcus Schäfer
2c2516988b
Update obs docs per review by Tom 2019-05-23 15:34:39 +02:00
Dan Čermák
8e20deec75
Extend docs about building multiple profiles on OBS 2019-05-13 17:17:02 +02:00
Dan Čermák
ea33b40813
Improve the documentation about building in the Build Service
Co-Authored-By: Thomas Schraitle <tom_schr@web.de>
2019-05-10 12:56:49 +02:00
Dan Čermák
ecaaed4480
Add documentation of the XML schema in a tutorial like fashion
Co-Authored-By: Thomas Schraitle <tom_schr@web.de>
2019-05-02 09:55:05 +02:00
Marcus Schäfer
799b809589
Merge pull request #1073 from SUSE/disk_volume_docs
Extend the documentation of Custom Disk Volumes
2019-05-01 12:33:46 +02:00
Marcus Schäfer
7b40fd6f5d
Fixing doc source for broken refs and xml syntax 2019-04-25 16:40:39 +02:00
Marcus Schäfer
806e7cba5a
Merge pull request #1072 from SUSE/vmx_documentation
Add documentation how to configure VMX build types
2019-04-25 16:15:42 +02:00
Dan Čermák
43d73f53ab
Document the usage of profiles via the CLI and OBS 2019-04-24 22:57:24 +02:00
Dan Čermák
930bd9a5ea
Extend live ISO documentation 2019-04-24 22:57:06 +02:00
Dan Čermák
2f41edcb20
Minor improvements to the documentation
- add a newline to the workflow's abstract
- add warning to installation via the distro's package manager
- fix package name of git
- add marker for `Installation from OBS` section
2019-04-24 22:56:53 +02:00
Tom Schraitle
1c71e92724
Apply suggestions from @tomschr
Co-Authored-By: dcermak <45594031+dcermak@users.noreply.github.com>
2019-04-24 22:40:00 +02:00
Dan Čermák
58ba6df11e
Extend the documentation of Custom Disk Volumes 2019-04-24 22:39:54 +02:00
Tom Schraitle
b76e8314a6
Apply suggestions from @tomschr
Co-Authored-By: dcermak <45594031+dcermak@users.noreply.github.com>
2019-04-24 15:33:19 +02:00
Dan Čermák
bba1854e4c
Add documentation how to configure VMX build types 2019-04-24 14:36:42 +02:00
Marcus Schäfer
68d28cb81f
Fixed build_in_buildservice stale references
Fixed style issues reported on sphinx build. Also deleted
pointers to non existing references
2019-04-22 21:57:22 +02:00
Tom Schraitle
30ac2f4531 Update doc/source/building/build_in_buildservice.rst
Co-Authored-By: dcermak <45594031+dcermak@users.noreply.github.com>
2019-04-16 17:54:29 +02:00
Dan Čermák
5bc3dbcdd0
Rework documentation about building on OBS 2019-04-16 13:27:42 +02:00
David Cassany
77b3089791
Fix xml syntax on documentation example 2019-04-10 17:13:58 +02:00
David Cassany
50fb671122
Add custom curl options docs 2019-04-10 12:18:57 +02:00
Marcus Schäfer
d0f4b2c1ca
Doc fix for lex literal_block as xml 2019-04-02 16:24:16 +02:00
Marcus Schäfer
2c319fdac1
Added doc chapter on Fstab modifications 2019-03-25 15:04:40 +01:00
Dan Čermák
5b21158528
Add warning about a missing /vagrant/ folder to the documentation 2019-03-21 12:24:11 +01:00
Marcus Schäfer
8992a28565
Update the documentation regarding vagrant boxes
Extend the documentation on how to build VirtualBox vagrant boxes
All this was done by Dan Čermák <dcermak@suse.com>
2019-03-15 15:46:32 +01:00
Marcus Schäfer
94a006d8ba
Update provider support status in vagrant docs 2019-03-07 15:54:05 +01:00
Marcus Schäfer
921fa17f4f
Fixed permanent redirect links in documentation 2019-03-07 15:38:13 +01:00
Dan Čermák
207e8d4034
Extend documentation about using KIWI to build vagrant images 2019-03-07 13:33:55 +01:00
Dan Čermák
d9b1bb3dc8
Extend documentation on how to build inside OBS 2019-03-07 13:33:48 +01:00
David Cassany
72a63f0b16
Add custom partitioning docs
This commit adds two new documentation chapters. One covering
custom partitioning scheme in KIWI. And another covering setting
custom volumes in KIWI
2019-02-04 16:38:50 +01:00
Marcus Schäfer
a3765fd448
Fixed azurectl redirect in documentation 2018-11-05 12:03:36 +01:00
Marcus Schäfer
9e6a2698ae
Added Deploy and Run System in a RamDisk docu 2018-11-04 17:17:06 +01:00
Marcus Schäfer
6f607df516
Fixup zypper calls in documentation
The way the documentation describes the zypper call to add
a repository was wrong in several places.
2018-10-09 10:44:03 +02:00
Marcus Schäfer
b702873e37
Fixed broken link to ec2uploadimg tool 2018-09-29 21:37:46 +02:00
Marcus Schäfer
3b30a2edc9
Fixed dice documentation
The chapter: Building in a Self-Contained Environment holds
a fixed ruby version in the package install which was outdated.
It also still referenced the container as tar.xz but we have
changed to uncompressed containers by default a while back
2018-09-12 09:55:18 +02:00
Marcus Schäfer
0baeedc8c3
Update pxe server setup documentation
Delete the suggested modifications to /etc/sysconfig/atftpd
and trust the defaults provided by the package
2018-08-08 18:02:59 +02:00
Marcus Schäfer
dbb46178d3
Added doc chapter for remote live boot 2018-08-08 09:41:23 +02:00
Marcus Schäfer
6028e406b2
Update vagrant doc chapter redirect links 2018-08-06 12:23:52 +02:00