README
¶
Rancher Compose
Docker compose compatible client that deploys to Rancher.
Binaries
Binaries are available for Linux, OS X, and Windows. Refer to the latest release.
Building
Run ./scripts/build to create ./bin/rancher-compose
Usage:
NAME:
rancher-compose - Docker-compose to Rancher
USAGE:
rancher-compose [global options] command [command options] [arguments...]
VERSION:
0.1.0
AUTHOR:
Rancher
COMMANDS:
create Create all services but do not start
up Bring all services up
start Start services
logs Get service logs
restart Restart services
stop, down Stop services
scale Scale services
rm Delete services
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--debug
--url Specify the Rancher API endpoint URL [$RANCHER_URL]
--access-key Specify Rancher API access key [$RANCHER_ACCESS_KEY]
--secret-key Specify Rancher API secret key [$RANCHER_SECRET_KEY]
--file, -f "docker-compose.yml" Specify an alternate compose file (default: docker-compose.yml)
--rancher-file, -r Specify an alternate Rancher compose file (default: rancher-compose.yml)
--project-name, -p Specify an alternate project name (default: directory name)
--help, -h show help
--version, -v print the version
Compose compatibility
rancher-compose strives to be completely compatible with Docker Compose. Since rancher-compose is largely focused
on running production workloads some behaviors between Docker Compose and Rancher Compose are different.
Deleting Services/Container
rancher-compose will not delete things by default. This means that if you do two up commands in a row, the second up will
do nothing. This is because the first up will create everything and leave it running. Even if you do not pass -d to up,
rancher-compose will not delete your services. To delete a service you must use rm.
Builds
Docker builds are supported in two ways. First is to set build: to a git or HTTP URL that is compatible with the remote parameter in https://docs.docker.com/reference/api/docker_remote_api_v1.18/#build-image-from-a-dockerfile. The second approach is to set build: to a local directory and the build context will be uploaded to S3 and then built on demand on each node.
For S3 based builds to work you must setup AWS credentials.
Contact
For bugs, questions, comments, corrections, suggestions, etc., open an issue in
rancherio/rancher with a title starting with [rancher-compose] .
Or just click here to create a new issue.
License
Copyright (c) 2014-2015 Rancher Labs, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/awslabs/aws-sdk-go/aws
Package aws provides core functionality for making requests to AWS services.
|
Package aws provides core functionality for making requests to AWS services. |
|
_workspace/src/github.com/awslabs/aws-sdk-go/aws/awserr
Package awserr represents API error interface accessors for the SDK.
|
Package awserr represents API error interface accessors for the SDK. |
|
_workspace/src/github.com/awslabs/aws-sdk-go/aws/credentials
Package credentials provides credential retrieval and management The Credentials is the primary method of getting access to and managing credentials Values.
|
Package credentials provides credential retrieval and management The Credentials is the primary method of getting access to and managing credentials Values. |
|
_workspace/src/github.com/awslabs/aws-sdk-go/internal/apierr
Package apierr represents API error types.
|
Package apierr represents API error types. |
|
_workspace/src/github.com/awslabs/aws-sdk-go/service/s3
Package s3 provides a client for Amazon Simple Storage Service.
|
Package s3 provides a client for Amazon Simple Storage Service. |
|
_workspace/src/github.com/awslabs/aws-sdk-go/service/s3/s3iface
Package s3iface provides an interface for the Amazon Simple Storage Service.
|
Package s3iface provides an interface for the Amazon Simple Storage Service. |
|
_workspace/src/github.com/codegangsta/cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
|
Package cli provides a minimal framework for creating and organizing command line Go applications. |
|
_workspace/src/github.com/docker/docker/api/client
Package client provides a command-line interface for Docker.
|
Package client provides a command-line interface for Docker. |
|
_workspace/src/github.com/docker/docker/api/types
This package is used for API stability in the types and response to the consumers of the API stats endpoint.
|
This package is used for API stability in the types and response to the consumers of the API stats endpoint. |
|
_workspace/src/github.com/docker/docker/autogen/dockerversion
AUTOGENERATED FILE; see ./hack/make/.go-autogen
|
AUTOGENERATED FILE; see ./hack/make/.go-autogen |
|
_workspace/src/github.com/docker/docker/pkg/mflag
Package flag implements command-line flag parsing.
|
Package flag implements command-line flag parsing. |
|
_workspace/src/github.com/docker/docker/pkg/pools
Package pools provides a collection of pools which provide various data types with buffers.
|
Package pools provides a collection of pools which provide various data types with buffers. |
|
_workspace/src/github.com/docker/libtrust
Package libtrust provides an interface for managing authentication and authorization using public key cryptography.
|
Package libtrust provides an interface for managing authentication and authorization using public key cryptography. |
|
_workspace/src/github.com/gorilla/websocket
Package websocket implements the WebSocket protocol defined in RFC 6455.
|
Package websocket implements the WebSocket protocol defined in RFC 6455. |
|
_workspace/src/github.com/gorilla/websocket/examples/autobahn
Command server is a test server for the Autobahn WebSockets Test Suite.
|
Command server is a test server for the Autobahn WebSockets Test Suite. |
|
_workspace/src/github.com/stretchr/testify/assert
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. |
|
_workspace/src/github.com/vaughan0/go-ini
Package ini provides functions for parsing INI configuration files.
|
Package ini provides functions for parsing INI configuration files. |
|
_workspace/src/golang.org/x/crypto/ssh/terminal
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
|
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems. |
|
_workspace/src/gopkg.in/yaml.v2
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |