mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Doc updates
This commit is contained in:
parent
b68f81a727
commit
e086d6fd89
16 changed files with 76 additions and 42 deletions
|
@ -134,6 +134,8 @@ $(window).ready(set_max_menu_height);
|
||||||
|
|
||||||
{%- block footer %}
|
{%- block footer %}
|
||||||
<footer class="footer">
|
<footer class="footer">
|
||||||
|
<center>
|
||||||
|
<a href="http://ansibleworks.com"><img src="http://ansible.cc/img/AnsibleWorks.png" alt="AnsibleWorks"></a>
|
||||||
<p>
|
<p>
|
||||||
{%- if show_copyright %}
|
{%- if show_copyright %}
|
||||||
{%- if hasdoc('copyright') %}
|
{%- if hasdoc('copyright') %}
|
||||||
|
@ -147,6 +149,7 @@ $(window).ready(set_max_menu_height);
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
</center>
|
||||||
</footer>
|
</footer>
|
||||||
{%- endblock %}
|
{%- endblock %}
|
||||||
|
|
||||||
|
|
|
@ -25,7 +25,7 @@ sys.path.insert(0, os.path.join('ansible', 'lib'))
|
||||||
sys.path.append(os.path.abspath('_themes'))
|
sys.path.append(os.path.abspath('_themes'))
|
||||||
|
|
||||||
VERSION='0.01'
|
VERSION='0.01'
|
||||||
AUTHOR='Michael DeHaan'
|
AUTHOR='AnsibleWorks'
|
||||||
|
|
||||||
|
|
||||||
# General configuration
|
# General configuration
|
||||||
|
@ -51,7 +51,7 @@ master_doc = 'index'
|
||||||
|
|
||||||
# General substitutions.
|
# General substitutions.
|
||||||
project = 'Ansible Documentation'
|
project = 'Ansible Documentation'
|
||||||
copyright = "2012 Michael DeHaan"
|
copyright = "2013 AnsibleWorks"
|
||||||
|
|
||||||
# The default replacements for |version| and |release|, also used in various
|
# The default replacements for |version| and |release|, also used in various
|
||||||
# other places throughout the built documents.
|
# other places throughout the built documents.
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
YAML Syntax
|
YAML Syntax
|
||||||
===========
|
===========
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
This page provides a basic overview of correct YAML syntax, which is how Ansible
|
This page provides a basic overview of correct YAML syntax, which is how Ansible
|
||||||
playbooks (our configuration management language) are expressed.
|
playbooks (our configuration management language) are expressed.
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
API & Integrations
|
API & Integrations
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
There are several interesting ways to use Ansible from an API perspective. You can use
|
There are several interesting ways to use Ansible from an API perspective. You can use
|
||||||
the Ansible python API to control nodes, you can extend Ansible to respond to various python events,
|
the Ansible python API to control nodes, you can extend Ansible to respond to various python events,
|
||||||
and you can plug in inventory data from external data sources. Ansible is written in its own
|
and you can plug in inventory data from external data sources. Ansible is written in its own
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
Best Practices
|
Best Practices
|
||||||
==============
|
==============
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
Here are some tips for making the most of Ansible.
|
Here are some tips for making the most of Ansible.
|
||||||
|
|
||||||
You can find some example playbooks illustrating these best practices in our `ansible-examples repository <https://github.com/ansible/ansible-examples>`_.
|
You can find some example playbooks illustrating these best practices in our `ansible-examples repository <https://github.com/ansible/ansible-examples>`_.
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
Ansible Resources
|
Ansible Resources
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
User contributed playbooks, modules, and articles. This is a small
|
User contributed playbooks, modules, and articles. This is a small
|
||||||
curated list, but growing. Everyone is encouraged to add to this
|
curated list, but growing. Everyone is encouraged to add to this
|
||||||
document, just send in a github pull request to docsite/rst/contrib.rst!
|
document, just send in a github pull request to docsite/rst/contrib.rst!
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
Command Line Examples And Next Steps
|
Command Line Examples And Next Steps
|
||||||
====================================
|
====================================
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
.. highlight:: bash
|
.. highlight:: bash
|
||||||
|
|
||||||
The following examples show how to use `/usr/bin/ansible` for running
|
The following examples show how to use `/usr/bin/ansible` for running
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
Getting Started
|
Getting Started
|
||||||
===============
|
===============
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
:depth: 2
|
:depth: 2
|
||||||
:backlinks: top
|
:backlinks: top
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
Glossary
|
Glossary
|
||||||
========
|
========
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
The following is a list (and re-explanation) of term definitions used elsewhere in the Ansible documentation.
|
The following is a list (and re-explanation) of term definitions used elsewhere in the Ansible documentation.
|
||||||
|
|
||||||
Consult the documentation home page for the full documentation and to see this in context, but this should be a good resource
|
Consult the documentation home page for the full documentation and to see this in context, but this should be a good resource
|
||||||
|
|
|
@ -3,12 +3,22 @@
|
||||||
Ansible Documentation
|
Ansible Documentation
|
||||||
`````````````````````
|
`````````````````````
|
||||||
|
|
||||||
This page contains documentation about how to use `Ansible <http://ansible.cc>`_.
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
Before we dive into playbooks, configuration management, deployment, and orchestration, learn how to get Ansible installed and some
|
|
||||||
|
This page contains documentation about how to use `Ansible <http://ansible.cc>`_. You may also be interested in taking a class:
|
||||||
|
|
||||||
|
.. image:: http://www.ansibleworks.com.s3-website-us-east-1.amazonaws.com/img/banners/training.png
|
||||||
|
:alt: ansibleworks training
|
||||||
|
:target: http://www.ansibleworks.com/training/
|
||||||
|
|
||||||
|
Before we dive into playbooks, configuration management, deployment, and orchestration, we'll learn how to get Ansible installed and some
|
||||||
basic information. We'll go over how to execute ad-hoc commands in parallel across your nodes using /usr/bin/ansible. We'll also see
|
basic information. We'll go over how to execute ad-hoc commands in parallel across your nodes using /usr/bin/ansible. We'll also see
|
||||||
what sort of modules are available in Ansible's core (though you can also write your own, which we'll also show later).
|
what sort of modules are available in Ansible's core (though you can also write your own, which we'll also show later).
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
@ -17,7 +27,6 @@ what sort of modules are available in Ansible's core (though you can also write
|
||||||
examples
|
examples
|
||||||
modules
|
modules
|
||||||
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
````````
|
````````
|
||||||
|
|
||||||
|
@ -26,6 +35,7 @@ Overview
|
||||||
:width: 566px
|
:width: 566px
|
||||||
:height: 439px
|
:height: 439px
|
||||||
|
|
||||||
|
|
||||||
Playbooks
|
Playbooks
|
||||||
`````````
|
`````````
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
Module Development
|
Module Development
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
Ansible modules are reusable units of magic that can be used by the Ansible API,
|
Ansible modules are reusable units of magic that can be used by the Ansible API,
|
||||||
or by the `ansible` or `ansible-playbook` programs.
|
or by the `ansible` or `ansible-playbook` programs.
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
Ansible Modules
|
Ansible Modules
|
||||||
===============
|
===============
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
:depth: 2
|
:depth: 2
|
||||||
:backlinks: top
|
:backlinks: top
|
||||||
|
|
|
@ -3,6 +3,11 @@
|
||||||
Inventory & Patterns
|
Inventory & Patterns
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
Ansible works against multiple systems in your infrastructure at the
|
Ansible works against multiple systems in your infrastructure at the
|
||||||
same time. It does this by selecting portions of systems listed in
|
same time. It does this by selecting portions of systems listed in
|
||||||
Ansible's inventory file, which defaults to /etc/ansible/hosts.
|
Ansible's inventory file, which defaults to /etc/ansible/hosts.
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
Playbooks
|
Playbooks
|
||||||
=========
|
=========
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
:depth: 2
|
:depth: 2
|
||||||
:backlinks: top
|
:backlinks: top
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
Advanced Playbooks
|
Advanced Playbooks
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png
|
||||||
|
:alt: ansiblefest 2013
|
||||||
|
:target: http://www.eventbrite.com/event/5593981750
|
||||||
|
|
||||||
|
|
||||||
Here are some advanced features of the playbooks language. Using all of these features
|
Here are some advanced features of the playbooks language. Using all of these features
|
||||||
are not neccessary, but many of them will prove useful. If a feature doesn't seem immediately
|
are not neccessary, but many of them will prove useful. If a feature doesn't seem immediately
|
||||||
relevant, feel free to skip it. For many people, the features documented in `playbooks` will
|
relevant, feel free to skip it. For many people, the features documented in `playbooks` will
|
||||||
|
|
|
@ -1,37 +0,0 @@
|
||||||
.. _who_uses_ansible:
|
|
||||||
|
|
||||||
Who Uses Ansible
|
|
||||||
================
|
|
||||||
|
|
||||||
The following is an opt-in list of just some of the folks using Ansible -- to get your company details here, `Email Michael <mailto:michael.dehaan@gmail.com>`_.
|
|
||||||
|
|
||||||
* `Action.IO <http://www.action.io/>`_ - Action.IO Cloud Development Platform
|
|
||||||
* `Alta Language Services <http://www.altalang.com>`_ - language testing, solutions, and translation services
|
|
||||||
* `Aspiro TV <http://www.aspiro.com/en/TV/>`_ - Media Streaming
|
|
||||||
* `Basho <http://basho.com>`_ - makers of NoSQL engine Riak
|
|
||||||
* `CatN Hosting <http://catn.com>`_ - scalable Cloud hosting
|
|
||||||
* `Cygate AB <http://cygate.se>`_ - IT solutions from Malmo, Sweeden
|
|
||||||
* `D square NV <http://dsquare.be>`_ - Process industry data mining, Belgium
|
|
||||||
* `Dag IT Solutions <http://dagit.net>`_ - Enterprise Linux & Beyond
|
|
||||||
* `Digital Repository of Ireland <http://www.dri.ie/>` - Digital Preservation and Archiving
|
|
||||||
* `Duke University Economics <http://duke.edu>`_ - Research & Education
|
|
||||||
* `Eucalyptus Systems Inc. <http://www.eucalyptus.com>`_ - Makers of the AWS-compatible private cloud platform
|
|
||||||
* `Ginsys <http://ginsys.eu/>`_ - Linux infrastructure consulting from Belgium
|
|
||||||
* `The Fedora Project <http://fedoraproject.org>`_ - Produces the Popular Linux Distribution
|
|
||||||
* `Four Kitchens <http://fourkitchens.com>`_ - The Drupal Experts
|
|
||||||
* `Muck Rack <http://muckrack.com>`_ - "The destination for journalists on twitter & social media"
|
|
||||||
* `HP (Germany) <http://hp.com>`_ - HP
|
|
||||||
* `Nimbis Services <http://nimbisservices.com>`_ - Technical Computing for the Cloud
|
|
||||||
* `Lizenfrei.at <http://lizenzfrei.at/>`_ - Open Source consulting and development, Austria
|
|
||||||
* `Schmooze Com <http://www.schmoozecom.com/>`_ - Creators of Industry Leading PBX Platforms
|
|
||||||
* `Scientific Computing Center, Aristotle Univ. of Thessaloniki <http://www.grid.auth.gr/en/>`_ - Grid/Cloud-Based Scientific Computing
|
|
||||||
* `Shorty Awards <http://shortyawards.com>`_ - Honoring the best in social media
|
|
||||||
* `Speedy Rails <http://speedyrails.com>`_ - Cloud Based Rails Hosting
|
|
||||||
* `Skylines.io <http://skylines.io>`_ - Real time photo search engine
|
|
||||||
* `Steelhouse <http://steelhouse.com>`_ - Behavioral commerce
|
|
||||||
* `Tent.is <http://tent.is>`_ - "The easiest way to start using Tent"
|
|
||||||
* `Tranquil Hosting <http://tranquilhosting.com>`_ - Managed Linux Hosting Services
|
|
||||||
* `Trinity Centre for High Performance Computing - <http://www.tchpc.tcd.ie>`_ - Research and Education
|
|
||||||
* `Tomorrow Focus Technologies GmbH <http://www.t-f-t.net/>`_ - Running some of the biggest web sites in Europe
|
|
||||||
* `123i.com.br <http://123i.com.br>`_ - Find real estate in Brazil
|
|
||||||
|
|
Loading…
Reference in a new issue