Skip to content

Commit c827871

Browse files
committed
[NRL-1386] Fix invalid markdown URLs in README
1 parent bdc0a14 commit c827871

File tree

2 files changed

+39
-9
lines changed

2 files changed

+39
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -499,9 +499,9 @@ The process to create a new release is as follows:
499499

500500
Once your new release has been created, you can then deploy this release through the NRLF environments using the "Persistent Environment Deploy" Github Action.
501501

502-
If the Consumer API has changed, or the documentation for that API has changed, you will also need to release (NRL Consumer API)[https://github.com/NHSDigital/nrl-consumer-api].
502+
If the Consumer API has changed, or the documentation for that API has changed, you will also need to release [NRL Consumer API](https://github.com/NHSDigital/nrl-consumer-api).
503503

504-
If the Producer API has changed, or the documentation for that API has changed, you will also need to release (NRL Producer API)[https://github.com/NHSDigital/nrl-producer-api].
504+
If the Producer API has changed, or the documentation for that API has changed, you will also need to release [NRL Producer API](https://github.com/NHSDigital/nrl-producer-api).
505505

506506
### Deploying releases
507507

terraform/account-wide-infrastructure/README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -126,19 +126,49 @@ Replacing AWS_ACCOUNT_ID with the AWS account number of your account.
126126
127127
### Reporting Resources
128128
129-
If deploying the EC2 set up to a new environment, these steps need to be followed:
129+
To enable reporting resources for the account, do the following:
130130
131-
1. Run the below CLI command, and RDP into the newly created EC2 instance (localhost:13389)
131+
1. Set the `enable_reporting` variable to `true` in `./ACCOUNT_NAME/vars.tf`
132+
2. Deploy the account-wide infrastructure to the account
133+
134+
To disable reporting resources for the account, do the following:
135+
136+
1. Set the `enable_reporting` variable to `true` in `./ACCOUNT_NAME/vars.tf`
137+
2. Deploy the account-wide infrastructure to the account
138+
139+
#### Deploying the PowerBI Gateway
140+
141+
The first time you deploy the PowerBI Gateway set up to a new account, these steps need to be followed:
142+
143+
1. Set the `enable_powerbi_auto_push` variable to `true` in `./ACCOUNT_NAME/vars.tf`
144+
2. Set the `use_powerbi_gw_custom_ami` variable to `false` in `./ACCOUNT_NAME/vars.tf`
145+
3. Deploy the account-wide infrastructure for the account
146+
4. Run the below CLI command, and RDP into the newly created EC2 instance (localhost:13389)
147+
148+
```
149+
aws ssm start-session --target <AMI> --document-name AWS-StartPortForwardingSession --parameters "localPortNumber=13389,portNumber=3389"
150+
```
151+
152+
5. Install Athena ODBC driver and Power BI standard on premises gateway
153+
6. Configure ODBC driver to connect to relevant Athena instance
154+
7. Log in to the gateway using NHS email, name the cluster to nhsd-nrlf-{env}--reporting-gw
155+
8. Log on to power bi, navigate to Manage Connections and Gateways in settings and set up Athena connector with authentication method: Anonymous and privacy level: Private
156+
9. Set dataset to point to this gateway, define schedule as needed
157+
10. In the AWS Console, create an AMI from the instance called `PowerBI_GW`
158+
11. Set the `use_powerbi_gw_custom_ami` variable to `true`
159+
12. Deploy the account-wide infrastructure for the account
160+
13. Run the below CLI command, and RDP into the newly created EC2 instance (localhost:13389)
132161
133162
```
134163
aws ssm start-session --target <AMI> --document-name AWS-StartPortForwardingSession --parameters "localPortNumber=13389,portNumber=3389"
135164
```
136165
137-
2. Install Athena ODBC driver and Power BI standard on premises gateway
138-
3. Configure ODBC driver to connect to relevant Athena instance
139-
4. Log in to the gateway using NHS email, name the cluster to nhsd-nrlf-{env}--reporting-gw
140-
5. Log on to power bi, navigate to Manage Connections and Gateways in settings and set up Athena connector with authentication method: Anonymous and privacy level: Private
141-
6. Set dataset to point to this gateway, define schedule as needed
166+
14. Start the PowerBI Gateway service on the instance
167+
168+
To disable the PowerBI Gateway from the account:
169+
170+
1. Set the `enable_powerbi_auto_push` variable to `false` in `./ACCOUNT_NAME/vars.tf`
171+
2. Deploy the account-wide infrastructure to the account
142172
143173
## Tear down account wide resources
144174

0 commit comments

Comments
 (0)