From 8be24f7d804aea325cebf5cf8b3e2e558002573a Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Sun, 27 May 2018 17:16:06 -0700 Subject: [PATCH 1/8] Remove redundant mkdir command --- test/start_local_daemon.sh | 2 -- 1 file changed, 2 deletions(-) diff --git a/test/start_local_daemon.sh b/test/start_local_daemon.sh index d0c60457..508cdbc0 100644 --- a/test/start_local_daemon.sh +++ b/test/start_local_daemon.sh @@ -5,8 +5,6 @@ go build ./daemon/inertiad echo "Daemon Token:" $(./inertiad token $(pwd)/test/keys/id_rsa) -mkdir inertia_local - ./inertiad run 127.0.0.1 \ $(pwd)/test/keys/id_rsa \ $(pwd)/test/certs/ \ From 4521918b161afc0af2d5232766eede179a5dbc4e Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Tue, 29 May 2018 14:44:55 -0700 Subject: [PATCH 2/8] Add Docker Image size badge --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc081334..a18ed13d 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,10 @@ + + + + @@ -41,7 +45,7 @@
-Inertia is a simple cross-platform command line application that enables quick and easy setup and management of continuous, automated deployment of a variety of project types on any virtual private server. The project is used, built, and maintained with :heart: by [UBC Launch Pad](https://www.ubclaunchpad.com/). +Inertia is a simple cross-platform command line application that enables quick and easy setup and management of continuous, automated deployment of a variety of project types on any virtual private server. The project is used, built, and maintained with :heart: by [UBC Launch Pad](https://www.ubclaunchpad.com/), UBC's student-run software engineering club. | | Main Features | ----|----------------- From 3420b55cd35121470b0c63214d9dc5009d8332b9 Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Tue, 29 May 2018 22:52:20 -0700 Subject: [PATCH 3/8] Add inertia command godoc --- README.md | 4 ++++ doc.go | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 doc.go diff --git a/README.md b/README.md index a18ed13d..6b91a252 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ Clean code + + + + diff --git a/doc.go b/doc.go new file mode 100644 index 00000000..70cc6167 --- /dev/null +++ b/doc.go @@ -0,0 +1,58 @@ +/* + +Inertia is the command line interface that helps you set up your remote for +continuous deployment and allows you to manage your deployment through +configuration options and various commands. It can be installed in several ways: + + # Mac users + brew install ubclaunchpad/inertia + + # Windows users + scoop bucket add ubclaunchpad https://github.com/ubclaunchpad/scoop-bucket + scoop install inertia + +Users of other platforms can install the Inertia CLI from the Releases page, +found here: https://github.com/ubclaunchpad/inertia/releases/latest + +To help with usage, most relevant documentation can be seen by using the --help +flag on any command: + + inertia --help + inertia init --help + inertia [REMOTE] up --help + +Documentation can also be triggered by simply entering a command without the +prerequisite arguments or additional commands: + + inertia remote # documentation about remote configuration commands + +Inertia has two "core" sets of commands - one that primarily handles local +configuration, and one that allows you to control your remote VPS instances and +their associated deployments. + +For local configuration, most commands will build off of the root "inertia ..." +command. For example, a typical set of commands to set up a project might look +like: + + inertia init # initiates Inertia configuration + inertia remote add my_cloud # adds configuration for a remote VPS instance + +The other set of commands are based on a remote VPS configuration, and the +available commands can be seen by running: + + inertia [REMOTE] --help + +In the previous example, the next steps to set up a deployment might be: + + inertia my_cloud init # bootstraps remote and installs Inertia daemon + inertia my_cloud up # deploys your project + +Some of these commands offer a --stream flag that allows you to view realtime +log feedback from the daemon. + +More documentation on Inertia, how it works, and how to use it can be found +in the project repository: https://github.com/ubclaunchpad/inertia/tree/master + +*/ + +package main From 08b60c0186cecf81d7f66c0a7b92eaa730f1a0b1 Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Tue, 29 May 2018 22:57:58 -0700 Subject: [PATCH 4/8] Add inertiad command godoc --- daemon/inertiad/cmd.go | 2 +- daemon/inertiad/doc.go | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 daemon/inertiad/doc.go diff --git a/daemon/inertiad/cmd.go b/daemon/inertiad/cmd.go index dd880b6f..8fadf156 100644 --- a/daemon/inertiad/cmd.go +++ b/daemon/inertiad/cmd.go @@ -64,7 +64,7 @@ Created using an RSA private key.`, } var rootCmd = &cobra.Command{ - Use: "inertia", + Use: "inertiad", Short: "The inertia daemon CLI", Version: getVersion(), } diff --git a/daemon/inertiad/doc.go b/daemon/inertiad/doc.go new file mode 100644 index 00000000..121452d5 --- /dev/null +++ b/daemon/inertiad/doc.go @@ -0,0 +1,18 @@ +/* + +Inertiad is Inertia's daemon component. This service runs in the background on +your remote VPS and allows you to monitor and control your deployed application. + +Even though it is built as command line application, inertiad not intended for +direct use - the Inertia daemon is supposed to be deployed as a Docker container, +the image for which can be found here: +https://hub.docker.com/r/ubclaunchpad/inertia/ + +When used, however, it offers two main commands: + + inertiad token # generates and outputs a JWT in stdout + inertiad run # starts daemon service + +*/ + +package main From 8bdb54ba283ff365d3db7975b9df5defbfa62b21 Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Tue, 29 May 2018 23:18:42 -0700 Subject: [PATCH 5/8] Update godoc badges --- README.md | 8 ++++---- client/README.md | 2 +- daemon/README.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6b91a252..93e0bacd 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,14 @@ Clean code - - - - + + + + diff --git a/client/README.md b/client/README.md index d5eb7868..e773527d 100644 --- a/client/README.md +++ b/client/README.md @@ -1,6 +1,6 @@ # Client -[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertia/client) +[![GoDoc](https://godoc.org/github.com/ubclaunchpad/inertia?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertia/client) This package contains Inertia's clientside configuration and interface to remote Inertia daemons. It can be imported for use if you don't like the CLI - for example: diff --git a/daemon/README.md b/daemon/README.md index 47779bb7..00da6c22 100644 --- a/daemon/README.md +++ b/daemon/README.md @@ -1,6 +1,6 @@ # Daemon -[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertia/daemon/) +[![GoDoc](https://godoc.org/github.com/ubclaunchpad/inertia?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertia/daemon/) This directory contains the Inertia daemon's two components: From f5fbedae2d8e3ab7ba389fd6add8ce0b68e04357 Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Wed, 30 May 2018 11:03:03 -0700 Subject: [PATCH 6/8] Update doc.go --- doc.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc.go b/doc.go index 70cc6167..040d264d 100644 --- a/doc.go +++ b/doc.go @@ -2,7 +2,9 @@ Inertia is the command line interface that helps you set up your remote for continuous deployment and allows you to manage your deployment through -configuration options and various commands. It can be installed in several ways: +configuration options and various commands. + +It can be installed in several ways: # Mac users brew install ubclaunchpad/inertia @@ -54,5 +56,4 @@ More documentation on Inertia, how it works, and how to use it can be found in the project repository: https://github.com/ubclaunchpad/inertia/tree/master */ - package main From a32f70d34298ca738a7bc383216066c17e29e6d4 Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Wed, 30 May 2018 11:06:15 -0700 Subject: [PATCH 7/8] Update doc.go --- daemon/inertiad/doc.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/daemon/inertiad/doc.go b/daemon/inertiad/doc.go index 121452d5..1fb19cfb 100644 --- a/daemon/inertiad/doc.go +++ b/daemon/inertiad/doc.go @@ -1,7 +1,9 @@ /* -Inertiad is Inertia's daemon component. This service runs in the background on -your remote VPS and allows you to monitor and control your deployed application. +Inertiad is Inertia's daemon component. + +This service runs in the background on your remote VPS and allows you to monitor +and control your deployed application. Even though it is built as command line application, inertiad not intended for direct use - the Inertia daemon is supposed to be deployed as a Docker container, @@ -14,5 +16,4 @@ When used, however, it offers two main commands: inertiad run # starts daemon service */ - package main From 407cb7d5db735d4783922a75eb83066c2ae58854 Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Wed, 30 May 2018 11:11:04 -0700 Subject: [PATCH 8/8] Update doc.go --- doc.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc.go b/doc.go index 040d264d..bbfe0a99 100644 --- a/doc.go +++ b/doc.go @@ -26,7 +26,7 @@ flag on any command: Documentation can also be triggered by simply entering a command without the prerequisite arguments or additional commands: - inertia remote # documentation about remote configuration commands + inertia remote # documentation about remote configuration Inertia has two "core" sets of commands - one that primarily handles local configuration, and one that allows you to control your remote VPS instances and