mirror of
https://github.com/kevingruesser/bootstrap-vz.git
synced 2025-08-24 07:26:29 +00:00
Fix some links
This commit is contained in:
parent
6980dd6517
commit
65ddee99d7
5 changed files with 39 additions and 36 deletions
|
@ -6,15 +6,15 @@ Sending pull requests
|
||||||
|
|
||||||
Do you want to contribute to the bootstrap-vz project? Nice! Here is the basic workflow:
|
Do you want to contribute to the bootstrap-vz project? Nice! Here is the basic workflow:
|
||||||
|
|
||||||
+ Read the [development guidelines](http://bootstrap-vz.readthedocs.org/en/master/guidelines.html)
|
+ Read the `development guidelines <http://bootstrap-vz.readthedocs.org/en/master/contributing.html#development-guidelines>`__
|
||||||
+ Fork this repository.
|
+ Fork this repository.
|
||||||
+ Make any changes you want/need.
|
+ Make any changes you want/need.
|
||||||
+ Check the coding style of your changes using [tox](http://tox.readthedocs.org/) by running `tox -e flake8`
|
+ Check the coding style of your changes using `tox <http://tox.readthedocs.org/>`__ by running `tox -e flake8`
|
||||||
and fix any warnings that may appear.
|
and fix any warnings that may appear.
|
||||||
This check will be repeated by [Travis CI](https://travis-ci.org/andsens/bootstrap-vz)
|
This check will be repeated by `Travis CI <https://travis-ci.org/andsens/bootstrap-vz>`__
|
||||||
once you send a pull request, so it's better if you check this beforehand.
|
once you send a pull request, so it's better if you check this beforehand.
|
||||||
+ If the change is significant (e.g. a new plugin, manifest setting or security fix)
|
+ If the change is significant (e.g. a new plugin, manifest setting or security fix)
|
||||||
add your name and contribution to the [CHANGELOG](CHANGELOG).
|
add your name and contribution to the `changelog <http://bootstrap-vz.readthedocs.org/en/master/changelog.html>`__.
|
||||||
+ Commit your changes.
|
+ Commit your changes.
|
||||||
+ Squash the commits if needed. For instance, it is fine if you have multiple commits describing atomic units
|
+ Squash the commits if needed. For instance, it is fine if you have multiple commits describing atomic units
|
||||||
of work, but there's no reason to have many little commits just because of corrected typos.
|
of work, but there's no reason to have many little commits just because of corrected typos.
|
||||||
|
@ -61,7 +61,7 @@ value to the bootstrap-vz codebase.
|
||||||
This allows others to easily reproduce any
|
This allows others to easily reproduce any
|
||||||
setup other people are running and makes it possible to share
|
setup other people are running and makes it possible to share
|
||||||
manifests. `The official debian EC2 images <https:/aws.amazon.com/marketplace/seller-
|
manifests. `The official debian EC2 images <https:/aws.amazon.com/marketplace/seller-
|
||||||
profile?id=890be55d-32d8-4bc8-9042-2b4fd83064d5>`_
|
profile?id=890be55d-32d8-4bc8-9042-2b4fd83064d5>`__
|
||||||
for example can be reproduced using the manifests available
|
for example can be reproduced using the manifests available
|
||||||
in the manifest directory of bootstrap-vz.
|
in the manifest directory of bootstrap-vz.
|
||||||
|
|
||||||
|
@ -107,7 +107,7 @@ value to the bootstrap-vz codebase.
|
||||||
This allows other tasks to interleave with the control-flow and add extended
|
This allows other tasks to interleave with the control-flow and add extended
|
||||||
functionality (e.g. because volume creation and mounting are two
|
functionality (e.g. because volume creation and mounting are two
|
||||||
separate tasks, `the prebootstrapped plugin
|
separate tasks, `the prebootstrapped plugin
|
||||||
<http://andsens.github.io/bootstrap-vz/plugins.html#prebootstrapped>`_
|
<http://bootstrap-vz.readthedocs.org/en/master/plugins/prebootstrapped.html>`__
|
||||||
can replace the volume creation task with a task of its own that
|
can replace the volume creation task with a task of its own that
|
||||||
creates a volume from a snapshot instead, but still reuse the mount task).
|
creates a volume from a snapshot instead, but still reuse the mount task).
|
||||||
|
|
||||||
|
@ -152,7 +152,7 @@ guidelines. There however a few exceptions:
|
||||||
+ Ignore ``W191``: Indent with tabs not spaces
|
+ Ignore ``W191``: Indent with tabs not spaces
|
||||||
|
|
||||||
The codebase can be checked for any violations quite easily, since those rules are already specified in the
|
The codebase can be checked for any violations quite easily, since those rules are already specified in the
|
||||||
`tox <http://tox.readthedocs.org/>`_ configuration file.
|
`tox <http://tox.readthedocs.org/>`__ configuration file.
|
||||||
::
|
::
|
||||||
|
|
||||||
tox -e flake8
|
tox -e flake8
|
||||||
|
|
43
README.rst
43
README.rst
|
@ -18,14 +18,14 @@ bootstrapper reached its limits.
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
The end-user documentation for bootstrap-vz is available at
|
The documentation for bootstrap-vz is available at
|
||||||
`andsens.github.io/bootstrap-vz <http://andsens.github.io/bootstrap-vz>`__.
|
`bootstrap-vz.readthedocs.org <http://bootstrap-vz.readthedocs.org/en/master>`__.
|
||||||
There, you can discover `what the
|
There, you can discover `what the
|
||||||
dependencies <http://andsens.github.io/bootstrap-vz/#dependencies>`__
|
dependencies <http://bootstrap-vz.readthedocs.org/en/master/index.html#dependencies>`__
|
||||||
for a specific cloud provider are, `see a list of available
|
for a specific cloud provider are, `see a list of available
|
||||||
plugins <http://andsens.github.io/bootstrap-vz/plugins.html>`__ and
|
plugins <http://bootstrap-vz.readthedocs.org/en/master/plugins>`__ and
|
||||||
learn `how you create a
|
learn `how you create a
|
||||||
manifest <http://andsens.github.io/bootstrap-vz/manifest.html>`__.
|
manifest <http://bootstrap-vz.readthedocs.org/en/master/manifest.html>`__.
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
@ -38,7 +38,7 @@ python dependencies by running ``python setup.py install``. However,
|
||||||
depending on what kind of image you'd like to bootstrap, there are
|
depending on what kind of image you'd like to bootstrap, there are
|
||||||
other debian package dependencies as well, at the very least you will
|
other debian package dependencies as well, at the very least you will
|
||||||
need ``debootstrap``.
|
need ``debootstrap``.
|
||||||
`The documentation <http://andsens.github.io/bootstrap-vz/>`__
|
`The documentation <http://bootstrap-vz.readthedocs.org/en/master>`__
|
||||||
explains this in more detail.
|
explains this in more detail.
|
||||||
|
|
||||||
Note that bootstrap-vz will tell you which tools it requires when they
|
Note that bootstrap-vz will tell you which tools it requires when they
|
||||||
|
@ -68,7 +68,7 @@ VirtualBox Vagrant
|
||||||
root@host:~# pip install termcolor jsonschema fysom docopt pyyaml # Install python dependencies
|
root@host:~# pip install termcolor jsonschema fysom docopt pyyaml # Install python dependencies
|
||||||
root@host:~# bootstrap-vz/bootstrap-vz bootstrap-vz/manifests/virtualbox-vagrant.manifest.yml
|
root@host:~# bootstrap-vz/bootstrap-vz bootstrap-vz/manifests/virtualbox-vagrant.manifest.yml
|
||||||
|
|
||||||
If you want to use the `minimize\_size <dev_Plugins#minimize_size>`__
|
If you want to use the `minimize\_size <http://bootstrap-vz.readthedocs.org/en/master/plugins/minimize_size.html>`__
|
||||||
plugin, you will have to install the ``zerofree`` package and `VMWare
|
plugin, you will have to install the ``zerofree`` package and `VMWare
|
||||||
Workstation <https://my.vmware.com/web/vmware/info/slug/desktop_end_user_computing/vmware_workstation/10_0>`__
|
Workstation <https://my.vmware.com/web/vmware/info/slug/desktop_end_user_computing/vmware_workstation/10_0>`__
|
||||||
as well.
|
as well.
|
||||||
|
@ -113,16 +113,18 @@ Dependencies
|
||||||
------------
|
------------
|
||||||
|
|
||||||
bootstrap-vz has a number of dependencies depending on the target
|
bootstrap-vz has a number of dependencies depending on the target
|
||||||
platform and `the selected plugins <dev_Plugins>`__. At a bare minimum
|
platform and `the selected plugins <http://bootstrap-vz.readthedocs.org/en/master/plugins>`__.
|
||||||
the following python libraries are needed: \*
|
At a bare minimum the following python libraries are needed:
|
||||||
`termcolor <https://pypi.python.org/pypi/termcolor>`__ \*
|
|
||||||
`fysom <https://pypi.python.org/pypi/fysom>`__ \*
|
* `termcolor <https://pypi.python.org/pypi/termcolor>`__
|
||||||
`jsonschema <https://pypi.python.org/pypi/jsonschema>`__ \*
|
* `fysom <https://pypi.python.org/pypi/fysom>`__
|
||||||
`docopt <https://pypi.python.org/pypi/docopt>`__ \*
|
* `jsonschema <https://pypi.python.org/pypi/jsonschema>`__
|
||||||
`pyyaml <https://pypi.python.org/pypi/pyyaml>`__ To bootstrap Debian
|
* `docopt <https://pypi.python.org/pypi/docopt>`__
|
||||||
itself
|
* `pyyaml <https://pypi.python.org/pypi/pyyaml>`__
|
||||||
`debootstrap <https://packages.debian.org/wheezy/debootstrap>`__ is
|
|
||||||
needed as well.
|
To bootstrap Debian itself
|
||||||
|
`debootstrap <https://packages.debian.org/wheezy/debootstrap>`__
|
||||||
|
is needed as well.
|
||||||
|
|
||||||
Any other requirements are dependent upon the manifest configuration
|
Any other requirements are dependent upon the manifest configuration
|
||||||
and are detailed in the corresponding sections of the documentation.
|
and are detailed in the corresponding sections of the documentation.
|
||||||
|
@ -139,7 +141,8 @@ bootstrap-vz internals can be found at
|
||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Contribution guidelines are described on the
|
Contribution guidelines are described in the documentation under
|
||||||
`CONTRIBUTING <CONTRIBUTING.md>`__ file. There's also a `topic on the
|
`Contributing <http://bootstrap-vz.readthedocs.org/en/master/contributing.html>`__.
|
||||||
documentation <http://bootstrap-vz.readthedocs.org/en/development/guidelines.html#coding-style>`__
|
There's also
|
||||||
|
`a topic <http://bootstrap-vz.readthedocs.org/en/master/contributing.html#coding-style>`__
|
||||||
regarding the coding style.
|
regarding the coding style.
|
||||||
|
|
|
@ -7,8 +7,8 @@ once it is done and registers it as an AMI. EBS volume backing only
|
||||||
works on an EC2 host while S3 backed volumes *should* work locally (at
|
works on an EC2 host while S3 backed volumes *should* work locally (at
|
||||||
this time however they do not, a fix is in the works).
|
this time however they do not, a fix is in the works).
|
||||||
|
|
||||||
Unless `the cloud-init plugin <dev_Plugins#cloud_init>`__ is used,
|
Unless `the cloud-init plugin <http://bootstrap-vz.readthedocs.org/en/master/plugins/cloud_init.html>`__
|
||||||
special startup scripts will be installed that automatically fetch the
|
is used, special startup scripts will be installed that automatically fetch the
|
||||||
configured authorized\_key from the instance metadata and save or run
|
configured authorized\_key from the instance metadata and save or run
|
||||||
any userdata supplied (if the userdata begins with ``#!`` it will be
|
any userdata supplied (if the userdata begins with ``#!`` it will be
|
||||||
run).
|
run).
|
||||||
|
|
|
@ -9,4 +9,4 @@ interoperability (e.g.
|
||||||
*should* support vdi files, but since they have no identifier URL not
|
*should* support vdi files, but since they have no identifier URL not
|
||||||
even VirtualBox itself can import them). VirtualBox Guest Additions can
|
even VirtualBox itself can import them). VirtualBox Guest Additions can
|
||||||
be installed automatically if the ISO is `provided in the
|
be installed automatically if the ISO is `provided in the
|
||||||
manifest <dev_Manifest#bootstrapper>`__.
|
manifest <http://bootstrap-vz.readthedocs.org/en/master/manifest.html#bootstrapper>`__.
|
||||||
|
|
|
@ -39,7 +39,7 @@ name of the provider itself.
|
||||||
- **``name``**: target virtualization platform of the installation
|
- **``name``**: target virtualization platform of the installation
|
||||||
*``required``*
|
*``required``*
|
||||||
|
|
||||||
Consult the `providers <dev_Providers>`__ section of the documentation
|
Consult the `providers <http://bootstrap-vz.readthedocs.org/en/master/providers>`__ section of the documentation
|
||||||
for a list of valid values.
|
for a list of valid values.
|
||||||
|
|
||||||
Bootstrapper
|
Bootstrapper
|
||||||
|
@ -76,8 +76,8 @@ are 4 possible settings:
|
||||||
Accepts a list of package names.
|
Accepts a list of package names.
|
||||||
*``optional``*
|
*``optional``*
|
||||||
- **``guest_additions``**: This setting is only relevant for the
|
- **``guest_additions``**: This setting is only relevant for the
|
||||||
`virtualbox provider <dev_Providers#virtualbox>`__. It specifies the
|
`virtualbox provider <http://bootstrap-vz.readthedocs.org/en/master/providers/virtualbox.html>`__.
|
||||||
path to the VirtualBox Guest Additions ISO, which, when specified,
|
It specifies the path to the VirtualBox Guest Additions ISO, which, when specified,
|
||||||
will be mounted and used to install the VirtualBox Guest Additions.
|
will be mounted and used to install the VirtualBox Guest Additions.
|
||||||
*``optional``*
|
*``optional``*
|
||||||
|
|
||||||
|
@ -216,7 +216,7 @@ boot, root and swap.
|
||||||
optional setting overrides the command bootstrap-vz would normally
|
optional setting overrides the command bootstrap-vz would normally
|
||||||
use to format the partition. The command is specified as a string
|
use to format the partition. The command is specified as a string
|
||||||
array where each option/argument is an item in that array (much
|
array where each option/argument is an item in that array (much
|
||||||
like the `image\_commands <dev_Plugins#image_commands>`__ plugin).
|
like the `image\_commands <http://bootstrap-vz.readthedocs.org/en/master/plugins/image_commands.html>`__ plugin).
|
||||||
*``optional``* The following variables are available:
|
*``optional``* The following variables are available:
|
||||||
- **``{fs}``**: The filesystem of the partition.
|
- **``{fs}``**: The filesystem of the partition.
|
||||||
- **``{device_path}``**: The device path of the partition.
|
- **``{device_path}``**: The device path of the partition.
|
||||||
|
@ -237,5 +237,5 @@ Plugins
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
|
||||||
The plugins section is a map of plugin names to whatever configuration a
|
The plugins section is a map of plugin names to whatever configuration a
|
||||||
plugin requires. Go to the `plugin section <dev_Plugins>`__ of the
|
plugin requires. Go to the `plugin section <http://bootstrap-vz.readthedocs.org/en/master/plugins>`__
|
||||||
documentation, to see the configuration for a specific plugin.
|
of the documentation, to see the configuration for a specific plugin.
|
||||||
|
|
Loading…
Add table
Reference in a new issue