Documentation

rax - create / delete an instance in Rackspace Public Cloud

Synopsis

creates / deletes a Rackspace Public Cloud instance and optionally waits for it to be ‘running’.

Requirements (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
api_key
no
    Rackspace API key (overrides credentials)

    aliases: password
    auth_endpoint
    (added in 1.5)
    no https://identity.api.rackspacecloud.com/v2.0/
      The URI of the authentication service
      auto_increment
      (added in 1.5)
      no True
      • yes
      • no
      Whether or not to increment a single number with the name of the created servers. Only applicable when used with the group attribute or meta key.
      boot_from_volume
      (added in 1.9)
      no no
      • yes
      • no
      Whether or not to boot the instance from a Cloud Block Storage volume. If yes and image is specified a new volume will be created at boot time. boot_volume_size is required with image to create a new volume at boot time.
      boot_volume
      (added in 1.9)
      no
        Cloud Block Storage ID or Name to use as the boot volume of the instance
        boot_volume_size
        (added in 1.9)
        no 100
          Size of the volume to create in Gigabytes. This is only required with image and boot_from_volume.
          boot_volume_terminate
          (added in 1.9)
          no
            Whether the boot_volume or newly created volume from image will be terminated when the server is terminated
            config_drive
            (added in 1.7)
            no
            • yes
            • no
            Attach read-only configuration drive to server as label config-2
            count
            (added in 1.4)
            no 1
              number of instances to launch
              count_offset
              (added in 1.4)
              no 1
                number count to start at
                credentials
                no
                  File to find the Rackspace credentials in (ignored if api_key and username are provided)

                  aliases: creds_file
                  disk_config
                  (added in 1.4)
                  no auto
                  • auto
                  • manual
                  Disk partitioning strategy
                  env
                  (added in 1.5)
                  no
                    exact_count
                    (added in 1.4)
                    no
                    • yes
                    • no
                    Explicitly ensure an exact count of instances, used with state=active/present. If specified as yes and count is less than the servers matched, servers will be deleted to match the count. If the number of matched servers is fewer than specified in count additional servers will be added.
                    extra_client_args
                    (added in 1.6)
                    no
                      A hash of key/value pairs to be used when creating the cloudservers client. This is considered an advanced option, use it wisely and with caution.
                      extra_create_args
                      (added in 1.6)
                      no
                        A hash of key/value pairs to be used when creating a new server. This is considered an advanced option, use it wisely and with caution.
                        files
                        no
                          Files to insert into the instance. remotefilename:localcontent
                          flavor
                          no
                            flavor to use for the instance
                            group
                            (added in 1.4)
                            no
                              host group to assign to server, is also used for idempotent operations to ensure a specific number of instances
                              identity_type
                              (added in 1.5)
                              no rackspace
                                Authentication machanism to use, such as rackspace or keystone
                                image
                                no
                                  image to use for the instance. Can be an id, human_id or name. With boot_from_volume, a Cloud Block Storage volume will be created with this image
                                  instance_ids
                                  (added in 1.4)
                                  no
                                    list of instance ids, currently only used when state='absent' to remove instances
                                    key_name
                                    no
                                      key pair to use on the instance

                                      aliases: keypair
                                      meta
                                      no
                                        A hash of metadata to associate with the instance
                                        name
                                        no
                                          Name to give the instance
                                          networks
                                          (added in 1.4)
                                          no [u'public', u'private']
                                            The network to attach to the instances. If specified, you must include ALL networks including the public and private interfaces. Can be id or label.
                                            region
                                            no DFW
                                              Region to create an instance in
                                              state
                                              no present
                                              • present
                                              • absent
                                              Indicate desired state of the resource
                                              tenant_id
                                              (added in 1.5)
                                              no
                                                The tenant ID used for authentication
                                                tenant_name
                                                (added in 1.5)
                                                no
                                                  The tenant name used for authentication
                                                  user_data
                                                  (added in 1.7)
                                                  no
                                                    Data to be uploaded to the servers config drive. This option implies config_drive. Can be a file path or a string
                                                    username
                                                    no
                                                      Rackspace username (overrides credentials)
                                                      verify_ssl
                                                      (added in 1.5)
                                                      no
                                                        Whether or not to require SSL validation of API endpoints
                                                        wait
                                                        no no
                                                        • yes
                                                        • no
                                                        wait for the instance to be in state 'running' before returning
                                                        wait_timeout
                                                        no 300
                                                          how long before wait gives up, in seconds

                                                          Examples

                                                          - name: Build a Cloud Server
                                                            gather_facts: False
                                                            tasks:
                                                              - name: Server build request
                                                                local_action:
                                                                  module: rax
                                                                  credentials: ~/.raxpub
                                                                  name: rax-test1
                                                                  flavor: 5
                                                                  image: b11d9567-e412-4255-96b9-bd63ab23bcfe
                                                                  key_name: my_rackspace_key
                                                                  files:
                                                                    /root/test.txt: /home/localuser/test.txt
                                                                  wait: yes
                                                                  state: present
                                                                  networks:
                                                                    - private
                                                                    - public
                                                                register: rax
                                                          
                                                          - name: Build an exact count of cloud servers with incremented names
                                                            hosts: local
                                                            gather_facts: False
                                                            tasks:
                                                              - name: Server build requests
                                                                local_action:
                                                                  module: rax
                                                                  credentials: ~/.raxpub
                                                                  name: test%03d.example.org
                                                                  flavor: performance1-1
                                                                  image: ubuntu-1204-lts-precise-pangolin
                                                                  state: present
                                                                  count: 10
                                                                  count_offset: 10
                                                                  exact_count: yes
                                                                  group: test
                                                                  wait: yes
                                                                register: rax
                                                          

                                                          Notes

                                                          Note

                                                          exact_count can be “destructive” if the number of running servers in the group is larger than that specified in count. In such a case, the state is effectively set to absent and the extra servers are deleted. In the case of deletion, the returned data structure will have action set to delete, and the oldest servers in the group will be deleted.

                                                          Note

                                                          The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

                                                          Note

                                                          RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating

                                                          Note

                                                          RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

                                                          Note

                                                          RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)

                                                          This is a Core Module

                                                          For more information on what this means please read Core Modules

                                                          For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.