.. _salt-cloud: ========== Salt Cloud ========== .. raw:: html :file: index.html Getting Started =============== Salt Cloud is built-in to Salt and is configured on and executed from your Salt Master. Define a Provider ----------------- The first step is to add the credentials for your cloud host. Credentials and other settings provided by the cloud host are stored in provider configuration files. Provider configurations contain the details needed to connect to a cloud host such as EC2, GCE, Rackspace, etc., and any global options that you want set on your cloud minions (such as the location of your Salt Master). On your Salt Master, browse to ``/etc/salt/cloud.providers.d/`` and create a file called ``.provider.conf``, replacing ```` with ``ec2``, ``softlayer``, and so on. The name helps you identify the contents, and is not important as long as the file ends in ``.conf``. Next, browse to the :ref:`Provider specifics ` and add any required settings for your cloud host to this file. Here is an example for Amazon EC2: .. code-block:: yaml my-ec2: driver: ec2 # Set the EC2 access credentials (see below) # id: 'HJGRYCILJLKJYG' key: 'kdjgfsgm;woormgl/aserigjksjdhasdfgn' # Make sure this key is owned by root with permissions 0400. # private_key: /etc/salt/my_test_key.pem keyname: my_test_key securitygroup: default # Optional: Set up the location of the Salt Master # minion: master: saltmaster.example.com The required configuration varies between cloud hosts so make sure you read the provider specifics. List Cloud Provider Options --------------------------- You can now query the cloud provider you configured for available locations, images, and sizes. This information is used when you set up VM profiles. .. code-block:: bash salt-cloud --list-locations # my-ec2 in the previous example salt-cloud --list-images salt-cloud --list-sizes Replace ```` with the name of the provider configuration you defined. Create VM Profiles ------------------ On your Salt Master, browse to ``/etc/salt/cloud.profiles.d/`` and create a file called ``.profiles.conf``, replacing ```` with ``ec2``, ``softlayer``, and so on. The file must end in ``.conf``. You can now add any custom profiles you'd like to define to this file. Here are a few examples: .. code-block:: yaml micro_ec2: provider: my-ec2 image: ami-d514f291 size: t1.micro medium_ec2: provider: my-ec2 image: ami-d514f291 size: m3.medium large_ec2: provider: my-ec2 image: ami-d514f291 size: m3.large Notice that the ``provider`` in our profile matches the provider name that we defined? That is how Salt Cloud knows how to connect to create a VM with these attributes. Create VMs ---------- VMs are created by calling ``salt-cloud`` with the following options: .. code-block:: bash salt-cloud -p ... For example: .. code-block:: bash salt-cloud -p micro_ec2 minion1 minion2 Destroy VMs ----------- Add a ``-d`` and the minion name you provided to destroy: .. code-block:: bash salt-cloud -d minion1 minion2 Query VMs --------- You can view details about the VMs you've created using ``--query``: .. code-block:: bash salt-cloud --query Using Salt Cloud ================ .. toctree:: :maxdepth: 3 Command Line Reference <../../ref/cli/salt-cloud> Basic Profiles Maps Actions Functions Core Configuration ================== .. toctree:: :maxdepth: 3 Installing salt cloud Core Configuration Windows Configuration ===================== .. toctree:: :maxdepth: 3 Windows Configuration .. _cloud-provider-specifics: Cloud Provider Specifics ======================== .. toctree:: :maxdepth: 3 Getting Started With Aliyun Getting Started With Azure Getting Started With DigitalOcean Getting Started With EC2 Getting Started With GoGrid Getting Started With Google Compute Engine Getting Started With HP Cloud Getting Started With Joyent Getting Started With LXC Getting Started With Linode Getting Started With OpenStack Getting Started With Parallels Getting Started With Proxmox Getting Started With Rackspace Getting Started With Saltify Getting Started With Scaleway Getting Started With SoftLayer Getting Started With Vexxhost Getting Started With VMware Getting Started With vSphere Miscellaneous Options ===================== .. toctree:: :maxdepth: 3 Miscellaneous Troubleshooting Steps ===================== .. toctree:: :maxdepth: 3 Troubleshooting Extending Salt Cloud ==================== .. toctree:: :maxdepth: 3 Adding Cloud Providers Adding OS Support Using Salt Cloud from Salt ========================== .. toctree:: :maxdepth: 3 Using Salt Cloud from Salt Feature Comparison ================== .. toctree:: :maxdepth: 3 Features Tutorials ========= .. toctree:: :maxdepth: 3 Using Salt Cloud with the Event Reactor