Skip to content

Commit 3e70015

Browse files
committed
Added ICA support
* Made aware `ICA_ACCESS_TOKEN` env var * Improved token loading from ica cli * Improved README and added TL;DR * Bumped deps versions
1 parent d5419f6 commit 3e70015

File tree

7 files changed

+65
-1947
lines changed

7 files changed

+65
-1947
lines changed

.dockerignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules/

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
ami_license_vccc.txt
2-
node_modules
2+
node_modules/
33

44
.Rproj.user
55
.Rhistory

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM node:alpine
1+
FROM node:14-alpine
22

33
COPY . /opt/illumination
44

README.md

+45-18
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,34 @@
11
# Illumination
22

3+
## TL;DR
4+
5+
- Required [ICA CLI installed and configured](https://support.illumina.com/sequencing/sequencing_software/illumina-connected-analytics.html)
6+
- Required [Docker Desktop](https://www.docker.com/products/docker-desktop)
7+
8+
```
9+
ica login
10+
11+
export ICA_ACCESS_TOKEN=$(ica tokens create --project-name development)
12+
13+
docker run --rm -it -e ICA_ACCESS_TOKEN -p 3000:3000 victorskl/illumination
14+
15+
(Ctrl+C to stop)
16+
unset ICA_ACCESS_TOKEN
17+
```
18+
19+
- Open http://localhost:3000
20+
21+
22+
## TOC
23+
324
- [Illumination](#illumination)
425
- [Installation](#installation)
526
- [Running](#running)
627
- [Updating](#updating)
728
- [Features](#features)
829
- [Display JSON of Workflow Version Definitions](#display-json-of-workflow-version-definitions)
930
- [Display Summarised JSON Information In Tables](#display-summarised-json-information-in-tables)
10-
- [Docker Shortcuts](#docker-shortcuts)
31+
- [Docker](#docker)
1132
- [Developer Notes](#developer-notes)
1233
- [Adding new endpoints](#adding-new-endpoints)
1334
- [Resources](#resources)
@@ -41,24 +62,14 @@ cd illumination
4162
npm install
4263
```
4364

44-
**(Optional) Docker**:
45-
46-
```bash
47-
# build the image
48-
docker build -t umccr/illumination:latest .
49-
50-
# set your IAP access token
51-
export IAP_TOKEN='...'
52-
# run the container
53-
docker run --rm --env IAP_TOKEN -p 3000:3000 umccr/illumination:latest
54-
```
55-
5665
## Running
5766

5867
```bash
59-
npm start # or node app.js
68+
npm start
6069
```
6170

71+
- `Ctrl+C` to stop
72+
6273
### Updating
6374

6475
Pull latest code changes and install/update newer dependencies:
@@ -79,25 +90,41 @@ npm install
7990

8091
<img src="https://i.postimg.cc/26SY3Jpx/workflow-run-table.png" alt="workflow run table" height="500">
8192

93+
## Docker
94+
95+
### Using Docker
96+
97+
```bash
98+
# build the image
99+
docker build -t victorskl/illumination:latest .
100+
101+
# set your ICA access token
102+
export ICA_ACCESS_TOKEN='...'
103+
# run the container
104+
docker run --rm --env ICA_ACCESS_TOKEN -p 3000:3000 victorskl/illumination:latest
105+
```
106+
82107
### Docker Shortcuts
83108

84109
For convenience, enter the following into your `~/.bashrc`. Then you can
85110
simply type `run_illumination` in order to run the illumination docker command.
86111

87112
```bash
88-
# IAP token
89-
if [[ -f ~/.iap/.session.yaml ]]; then
90-
export IAP_TOKEN=$(cat ~/.iap/.session.yaml | {
113+
# ICA access token
114+
if [[ -f ~/.ica/.session.aps2.yaml ]]; then
115+
export ICA_ACCESS_TOKEN=$(cat ~/.ica/.session.aps2.yaml | {
91116
grep '^access-token: '
92117
} | {
93118
cut -d' ' -f2
94119
})
95120
fi
96121

97122
# ILLUMINATION ALIAS
98-
alias run_illumination="docker run --rm -i -t --env IAP_TOKEN --publish 3000:3000 umccr/illumination:latest"
123+
alias run_illumination="docker run --rm -i -t --env ICA_ACCESS_TOKEN --publish 3000:3000 victorskl/illumination:latest"
99124
```
100125

126+
> Note: there can be many variations on how you would like to automate ICA token generation then launch illumination into a specific ICA project context. i.e., bash-ing, alias-ing, zZZ-ing, etc... See relevant [wiki entry](https://github.com/umccr/wiki/tree/master/computing/cloud/illumina) and/or https://github.com/umccr/ica-ica-lazy for more pointers.
127+
101128
## Developer Notes
102129

103130
### Adding new endpoints

0 commit comments

Comments
 (0)