Class: Gantree::CLI::Help

Inherits:
Object
  • Object
show all
Defined in:
lib/gantree/cli/help.rb

Class Method Summary collapse

Class Method Details

.build ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/gantree/cli/help.rb', line 76

def build
<<-EOL
Builds and tags a docker application.

Examples:

# Automatically tag a build

$ gantree build

# Add custom tag to a build 

$ gantree build -t deploy 

# Override image path to point to another hub

$ gantree build -i quay.io/bleacherreport/cms

EOL
end

.create ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/gantree/cli/help.rb', line 40

def create
<<-EOL
Examples:

$ gantree create APPLICATION

$ gantree create linguist-stag-s1

$ gantree create APPLICATION -e ENVIRONMENT

$ gantree create linguist-stag-s1 -e linguist-stag-app-s1

$ gantree create --dupe=rails-stag-s1 rails-stag-s3 
EOL
end

.deploy ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/gantree/cli/help.rb', line 15

def deploy
<<-EOL
Examples:

$ gantree deploy -t TAG ENVIRONMENT

$ gantree deploy -t latest stag-cauldon-app-s1

# to deploy to all environments to within the same application

$ gantree deploy -t TAG APPLICATION

$ gantree deploy -t TAG cauldron-stag-s1

# add remote .ebextensions

$ gantree deploy -t TAG stag-cauldron-s1 -x "[email protected]:br/.ebextensions.git"

# add remote .ebextensions branch

$ gantree deploy -t TAG stag-cauldron-s1 -x "[email protected]:br/.ebextensions:feature_branch"

EOL
end

.init ⇒ Object 



5
6
7
8
9
10
11
12
13
 
# File 'lib/gantree/cli/help.rb', line 5

def init
<<-EOL
Examples:

$ gantree init -u USERNAME -p PORT HANDLE/REPO:TAG

$ gantree init -u frodriguez -p 3000 bleacher/cauldron:master
EOL
end

.push ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/gantree/cli/help.rb', line 97

def push
<<-EOL
Push docker image tag to hub

Examples:

# Push automatically tagged build

$ gantree push

# Push custom tagged build

$ gantree push -t deploy 

# Push to another hub/acocunt/repo

$ gantree push -i quay.io/bleacherreport/cms
EOL
end

.restart ⇒ Object 



135
136
137
138
139
140
141
142
143
 
# File 'lib/gantree/cli/help.rb', line 135

def restart
<<-EOL
Restart docker environment

Examples:

$ gantree restart stag-rails-app-s1
EOL
end

.ship ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/gantree/cli/help.rb', line 117

def ship
<<-EOL
build, push and deploy docker image to elastic beanstalk

Examples:

# Automatically tag a build, push that build and deploy to elastic beanstalk

$ gantree ship cms-stag-s1

# Override defaults

$ gantree ship -i bleacher/cms -x "[email protected]:br/.ebextensions.git:master" cms-stag-s1

$ gantree ship -i bleacher/cms -t built -x "[email protected]:br/.ebextensions.git:master" cms-stag-s1
EOL
end

.update ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/gantree/cli/help.rb', line 56

def update
<<-EOL
Examples:

# Update a cloudformation stack

$ gantree update linguist-stag-s1

# Add an app role to an existing stack

$ gantree update linguist-stag-s1 -r worker

# Update docker solution starck version

$ gantree update linguist-stag-s1 -s latest

$ gantree update linguist-stag-s1 -s "64bit Amazon Linux 2014.09 v1.0.11 running Docker 1.3.3"
EOL
end