Cloudmesh Version 4

Manual

INTRODUCTION

• Preface
  • About
    • Features
    • Versions
    • Contact
  • Contributors
• Installation
  • Overview
    • Installation of cloudmesh with Docker
    • Installation of Cloudmesn in Python
      • Anaconda and Conda
        • Python Installation from python.org
    • SSH key
    • First configuration
    • The Directory .cloudmesh
    • Installation of MongoDB
  • Quickstart
    • Configuration with the GUI
    • Manual
    • Generating the Key and Certificate
    • Validate and verify the key
    • Initialization
    • Initialize keys and Security Groups
    • Command line
    • Interactive shell
    • Command scripts
    • Cache
    • Using quotes
    • Configuring chameleon cloud
    • Timer
    • Debugging
  • Docker
  • Installation for for Linux
    • Prerequisites for Ubuntu 20.4
    • Prerequisites for Ubuntu 18.04
    • Installation for Container Users
    • Installation for Users
    • Installation for Developers
    • Installation Diagram
  • Installation for macOS
    • Prerequisites for macOS
    • Prerequisite venv
    • Installation for Container Users
    • Installation for Users
    • Installation for Developers
    • Installation Diagram
  • Prerequisites for Raspbian
    • Setup with curl
  • Windows Installation
    • Windows
      • Prerequisites for Windows
      • Install
        • Windows Container Approach
        • Linux Subsystem Installation Approach
        • venv Setup on Windows CMD.EXE
    • User Update
    • Developer Reinstall
    • Linux Subsystem on Windows 10
      • Installation for Users
      • Installation for Developers
    • FAQ for Windows
      • Videos
      • Visual Studio Build Tools
      • MongoDB
      • Which version of Windows do I need to use multipass?
      • multipass Hyper-V instalation on Windows
        • General Windows Tips
          • Where do I find the release numbers for Windows?
          • How can I get the EDU Version?
          • Issues with docker on Windows
          • Usernames in Windows must not have spaces
  • Installation of Cloudmesh (Source Install for Developers)
    • Cloudmesh Updates
    • Reinstallation
  • Cloudmesh Database
    • MongoDB Installation Steps
    • Uninstall of MongoDB on Windows 10
• Configuration
  • Cloudmesh Yaml File Object definitions
  • Getting Values
  • Setting values
  • Editing Values
  • Advanced Yaml Variables
  • Profile
  • Default
  • General Service Attributes
    • cm
  • Adding Templates
  • Compute Cloud Providers
    • Default
    • Credentials
    • Google
    • OpenStack
    • Virtual Box
  • Storage Providers
    • AWS S3
    • Google drive
    • Google Cloud Storage
    • Box
  • Volume Cloud Providers
    • AWS
    • Azure
    • Google
    • Multipass
    • Oracle
    • Openstack
  • Log File
  • Mongo
    • Mongo via Docker
  • Config API
• Concepts
  • Extensible Command Shell
  • Cloudmesh API Namespace
  • Virtual Machine Providers
  • Storage Providers
    • Configuration
    • Commandline
      • Monitor
      • Run
      • Clean
      • Create dir
      • Put
      • Get
      • Search
      • List
      • Delete
      • Copy
      • API
    • Pytests
      • Generic Tests
      • Provider Specific Pytests
    • Virtual Directory
      • Configuration
      • Pytests
    • Google drive
      • Note
      • Links
  • Virtual Directory
    • PyTest
      • Google drive
    • Note
    • Links
  • OpenAPI Web Services
• Cloud Accounts
  • OpenStack Account
  • AWS Account
    • Access Key
      • Create and Download Access Key
      • Using the Access Key
    • Compute Service
      • Import Public key
      • Cloudmesh.yaml Configuration for AWS
    • Storage Service
    • References
  • Azure Account
    • Azure Account
    • Azure CLI
      • Installing Azure CLI on Ubuntu OS
      • Installing Azure CLI on Windows 10
    • Azure Resource Group (for Storage)
    • Azure API Credentials
      • Azure_Subscription_ID
      • Azure_Tenant_ID & Azure_Client_ID
      • Azure_Secret_Key
      • Grant permission to application
      • Add the credentials to cloudmesh.yaml
    • Azure Resource Group (for Compute)
    • Azure Resource Group (for Storage and Compute)
    • FAQ
    • References
  • Google Acounts
    • Google Cloud Platform
      • Google Compute Engine
      • Prerequisites
      • Creating the Google Account
      • Activation Google Cloud Service
        • Setting up Google Cloud Account
        • Registering Google Cloud to Cloudmesh
          • Register Google Compute
          • Register Google Storage
          • Register Google Volume
        • Verify Setup
      • Links
      • Google Cloud Storage
    • Google Drive
      • Create a Project
      • Enable APIs and Services
      • Create Credentials
      • Authorization Flow
  • Oracle Cloud Account
    • Account Creation
    • Account Login
    • Oracle API
    • Cloudmesh Config File
      • Compute Entry
      • Storage Entry
    • Required Keys and OCIDs
      • Create API Signing Key
      • User
      • Tenancy
      • Compartment
      • Public Key
    • Compute Service
    • Storage Service
    • References
  • Box Account
    • Sign up
    • Create an App
    • Authenticate with JWT
    • References
• Cloudmesh Viewer
• FAQ
  • FAQ - Cloudmesh
    • Where is the manual
    • Having control over your computers
      • Install MongoDB
      • Do an update of the source
      • Interact with Chameleon CLoud
      • Draft: Cms Mostly automated install on macOS and Linux
    • Switching between cms and cmsd
  • FAQ - Chameleon cloud
    • How check if chmaeleon cloud works
    • How do I upload my key to chameleon?
    • What is the error …?
    • What is the chameleon account bug?
    • You must not use IUGuest network
    • Tethering you computer through a cell phone
    • Can I keep my instance running when not in use?
    • What is WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!
    • ssh-keygen vs putty
    • Can I give my own network when booting
    • How do I upload the secgroups
    • Are there additional Videos
      • Starting vms in horizon
      • Starting VMs in cloudmesh
• Benchmarks
  • Benchmarks
    • Systems
      • Gregor Laptop
      • Gregor PC
    • Key
      • OpenStack
    • Flavor
      • AWS
        • Gregors PC
        • Gregor’s macOS Laptop
      • Openstack
        • Gregor’s macOS Laptop
    • Secgroup
      • Openstack
        • Gregor’s macOS Laptop

MANUAL PAGES

• cms
  • Features
    • Execution shell command
    • Timers
    • Variables
    • Defaults
    • Stopwatch
    • Accessing Python
    • Accessing Shell Commands
    • Accessing the yaml file
  • Plugins
  • Docker
• Command List
• Basic Commands
  • banner
  • clear
  • commands
  • default
  • debug
  • echo
  • EOF
  • help
  • info
  • man
  • pause
  • plugin
  • py
  • q
  • quit
  • set
  • shell
  • sleep
  • stopwatch
  • sys
  • var
  • version
• Configuration Commands
  • help
  • check
  • gui
  • admin
  • init
  • start
  • stop
• Group Command
  • group
• Compute Commands
  • host
  • inventory
  • config
  • register
  • batch
  • flavor
  • image
  • key
  • ip
  • open
  • openstack
  • sec
  • ssh
  • vbox
  • vcluster
  • vm
  • group
  • aws
  • azure
  • container
  • google
  • multipass
  • provider
  • oracle
• Storage Commands
  • storage
  • volume
  • vdir
• Community Commands
  • data
  • service
  • source
  • flow
  • openapi
• Reference Card
  • Shell invocation
  • Shell basic commands
  • Cloud commands

API

• Cloudmesh Command API
• Cloudmesh API
• Jupyter Integration
  • API calls

COMMUNITY

• Community Projects
  • Cloudmesh Cloud AI Service
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
  • Cloudmesh Compute
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
  • Cloudmesh Frugal
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
  • Cloudmesh Graphical User Interface
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
    • References
  • Cloudmesh HPC Batch
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
  • Cloudmesh Local Compute and Storage
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
  • Cloudmesh Raspberry Cloud Clusters
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
    • Resources
  • Cloudmesh Storage
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
  • Cloudmesh Twister2 Interface
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
  • Cloudmesh Workflow
    • Goals
    • Requirements
    • Difficulty
    • Deliverables
• Contributing
  • Code Conventions
  • Documentation Management
  • Code Management
  • Pytest
    • Installation
    • Cloudmesh Debugging Information
    • Test Specification and Execution
  • Version Management

Indices and tables

• Module Index

• Index

• Search Page

Other

OTHER

• Developping with Mongo
  • Database Decorator
  • Database Access
  • Creating Unique Names
• To Do
  • cloudmesh
  • analytics
  • book
  • bookmanagerservice
  • emr
  • git
  • queue
  • test
  • windows
  • workflow_draft
  • Windows Cloudmesh Ubuntu Subsystem Environment
    • Setup git
    • .bashrc
    • Pycharm different terminal
    • cloudmesh-installer
    • Development with pyCharm
    • Github use
    • Git Pull requests
    • Compiling the code
  • Using windows instead of Linux
    • Using bash
    • Using gitbash
    • Using conda
    • Using cmd
    • EASY INSTALL
      • ENV3.bat
      • SETUP-ENV3.bat
      • CMS-CLONE.bat
      • CMS-AA.bat
      • Using it
  • Windows Cloudmesh Development Environment
    • Development with pyCharm
    • Github use
    • Git Pull requests
    • Compiling the code
    • Makefile
    • Setup git
    • .bashrc
    • Pycharm different terminal
• Deprecated
  • Cloudmesh Config File Encryption
    • Background
    • Quick-Start
    • Installation
    • Preparation
    • Encrypting the Config File
    • Decrypting the Config File
    • Additional Configuration Options
      • Changing the secinit Directory
      • CMS Key Gen Options
        • Setting Non-Default Names for Key Generation
        • Setting Keys for Encryption Without Key Gen Command
        • Generating a Key Without a Password
      • Selecting Attributes to Encrypt
      • Selecting Attributes to Exclude from Encryption
  • Virtual Cluster (in progress)
    • Creating a Virtual Cluster and testing connections
    • Creating a runtime-configuration
    • Running Parallel Remote Jobs
    • Cleaning the remote
  • Batch
    • Creating a job configuration
    • Testing the connection
    • Running the Job
    • Downloading the Results
    • Cleaning the remote
    • Get the list of the jobs and clusters
    • Modifying the Configuration by Setting Parameters
    • Removing jobs and clusters
  • HPC
  • Infrastructure Workflow
    • Database Objects
      • Definition Collection
      • Running Flow Collection
    • Javascript Interface (proposed)
    • REST
    • Resources
  • Virtual Machine Management
    • Command Line and Shell Interface
    • Uniform Parameter Management
    • Virtual machine management
    • Key management
    • Security groups
    • Check instances
    • Command Examples
    • Example