===========================
Getting Started With Joyent
===========================

Joyent is a public cloud provider supporting SmartOS, Linux, FreeBSD and
Windows.


Dependencies
============
This driver requires the Python ``requests`` library to be installed.


Configuration
=============
The Joyent cloud requires three configuration parameters. The user name and 
password that are used to log into the Joyent system, and the location of the 
private ssh key associated with the Joyent account. The ssh key is needed to 
send the provisioning commands up to the freshly created virtual machine.

.. code-block:: yaml

    # Note: This example is for /etc/salt/cloud.providers or any file in the
    # /etc/salt/cloud.providers.d/ directory.

    my-joyent-config:
        provider: joyent
        user: fred
        password: saltybacon
        private_key: /root/joyent.pem


Profiles
========

Cloud Profiles
~~~~~~~~~~~~~~
Set up an initial profile at ``/etc/salt/cloud.profiles`` or in the
``/etc/salt/cloud.profiles.d/`` directory:

.. code-block:: yaml

    joyent_512
      provider: my-joyent-config
      size: Extra Small 512 MB
      image: Arch Linux 2013.06

Sizes can be obtained using the ``--list-sizes`` option for the ``salt-cloud``
command:

.. code-block:: bash

    # salt-cloud --list-sizes my-joyent-config
    my-joyent-config:
        ----------
        joyent:
            ----------
            Extra Small 512 MB:
                ----------
                default:
                    false
                disk:
                    15360
                id:
                    Extra Small 512 MB
                memory:
                    512
                name:
                    Extra Small 512 MB
                swap:
                    1024
                vcpus:
                    1
    ...SNIP...

Images can be obtained using the ``--list-images`` option for the ``salt-cloud``
command:

.. code-block:: bash

    # salt-cloud --list-images my-joyent-config
    my-joyent-config:
        ----------
        joyent:
            ----------
            base:
                ----------
                description:
                    A 32-bit SmartOS image with just essential packages
                    installed. Ideal for users who are comfortable with setting
                    up their own environment and tools.
                disabled:
                    False
                files:
                    ----------
                    - compression:
                        bzip2
                    - sha1:
                        40cdc6457c237cf6306103c74b5f45f5bf2d9bbe
                    - size:
                        82492182
                name:
                    base
                os:
                    smartos
                owner:
                    352971aa-31ba-496c-9ade-a379feaecd52
                public:
                    True
    ...SNIP...