Skip to content

Commit

Permalink
adding documentation for new compound_explorer application
Browse files Browse the repository at this point in the history
  • Loading branch information
brifordwylie committed Jan 6, 2025
1 parent c106117 commit ac9e3ba
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 1 deletion.
12 changes: 12 additions & 0 deletions applications/compound_explorer/open_source_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"WORKBENCH_BUCKET": "env-will-overwrite",
"WORKBENCH_ROLE": "Workbench-ExecutionRole",
"WORKBENCH_PLUGINS": "package",
"WORKBENCH_FEATURES": {
"plugins": "true",
"experimental": "false",
"large_meta_data": "false",
"enterprise": "false"
},
"WORKBENCH_API_KEY": "eyJsaWNlbnNlX2lkIjogIk9wZW4gU291cmNlIiwgImF3c19hY2NvdW50X2lkIjogbnVsbCwgImZlYXR1cmVzIjogeyJmZWF0dXJlX3NldHMiOiB0cnVlLCAibW9kZWxfbW9uaXRvcmluZyI6IHRydWV9LCAiZXhwaXJlcyI6ICIyMDI1LTAxLTEwIn2QElHhryzF61yIVDi5SgVZIog7L4zR5frdMrv8fncPEgXZjs+pTQkzxCtnvDIB8ZpcPR+1AQ1apyGnTUab6yt3+m4GH11HOZgOmqEl5EhapufmQfI2w6kRn1HSp3HKU+EKzbANqlhTrGnuJnret9YHItD2DlXe7D7hMcrQW4Fh1g=="
}
63 changes: 63 additions & 0 deletions docs/admin/explorer_docker_push.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Explorer Docker Build and Push

Notes and information on how to do the Dashboard Docker Builds and Push to AWS ECR.

### Update Workbench Version
```
cd applications/compound_explorer
vi Dockerfile
# Install Workbench (changes often)
RUN pip install --no-cache-dir workbench==0.8.90 <-- change this
```

### Build the Docker Image
**Note:** For a client specific config file you'll need to copy it locally so that it's within Dockers 'build context'. If you're building the 'vanilla' open source Docker image, then you can use the `open_source_config.json` that's in the directory already.

```
docker build --build-arg WORKBENCH_CONFIG=open_source_config.json -t \
compound_explorer:v0_8_90_amd64 --platform linux/amd64 .
```

### Test the Image Locally
You have a `docker_local_dashboard` alias in your `~/.zshrc` :)

### Login to ECR
```
aws ecr-public get-login-password --region us-east-1 --profile \
scp_sandbox_admin | docker login --username AWS \
--password-stdin public.ecr.aws
```
### Tag/Push the Image to AWS ECR
```
docker tag compound_explorer:v0_8_90_amd64 \
public.ecr.aws/m6i5k1r2/compound_explorer:v0_8_90_amd64
```
```
docker push public.ecr.aws/m6i5k1r2/compound_explorer:v0_8_90_amd64
```

### Update the 'latest' tag
```
docker tag public.ecr.aws/m6i5k1r2/compound_explorer:v0_8_90_amd64 \
public.ecr.aws/m6i5k1r2/compound_explorer:latest
```
```
docker push public.ecr.aws/m6i5k1r2/compound_explorer:latest
```

### Update the 'stable' tag
This is obviously only when you want to mark a version as stable. Meaning that it seems to 'be good and stable (ish)' :)

```
docker tag public.ecr.aws/m6i5k1r2/compound_explorer:v0_8_90_amd64 \
public.ecr.aws/m6i5k1r2/compound_explorer:stable
```
```
docker push public.ecr.aws/m6i5k1r2/workbench_dashboard:stable
```

### Test the ECR Image
You have a `docker_ecr_dashboard` alias in your `~/.zshrc` :)


3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,9 @@ nav:
- Base Docker Push: admin/base_docker_push.md
- Dashboard Docker Push: admin/dashboard_docker_push.md
- Dashboard with S3 Plugins: admin/dashboard_s3_plugins.md
- Dashboard with Docker Plugins: admin/dashboard_with_plugins.md
- Explorer Docker Push: admin/explorer_docker_push.md
- Storage:
- Dashboard with Docker Plugins: admin/dashboard_with_plugins.md
- Workbench Docker for Lambdas: admin/workbench_docker_for_lambdas.md

theme:
Expand Down

0 comments on commit ac9e3ba

Please sign in to comment.