Commit Graph

34 Commits

Author SHA1 Message Date
Marcus Schäfer
5702245aa6
Fixed plugin documentation
While setting up the kiwi boxed plugin I realized some small
mistakes in the plugin documentation
2020-04-02 17:13:26 +02:00
Marcus Schäfer
10a02a9d01
Added task plugin documentation
Documentation for developers how to write a custom kiwi
task plugin.
2020-02-27 15:30:00 +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
1550cb8691
Update development documentation
With the latest change to the logger kiwi can now be better
used as an api in other python programs
2019-10-23 17:59:31 +02:00
Marcus Schäfer
ab59d4d217
Delete obsolete repository types
Deleted red-carpet, slack-site, up2date-mirrors, urpmi and yast2
from the allowed values list of the repository type attribute.
This Fixes #1029
2019-04-22 23:15:42 +02:00
Marcus Schäfer
c148d661b9
Deleted pxedeploy section
There is no further demand in the client config creation for the
legacy netboot code. Customers using the netboot initrd already
create the client config.<MAC> file manually or through another
system. With the next generation kiwi we also recommend the disk
based network deployment using the dracut capabilities and marked
the netboot code as still supported but on the legacy stream.
Along with the deletion in the schema the following changes
were also done:

* Deleted use of pxedeploy section in implementation
* Increase schema version to v7.0
* Update documentation on schema version update
* Added xsl stylesheet conversion from v6.9 to v7.0
  Automatic schema version upgrade from v6.9 to v7.0 deletes
  the pxedeploy section from any type specification

This Fixes #19
2019-04-05 14:26:54 +02:00
Marcus Schäfer
8aeaa874c2
Update API documentation
In reference to Refactor OCI images packing the difference
between docker and OCI images is just on packing format.
Thus the extra docker container subclass is no longer present.
2019-03-13 14:39:55 +01:00
Marcus Schäfer
21b4bce5a6
Rebuild schema docs
Create an up to date state of the oxygen schema doc in the repo
2019-03-07 15:46:24 +01:00
Marcus Schäfer
ad5b19a9e2
Fixed Title underline too short warning in the doc 2019-03-07 15:44:35 +01:00
Dan Čermák
2b17684d2c
Add support to build vagrant boxes with the Virtualbox provider
This commits adds initial support to build Vagrant boxes with the Virtualbox
provider.
- The attribute 'provider' of the option <vagrantconfig> now supports the option
  "virtualbox".
- A new boolean attribute 'virtualbox_guest_additions_present' was added to
  <vagrantconfig>. When set to true, KIWI will assume that guest additions have
  been installed into the base image and configure the shared folders to use
  vboxfs, otherwise rsync will be used.

This fixes #532 (https://github.com/SUSE/kiwi/issues/532).
2019-03-05 15:33:18 +01:00
e33f53aa45 Rework package manager selection to use DNF when YUM is requested
YUM v3 is no longer developed, having been superseded by DNF for
several years. With DNF now available as a usable package manager
in Red Hat Enterprise Linux 7 through the Extras channel and
SUSE Linux Enterprise 15 through PackageHub, there is no reason for
keeping support for YUM v3 around.

We are keeping support for requesting YUM because in Red Hat Enterprise
Linux 7, DNF is referred to as "YUM v4", and it is simply referred to
as "YUM" in Red Hat Enterprise Linux 8. To avoid confusion from people,
we're just going to leave it in place as an alias to the DNF package
manager.

As for why this is happening now, Fedora is retiring YUM v3 in
Fedora 31, so we might as well get it over with and cut over now.

Reference: https://fedoraproject.org/wiki/Changes/Retire_YUM_3
2019-02-28 15:09:21 -05:00
Marcus Schäfer
a50c251f5f
Refactor vagrant storage subformat
In preparation to support other vagrant providers a base class
for Vagrant operations has been created. Original Code written
by DanČermák <dcermak@suse.com>
2019-02-21 15:48:05 +01:00
Marcus Schäfer
08b6dd35b5
Rebuild schema documentation 2018-07-16 13:07:21 +02:00
Marcus Schäfer
8e866d6b1f
Rebuild schema documentation 2018-07-16 11:04:05 +02:00
Marcus Schäfer
8668fbbc24
Cleanup api doc strings
This cleans up and fixes the api documentation for
the public interface of the projects storage source code
files and Fixes #698
2018-04-17 10:29:42 +02:00
Marcus Schäfer
1ad29571c1
Update schema version in headline of doc chapter 2018-03-23 10:44:32 +01:00
Marcus Schäfer
7d8df73a31
Rebuild online schema documentation 2018-03-23 10:33:08 +01:00
Marcus Schäfer
678866f9e6 Added iso_tools api documentation 2018-03-16 21:23:26 +01:00
Marcus Schäfer
ef31f2b05f
Rebuild online schema documentation 2018-03-13 15:36:29 +01:00
Marcus Schäfer
2b582a3339
Update schema version in documentation 2018-01-17 10:22:34 +01:00
Marcus Schäfer
a39f527e10
Rebuild schema documentation 2017-12-04 12:33:29 +01:00
Marcus Schäfer
7250655ac2
Rebuild schema documentation 2017-09-22 15:53:43 +02:00
Marcus Schäfer
c44ffc70b5
Rebuild online schema documentation 2017-09-11 17:03:29 +02:00
Marcus Schäfer
170bb9c2fa
Fixup schema version in chapter topic 2017-07-28 14:07:21 +02:00
Marcus Schäfer
ecea0ee1b8
Rebuild schema documentation 2017-07-27 16:54:08 +02:00
Marcus Schäfer
f2df1ae3c4
Rebuild schema documentation 2017-07-24 12:33:08 +02:00
Marcus Schäfer
5ed0ea7486
Update schema documentation 2017-06-29 11:08:13 +02:00
Marcus Schäfer
d9160d4926
Update schema docstring for oem-systemsize 2017-06-21 14:57:43 +02:00
David Cassany
26e15929ab Include imageonly attribute for repositories
This commit adds imageonly attribute support for the repository
element. imageonly is a boolean attribute that if true indicates
that the repository is no used for the build but needs to be
configured for the resulting image.

Fixes #362
2017-06-12 16:46:52 +02:00
David Cassany
753c840e44 Update rpm-check-signatures documentation 2017-06-09 12:33:03 +02:00
David Cassany
02a1b89086 Include repository_gpgcheck and package_gpgcheck documentation 2017-06-08 17:01:16 +02:00
David Cassany
62095aeaf3 Improve package/repository signature checking setup
This commit adds repository_gpgcheck and package_gpgcheck attributes
to the repository tag in schema. With this change each repository
can be configured individualy to enable repository signatures check
and/or enable signature package check. The configuration is done at
repository level, thus it is not conflicting with the wide package
manager configuration flag <rpm-signatures-check>.

Fixes #358
2017-06-08 16:40:20 +02:00
Marcus Schäfer
2046220c07 Refactor documentation layout and structure
The current design of the documentation does not allow for
continous improvement and development. It's missing a basic
structure and concept for documenting step-by-step workflows
and generic explanations.
2017-05-10 16:32:23 +02:00