7. Developers Guide

• 1. Creating applications with kamaki API
  • 1.1. Setup a client instance
  • 1.2. Using endpoints to get the base_url
  • 1.3. Use client methods
  • 1.4. Error handling
  • 1.5. Scripts
    • 1.5.1. Batch-create servers
    • 1.5.2. Batch-create 4 servers of the same kind
    • 1.5.3. Register a banch of pre-uploaded images
    • 1.5.4. Two servers and a private network
• 2. The Configuration module
  • 2.1. Types of configuration options
  • 2.2. The Config class
  • 2.3. Global options
  • 2.4. Cloud options
  • 2.5. Examples
    • 2.5.1. Get the default cloud values from a configuration file
    • 2.5.2. Set a new cloud, name it “new_cloud” and set it as default
    • 2.5.3. List all clouds with their URLs, let the user pick one
• 3. Logging
  • 3.1. Monitor requests and responses
  • 3.2. Logger in external code
  • 3.3. Logger in kamaki code
• 4. Adding Commands
  • 4.1. The CommandTree structure
  • 4.2. The command decorator
  • 4.3. Creating a new command specification set
  • 4.4. Set command description
  • 4.5. Description placeholders
  • 4.6. Declare run-time argument
  • 4.7. Accessing run-time arguments
  • 4.8. The main method and command parameters
  • 4.9. Letting kamaki know
  • 4.10. Summary: create a command set
• 5. Extending kamaki.clients
  • 5.1. How to build a client
  • 5.2. How to use your client
  • 5.3. Concurrency control
  • 5.4. Going agile
    • 5.4.1. Using the tests
    • 5.4.2. Mechanism
    • 5.4.3. Adding unit tests
      • 5.4.3.1. Modifying an existing method
      • 5.4.3.2. Adding a new method
      • 5.4.3.3. Implementing a new class or module
• 6. Showcase: create a virtual cluster from scratch
  • 6.1. Credentials and endpoints
  • 6.2. Upload the image
  • 6.3. Register the image
  • 6.4. Create the virtual cluster
  • 6.5. Some improvements
    • 6.5.1. Progress Bars
    • 6.5.2. Wait for servers to built
    • 6.5.3. Asynchronous server creation
    • 6.5.4. Clean up virtual cluster
    • 6.5.5. Inject ssh keys
    • 6.5.6. Save server passwords in a file
    • 6.5.7. Errors and logs
  • 6.6. create a cluster from scratch
• 7. APIs code
  • 7.1. Command Specifications
    • 7.1.1. user
    • 7.1.2. cyclades (server, flavor, network)
    • 7.1.3. pithos (file)
    • 7.1.4. image
    • 7.1.5. Kamaki commands
      • 7.1.5.1. config
      • 7.1.5.2. history
  • 7.2. Command Line Interfaces
    • 7.2.1. argument
    • 7.2.2. command_shell
    • 7.2.3. command_tree
    • 7.2.4. config
    • 7.2.5. errors
    • 7.2.6. history
    • 7.2.7. utils
  • 7.3. The clients API
    • 7.3.1. Modules list
    • 7.3.2. compute REST API
    • 7.3.3. compute
    • 7.3.4. cyclades REST API
    • 7.3.5. cyclades
    • 7.3.6. storage
    • 7.3.7. pithos_rest_api
    • 7.3.8. pithos
    • 7.3.9. image
    • 7.3.10. astakos
    • 7.3.11. utils