Categorygithub.com/yamamoto-febc/docker-machine-sakuracloud
repositorypackage
0.0.16
Repository: https://github.com/yamamoto-febc/docker-machine-sakuracloud.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

Docker Machine SAKURA CLOUD Driver

This is a plugin for Docker Machine allowing to create Docker hosts on SAKURA CLOUD

(日本語版)

Build Status

Requirements

Tested Operationg System

  • OSX 10.9+
  • Windows 10

Installation

Install for Windows

Download the installer from here and run it.

Install for OSX:

download the binary docker-machine-driver-sakuracloud and make it available by $PATH, for example by putting it to /usr/local/bin/

curl -L https://github.com/yamamoto-febc/docker-machine-sakuracloud/releases/download/v0.0.13/docker-machine-driver-sakuracloud-`uname -s`-`uname -m` >/usr/local/bin/docker-machine-driver-sakuracloud && \
  chmod +x /usr/local/bin/docker-machine/docker-machine-driver-sakuracloud

The latest version of docker-machine-driver-sakuracloud binary is available on the "Releases" page.

Usage

Official documentation for Docker Machine is available here.

To create a virtual machine on SAKURA CLOUD for Docker purposes just run this command:

$ docker-machine create --driver=sakuracloud \
    --sakuracloud-access-token=[YOUR TOKEN] \
    --sakuracloud-access-token-secret=[YOUR TOKEN SECRET] \
    sakura-dev

Options:

  • --sakuracloud-access-token: required Your personal access token for the SAKURA CLOUD API.
  • --sakuracloud-access-token-secret: required Your personal access token secret for the SAKURA CLOUD API.
  • --sakuracloud-core: The number of CPU cores.
  • --sakuracloud-connected-switch: The ID of SAKURA CLOUD switch or router.
  • --sakuracloud-disk-connection: The type of disk connection (virtio or ide).
  • --sakuracloud-disk-name: The name of SAKURA CLOUD disk.
  • --sakuracloud-disk-plan: The plan of SAKURA CLOUD disk plan (HDD:2 or SSD:4).
  • --sakuracloud-disk-size: The size of disk for the SAKURA CLOUD server(in MB).
  • --sakuracloud-dns-zone : The domain name for SAKURACLOUD DNS.
  • --sakuracloud-memory-size: The size of Memory(in GB).
  • --sakuracloud-private-ip-only: The flag of to use private IP only(use eth1 only).
  • --sakuracloud-private-ip: The IP address for eth1.
  • --sakuracloud-private-ip-subnet-mask: The subnet mask for eth1.
  • --sakuracloud-gateway: The default gateway ip address.
  • --sakuracloud-region: The resion to create the server in.
  • --sakuracloud-group: The @group tag.
  • --sakuracloud-gslb: The Name of GSLB.
  • --sakuracloud-auto-reboot: The @auto-reboot tag.
  • --sakuracloud-ignore-virtio-net: The flag of to not set @virtio-net-pci tag.
  • --sakuracloud-packet-filter: The Packet Filter ID or Name for eth0(shared).
  • --sakuracloud-private-packet-filter: The Packet Filter ID or Name for eth1(private).
  • --sakuracloud-enable-password-auth : The flag of enable password auth.
  • --sakuracloud-engine-port : The number of DockerEngine port.
  • --sakuracloud-ssh-key : The path of ssh private key.

Environment variables and default values:

CLI optionEnvironment variableDefault
--sakuracloud-access-tokenSAKURACLOUD_ACCESS_TOKEN-
--sakuracloud-access-token-secretSAKURACLOUD_ACCESS_TOKEN_SECRET-
--sakuracloud-auto-rebootSAKURACLOUD_AUTO_REBOOT-
--sakuracloud-coreSAKURACLOUD_CORE1
--sakuracloud-connected-switchSAKURACLOUD_CONNECTED_SWITCH-
--sakuracloud-disk-connectionSAKURACLOUD_DISK_CONNECTIONvirtio
--sakuracloud-disk-nameSAKURACLOUD_DISK_NAMEdisk001
--sakuracloud-disk-planSAKURACLOUD_DISK_PLAN4
--sakuracloud-disk-sizeSAKURACLOUD_DISK_SIZE20480
--sakuracloud-dns-zoneSAKURACLOUD_DNS_ZONE-
--sakuracloud-enable-password-authSAKURACLOUD_ENABLE_PASSWORD_AUTHfalse
--sakuracloud-engine-portSAKURACLOUD_ENGINE_PORT2376
--sakuracloud-gatewaySAKURACLOUD_GATEWAY-
--sakuracloud-groupSAKURACLOUD_GROUP-
--sakuracloud-gslbSAKURACLOUD_GSLB-
--sakuracloud-ignore-virtio-netSAKURACLOUD_IGNORE_VIRTIO_NET-
--sakuracloud-memory-sizeSAKURACLOUD_MEMORY_SIZE1
--sakuracloud-packet-filterSAKURACLOUD_PACKET_FILTER-
--sakuracloud-private-ip-onlySAKURACLOUD_PRIVATE_IP_ONLY-
--sakuracloud-private-ipSAKURACLOUD_PRIVATE_IP-
--sakuracloud-private-ip-subnet-maskSAKURACLOUD_PRIVATE_IP_SUBNET_MASK255.255.255.0
--sakuracloud-private-packet-filterSAKURACLOUD_PRIVATE_PACKET_FILTER-
--sakuracloud-regionSAKURACLOUD_REGIONis1b
--sakuracloud-ssh-keySAKURACLOUD_SSH_KEY-

Author