How to associate an existing RDS instance to an Elastic Beanstalk environment?

Solution 1:

The "selected" answer is correct, but I wanted to add some extra information as most people using EB and RDS together should have the same requirement too - even if they don't know it yet.

First question: Why would you want the RDS instance to exist outside the EB environment? Answer: So that the lifetime of the RDS instance is not tied to the lifetime of the EB environment. i.e. when you remove an environment, you don't want to destroy the DB with it. There are very few reasons why you'd want to actually tie your RDS instance to your environment.

A problem with settings up RDS independently of EB is that you don't get the RDS_* variables automatically populated and therefore need to retrieve their values and populate them yourselves via web console or .ebextensions. It's not recommended that you add credentials to your code though, as that can be a security hole.

But then, the next problem is if you want to programmatically create environments (such as for blue-green zero downtime deployments) then you need a solution for how to populate the sensitive RDS values (e.g. password) every time. Unfortunately, this requires you to drop further down the AWS stack and use a CloudFormation template.

The ideal solution is an enhancement to EB so that the "use an existing database" link mentioned in the question actually lets you manually associate an existing RDS database and then have the RDS_* environment variables automatically populated again, rather than redirecting you to unhelpful documentation. AWS Support said this has been raised as a feature request but of course no timeframe given.

Solution 2:

Answer from the AWS support:

In order to associate an existing database to a EB Environment you have to take a snapshot of it via the Management Console and then choose "create a new RDS database" under the Data Layer. There does not appear to be a way to associate a running RDS instance to an existing EB Environment without launching a new one from a snapshot due to the way the RDS instance is tied into the Beanstalk environment's underlying Cloudformation stack. If you take a snapshot of your current RDS instance you can start it anew in EB if you wish.

If you want the RDS instance to exist outside of the environment you can simply provide the connection parameters as environment variables via the EB Console: Configuration -> Web Layer -> Software Configuration. Then, you can read the environment variable via PHP.

---

Solution 3:

I needed to this recently and also wanted to automate the steps using the AWS CLI/EB CLI. In any case, here are basically the steps I followed (assuming you already created an RDS instance):

1. Make sure you have a different security group setup for your RDS instance (not the VPC default group). You can use aws ec2 create-security-group (AWS CLI) for that and associate it with the RDS instance using aws rds modify-db-instance (AWS CLI).
2. Initialize your beanstalk application (I used eb init (EB CLI) for that).
3. Read relevant configuration data from your RDS database (DB name, host name, port, etc). I used aws rds describe-db-instances for that.
4. Using that data set the RDS_* environment variables on the EB instance when you create the environment (or deploy the environment later). You can do this with eb create/eb deploy (EB CLI). When you create the environment initially it will be degraded, since the security groups to access the RDS database are not set up properly.
5. Get the relevant security groups from the EB configuration. You need the one for the autoscaling group and for the elastic load balancer. You can use aws elasticbeanstalk describe-configuration-settings (AWS CLI) for that.
6. Authorize your autoscaling group for inbound traffic to your database for the security group you set up in step 1. I used aws ec2 authorize-security-group-ingress (AWS CLI) for that, which uses VPC security groups (not DB security groups). You can probably achieve the same with DB security groups if they are supported in your region. When setting up the inbound traffic rule make sure you use the right protocal and port for your database engine.
7. Add the elastic load balancer group to the security groups of your RDS instance (again using aws rds modify-db-instance (AWS CLI)).
8. Reboot or redeploy the Elastic Beanstalk application (e.g. using eb deploy (EB CLI)). I had to do a redeploy, since I run migrations on deployments.

That is mostly it. Now you should be able to scale up/down your RDS instances without care of the EB instances, as long you keep the hostname and DB credentials the same. You can also do blue/green deployments with that approach (but you might need to do some extra steps to also revoke security group access).