README
¶
Local cluster Plugin
This is the plugin for creating and initializing a swarm on the local machine.
Dockerfile.compiler builds the image for compiling the Go source files for
the plugin.
Dockerfile builds the image for the actual plugin that will be used by the
AMP cli.
For more details about the design and use, see the wiki.
Build
make (or make build) builds appcelerator/amp-local.
make vendor updates the vendors.
make clean removes the target binary (local.alpine) that is created by the
compiler to be copied into the appcelerator/amp-local image when building it.
make test uses appcelerator/amp-local to create, update, and remove test clusters.
Options
The parameters available for the local plugins are:
- advertise-addr (interface for the Swarm initialization, default=eth0)
Parameters should be passed as followed:
--advertise-addr en0 ...
Prerequisites
The host should have these prerequisites:
- a proper storage driver (AUFS, overlay, overlay2, devicemapper on thin-pool)
- max map count limit at least equals to 262144 (Linux only)
- enough system resources (4GB memory, 20GB storage)
Trying it out
From the cluster/plugin/local directory, run the following:
$ make vendor
$ make image
$ docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock -v /var/run/docker:/var/run/docker appcelerator/amp-local init
Verify output similar to the following:
$ docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock -v /var/run/docker:/var/run/docker appcelerator/amp-local init
2017/07/29 05:16:49 ampctl (version: latest, build: 43437f20)
2017/07/29 05:16:49 Version test: PASS
2017/07/29 05:16:49 Labels test: PASS
Update Swarm
N/A
Destroy Swarm
Execute the destroy command:
$ docker run -it --rm appcelerator/amp-local destroy
Tests
$ make test
Documentation
¶
Index ¶
- Constants
- Variables
- func DeleteCluster(ctx context.Context, c *client.Client, opts *RequestOptions) error
- func EnsureSwarmExists(ctx context.Context, c *client.Client, opts *RequestOptions) error
- func InfoCluster(ctx context.Context, c *client.Client) (swarm.Swarm, error)
- func InfoNode(ctx context.Context, c *client.Client) (swarm.Node, error)
- func InfoToJSON(sw swarm.Swarm, node swarm.Node) (string, error)
- func LabelNode(ctx context.Context, c *client.Client, opts *RequestOptions) error
- func RunAgent(ctx context.Context, c *client.Client, action string, opts *RequestOptions) error
- type FullSwarmInfo
- type RequestOptions
- type ShortSwarmInfo
Constants ¶
const ( InitTimeout = 10 ContainerName = "ampagent" ImageName = "appcelerator/ampagent" DockerSocket = "/var/run/docker.sock" DockerSwarmSocket = "/var/run/docker" )
Variables ¶
var (
ContainerLabels = map[string]string{"io.amp.role": "infrastructure"}
)
Functions ¶
func DeleteCluster ¶
DeleteSwarm starts the delete operation
func EnsureSwarmExists ¶
EnsureSwarmExists checks that the Swarm is initialized, and does it if it's not the case
func InfoCluster ¶
InfoCluster returns the Swarm info
Types ¶
type RequestOptions ¶
type RequestOptions struct {
InitRequest swarm.InitRequest
// Node labels
Labels map[string]string
// Tag of the ampagent image
Tag string
Registration string
Notifications bool
ForceLeave bool
SkipTests bool
NoMonitoring bool
}
RequestOptions stores parameters for the Docker API
Source Files
Directories