Skip to content
This repository has been archived by the owner on Sep 17, 2021. It is now read-only.

Commit

Permalink
Adding RDS Postgres docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scriptsrc committed Apr 10, 2017
1 parent bd2a6e1 commit 1f9f651
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 7 deletions.
5 changes: 5 additions & 0 deletions docs/iam_aws.md
Expand Up @@ -223,3 +223,8 @@ Additional SecurityMonkeyInstanceProfile roles are not required. You only need t
**Note**

You will also need to add the new account in the Web UI, and restart the scheduler. More information on how do to this will be presented later in this guide.

Next:
-----

- [Back to the Quickstart](quickstart.md#database)
8 changes: 5 additions & 3 deletions docs/iam_gcp.md
Expand Up @@ -30,6 +30,8 @@ To restrict which permissions Security Monkey has to your projects, we'll create

![Add User to Service Account](images/add_user_to_service_account.png "Add User to Service Account")

Next, we'll launch an instance using that service account.
- [Launch an AWS instance](instance_launch_aws.md).
- [Launch a GCP instance](instance_launch_gcp.md).

Next:
-----

- [Back to the Quickstart](quickstart.md#database)
Binary file added docs/images/aws_rds.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/instance_launch_aws.md
Expand Up @@ -38,3 +38,8 @@ We will connect to the new instance over ssh:
$ ssh -i SecurityMonkeyKeyPair.pem -l ubuntu <PUBLIC_IP_ADDRESS>

Replace the last parameter (\<PUBLIC\_IP\_ADDRESS\>) with the Public IP of your instance.

Next:
-----

- [Back to the Quickstart](quickstart.md#install-security-monkey-on-your-instance)
9 changes: 7 additions & 2 deletions docs/instance_launch_gcp.md
Expand Up @@ -23,6 +23,11 @@ Connecting to your new instance:

We will connect to the new instance over ssh with the gcloud command:

$ gcloud compute ssh <USERNAME>@<PUBLIC_IP_ADDRESS> --zone us-west1-b
$ gcloud compute ssh <USERNAME>@<PUBLIC_IP_ADDRESS> --zone us-central

Replace the first parameter (\<USERNAME\>) with the username you authenticated gcloud with. Replace the last parameter (\<PUBLIC\_IP\_ADDRESS\>) with the Public IP of your instance.
Replace the first parameter `<USERNAME>` with the username you authenticated gcloud with. Replace the last parameter `<PUBLIC_IP_ADDRESS>` with the Public IP of your instance.

Next:
-----

- [Back to the Quickstart](quickstart.md#install-security-monkey-on-your-instance)
19 changes: 19 additions & 0 deletions docs/postgres_aws.md
@@ -0,0 +1,19 @@
Postgres on AWS
===============

Amazon can host your postgres database in their [RDS service](https://aws.amazon.com/rds/). We recommend using AWS RDS or [GCP Cloud SQL](postgres_gcp.md) to productionalize your security_monkey deployment.

Create a Postgres RDS instance in the same region you intend to launch your security_monkey instance.

![Create RDS Instance](images/aws_rds.png "Create RDS Instance")

The AWS supplied defaults should get you going. You will need to use the hostname, dbname, username, password to create a SQLALCHEMY_DATABASE_URI for your config.

SQLALCHEMY_DATABASE_URI = 'postgresql://securitymonkeyuser:securitymonkeypassword@hostname:5432/secmonkey'

Advanced users may wish to supply a KMS key for encryption at rest.

Next:
-----

- [Quickstart](quickstart.md#launch-an-instance)
5 changes: 5 additions & 0 deletions docs/postgres_gcp.md
Expand Up @@ -16,3 +16,8 @@ Connect to the Postgres instance:
$ sudo -u postgres psql -h 127.0.0.1 -p 5432

After you've connected successfully in psql, follow the instructions in Setup Postgres\_ to set up the Security Monkey database.

Next:
-----

- [Quickstart](quickstart.md)
4 changes: 2 additions & 2 deletions docs/quickstart.md
Expand Up @@ -148,8 +148,8 @@ This will add Amazon owned AWS accounts to security monkey. :

You'll need to add at least one account before starting the scheduler. It's easiest to add them from the command line, but it can also be done through the web UI. :

$ sudo -E python manage.py add_account_aws
$ sudo -E python manage.py add_account_gcp
$ sudo -E python manage.py add_account_aws --number $account --name $name -r SecurityMonkey
$ sudo -E python manage.py add_account_gcp --help

### Create the first user:

Expand Down

0 comments on commit 1f9f651

Please sign in to comment.