fork/cellxgene
1
0
Fork 0
mirror of https://github.com/chanzuckerberg/cellxgene.git synced 2026-10-07 23:58:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update the EB build process to package in scripts (#1434)

Browse Source 
This is implemented specifically to handle the google analytics
script for hosted cellxgene
This commit is contained in:
bmccandless
2020-04-28 14:38:35 -07:00
committed by GitHub
parent e495c571c3
commit cd821a0344
2 changed files with 31 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/eb/Makefile
+3
View File
@@ -27,6 +27,9 @@ build: clean
mkdir -p artifact.dir/server/common/web/static/deploy; \ mkdir -p artifact.dir/server/common/web/static/deploy; \
cp -r static/* artifact.dir/server/common/web/static/deploy; \ cp -r static/* artifact.dir/server/common/web/static/deploy; \
fi; \ fi; \
if [ -d scripts ] ; then \
cp -r scripts/* artifact.dir/server/common/web/templates; \
fi; \
(cd artifact.dir; \ (cd artifact.dir; \
cp -r server/common/web/static static; \ cp -r server/common/web/static static; \
zip -r ../artifact.zip . --exclude server/test/\* server/eb/\* ; ); \ zip -r ../artifact.zip . --exclude server/test/\* server/eb/\* ; ); \
server/eb/README.md
+28 -7
View File
@@ -69,7 +69,7 @@ There are many more options to these commands that may be important or necessary
To use this feature, do the following: To use this feature, do the following:
* In this directory, create a sub directory called "static". * In this directory, create a sub directory called "static".
* Copy the files you want to server into this directory * Copy the files you want to serve into this directory
* modify your configuration file to set the location to these file: /static/deploy/<filename> * modify your configuration file to set the location to these file: /static/deploy/<filename>
Example: you want to include an "about_legal_tos" and "about_legal_privacy" page to cellxgene. Example: you want to include an "about_legal_tos" and "about_legal_privacy" page to cellxgene.
@@ -87,14 +87,35 @@ There are many more options to these commands that may be important or necessary
``` ```
The next step will place these files into the deployment. The next step will place these files into the deployment.
5. Add additional script files to include in HTML page
Additional scripts can be added using the server/scripts or server/inline_scripts config parameters.
To include these scripts in the deployment, use the following steps:
* In this directory, create a sub directory called "scripts".
* Copy the script files into this directory
* modify your configuration file to set the location to these file:
- for server/scripts, the path is: /templates/<filename>
- for server/inline_scripts, the path is: <filename>
For example, to add an inline script called "myscript.js":
5. Create the artifact.zip file for the application ```
$ mkdir scripts
$ cp <source_dir>/myscript.js scripts/myscript.js
# edit the config.yaml
$ grep inline_scripts config.yaml
inline_scripts : [ myscript.js ]
```
6. Create the artifact.zip file for the application
``` ```
$ make build $ make build
``` ```
6. Flask secret key 7. Flask secret key
The application requires as secret key to be provided to flask, the web framework used by cellxgene. The application requires as secret key to be provided to flask, the web framework used by cellxgene.
There are three ways to provide the secret key: There are three ways to provide the secret key:
@@ -109,7 +130,7 @@ There are many more options to these commands that may be important or necessary
then the AWS Secret Manager region name can be specified in an environment variable: CXG_AWS_SECRET_REGION_NAME. then the AWS Secret Manager region name can be specified in an environment variable: CXG_AWS_SECRET_REGION_NAME.
7. Create an environment 8. Create an environment
``` ```
# name of the environment # name of the environment
@@ -128,18 +149,18 @@ There are many more options to these commands that may be important or necessary
--envvars CXG_DATAROOT=$CXG_DATAROOT,CXG_CONFIG_FILE=$CXG_CONFIG_FILE --envvars CXG_DATAROOT=$CXG_DATAROOT,CXG_CONFIG_FILE=$CXG_CONFIG_FILE
``` ```
8. Give the elastic beanstalk environment access to the S3 bucket. 9. Give the elastic beanstalk environment access to the S3 bucket.
This link may provide some useful information: This link may provide some useful information:
https://aws.amazon.com/premiumsupport/knowledge-center/elastic-beanstalk-s3-bucket-instance/ https://aws.amazon.com/premiumsupport/knowledge-center/elastic-beanstalk-s3-bucket-instance/
9. Deploy the application 10. Deploy the application
``` ```
$ eb deploy $EB_ENV $ eb deploy $EB_ENV
``` ```
10. Open the application in a browser 11. Open the application in a browser
``` ```
$ eb open $EB_ENV $ eb open $EB_ENV