diff --git a/README.md b/README.md index b090a18..d187c3c 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,45 @@ -# Triton Docker CLI helper +# Spearhead Docker CLI helper -This script installs known good, tested versions of the Docker (now Moby) and Docker Compose CLI tools for use with Triton. +This script will install compatible Docker versions for use with the Spearhead Cloud. -Additionally, this script will automatically configure those tools for use with Triton when you use them, making it easy to switch between Docker on your laptop and Docker on Triton. +Your existing Docker will not be affected and you can conveniently switch between your own Docker and the Spearhead Cloud docker tools. ### Compatibility and requirements This is designed and tested for Linux and MacOS X. -This code also requires [the Triton CLI tools](https://docs.joyent.com/public-cloud/api-access/cloudapi) and [a Triton account](https://docs.joyent.com/public-cloud/getting-started) on either Triton public cloud (Joyent public cloud) or in a private cloud powered by Triton. - -Use of this software also requires [a Triton profile configured in the Triton CLI tool](https://docs.joyent.com/public-cloud/api-access/cloudapi#configuration). +This code requires [Spearhead Cloud CLI tool](https://code.spearhead.cloud/Spearhead/node-spearhead) and [a Spearhead Cloud account](https://docs.spearhead.cloud/start/). ### Installation In a terminal window, run the following command: ```bash -sudo bash -c 'curl -o /usr/local/bin/triton-docker https://raw.githubusercontent.com/joyent/triton-docker-cli/master/triton-docker && chmod +x /usr/local/bin/triton-docker && ln -Fs /usr/local/bin/triton-docker /usr/local/bin/triton-compose && ln -Fs /usr/local/bin/triton-docker /usr/local/bin/triton-docker-install' +sudo bash -c 'curl -o /usr/local/bin/spearhead-docker https://code.spearhead.cloud/Spearhead/spearhead-docker-cli/raw/branch/master/spearhead-docker && chmod +x /usr/local/bin/spearhead-docker && ln -Fs /usr/local/bin/spearhead-docker /usr/local/bin/spearhead-compose && ln -Fs /usr/local/bin/spearhead-docker /usr/local/bin/spearheadn-docker-install' ``` -That command will copy the `triton-docker` shell script from this repo, and link it as `triton-compose` and `triton-docker-install`. +That command will copy the `spearhead-docker` shell script from this repo, and link it as `spearhead-compose` and `spearhead-docker-install`. -To complete the installation, run `sudo triton-docker-install` to install the platform-specific versions of the Docker (now Moby) and Docker Compose CLI tools. These versions will not replace any existing Docker or Docker Compose versions you may have installed. +To complete the installation, run `sudo spearhead-docker-install` to install the platform-specific versions of the Docker (now Moby) and Docker Compose CLI tools. These versions will not replace any existing Docker or Docker Compose versions you may have installed. ### Usage -Once installed, use `triton-docker` and `triton-compose` in place of `docker` and `docker-compose` when interacting with the Triton Elastic Docker Host. +Once installed, use `spearhead-docker` and `spearhead-compose` in place of `docker` and `docker-compose` when interacting with the Spearhead Cloud. -Start a Docker container running Nginx container on Triton: +Start a Docker container running Nginx container on Spearhead Cloud: ```bash -$ triton-docker run -d -p 80 --name webserver nginx -Executing in 'us-sw-1' (default; use `triton profile set ` to change) at 03:11:11 PM -d5cae48b0072610ecc67f6aecb3115f9fadff59b2151694a963084dad40e5d85 +$ spearhead-docker run -d -p 80 --name webserver nginx +Executing in 'ro-1' (default; use `spearhead profile set ` to change) at 05:02:41 AM +x5gso83h9365831psn43h7qwuc3115f9fitff59b2151694a963043sue94k2f73 $ ``` -Start [all the containers to run WordPress](https://github.com/autopilotpattern/wordpress) via Docker Compose on Triton: +Start [all the containers to run WordPress](https://github.com/autopilotpattern/wordpress) via Docker Compose on Spearhead Cloud: ```bash -$ triton-compose up -d -Executing in 'us-sw-1' (default; use `triton profile set ` to change) at 03:15:56 PM +$ spearhead-compose up -d +Executing in 'ro-1' (default; use `spearhead profile set ` to change) at 03:15:56 PM Creating wp_wordpress_1 Creating wp_nginx_1 Creating wp_nfs_1 @@ -62,25 +60,19 @@ More about: This will also set some helpful environment variables for using [Triton Container Name Service (CNS)](https://docs.joyent.com/public-cloud/network/cns): -- `TRITON_CNS_SEARCH_DOMAIN_PUBLIC` -- `TRITON_CNS_SEARCH_DOMAIN_PRIVATE` +- `SC_CNS_SEARCH_DOMAIN_PUBLIC` +- `SC_CNS_SEARCH_DOMAIN_PRIVATE` -Those vars will be automatically set with values appropriate for use in Triton Public Cloud: +Those vars will be automatically set with values appropriate for use in Spearhead Public Cloud: ``` -TRITON_CNS_SEARCH_DOMAIN_PRIVATE=a42e7881-89d2-459e-bc0b-e9af0bca409a.us-east-3.cns.joyent.com -TRITON_CNS_SEARCH_DOMAIN_PUBLIC=a42e7881-89d2-459e-bc0b-e9af0bca409a.us-east-3.triton.zone +SC_CNS_SEARCH_DOMAIN_PRIVATE=a42e7881-89d2-459e-bc0b-e9af0bca409a.us-east-3.cns.spearhead.cloud +SC_CNS_SEARCH_DOMAIN_PUBLIC=a42e7881-89d2-459e-bc0b-e9af0bca409a.us-east-3.spearhead.cloud ``` -#### Notes and cautions about CNS env vars - -- The mechanism that sets these environment vars only works for Triton Public Cloud. To use Triton Docker CLI with private cloud implementations of Triton, please set the `TRITON_CNS_SEARCH_DOMAIN_PUBLIC` and `TRITON_CNS_SEARCH_DOMAIN_PRIVATE` vars manually -- These environment variables will be removed following the completion of [CNS-164](https://smartos.org/bugview/CNS-164) and [DOCKER-898](https://smartos.org/bugview/DOCKER-898), which will automatically set the DNS search domain to these values -- [CNS-164](https://smartos.org/bugview/CNS-164) and [DOCKER-898](https://smartos.org/bugview/DOCKER-898) will also work on private cloud implementations of Triton, solving the problem for everybody - ### Components In addition to the shell script in this repo, this script will install: -- [Docker (now Moby) 1.12.6](https://github.com/moby/moby/releases/tag/v1.12.6) +- [Moby 1.12.6](https://github.com/moby/moby/releases/tag/v1.12.6) - [Docker Compose 1.9.0](https://github.com/docker/compose/releases/tag/1.9.0)