Skip to content

Docker App wrapper to simplify container creation

Notifications You must be signed in to change notification settings

admpresales/nimbusapp

Repository files navigation

nimbusapp

Script to make starting demo containers easier.

This script is based on the images in https://hub.docker.com/u/admpresales

Installation - Prerequisites

Starting with version 1.6.0, nimbusapp requires the following:

Installation - Linux

Quick Install

wget -nv https://github.com/admpresales/nimbusapp/releases/latest/download/nimbusapp.tar.gz -O- | sudo tar -xz -C /usr/local/bin

Manual Install

Download the latest .tar.gz release from https://github.com/admpresales/nimbusapp/releases by executing the following commands from a terminal window:

[demo@nimbusserver ~]$ cd ~/Downloads
[demo@nimbusserver ~]$ rm -f nimbusapp.tar.gz*
[demo@nimbusserver Downloads]$ wget -nv https://github.com/admpresales/nimbusapp/releases/latest/download/nimbusapp.tar.gz

Extract the downloaded file to /usr/local/bin:

[demo@nimbusserver Downloads]$ sudo tar -xzf nimbusapp.tar.gz -C /usr/local/bin

Installation - Windows

Quick Install

Compress-Archive -Path 'C:\Program Files\Docker\nimbusapp*' -DestinationPath C:\Users\demo\Desktop\nimbusapp-backup.zip
Invoke-WebRequest https://github.com/admpresales/nimbusapp/releases/latest/download/nimbusapp.zip -OutFile C:\temp\nimbusapp.zip
Expand-Archive -Path C:\temp\nimbusapp.zip -DestinationPath 'C:\Program Files\Docker' -Force

Manual Install

Download the latest .zip release from https://github.com/admpresales/nimbusapp/releases.

Extract the downloaded .zip file into a location on your system's %PATH%. A convenient location is "C:\Program Files\Docker".

Verify

To verify your installation, run the nimbusapp version command and compare the reported version to the release you intended to install:

[demo@nimbusserver Downloads]$ nimbusapp version
nimbusapp version N.N.N
Released on YYYY-MM-DD

Troubleshooting

If nimbusapp version does not return the correct version, another copy may be installed on your system. Use the which command to check where your copy of nimbusapp is located:

[demo@nimbusserver ~]$ which nimbusapp
~/bin/nimbusapp

You may need to remove or rename extra copies of the script until the correct script is detected:

[demo@nimbusserver ~]$ rm ~/bin/nimbusapp 
[demo@nimbusserver ~]$ which nimbusapp
/usr/local/bin/nimbusapp

Using Nimbusapp

This section provides basic usage instructions.

Please refer to the individual dockerapp entries on ADM Presales Docker Hub for image specific instructions.

Examples use the Nimbusapp Test Image, which starts a single container with a lightweight web server.

See the Usage Text or nimbusapp help for more information.

Gerneral Format

Where possible commands mirror the docker-compose features which are used under the covers.

nimbusapp <image> <command>

Create Containers

Using the up command will pull images, create containers and start the containers all in one operation.

Version numbers are only required the first time an image is pulled, and will be remembered for future commands.

[demo@nimbusserver nimbusapp]$ nimbusapp nimbusapp-test:0.1.0 up
Authenticating with existing credentials...
Login Succeeded
Creating nimbusapp-test-web ... done

To create containers from an image without starting the containers immediately, use the --no-start option:

[demo@nimbusserver nimbusapp]$ nimbusapp nimbusapp-test:0.1.0 up --no-start

Check Container Status

To verify the state of a container, use the ps command.

[demo@nimbusserver nimbusapp]$ nimbusapp nimbusapp-test ps
       Name              Command        State           Ports
---------------------------------------------------------------------
nimbusapp-test-web   httpd-foreground   Up      0.0.0.0:12345->80/tcp

Starting Containers

To start existing containers, use the start command.

[demo@nimbusserver nimbusapp]$ nimbusapp nimbusapp-test start
Starting web ... done

Stopping Containers

To stop running containers, use the stop command.

[demo@nimbusserver nimbusapp]$ nimbusapp nimbusapp-test stop
Stopping nimbusapp-test-web ... done

Delete Containers

[demo@nimbusserver nimbusapp]$ nimbusapp nimbusapp-test down

This action will DELETE your containers and is IRREVERSIBLE!

You may wish to use `nimbusapp ... stop' to shut down your containers without deleting them

The following containers will be deleted:
- /nimbusapp-test-web

Do you wish to DELETE these containers? [y/n] y
Stopping nimbusapp-test-web ... done
Removing nimbusapp-test-web ... done