Hyper Docs
  • Introduction
  • What is Hyper
  • Why Hyper
  • Regions
  • Pricing
  • Quota and Limits
  • FAQ
  • Getting Started
    • Generate API Credential
    • Install CLI
    • Part 1 - Starting and inspecting your first container
    • Part 2 - Working with multiple containers
    • Part 3 - Hyper Compose
    • Migrate data
      • hyper container as client
      • hyper container as server
  • Features
    • Container
      • Container
      • Logs
      • Compose
      • Cron
      • Service
      • Func
    • Storage
      • Volume
      • Snapshot
    • Network
      • Network
      • Floating IP
      • Port
      • Security Group
    • Console
      • Filter
  • Reference
    • CLI
      • attach
      • commit
      • config
      • create
      • exec
      • images
      • info
      • inspect
      • kill
      • load
      • login
      • logout
      • logs
      • port
      • ps
      • pull
      • push
      • rename
      • restart
      • rm
      • rmi
      • run
      • search
      • start
      • stats
      • stop
      • version
      • update
      • wait
      • Volume
        • create
        • init
        • inspect
        • ls
        • rm
      • Snapshot
        • create
        • ls
        • rm
      • FIP
        • allocate
        • attach
        • detach
        • ls
        • release
        • name
      • Security Group
        • create
        • ls
        • inspect
        • rm
        • update
      • Compose
        • create
        • down
        • up
        • rm
        • ps
        • pull
        • run
        • kill
        • start
        • stop
        • scale
      • Service
        • create
        • ls
        • inspect
        • scale
        • rolling-update
        • attach-fip
        • detach-fip
        • rm
      • Cron
        • create
        • inspect
        • ls
        • history
        • rm
      • Func
        • create
        • update
        • inspect
        • ls
        • rm
        • logs
        • call
        • get
    • API
      • 2016-04-04 [Ver. 1.23]
        • Container
          • List Containers
          • Create a container
          • Get container logs
          • Start a container
          • Stop a container
          • Restart a container
          • Resize a container
          • Rename a container
          • Kill a container
          • Attach to a container
          • Remove a container
          • Update a container
          • Get container stats
          • Inspect a container
          • Exec Create
          • Commit a container
        • Event
          • Monitor events with WebSocket
        • Misc
          • Display system-wide information
          • Show the hyper version information
          • Exec Start
          • Exec Resize
          • Exec Inspect
        • Image
          • Inspect Images
          • Search Images
          • List Images
          • Load Images
          • Create an image
          • Remove an image
          • Push an image
        • Volume
          • List volumes
          • Create a volume
          • Remove a volume
          • Init a volume
          • Inspect a volume
        • Snapshot
          • Create a snapshot
          • List snapshots
          • Inspect a snapshot
          • Remove a snapshot
        • Network
          • Allocate floating IP
          • Attach a floating IP to a (running) container
          • Detach floating IP from a (running) container
          • List floating IP
          • Release floating IP
          • Name floating IP
        • Security Group
          • Create a security group
          • Remove a security group
          • Inspect a security group
          • Update a security group
          • List security groups
        • Service
          • service create
          • service list
          • service inspect
          • service update
          • service remove
        • Compose
          • Compose up
          • Compose create
          • Compose down
          • Compose rm
          • Compose start
          • Compose stop
          • Compose kill
        • Cron
          • Cron create
          • Cron list
          • Cron inspect
          • Cron remove
          • Cron history
        • Func
          • Func create
          • Func update
          • Func list
          • Func inspect
          • Func remove
          • Func call
          • Func get
          • Func logs
          • Func status
    • Compose File Reference
    • Security Group Reference
  • FAQ
    • Pricing
    • Quota and Limits
    • Privacy Policy
    • Terms of Service
    • Acceptable Use Policy
  • Docs version
Powered by GitBook
On this page
  • Specify Your Regions
  • Setup the region credential
  • Specify a different region with the --region option
  • Layout of the region config file

Regions

Hyper regions are physical data centers isolated from one another. When you view your resources, you'll only see the resources tied to the region you've specified. This is because regions are isolated from each other, and are not replicated across regions automatically.

The following table lists the regions provided by Hyper

Region

Location

us-west-1

Los Angeles

eu-central-1

Frankfurt

Specify Your Regions

We now have support for two regions. You may specify the region via the --region option when you want to manage the resources for that specific region. The us-west-1 region will be the default region.

You can only use the --region option if first run the command hyper config. Otherwise all commands will default to the us-west-1 region.

Setup the region credential

$ hyper config
Enter Access Key: HYPERTHEMOSTEASYCONTAINER
Enter Secret Key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Enter Default Region (us-west-1):    # if set Europe region, it will be default region.
WARNING: Your login credentials has been saved in /home/lei/.hyper/config.json

Specify a different region with the --region option

$ hyper --region us-west-1 run -d busybox ping -c 30 8.8.8.8
e697934c9577171cf06bc6d458124306d54de9543ad74f2afb58fcf97a888b22
$ hyper --region us-west-1 ps
CONTAINER ID        IMAGE                                       COMMAND                  CREATED             STATUS                      PORTS                                              NAMES                       PUBLIC IP
e697934c9577        busybox                                     "ping -c 30 8.8.8.8"     52 seconds ago      Exited (0) 19 seconds ago                                                      evil-pike
# run `ps` with different region
$ hyper --region eu-central-1 ps
CONTAINER ID        IMAGE                                       COMMAND                  CREATED             STATUS                      PORTS                                              NAMES                       PUBLIC IP

Layout of the region config file

{
    "auths": {},
    "clouds": {
        "tcp://*.hyper.sh:443": {
            "accesskey": "HYPERTHEMOSTEASYCONTAINER",
            "secretkey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "region": "us-west-1"
        }
    }
}

You may find that there is a new field named region, it identifes which region is the default region. You may edit it with any editor, but we do recommand you modify it via hyper config command.

PreviousWhy HyperNextPricing

Last updated 7 years ago

A more detailed introduction to the hyper command line can be found here: .

CLI index