The corona Reference Manual

Table of Contents

The corona Reference Manual

This is the corona Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:38:46 2018 GMT+0.

1 Introduction

Corona

Corona is a library for creating and managing virtual machines from Common Lisp. All you need is VirtualBox and an internet connection.

Corona uses Vagrant Cloud as a source of base systems to bootstrap virtual machines from.

Usage

(defmachine my-app
  :system (:ubuntu :14.04 :64)
  :memory 1024)

(start my-app)

(stop my-app)

That's it.

Use Cases

Development Environments

Corona can be used to create isolated, reproducible development environments so you and your team can work on the same system.

No more 'works on my machine', no more difference between development and production.

Testing

If you have a library that uses an external tool, like a database server or something equally large, you can use Corona to set up a virtual machine and install whatever dependencies you need, so the user doesn't actually have to run anything on their computer.

Additionally, since you can set up multiple virtual machines with different systems, you can use Corona to ensure your library works on most operating systems. This is especially useful for testing compilers and similar applications where portability is critical.

Building

You can use Corona as a build server: Fire up virtual machines of the operating system you want to build on, set them up with everything you need, and run the builds.

Usage

Defining Machines

Machines are defined with the defmachine macro. The first argument to defmachine is a symbol, which will be the machine's name (Including the package). The other arguments are:

system : This is a system triple, a literal list with three elements which uniquely identifies a base system: The system's name, version, and architecture.

memory : The amount of RAM given to the VM in megabytes. Default: 512.

cpu-count : The number of virtual CPUs. One by default.

ip : The system's IP address. By default this is not used.

Examples:

(defmachine my-app:db-server
  :system (:debian :7.4 :32)
  :memory 2048
  :ip "192.128.65.20")

(defmachine my-app:web-server
  :system (:freebsd :10.0 :64)
  :memory 512
  :cpu-count 2)

Controlling VM State

The following six functions can be used to control the state of the virtual machines:

start, stop : Start and shut down the VM. If possible, shut it down gently.

pause, resume : Pause and resume the VM.

reboot : Reboot the virtual machine.

poweroff : Force VM shutdown.

Examples:

(start my-app:web-server)

;; Do some work

(pause my-app:web-server)

;; Come back to work next morning

(resume my-app:web-server)

;; Shut it down

(stop my-app:web-server)

FAQ

Why not Vagrant?

The advantage over Vagrant is simply that it's written in Common Lisp and, as such, available in Quicklisp without any external commands. This way, the library can be included as a dependency and used without anyone having to set up an external tool other than VirtualBox.

Where are disk images stored?

Everything is stored in specific subdirectories under ~/.config/corona/. Vagrant Cloud images are stored, in their extracted form, in ~/.config/corona/files/vagrant-cloud/. The disk images of virtual machines are stored in ~/.config/corona/files/virtual-machines.

How are VM names handled?

Virtual machines are identified by a name, which is a Common Lisp symbol. Inside the VM directory, all the data for a virtual machine is stored inside a folder for the package and another folder for the symbol name. For example:

virtual-machines/
  COMMON-LISP/
    TEST-VM/
    UBUNTU-PERSONAL/
  MY-APP/
    TESTING/
    STAGING/

The names of your virtual machines are restricted by the limitations of your filesystem (Allowed characters, pathname length, etc.). Rather than add specific checks for meaningless edge cases, I'll just warn you not to name your virtual machines myapp:My/Test\<<VM>>.

License

Copyright (c) 2014-2015 Fernando Borretti (eudoxiahp@gmail.com)

Licensed under the MIT License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 corona

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

http://eudoxia.me/corona

Source Control

(:git "git@github.com:eudoxia0/corona.git")

Bug Tracker

https://github.com/eudoxia0/corona/issues

License

MIT

Description

Isolated, reproducible virtual development environments.

Long Description

# Corona

Corona is a library for creating and managing virtual machines from Common Lisp. All you need is VirtualBox and an internet connection.

Corona uses [Vagrant Cloud][vc] as a source of base systems to bootstrap virtual machines from.

[vc]: https://vagrantcloud.com/

## Usage

~~~lisp
(defmachine my-app
:system (:ubuntu :14.04 :64)
:memory 1024)

(start my-app)

(stop my-app)
~~~

That’s it.

# Use Cases

## Development Environments

Corona can be used to create isolated, reproducible development environments so you and your team can work on the same system.

No more ’works on my machine’, no more difference between development and production.

## Testing

If you have a library that uses an external tool, like a database server or something equally large, you can use Corona to set up a virtual machine and install whatever dependencies you need, so the user doesn’t actually have to run anything on their computer.

Additionally, since you can set up multiple virtual machines with different systems, you can use Corona to ensure your library works on most operating systems. This is especially useful for testing compilers and similar applications where portability is critical.

## Building

You can use Corona as a build server: Fire up virtual machines of the operating system you want to build on, set them up with everything you need, and run the builds.

# Usage

## Defining Machines

Machines are defined with the ‘defmachine‘ macro. The first argument to ‘defmachine‘ is a symbol, which will be the machine’s name (Including the package). The other arguments are:

‘system‘
: This is a system triple, a literal list with three elements which uniquely identifies a base system: The system’s name, version, and architecture.

‘memory‘
: The amount of RAM given to the VM in megabytes. Default: ‘512‘.

‘cpu-count‘
: The number of virtual CPUs. One by default.

‘ip‘
: The system’s IP address. By default this is not used.

Examples:

“‘lisp
(defmachine my-app:db-server
:system (:debian :7.4 :32)
:memory 2048
:ip "192.128.65.20")

(defmachine my-app:web-server
:system (:freebsd :10.0 :64)
:memory 512
:cpu-count 2)
“‘

## Controlling VM State

The following six functions can be used to control the state of the virtual machines:

‘start‘, ‘stop‘
: Start and shut down the VM. If possible, shut it down gently.

‘pause‘, ‘resume‘
: Pause and resume the VM.

‘reboot‘
: Reboot the virtual machine.

‘poweroff‘
: Force VM shutdown.

Examples:

“‘lisp
(start my-app:web-server)

;; Do some work

(pause my-app:web-server)

;; Come back to work next morning

(resume my-app:web-server)

;; Shut it down

(stop my-app:web-server)
“‘

# FAQ

## Why not Vagrant?

The advantage over Vagrant is simply that it’s written in Common Lisp and, as such, available in Quicklisp without any external commands. This way, the library can be included as a dependency and used without anyone having to set up an external tool other than VirtualBox.

## Where are disk images stored?

Everything is stored in specific subdirectories under
‘~/.config/corona/‘. Vagrant Cloud images are stored, in their extracted form, in ‘~/.config/corona/files/vagrant-cloud/‘. The disk images of virtual machines are stored in ‘~/.config/corona/files/virtual-machines‘.

## How are VM names handled?

Virtual machines are identified by a name, which is a Common Lisp symbol. Inside the VM directory, all the data for a virtual machine is stored inside a folder for the package and another folder for the symbol name. For example:

~~~
virtual-machines/
COMMON-LISP/
TEST-VM/
UBUNTU-PERSONAL/
MY-APP/
TESTING/
STAGING/
~~~

The names of your virtual machines are restricted by the limitations of your filesystem (Allowed characters, pathname length, etc.). Rather than add specific checks for meaningless edge cases, I’ll just warn you not to name your virtual machines ‘myapp:My/Test\<<VM>>‘.

# License

Copyright (c) 2014-2015 Fernando Borretti (eudoxiahp@gmail.com)

Licensed under the MIT License.

Version

0.1

Dependencies

• cl-virtualbox
• trivial-download
• trivial-types
• trivial-extract
• ironclad
• cl-fad
• log4cl
• anaphora

Source

corona.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 corona/src

Parent

corona (system)

Location

src/

Components

• files.lisp (file)
• vagrant-cloud.lisp (file)
• system.lisp (file)
• system-list.lisp (file)
• virtual-machines.lisp (file)
• corona.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 corona.asd

Location

corona.asd

Systems

corona (system)

Packages

corona-asd

4.1.2 corona/src/files.lisp

Parent

src (module)

Location

src/files.lisp

Packages

corona.files

Exported Definitions

• +corona-directory+ (special variable)
• +vagrant-cloud-directory+ (special variable)
• +vm-directory+ (special variable)
• copy-files-to-directory (function)
• download (function)
• verify-file (function)

Internal Definitions

• +files-directory+ (special variable)
• checksum-mismatch (condition)
• checksum-type (method)
• download-over-curl (function)
• file-checksum (function)
• file-sum (method)
• have-curl-p (function)
• path (method)
• trusted-sum (method)

4.1.3 corona/src/vagrant-cloud.lisp

Dependency

files.lisp (file)

Parent

src (module)

Location

src/vagrant-cloud.lisp

Packages

corona.cloud

Exported Definitions

• <cloud-box> (class)
• author (method)
• box-directory (method)
• checksum (method)
• checksum-type (method)
• download-and-extract-box (method)
• local-box-p (method)
• name (method)
• source-url (method)
• version (method)

Internal Definitions

+vagrant-cloud-url-fmt+ (special variable)

4.1.4 corona/src/system.lisp

Dependency

vagrant-cloud.lisp (file)

Parent

src (module)

Location

src/system.lisp

Packages

corona.sys

Exported Definitions

• <system> (class)
• arch (method)
• box (method)
• ensure-box (method)
• find-system (function)
• list-archs-for-system (function)
• list-system-names (function)
• list-systems (function)
• list-versions-for-system (function)
• name (method)
• version (method)

Internal Definitions

• *known-systems* (special variable)
• define-box (macro)
• define-system (macro)

4.1.5 corona/src/system-list.lisp

Dependency

system.lisp (file)

Parent

src (module)

Location

src/system-list.lisp

4.1.6 corona/src/virtual-machines.lisp

Dependency

system-list.lisp (file)

Parent

src (module)

Location

src/virtual-machines.lisp

Packages

corona.vm

Exported Definitions

• <hardware> (class)
• <vm> (class)
• already-built-p (method)
• build-vm (method)
• cpu-count (method)
• gb (function)
• hardware (method)
• memory (method)
• name (method)
• pause (method)
• poweroff (method)
• reboot (method)
• resume (method)
• setup-vm (method)
• start (method)
• stop (method)
• system (method)
• vm-directory (method)

Internal Definitions

• +wait-time+ (special variable)
• ensure-vm (method)
• ip (method)
• map-ports (method)
• network-name (method)
• readyp (method)
• stored-name (method)
• wait-for-ready (method)

4.1.7 corona/src/corona.lisp

Dependency

virtual-machines.lisp (file)

Parent

src (module)

Location

src/corona.lisp

Packages

corona

Exported Definitions

defmachine (macro)

5 Packages

Packages are listed by definition order.

5.1 corona-asd

Source

corona.asd

Use List

• asdf/interface
• common-lisp

5.2 corona.files

Source

files.lisp (file)

Use List

common-lisp

Exported Definitions

• +corona-directory+ (special variable)
• +vagrant-cloud-directory+ (special variable)
• +vm-directory+ (special variable)
• copy-files-to-directory (function)
• download (function)
• verify-file (function)

Internal Definitions

• +files-directory+ (special variable)
• checksum-mismatch (condition)
• checksum-type (generic function)
• checksum-type (method)
• download-over-curl (function)
• file-checksum (function)
• file-sum (generic function)
• file-sum (method)
• have-curl-p (function)
• path (generic function)
• path (method)
• trusted-sum (generic function)
• trusted-sum (method)

5.3 corona.cloud

Source

vagrant-cloud.lisp (file)

Use List

common-lisp

Exported Definitions

• <cloud-box> (class)
• author (generic function)
• author (method)
• box-directory (generic function)
• box-directory (method)
• checksum (generic function)
• checksum (method)
• checksum-type (generic function)
• checksum-type (method)
• download-and-extract-box (generic function)
• download-and-extract-box (method)
• local-box-p (generic function)
• local-box-p (method)
• name (generic function)
• name (method)
• source-url (generic function)
• source-url (method)
• version (generic function)
• version (method)

Internal Definitions

+vagrant-cloud-url-fmt+ (special variable)

5.4 corona.sys

Source

system.lisp (file)

Use List

common-lisp

Exported Definitions

• <system> (class)
• arch (generic function)
• arch (method)
• box (generic function)
• box (method)
• ensure-box (generic function)
• ensure-box (method)
• find-system (function)
• list-archs-for-system (function)
• list-system-names (function)
• list-systems (function)
• list-versions-for-system (function)
• name (generic function)
• name (method)
• version (generic function)
• version (method)

Internal Definitions

• *known-systems* (special variable)
• define-box (macro)
• define-system (macro)

5.5 corona.vm

Source

virtual-machines.lisp (file)

Use List

• anaphora
• common-lisp

Exported Definitions

• <hardware> (class)
• <vm> (class)
• already-built-p (generic function)
• already-built-p (method)
• build-vm (generic function)
• build-vm (method)
• cpu-count (generic function)
• cpu-count (method)
• gb (function)
• hardware (generic function)
• hardware (method)
• memory (generic function)
• memory (method)
• name (generic function)
• name (method)
• pause (generic function)
• pause (method)
• poweroff (generic function)
• poweroff (method)
• reboot (generic function)
• reboot (method)
• resume (generic function)
• resume (method)
• setup-vm (generic function)
• setup-vm (method)
• start (generic function)
• start (method)
• stop (generic function)
• stop (method)
• system (generic function)
• system (method)
• vm-directory (generic function)
• vm-directory (method)

Internal Definitions

• +wait-time+ (special variable)
• ensure-vm (generic function)
• ensure-vm (method)
• ip (generic function)
• ip (method)
• map-ports (generic function)
• map-ports (method)
• network-name (generic function)
• network-name (method)
• readyp (generic function)
• readyp (method)
• stored-name (generic function)
• stored-name (method)
• wait-for-ready (generic function)
• wait-for-ready (method)

5.6 corona

Source

corona.lisp (file)

Use List

common-lisp

Exported Definitions

defmachine (macro)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: +corona-directory+

The directory where Corona stores everything it needs. By default, this is ‘~/.corona‘, but when testing this is overriden to the path to the Corona system definition, plus ‘t/corona‘.

Package

corona.files

Source

files.lisp (file)

Special Variable: +vagrant-cloud-directory+

The directory where Corona stores Vagrant Cloud images.

Package

corona.files

Source

files.lisp (file)

Special Variable: +vm-directory+

The directory where images of specific virtual machines are stored.

Package

corona.files

Source

files.lisp (file)

6.1.2 Macros

Macro: defmachine NAME &key SYSTEM MEMORY CPU-COUNT IP

Package

corona

Source

corona.lisp (file)

6.1.3 Functions

Function: copy-files-to-directory FILES DESTINATION

Copy a list of files to the ‘destination‘ directory.

Package

corona.files

Source

files.lisp (file)

Function: download URL PATHNAME

Download the file from ‘url‘ to its pathname if it doesn’t exist, returning ‘t‘. If it already exists, return ‘nil‘.

Package

corona.files

Source

files.lisp (file)

Function: find-system NAME VERSION ARCHITECTURE

Package

corona.sys

Source

system.lisp (file)

Function: gb AMOUNT

Convert ‘amount‘ gigabytes to megabytes.

Package

corona.vm

Source

virtual-machines.lisp (file)

Function: list-archs-for-system NAME

List the available architectures of a given system.

Package

corona.sys

Source

system.lisp (file)

Function: list-system-names ()

List the names of available systems.

Package

corona.sys

Source

system.lisp (file)

Function: list-systems &optional STREAM

Return a summary of available systems, their versions and architectures.

Package

corona.sys

Source

system.lisp (file)

Function: list-versions-for-system NAME

List the available versions of a given system.

Package

corona.sys

Source

system.lisp (file)

Function: verify-file PATHNAME CHECKSUM-TYPE CHECKSUM

Verify the ‘checksum-type‘ checksum of the file at ‘pathname‘ is equal to ‘checksum‘.

Package

corona.files

Source

files.lisp (file)

6.1.4 Generic functions

Generic Function: already-built-p VM

Package

corona.vm

Methods

Method: already-built-p (VM <vm>)

Have we already built the VM?

Source

virtual-machines.lisp (file)

Generic Function: arch OBJECT

Package

corona.sys

Methods

Method: arch (<SYSTEM> <system>)

The operating system’s architecture as a keyword, e.g. :64, :sparc.

Source

system.lisp (file)

Generic Function: author OBJECT

Package

corona.cloud

Methods

Method: author (<CLOUD-BOX> <cloud-box>)

The author name in Vagrant Cloud.

Source

vagrant-cloud.lisp (file)

Generic Function: box OBJECT

Package

corona.sys

Methods

Method: box (<SYSTEM> <system>)

The box that bootstraps this system.

Source

system.lisp (file)

Generic Function: box-directory BOX

Package

corona.cloud

Methods

Method: box-directory (BOX <cloud-box>)

Directory where a box contents would be/are stored.

Source

vagrant-cloud.lisp (file)

Generic Function: build-vm VM

Package

corona.vm

Methods

Method: build-vm (VM <vm>)

Build a virtual machine if it’s not yet built, downloading its base box if it’s not yet available. Returns ‘t‘ if everything went as planned, ‘nil‘ if the VM was already built.

Source

virtual-machines.lisp (file)

Generic Function: checksum OBJECT

Package

corona.cloud

Methods

Method: checksum (<CLOUD-BOX> <cloud-box>)

The checksum string.

Source

vagrant-cloud.lisp (file)

Generic Function: checksum-type OBJECT

Package

corona.cloud

Methods

Method: checksum-type (<CLOUD-BOX> <cloud-box>)

The type of checksum used to verify the download, e.g. :sha1, :md5.

Source

vagrant-cloud.lisp (file)

Generic Function: cpu-count OBJECT

Package

corona.vm

Methods

Method: cpu-count (<HARDWARE> <hardware>)

The number of virtual CPUs.

Source

virtual-machines.lisp (file)

Generic Function: download-and-extract-box BOX

Package

corona.cloud

Methods

Method: download-and-extract-box (BOX <cloud-box>)

Download a box from Vagrant Cloud, and extract its contents unless it already exists.

Source

vagrant-cloud.lisp (file)

Generic Function: ensure-box SYS

Package

corona.sys

Methods

Method: ensure-box (SYS <system>)

Ensure the system’s box is ready to be imported.

Source

system.lisp (file)

Generic Function: hardware OBJECT

Package

corona.vm

Methods

Method: hardware (<VM> <vm>)

The virtual hardware.

Source

virtual-machines.lisp (file)

Generic Function: local-box-p BOX

Package

corona.cloud

Methods

Method: local-box-p (BOX <cloud-box>)

Have we already downloaded the box?

Source

vagrant-cloud.lisp (file)

Generic Function: memory OBJECT

Package

corona.vm

Methods

Method: memory (<HARDWARE> <hardware>)

The virtual memory in megabytes.

Source

virtual-machines.lisp (file)

Generic Function: name OBJECT

Package

corona.cloud

Methods

Method: name (<CLOUD-BOX> <cloud-box>)

The box name in Vagrant Cloud.

Source

vagrant-cloud.lisp (file)

Generic Function: name OBJECT

Package

corona.sys

Methods

Method: name (<SYSTEM> <system>)

The name of the operating system, e.g. :ubuntu, :windows.

Source

system.lisp (file)

Generic Function: name OBJECT

Package

corona.vm

Methods

Method: name (<VM> <vm>)

The virtual machine name.

Source

virtual-machines.lisp (file)

Generic Function: pause VM

Package

corona.vm

Methods

Method: pause (VM <vm>)

Pause the VM.

Source

virtual-machines.lisp (file)

Generic Function: poweroff VM

Package

corona.vm

Methods

Method: poweroff (VM <vm>)

Force the VM to shut down.

Source

virtual-machines.lisp (file)

Generic Function: reboot VM

Package

corona.vm

Methods

Method: reboot (VM <vm>)

Reboot the VM.

Source

virtual-machines.lisp (file)

Generic Function: resume VM

Package

corona.vm

Methods

Method: resume (VM <vm>)

Resume a paused VM.

Source

virtual-machines.lisp (file)

Generic Function: setup-vm VM

Package

corona.vm

Methods

Method: setup-vm (VM <vm>)

Apply the virtual machine’s virtual hardware settings.

Source

virtual-machines.lisp (file)

Generic Function: source-url BOX

Package

corona.cloud

Methods

Method: source-url (BOX <cloud-box>)

URL to download a cloud box.

Source

vagrant-cloud.lisp (file)

Generic Function: start VM

Package

corona.vm

Methods

Method: start (VM <vm>)

Start the VM.

Source

virtual-machines.lisp (file)

Generic Function: stop VM

Package

corona.vm

Methods

Method: stop (VM <vm>)

Stop the VM.

Source

virtual-machines.lisp (file)

Generic Function: system OBJECT

Package

corona.vm

Methods

Method: system (<VM> <vm>)

The system this VM holds.

Source

virtual-machines.lisp (file)

Generic Function: version OBJECT

Package

corona.cloud

Methods

Method: version (<CLOUD-BOX> <cloud-box>)

The box version in Vagrant Cloud.

Source

vagrant-cloud.lisp (file)

Generic Function: version OBJECT

Package

corona.sys

Methods

Method: version (<SYSTEM> <system>)

The operating system’s version string as a keyword, e.g. :13.13.

Source

system.lisp (file)

Generic Function: vm-directory VM

Package

corona.vm

Methods

Method: vm-directory (VM <vm>)

Directory where VM configuration/disks are stored.

Source

virtual-machines.lisp (file)

6.1.5 Classes

Class: <cloud-box> ()

A base box.

Package

corona.cloud

Source

vagrant-cloud.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• download-and-extract-box (method)
• local-box-p (method)
• box-directory (method)
• source-url (method)
• checksum (method)
• checksum-type (method)
• version (method)
• author (method)
• name (method)

Direct slots

Slot: name

The box name in Vagrant Cloud.

Type

string

Initargs

:name

Readers

name (generic function)

Slot: author

The author name in Vagrant Cloud.

Type

string

Initargs

:author

Readers

author (generic function)

Slot: version

The box version in Vagrant Cloud.

Type

keyword

Initargs

:version

Readers

version (generic function)

Slot: checksum-type

The type of checksum used to verify the download, e.g. :sha1, :md5.

Type

keyword

Initargs

:checksum-type

Readers

checksum-type (generic function)

Slot: checksum

The checksum string.

Type

string

Initargs

:checksum

Readers

checksum (generic function)

Class: <hardware> ()

Virtual machine hardware. Some of these are probably VirtualBox-specific.

Package

corona.vm

Source

virtual-machines.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• cpu-count (method)
• memory (method)

Direct slots

Slot: memory

The virtual memory in megabytes.

Type

integer

Initargs

:memory

Initform

1024

Readers

memory (generic function)

Slot: cpu-count

The number of virtual CPUs.

Type

integer

Initargs

:cpu-count

Initform

1

Readers

cpu-count (generic function)

Class: <system> ()

Package

corona.sys

Source

system.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• ensure-box (method)
• box (method)
• arch (method)
• version (method)
• name (method)

Direct slots

Slot: name

The name of the operating system, e.g. :ubuntu, :windows.

Type

keyword

Initargs

:name

Readers

name (generic function)

Slot: version

The operating system’s version string as a keyword, e.g. :13.13.

Type

keyword

Initargs

:version

Readers

version (generic function)

Slot: arch

The operating system’s architecture as a keyword, e.g. :64, :sparc.

Type

keyword

Initargs

:arch

Readers

arch (generic function)

Slot: box

The box that bootstraps this system.

Type

corona.cloud:<cloud-box>

Initargs

:box

Readers

box (generic function)

Class: <vm> ()

A virtual machine is an instance of a system’s base box with its own virtual drive and resources.

Package

corona.vm

Source

virtual-machines.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• map-ports (method)
• poweroff (method)
• reboot (method)
• resume (method)
• pause (method)
• stop (method)
• start (method)
• wait-for-ready (method)
• readyp (method)
• ensure-vm (method)
• setup-vm (method)
• build-vm (method)
• already-built-p (method)
• vm-directory (method)
• network-name (method)
• stored-name (method)
• ip (method)
• hardware (method)
• system (method)
• name (method)

Direct slots

Slot: name

The virtual machine name.

Type

symbol

Initargs

:name

Readers

name (generic function)

Slot: system

The system this VM holds.

Type

corona.sys:<system>

Initargs

:system

Readers

system (generic function)

Slot: hardware

The virtual hardware.

Type

corona.vm:<hardware>

Initargs

:hardware

Readers

hardware (generic function)

Slot: ip

The VM’s IP address as a string.

Type

string

Initargs

:ip

Readers

ip (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *known-systems*

A list of available systems.

Package

corona.sys

Source

system.lisp (file)

Special Variable: +files-directory+

The directory where Corona stores files (CD/DVD images, virtual machine images, virtual hard drives, etc.)

Package

corona.files

Source

files.lisp (file)

Special Variable: +vagrant-cloud-url-fmt+

The format control string for a Vagrant Cloud box URL. The first parameter is the username, then the box name, and finally the version number.

Package

corona.cloud

Source

vagrant-cloud.lisp (file)

Special Variable: +wait-time+

Package

corona.vm

Source

virtual-machines.lisp (file)

6.2.2 Macros

Macro: define-box &rest PARAMS

Package

corona.sys

Source

system.lisp (file)

Macro: define-system &rest PARAMS

Package

corona.sys

Source

system.lisp (file)

6.2.3 Functions

Function: download-over-curl URL PATHNAME

Package

corona.files

Source

files.lisp (file)

Function: file-checksum CHECKSUM-TYPE PATHNAME

Generate the checksum of a file.

Package

corona.files

Source

files.lisp (file)

Function: have-curl-p ()

Package

corona.files

Source

files.lisp (file)

6.2.4 Generic functions

Generic Function: checksum-type CONDITION

Package

corona.files

Methods

Method: checksum-type (CONDITION checksum-mismatch)

Source

files.lisp (file)

Generic Function: ensure-vm VM

Package

corona.vm

Methods

Method: ensure-vm (VM <vm>)

Ensure the VM is built an setup.

Source

virtual-machines.lisp (file)

Generic Function: file-sum CONDITION

Package

corona.files

Methods

Method: file-sum (CONDITION checksum-mismatch)

Source

files.lisp (file)

Generic Function: ip OBJECT

Package

corona.vm

Methods

Method: ip (<VM> <vm>)

The VM’s IP address as a string.

Source

virtual-machines.lisp (file)

Generic Function: map-ports VM HOST-PORT GUEST-PORT

Package

corona.vm

Methods

Method: map-ports (VM <vm>) HOST-PORT GUEST-PORT

Map traffic going to ‘host-port‘ to ‘guest-port‘ if the machine has a ‘host‘.

Source

virtual-machines.lisp (file)

Generic Function: network-name VM

Package

corona.vm

Methods

Method: network-name (VM <vm>)

The name of the machine’s network.

Source

virtual-machines.lisp (file)

Generic Function: path CONDITION

Package

corona.files

Methods

Method: path (CONDITION checksum-mismatch)

Source

files.lisp (file)

Generic Function: readyp VM

Package

corona.vm

Methods

Method: readyp (VM <vm>)

Is the virtual machine ready to accept a login?

Source

virtual-machines.lisp (file)

Generic Function: stored-name VM

Package

corona.vm

Methods

Method: stored-name (VM <vm>)

The name of the virtual machine that VirtualBox knows.

Source

virtual-machines.lisp (file)

Generic Function: trusted-sum CONDITION

Package

corona.files

Methods

Method: trusted-sum (CONDITION checksum-mismatch)

Source

files.lisp (file)

Generic Function: wait-for-ready VM

Package

corona.vm

Methods

Method: wait-for-ready (VM <vm>)

Wait until the machine is ready for operation.

Source

virtual-machines.lisp (file)

6.2.5 Conditions

Condition: checksum-mismatch ()

Package

corona.files

Source

files.lisp (file)

Direct superclasses

error (condition)

Direct methods

• trusted-sum (method)
• file-sum (method)
• checksum-type (method)
• path (method)

Direct slots

Slot: path

Initargs

:path

Readers

path (generic function)

Slot: checksum-type

Initargs

:checksum-type

Readers

checksum-type (generic function)

Slot: file-sum

Initargs

:file-sum

Readers

file-sum (generic function)

Slot: trusted-sum

Initargs

:trusted-sum

Readers

trusted-sum (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types