fork/cellxgene
1
0
Fork 0
mirror of https://github.com/chanzuckerberg/cellxgene.git synced 2026-09-29 17:48:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add support to include static files into the eb deployment (#1305)

Browse Source 
Mostly this is just instructions for how to do this,
with a small addition to the makefile.
This enables support for serving the about_legal_tos and about_legal_privacy
from the cellxgene server.
This commit is contained in:
bmccandless
2020-03-26 15:03:37 -07:00
committed by GitHub
parent 8c0480b0bc
commit 54a75ffd7e
2 changed files with 47 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/eb/Makefile
+4
View File
@@ -23,6 +23,10 @@ build: clean
if [ -f config.yaml ] ; then \
cp config.yaml artifact.dir; \
fi; \
if [ -d static ] ; then \
mkdir -p artifact.dir/server/common/web/static/deploy; \
cp -r static/* artifact.dir/server/common/web/static/deploy; \
fi; \
(cd artifact.dir; \
cp -r server/common/web/static static; \
zip -r ../artifact.zip . --exclude server/test/\* server/eb/\* ; ); \
server/eb/README.md
+43 -15
View File
@@ -62,40 +62,68 @@ There are many more options to these commands that may be important or necessary
and cannot be enabled using configuration. They may be enabled manually by modifying app.py, however
this is not supported or recommended at this time.
4. Create the artifact.zip file for the application
4. Prepare static endpoints
The cellxgene server can server additional static webpages that may be associated with the deployment.
These include the about_legal_tos (terms of service), and bout_legal_privacy, for example.
To use this feature, do the following:
* In this directory, create a sub directory called "static".
* Copy the files you want to server into this directory
* 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.
Assume files called "tos.html" and "privacy.html" exist.
```
make build
$ mkdir static
$ cp <source_dir>/tos.html static/tos.html
$ cp <source_dir>/privacy.html static/privacy.html
# edit config.yaml
$ grep "/static/deploy" config.yaml
about_legal_tos: /static/deploy/tos.html
about_legal_privacy: /static/deploy/privacy.html
```
5. Create an environment
The next step will place these files into the deployment.
5. Create the artifact.zip file for the application
```
$ make build
```
6. Create an environment
```
# name of the environment
EB_ENV=cellxgene-env
# type of ec2 instance to run the cellxgene server.
EB_INSTANCE=m5.large
# One or both of the following environment variables needs to be set
CXG_DATAROOT=<location to your S3 bucket>
CXG_CONFIG_FILE=<location to your config file>
$ EB_ENV=cellxgene-env
eb create $EB_ENV --instance-type $EB_INSTANCE \
# type of ec2 instance to run the cellxgene server (for example)
$ EB_INSTANCE=m5.large
# One or both of the following environment variables needs to be set
$ CXG_DATAROOT=<location to your S3 bucket>
$ CXG_CONFIG_FILE=<location to your config file>
$ eb create $EB_ENV --instance-type $EB_INSTANCE \
--envvars CXG_DATAROOT=$CXG_DATAROOT,CXG_CONFIG_FILE=$CXG_CONFIG_FILE
```
6. Give the elastic beanstalk environment access to the S3 bucket.
7. Give the elastic beanstalk environment access to the S3 bucket.
This link may provide some useful information:
https://aws.amazon.com/premiumsupport/knowledge-center/elastic-beanstalk-s3-bucket-instance/
7. Deploy the application
8. Deploy the application
```
eb deploy $EB_ENV
$ eb deploy $EB_ENV
```
7. Open the application in a browser
9. Open the application in a browser
```
eb open $EB_ENV
$ eb open $EB_ENV
```