diff --git a/doc/topics/features.rst b/doc/topics/features.rst index ad85e4ddf1..e446d8531b 100644 --- a/doc/topics/features.rst +++ b/doc/topics/features.rst @@ -30,8 +30,12 @@ When adding new features to a particular cloud provider, please make sure to add the feature to this table. Additionally, if you notice a feature that is not properly listed here, pull requests to fix them is appreciated. +Standard Features +================= +These are features that are available for almost every provider. + +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|Feature |AWS |CloudStack|Digital|EC2|GoGrid|IBM|JoyEnt|Linode|OpenStack|Parallels|Rackspace|Saltify|Softlayer|Softlayer| +| |AWS |CloudStack|Digital|EC2|GoGrid|IBM|JoyEnt|Linode|OpenStack|Parallels|Rackspace|Saltify|Softlayer|Softlayer| | |(Legacy)| |Ocean | | |SCE| | | | |(Legacy) | | |Hardware | +=======================+========+==========+=======+===+======+===+======+======+=========+=========+=========+=======+=========+=========+ |Query |Yes |Yes |Yes |Yes|Yes |Yes|Yes |Yes |Yes |Yes |Yes | |Yes |Yes | @@ -46,36 +50,86 @@ properly listed here, pull requests to fix them is appreciated. +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |List Locations |Yes |Yes |Yes |Yes|Yes |Yes|Yes |Yes |Yes |Yes |Yes | |Yes |Yes | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|attach_volume | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|block_device_mappings |Yes | | | | | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |create |Yes |Yes |Yes |Yes|Yes |Yes|Yes |Yes |Yes |Yes |Yes |Yes |Yes |Yes | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|destroy |Yes |Yes |Yes |Yes|Yes |Yes|Yes |Yes |Yes |Yes |Yes | |Yes |Yes | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ + +Actions +======= +These are features that are performed on a specific instance, and require an +instance name to be passed in. For example: + +.. code-block:: bash + + # salt-cloud -a attach_volume ami.example.com + ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|Actions |AWS |CloudStack|Digital|EC2|GoGrid|IBM|JoyEnt|Linode|OpenStack|Parallels|Rackspace|Saltify|Softlayer|Softlayer| +| |(Legacy)| |Ocean | | |SCE| | | | |(Legacy) | | |Hardware | ++=======================+========+==========+=======+===+======+===+======+======+=========+=========+=========+=======+=========+=========+ +|attach_volume | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |create_attach_volumes |Yes | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|create_keypair | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|create_volume | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |del_tags |Yes | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|delete_key | | | | | | |Yes | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|delete_keypair | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|delete_volume | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |delvol_on_destroy | | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|destroy |Yes |Yes |Yes |Yes|Yes |Yes|Yes |Yes |Yes |Yes |Yes | |Yes |Yes | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |detach_volume | | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |disable_term_protect |Yes | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |enable_term_protect |Yes | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|get_tags |Yes | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|keepvol_on_destroy | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|list_keypairs | | |Yes | | | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|rename |Yes | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|set_tags |Yes | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|show_delvol_on_destroy | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|show_instance | | |Yes |Yes| | | | | |Yes | | |Yes |Yes | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|show_term_protect | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|start |Yes | | |Yes| | |Yes | | |Yes | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|stop |Yes | | |Yes| | |Yes | | |Yes | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|take_action | | | | | | |Yes | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ + +Functions +========= +These are features that are performed against a specific cloud provider, and +require the name of the provider to be passed in. For example: + +.. code-block:: bash + + # salt-cloud -f list_images my_digitalocean + ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|Functions |AWS |CloudStack|Digital|EC2|GoGrid|IBM|JoyEnt|Linode|OpenStack|Parallels|Rackspace|Saltify|Softlayer|Softlayer| +| |(Legacy)| |Ocean | | |SCE| | | | |(Legacy) | | |Hardware | ++=======================+========+==========+=======+===+======+===+======+======+=========+=========+=========+=======+=========+=========+ +|block_device_mappings |Yes | | | | | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|create_keypair | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|create_volume | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|delete_key | | | | | | |Yes | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|delete_keypair | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +|delete_volume | | | |Yes| | | | | | | | | | | ++-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |get_image | | |Yes | | | |Yes | | |Yes | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |get_ip | |Yes | | | | | | | | | | | | | @@ -98,14 +152,10 @@ properly listed here, pull requests to fix them is appreciated. +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |get_subnetid | | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|get_tags |Yes | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |iam_profile |Yes | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |import_key | | | | | | |Yes | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|keepvol_on_destroy | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |key_list | | | | | | |Yes | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |keyname |Yes | | |Yes| | | | | | | | | | | @@ -114,8 +164,6 @@ properly listed here, pull requests to fix them is appreciated. +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |list_custom_images | | | | | | | | | | | | |Yes | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|list_keypairs | | |Yes | | | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |list_keys | | | | | | |Yes | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |list_vlans | | | | | | | | | | | | |Yes |Yes | @@ -126,29 +174,16 @@ properly listed here, pull requests to fix them is appreciated. +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |reformat_node | | | | | | |Yes | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|rename |Yes | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |securitygroup |Yes | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |securitygroupid | | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|set_tags |Yes | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|show_delvol_on_destroy | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |show_image | | | |Yes| | | | | |Yes | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|show_instance | | |Yes |Yes| | | | | |Yes | | |Yes |Yes | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |show_key | | | | | | |Yes | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |show_keypair | | |Yes |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|show_term_protect | | | |Yes| | | | | | | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ |show_volume | | | |Yes| | | | | | | | | | | +-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|start |Yes | | |Yes| | |Yes | | |Yes | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ -|stop |Yes | | |Yes| | |Yes | | |Yes | | | | | -+-----------------------+--------+----------+-------+---+------+---+------+------+---------+---------+---------+-------+---------+---------+ +