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
{{ message }}
This repository was archived by the owner on Apr 13, 2023. It is now read-only.
Changes:
- All resources made from audit log or main yaml will be tagged the same
- This is to assist our customers with determining the billing
Tests:
- yarn run release
- sls deploy
Copy file name to clipboardexpand all lines: README.md
+27-3
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# FhirSolution MVP Installation (v 0.6.0)
1
+
# FhirSolution MVP Installation (v 0.6.1)
2
2
3
3
## Introduction
4
4
@@ -40,6 +40,7 @@ The system architecture consists of multiple layers of AWS serverless services.
40
40
This installation guide covers a basic installation on Windows, Unix-like systems, or through Docker. The Unix installation has been tested on OSX Catalina, CentOS (Amazon Linux 2), and Ubuntu (18.04 LTS), and the Windows installation has been tested on Windows Server 2019. If you encounter any problems installing in this way, please see the "Known Issues" section, or refer to the Manual Installation section.
41
41
42
42
### Unix Installation
43
+
43
44
In a Terminal application or command shell, navigate to the directory containing the package’s code.
44
45
45
46
Run the following lines of code:
@@ -51,52 +52,68 @@ sudo ./scripts/install.sh
51
52
52
53
The `sudo` command may prompt you for your password, after which installation will commence. Follow the directions in the script to finish installation. See the following section for details on optional installation settings.
53
54
The `stage` and `region` values are set by default to `dev` and `us-west-2`, but they can be changed with commandline arguments as follows:
The Kibana server allows you to explore data inside your ElasticSearch instance through a web UI. This server is automatically created if 'stage' is set to `dev`.
109
127
110
128
Accessing the Kibana server requires you to set up a cognito user. The installation script can help you set up a cognito user, or you can do it manually through the AWS Cognito Console.
@@ -122,12 +140,14 @@ The reason behind multiple stacks is that backup vaults can be deleted only if t
122
140
These back-ups work by using tags. In the [serverless.yaml](./serverless.yaml) you can see ResourceDynamoDBTable has a `backup - daily` & `service - fhir` tag. Anything with these tags will be backed-up daily at 5:00 UTC.
123
141
124
142
#### Audit Log Mover
143
+
125
144
Audit Logs are placed into CloudWatch Logs at <CLOUDWATCH_EXECUTION_LOG_GROUP>. The Audit Logs includes information about request/responses coming to/from your API Gateway. It also includes the Cognito user that made the request.
126
145
127
146
In addition, if you would like to archive logs older than 7 days into S3 and delete those logs from Cloudwatch Logs, please follow the instructions below.
After installation, all user-specific variables (such as `USER_POOL_APP_CLIENT_ID`) can be found in the `INFO_OUTPUT.yml` file. You can also retrieve these values by running `serverless info --verbose --aws-profile FHIR-Solution`.
145
166
If you used a `stage` and/or `dev` values different than the default, you'll need to use the command `serverless info --verbose --aws-profile FHIR-Solution --region <REGION> --stage <STAGE>`.
146
167
@@ -318,6 +339,7 @@ and execute the following command:
These parameters can be found by checking the `INFO_OUTPUT.yml` file generated by the installation script, or by running the previously mentioned `serverless info --verbose` command.
322
344
323
345
## Manual Installation Prerequisites
@@ -468,12 +490,14 @@ From the command’s output note down the following data
468
490
- from Stack Outputs: CloudwatchExecutionLogGroup:
469
491
470
492
### Deploying Audit Log Mover
493
+
471
494
Audit Logs are placed into CloudWatch Logs at <CLOUDWATCH_EXECUTION_LOG_GROUP>. The Audit Logs includes information about request/responses coming to/from your API Gateway. It also includes the Cognito user that made the request.
472
495
473
496
In addition, if you would like to archive logs older than 7 days into S3 and delete those logs from Cloudwatch Logs, please follow the instructions below.
0 commit comments