Skip to end of metadata
Go to start of metadata

OS Virtualized Machines, hereafter referred to as Zones, is a lightweight virtualization technology. Zones are fully isolated user-land environments, they do not possess their own kernel and therefore have effectively no performance overhead allowing for bare metal performance. Network and disk virtualization are provided by ZFS and the SmartOS networking stack ("Crossbow"). The result is a virtual environment that in every way acts like a complete environment.

Creating Zones

The process of creating zones is simple:

  1. Download a Zone Image
  2. Create a Manifest describing the Zone
  3. Create the Zone using vmadm
  4. Use the Zone

Obtaining a Zone Image

Zone creation requires an image to use as a template.

To find a zone image, use the command imgadm avail. Images with the OS type "smartos" are zone images. The "base" and "base-64" images are minimal images with only a basic 32bit or 64bit pkgsrc installation and should be considered for building your own custom images.

# imgadm avail name=base-64
UUID                                  NAME     VERSION  OS       TYPE          PUB
163cd9fe-0c90-11e6-bd05-afd50e5961b6  base-64  16.1.0   smartos  zone-dataset  2016-04-27
13f711f4-499f-11e6-8ea6-2b9fb858a619  base-64  16.2.0   smartos  zone-dataset  2016-07-14
adf9565c-8be6-11e6-a077-57637270218d  base-64  16.3.0   smartos  zone-dataset  2016-10-06
70e3ae72-96b6-11e6-9056-9737fd4d0764  base-64  16.3.1   smartos  zone-dataset  2016-10-20
f6acf198-2037-11e7-8863-8fdd4ce58b6a  base-64  17.1.0   smartos  zone-dataset  2017-04-13
643de2c0-672e-11e7-9a3f-ff62fd3708f8  base-64  17.2.0   smartos  zone-dataset  2017-07-12

Import an image by specifying its UUID:

# imgadm import 643de2c0-672e-11e7-9a3f-ff62fd3708f8
Importing 643de2c0-672e-11e7-9a3f-ff62fd3708f8 (base-64@17.2.0) from ""
Gather image 643de2c0-672e-11e7-9a3f-ff62fd3708f8 ancestry
Must download and install 1 image (176.6 MiB)
Imported image 643de2c0-672e-11e7-9a3f-ff62fd3708f8 (base-64@17.2.0)

You will reference this image's UUID when you create the zone manifest.

The Zone Manifest

A manifest is a JSON object which describes your zone. There are many options which are fully described in the vmadm(1m) man page. The most important are:

  • brand: This must be set to "joyent" for Zones
  • image_uuid: The UUID of the image you are using as a template (images were previously called "datasets")
  • alias: An arbitrary name displayed in vmadm list output in addition to the UUID
  • hostname: Hostname that will be set within the zone
  • max_physical_memory: Amount of RAM (RSS) available to the zone in MB
  • quota: Amount of disk space in GB
  • resolvers: DNS nameservers for this zone to use (placed in the zone's /etc/resolv.conf file)
  • nics: One or more network interfaces attached to this zone

Passing SSH keys to the VM

With some images you won't be able to log in to unless you pass an SSH public key to validate your connection with. Adjust your config to contain a customer_metadata block:

Creating the Zone

With your image imported and your manifest created, you can now create the zone. Do this by simply passing the manifest to vmadm create -f manifest.json:

# vmadm create -f web01.json
Successfully created VM d6a0a022-3855-4762-a2e5-3f16969ca2fb

Alternatively, you can pass the manifest via STDIN:

# vmadm create <<EOL
  (manifest json here)

The zone is now created and running.

Connecting to your Zone

Once you have created a zone with vmadm create, you can log into your zone via ssh or connect to the console with one of two methods:


Please refer to the manpage for vmadm(1m) and zlogin(1) respectively, for the escape sequence to exit out of console mode.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Oct 28, 2012

    It'd be great to add information on where to look for login credentials for joyent templates. Case in point I have just created a new VM using the base64 template and I have no idea what username / password to use on its console. 


    So I realised I should use the 'zlogin UUID' method as that doesn't require authentication, then 'passwd admin' etc. (as opposed to 'vmadm console UUID' which of course gives you the console login prompt).

    I also tried replacing the password in the zones shadow file but that didn't seem to work. 

    1. Feb 19, 2015

      You can set those passwords for the two predefined users yourself.

      Just add a section to your json while creating the machine:

      You can use the username "admin" to connect via ssh or root/admin if you use the console on the GZ

      Behaviour changed
      in the later SmartOS versions all metadata keys that end in '_pw' need to go into 'internal_metadata':
      1. Nov 03, 2012


        Hi, Daniel

        As you mentioned, "username" and "password" can be added in the coustermer_metedata.

        Do you know any other keys can be added in the metedata field?

        Assuming I wanna install mysql in the vm, what should I do in the creatation stepps?

        thank you! 

      2. Feb 10, 2013

        it should be noted that "root" and "admin" are the only accounts this works with, and that this is specific to the zoneinit scripts in specific datasets.  You can't, for example, use: "ryan_pw": "secretstuff" ... that will not work.

  2. Mar 21, 2013

    I've did this little hack to make my ssh_key working for the root and admin account, add the following to your json file, it's not perfect, but it works.

    "customer_metadata" : {
       "root_authorized_keys" : " ssh-rsa lalalalbbalak x@whatever\nssh-rsa 98ydoiowiu y@blah",
       "user-script" : "/usr/sbin/mdata-get root_authorized_keys > ~root/.ssh/authorized_keys ; /usr/sbin/mdata-get root_authorized_keys > ~admin/.ssh/authorized_keys"

    That's it

    1. Sep 16, 2013

      Sebastien, that is brilliant!  Thank you for sharing that.  Really cool.  That just saved me a lot of headaches.

  3. Sep 27, 2013

    How do I create a zone on a dedicated disk? I've 4 SATA disks, during setup, I specified the first disk and then used another one for dump. Created two VMs as well. Now I'd like each one of these VMs to have exclusive access to one disk each. How do I do that?