-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.txt
324 lines (248 loc) · 11.4 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
FirstMile
----------
FirstMile is a cloud developer's sandbox.
FirstMile simplifies the process of developing and deploying web applications to Amazon Elastic Beanstalk
and Google App Engine (GAE). FirstMile is unique in that you don't need to make any changes to your application code
in order to deploy it on Beanstalk or GAE. FirstMile supports testing your applications locally by deploying
them in FirstMile's Docker-based sandbox. Additionally, FirstMile supports provisioning of relational database instances
and their secure binding with your web applications.
Currently FirstMile supports Python Flask based web applications.
FirstMile has been tested on: Ubuntu 14.04, Ubuntu 16.04, Mac OS X (El Capitan, Darwin 15.4.0)
Completely scripted installation
---------------------------------
- Run ./install.sh
Manual installation
------------------------
If completely scripted installation fails for some reason, you can do manual setup of FirstMile as follows:
Ubuntu:
-------
Open a terminal window and execute following:
$ ./setup-ubuntu.sh
$ source firstmile/bin/activate
$ python cld.py
Open another terminal window and execute following:
$ <cd to directory where you have cloned firstmile>
$ source firstmile/bin/activate
$ cld app list
Mac OS:
-------
Open a terminal window and execute following:
Install Docker for Mac
$ eval "$(docker-machine env default)"
--> This command will enable this shell window to run Docker commands
without sudo
$ ./setup-mac.sh
$ source firstmile/bin/activate
$ python cld.py
Open another terminal window and execute following:
$ <cd to directory where you have cloned firstmile>
$ source firstmile/bin/activate
$ cld app list
Available Commands
-------------------
$ cld --help
usage: cld [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
Multi-cloud application orchestration and service provisioning CLI.
optional arguments:
--version show program's version number and exit
-v, --verbose Increase verbosity of output. Can be repeated.
-q, --quiet Suppress output except warnings and errors.
--log-file LOG_FILE Specify a file to log output. Disabled by default.
-h, --help Show help message and exit.
--debug Show tracebacks on errors.
Commands:
app delete Delete application
app deploy Build and deploy application
app list List applications
app logs Retrieve application deployment and runtime logs
app show Display application information
cloud reset Reset cloud setup in FirstMile sandbox
cloud setup Setup FirstMile sandbox for a particular cloud
complete print bash completion command (cliff)
fm cleanup Display steps to cleanup FirstMile workspace
fm logs Retrieve FirstMile sandbox logs
fm restart Display steps to restart FirstMile sandbox
help print detailed help for another command (cliff)
service delete Delete service instance
service list List service instances
service provision Provision service instance
service restrict-access Restrict access to a service instance
service show Display service instance information
Deployment to local Docker sandbox:
----------------------------------------
1) Deploy hello-world sample application:
- Navigate to the application folder (cd ./examples/hello-world)
- Deploy application:
> cld app deploy --cloud local-docker
+------------------+-----------+-----------------+
| App Name | Deploy ID | Cloud |
+------------------+-----------+-----------------+
| hello-world | 1 | local-docker |
+------------------+-----------+-----------------+
2) Check deployment status
> cld app show --deploy-id 1
+------------------+-----------+---------------------+--------------+------------------------+
| App Name | Deploy ID | Status | Cloud | App URL |
+------------------+-----------+---------------------+--------------+------------------------+
| hello-world | 1 | DEPLOYMENT_COMPLETE | local-docker | http://172.0.0.1 |
+------------------+-----------+---------------------+--------------+------------------------+
Deployment to Amazon Elastic Beanstalk:
----------------------------------------
1) Sign up for Amazon AWS account
2) Login to Amazon AWS web console and from the IAM panel do following:
- Create a IAM User (choose any name)
- Grant following permission to the user: "AWSElasticBeanstalkFullAccess - AWS Managed Policy" by
clicking the "Add permissions" button on the user panel.
3) Note down SECRET_ACCESS_KEY and ACCESS_KEY_ID for this user.
4) Setup FirstMile to work with AWS
- cld cloud setup --cloud aws
> Provide values when asked by cld.
5) Deploy hello-world sample application:
- Navigate to the application folder (cd ./examples/hello-world)
- Deploy application:
> cld app deploy --cloud aws
+------------------+-----------+------------+
| App Name | Deploy ID | Cloud |
+------------------+-----------+------------+
| hello-world | 2 | aws |
+------------------+-----------+------------+
6) Check deployment status
> cld app show --deploy-id 2
+------------------+-----------+---------------------+--------------+------------------------+
| App Name | Deploy ID | Status | Cloud | App URL |
+------------------+-----------+---------------------+--------------+------------------------+
| hello-world | 2 | DEPLOYMENT_COMPLETE | aws | <App URL on AWS> |
+------------------+-----------+---------------------+--------------+------------------------+
Deployment to Google App Engine:
--------------------------------
1) Sign up for a Google cloud account by visiting https://console.cloud.google.com
2) In order to deploy an application on Google App Engine, you will need to first
create a Google App Engine project from the GAE Console.
- Create a project and note down the Project ID (Note that it is important to use Project ID and not the Project name).
3) Setup FirstMile to work with Google
- cld cloud setup --cloud google
> Provide values when asked by cld.
4) Deploy sample application greetings-python:
- Navigate to the application folder (cd ./examples/greetings-python)
- Deploy application:
> cld app deploy --cloud google --service mysql
+------------------+-----------+--------+
| App Name | Deploy ID | Cloud |
+------------------+-----------+--------+
| greetings-python | 3 | google |
+------------------+-----------+--------+
5) Check deployment status
> cld app show --deploy-id 1
+------------------+-----------+---------------------+--------+---------------------------------------+
| App Name | Deploy ID | Status | Cloud | App URL |
+------------------+-----------+---------------------+--------+---------------------------------------+
| greetings-python | 3 | DEPLOYMENT_COMPLETE | google | https://greetings-python.appspot.com |
+------------------+-----------+---------------------+--------+---------------------------------------+
Note:
- Your application and all its resources will be deployed in the us-central region of GAE
App commands:
--------------
1) cld app deploy --cloud <cloud>
2) cld app deploy --cloud <cloud> --service mysql
3) cld app show --deploy-id <deploy-id>
4) cld app show --app-name <app-name>
E.g.:
cld app show --app-name express-checkout
+-----------+---------------------+--------+-----------------------------------------------------------------------------+
| Deploy ID | App Version | Cloud | App URL |
+-----------+---------------------+--------+-----------------------------------------------------------------------------+
| 153 | 2016-12-19-14-47-41 | google | https://express-checkout-153019.appspot.com |
| 154 | 2016-12-19-14-59-34 | aws | http://express-checkout-2016-12-19-14-59-34.us-west-2.elasticbeanstalk.com |
| 155 | 2016-12-19-15-14-52 | local | http://172.17.1.10:5000 |
+-----------+---------------------+--------+-----------------------------------------------------------------------------+
5) cld app show --cloud <cloud>
E.g.:
cld app show --cloud google
+-----------+------------------+---------------------+----------------------------------------------+
| Deploy ID | App Name | App Version | App URL |
+-----------+------------------+---------------------+----------------------------------------------+
| 104 | hello-world | 2016-12-18-11-22-40 | https://hello-world-152322.appspot.com |
| 145 | greetings-python | 2016-12-19-11-52-40 | https://greetings-python.appspot.com |
| 151 | express-checkout | 2016-12-19-13-40-03 | https://express-checkout-153019.appspot.com |
+-----------+------------------+---------------------+----------------------------------------------+
6) cld app logs --deploy-id <deploy-id>
7) cld app delete --deploy-id <deploy-id>
Service commands:
------------------
1) cld service provision --service <service-name>
2) cld service show --service-name <service-name>
3) cld service list
4) cld service delete --deploy-id <deploy-id>
5) cld service restrict-access --deploy-id <deploy-id>
Deploying using YAML file
--------------------------
FirstMile supports YAML file for deployments.
The yaml file needs to be named 'cld.yaml' and it needs to be placed in the application directory.
cld.yaml allows providing of all the inputs to FirstMile CLI
in one step instead of using different command line flags.
Structure of YAML file:
-----------------------
The YAML file consists of three sections: application, services, cloud.
The cloud section is compulsory whereas application and services section
can be included depending on whether you want to deploy a service instance
or an application. Below is an example of YAML file containing all three sections.
+++++++++++++++++++++++++++++++++++++++
application:
type: python
entry_point: application.py
env_variables:
MY_VAR1: VALUE1
MY_VAR2: VALUE2
services:
- service:
type: mysql
cloud:
type: google
project_id: greetings-python
user_email: cc1h499@gmail.com
+++++++++++++++++++++++++++++++++++++++
Here are some examples of YAML file for different deployments.
1) Deploying MySQL service instance locally
--
services:
- service:
type: mysql
cloud:
type: local-docker
--
2) Deploying Cloud SQL service instance on Google cloud
--
services:
- service:
type: mysql
cloud:
type: google
project_id: greetings-python
user_email: cc1h499@gmail.com
--
3) Deploying RDS instance on AWS cloud
--
services:
- service:
type: mysql
cloud:
type: aws
SECRET_ACCESS_KEY: secret-access-key
ACCESS_KEY_ID: access-key-id
--
4) Deploying application on Google cloud and using env_variables to
connect to an existing Cloud SQL instance:
--
application:
type: python
entry_point: application.py
env_variables:
DB: testdb
HOST: 107.178.214.1
USER: testuser
PASSWORD: testpass123!@#
cloud:
type: google
project_id: greetings-python
user_email: cc1h499@gmail.com
--