Gaucho is simply some Python scripts to access the
Rancher's API to perform tasks which
I need to have executed through my deployment workflow.
At this point, it does not contain much but it might grow as I get more
Contributions are welcome if you want to use it and add to it.
Gaucho can be run directly on a command line provided you have Python installed
as well as the dependencies listed below.
It can also be run as a Docker container:
docker run --rm -it etlweather/gaucho query 1s245
Rancher Host, Access Key and Secret
Gaucho needs to know the Rancher host and must be given an access key and access
secret to be able to interact with the Rancher's API. This can be done through
If you want to turn off SSL validation because you are using a self-signed certificate
or a private CA-signed certificate, you can pass the environment variable:
You can also mount the SSL certificate chain into the container, and pass the path to the
certificate as an environment variable:
Rancher Agent Container
If you run Gaucho in a container on Rancher, rather than set the environment
variables manually, use the following labels to have Rancher automatically do it
See Service Accounts in Rancher
for more information on this feature.
Usage: ./services.py query [<service_id>] Retrieves the service information. If you don't specify an ID, data for all services will be retrieved. Options: --service_id The ID of the service to read (optional)
Retrieves the ID of a service given its name.
$ ./services.py cassandra 1s130 $
Usage: ./gaucho start_containers <service_id> Starts the containers of a given service, typically a Start Once service. Required Arguments: service_id The ID of the service to start the containers of.
Usage: ./services.py upgrade <service_id> [<start_first>] [<complete_previous>] [<imageUuid>] [<auto_complete>] [<batch_size>] [<interval_millis>] [<replace_env_name>] [<replace_env_value>] Upgrades a service Performs a service upgrade, keeping the same configuration, but otherwise pulling new image as needed and starting new containers, dropping the old ones. Required Arguments: service_id The ID of the service to upgrade. Options: --start_first Whether or not to start the new instance first before stopping the old one. --complete_previous If set and the service was previously upgraded but the upgrade wasn't completed, it will be first marked as Finished and then the upgrade will occur. --imageUuid If set the config will be overwritten to use new image. Don't forget Rancher Formatting 'docker:<Imagename>:tag' --auto_complete Set this to automatically 'finish upgrade' once upgrade is complete --batch_size --interval_millis --replace_env_name The name of an environment variable to be changed in the launch config (requires replace_env_value). --replace_env_value The value of the environment variable to be replaced (requires replace_env_name). --timeout How many seconds to wait until an upgrade fails
Usage: ./services.py rollback <service_id> Rolls back service Performs a service rollback Required Arguments: service_id The ID of the service to roll back. Options: --timeout How many seconds to wait until an upgrade fails
Usage: ./gaucho execute <service_id> <command> Runs the given *command* on the first container found for the given *service id*. Required Arguments: service_id The ID of the service to perform the command on. command shell command to execute
Usage: ./gaucho activate <service_id> Activate the given *service id*. Required Arguments: service_id The ID of the service to perform the command on. Options: --timeout How many seconds to wait until get back prompt on activation
Usage: ./gaucho deactivate <service_id> Deactivate the given *service id*. Required Arguments: service_id The ID of the service to perform the command on. Options: --timeout How many seconds to wait until get back prompt on deactivation
Get service's state
Usage: ./gaucho state <service_id> Print state of the given *service id*. Required Arguments: service_id The ID of the service to check.