You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To make the Research Gateway application available securely over SSL, you need a certificate issued by a public Certificate Authority (CA).
36
+
If you already have a certificate for your domain issued by a third-party CA, you can import it into ACM. [See how](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html).
37
+
38
+
If you already have a certificate for your domain issued by AWS in ACM, you can pass CertificateArn with launch stack ( #7 - #9) and skip the following step.
The output of the command above will include the ARN of the loadbalancer. e.g. arn:aws:elasticloadbalancing:region:aws_account_id:loadbalancer/app/research-gw-alb/e5ba62739c16e642
The output of the command will include the ARN of the target group. e.g. arn:aws:elasticloadbalancing:region:aws_account_id:targetgroup/tg-research-gw/209a844cd01825a4
71
67
68
+
<!-- trunk-ignore(markdownlint/MD036) -->
69
+
*Create #7 - #9 above using the following quick-start*
72
70
73
-
*Create a certificate for your domain*
74
-
75
-
To make the Research Gateway application available securely over SSL, you need a certificate issued by a public Certificate Authority (CA).
76
-
If you already have a certificate for your domain issued by a third-party CA, you can import it into ACM. [See how](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html).
77
-
If you already have a certificate for your domain issued by AWS in ACM, you can skip the following step.
*Note* - Create #7 - #9 above using AWS CLI commands also .For that you refer to the rg_alb-tg-creation.md file from repo
94
78
95
-
<!-- trunk-ignore(markdownlint/MD036) -->
96
-
*Set up Route 53 for your domain/sub-domain*
79
+
*10.Set up Route 53 for your domain/sub-domain*
97
80
98
81
From the AWS Console, select Route 53 service. Create a hosted zone for your domain. If you are using an existing domain you can add a CNAME record and select the public DNS name of the ALB as the value. It is also possible to create a separate hosted zone for the sub-domain used for Research Gateway.
99
82
100
83
*Note* - It is possible to use Research Gateway without a domain-name but we do not recommend that for product workloads. To do so, use the public DNS name of the ALB as the URL of the Research Gateway in the setup scripts.
The application software for Research Gateway will be made available to you as a docker image shared from Relevance Lab's Elastic Container Registry instance to your AWS account.
111
94
As a part of this deployment, you will create an AMI for the portal EC2 instance which will have these softwares pre-deployed. Alternately, you can request the AMI to be shared with you by Relevance Lab and the software above will be available pre-deployed on the AMI shared with you.
112
95
113
-
#### 4. AWS Services required
96
+
#### 5. AWS Services required
114
97
115
98
- AWS Cognito
116
99
- Amazon S3
@@ -133,28 +116,9 @@ The following sofware needs to be installed on the Portal EC2 instance
133
116
| jq | latest |
134
117
| zip | latest |
135
118
136
-
For your convenience we have created packer scripts which allow you to create the AMI in your account.
137
-
If an AMI with the pre-requisites has been shared with you, you can skip this section.
119
+
For your convenience we have created packer scripts which allow you to create the AMI in your account For that you refer to the rg_AMI-creation.md file from repo
138
120
139
-
### Creating the AMI with pre-requisites
140
-
141
-
You can create the AMI with pre-requisites yourself by following these steps:
- Target Account number must be added in Admin Account-ECR and give permission to access image builds
152
-
- Create a Role and attach a policy which permits ECR and EC2 actions and Replace the "iam-instance_profile" :"<your_rolename>" in builders section which is in the packer-rg.json.
- At Run time pass VPCID, SubnetID, AWSRegion as variables declared in packer-rg.json
157
-
- Note that AMI id from the output
121
+
If an AMI with the pre-requisites has been shared with you, you can skip this section
158
122
159
123
### Installing Research Gateway
160
124
@@ -192,7 +156,7 @@ runid.json is created in the rgdeploy folder when you first run deploy.sh with p
192
156
193
157
The deployment creates EC2 Image Builder pipelines for building the RStudio and Nextflow AMIs that are used within Research Gateway. By default, these pipelines are set up to be manually triggered. You can change that in the AWS console if you wish to trigger them on a schedule.
194
158
195
-
steps to run pipelines: AWS console - Ec2imagebuilder – select image pipelines (Rstudio, Nextflow)-click on Actions-Run pipeline
159
+
steps to run pipelines: AWS Console - EC2Imagebuilder – select image pipelines (Rstudio, Nextflow)-click on Actions-Run pipeline
196
160
197
161
Once a build is completed, the AMIs are automatically distributed to the regions supported by Research Gateway in your account. The AMI Ids need to be updated into your database before creating any projects.
ConstraintDescription: must be a valid IP CIDR range of the form x.x.x.x/x.
48
+
TransitionIntoIA:
49
+
Description: Migrates files that have not been accessed for a set period of time to the EFS Standard–Infrequent Access (Standard-IA) or One Zone–Infrequent Access (One Zone-IA) storage class, depending on your file system.
Description: Automatically moves files back to the EFS Standard or EFS One Zone storage classes when the TransitionToPrimaryStorageClass lifecycle policy is set to On first access. This helps to eliminate the risk of unbounded access charges, while providing consistent low latencies.
55
+
Type: String
56
+
Default: NONE
57
+
AllowedValues: [AFTER_1_ACCESS, NONE]
58
+
PerformanceMode:
59
+
Description: >-
60
+
Amazon EFS delivers more than 10 gibibytes per second (GiBps) of throughput over 500,000 IOPS, and sub-millisecond or low single digit millisecond latencies.
61
+
General Purpose mode supports up to 35,000 IOPS and has the lowest per-operation latency. File systems with EFS One Zone storage classes always use General Purpose performance mode.
62
+
Max I/O mode supports 500,000+ IOPS and has higher per-operation latencies when compared to General Purpose mode.
63
+
Type: String
64
+
Default: generalPurpose
65
+
AllowedValues: [generalPurpose, maxIO]
66
+
ThroughputMode:
67
+
Description: >-
68
+
determines the throughput available to your file system.
69
+
Bursting Throughput mode is a good fit for traditional applications that have a bursty throughput pattern.
70
+
In Provisioned Throughput mode, you specify a level of throughput that the file system can drive independent of the file system's size or burst credit balance.
71
+
Type: String
72
+
Default: bursting
73
+
AllowedValues: [bursting, provisioned]
74
+
ProvisionedThroughputInMibps:
75
+
Description: >-
76
+
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.
77
+
Valid range is 1-1024 MiB/s
78
+
Type: Number
79
+
Default: 1
80
+
Encrypted:
81
+
Description: Choose to enable encryption of your file system's data at rest. Uses the AWS KMS service key (aws/elasticfilesystem) by default
82
+
Type: String
83
+
Default: false
84
+
AllowedValues: [true, false]
85
+
KmsKeyId:
86
+
Description: The ID of the AWS Key Management Service (AWS KMS) key used to encrypt Amazon EFS file system data.
87
+
Type: String
88
+
Default: NONE
89
+
ResearcherName:
90
+
Description: Researcher name that will be added as tag to the resources
91
+
Type: String
92
+
ProjectId:
93
+
Description: Project Id that will be added as tag to the resources
94
+
Type: String
95
+
Namespace:
96
+
Description: Name your file system. Name can include letters, numbers, and +-=._:/ symbols, up to 256 characters.
0 commit comments