{"id":13450288,"url":"https://github.com/rancher/rancher-compose","last_synced_at":"2025-03-23T16:31:16.841Z","repository":{"id":27474871,"uuid":"30954262","full_name":"rancher/rancher-compose","owner":"rancher","description":"Docker compose compatible client to deploy to Rancher","archived":true,"fork":false,"pushed_at":"2019-06-17T19:36:46.000Z","size":5533,"stargazers_count":215,"open_issues_count":0,"forks_count":62,"subscribers_count":63,"default_branch":"master","last_synced_at":"2024-07-31T07:15:31.574Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rancher.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-18T06:04:31.000Z","updated_at":"2024-05-14T15:44:31.000Z","dependencies_parsed_at":"2022-09-02T07:51:42.441Z","dependency_job_id":null,"html_url":"https://github.com/rancher/rancher-compose","commit_stats":null,"previous_names":["rancherio/rancher-compose"],"tags_count":116,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rancher%2Francher-compose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rancher%2Francher-compose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rancher%2Francher-compose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rancher%2Francher-compose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rancher","download_url":"https://codeload.github.com/rancher/rancher-compose/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221856382,"owners_count":16892435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T07:00:33.321Z","updated_at":"2024-10-28T16:30:56.360Z","avatar_url":"https://github.com/rancher.png","language":"Go","funding_links":[],"categories":["Go","Rancher 1.0"],"sub_categories":["Tools 1.0"],"readme":"# Rancher Compose [![Build Status](http://ci.rancher.io/api/badge/github.com/rancher/rancher-compose/status.svg?branch=master)](http://ci.rancher.io/github.com/rancher/rancher-compose)\n\nDocker compose compatible client that deploys to [Rancher](https://github.com/rancher/rancher).\n\n## Binaries\n\nBinaries are available for Linux, OS X, and Windows. Refer to the latest [release](https://github.com/rancher/rancher-compose/releases).\n\n## Building\nRun `make build` to create `./bin/rancher-compose`\n\n## Usage:\n\n```\nUsage: rancher-compose [OPTIONS] COMMAND [arg...]\n\nDocker-compose to Rancher\n\nVersion: v0.8.4\n\nAuthor:\nRancher Labs, Inc.\n\nOptions:\n--verbose, --debug\t\t\t\t\n--file, -f [--file option --file option]\tSpecify one or more alternate compose files (default: docker-compose.yml) [$COMPOSE_FILE]\n--project-name, -p \t\t\t\tSpecify an alternate project name (default: directory name)\n--url \t\t\t\t\tSpecify the Rancher API endpoint URL [$RANCHER_URL]\n--access-key \t\t\t\t\tSpecify Rancher API access key [$RANCHER_ACCESS_KEY]\n--secret-key \t\t\t\t\tSpecify Rancher API secret key [$RANCHER_SECRET_KEY]\n--rancher-file, -r \t\t\t\tSpecify an alternate Rancher compose file (default: rancher-compose.yml)\n--env-file, -e \t\t\t\tSpecify a file from which to read environment variables\n--help, -h\t\t\t\t\tshow help\n--version, -v\t\t\t\t\tprint the version\n\nCommands:\ncreate\tCreate all services but do not start\nup\t\tBring all services up\nstart\t\tStart services\nlogs\t\tGet service logs\nrestart\tRestart services\nstop, down\tStop services\nscale\t\tScale services\nrm\t\tDelete services\npull\t\tPulls images for services\nupgrade\tPerform rolling upgrade between services\nhelp, h\tShows a list of commands or help for one command\n```\n\n# Compose compatibility\n\n`rancher-compose` strives to be completely compatible with Docker Compose.  Since `rancher-compose` is largely focused\non running production workloads some behaviors between Docker Compose and Rancher Compose are different.\n\n## Deleting Services/Container\n\n`rancher-compose` will not delete things by default.  This means that if you do two `up` commands in a row, the second `up` will\ndo nothing.  This is because the first up will create everything and leave it running.  Even if you do not pass `-d` to `up`,\n`rancher-compose` will not delete your services.  To delete a service you must use `rm`.\n\n## Builds\n\nDocker 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.\n\nFor S3 based builds to work you must [setup AWS credentials](https://github.com/aws/aws-sdk-go/#configuring-credentials).\n\n\n## Contact\nFor bugs, questions, comments, corrections, suggestions, etc., open an issue in\n [rancher/rancher](//github.com/rancher/rancher/issues) with a title starting with `[rancher-compose] `.\n\nOr just [click here](//github.com/rancher/rancher/issues/new?title=%5Brancher-compose%5D%20) to create a new issue.\n\n# License\nCopyright (c) 2014-2015 [Rancher Labs, Inc.](http://rancher.com)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Francher%2Francher-compose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Francher%2Francher-compose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Francher%2Francher-compose/lists"}