Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbroeglin/azure-rails-starter
Sample Ruby on Rails app deployed (Bicep) on Azure Container App with PostgreSQL
https://github.com/dbroeglin/azure-rails-starter
azd-templates azure azure-devops azure-postgres devcontainer github rails ruby ruby-on-rails
Last synced: about 2 months ago
JSON representation
Sample Ruby on Rails app deployed (Bicep) on Azure Container App with PostgreSQL
- Host: GitHub
- URL: https://github.com/dbroeglin/azure-rails-starter
- Owner: dbroeglin
- License: mit
- Created: 2024-03-29T20:35:01.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-16T17:07:29.000Z (2 months ago)
- Last Synced: 2024-11-16T17:18:01.281Z (2 months ago)
- Topics: azd-templates, azure, azure-devops, azure-postgres, devcontainer, github, rails, ruby, ruby-on-rails
- Language: Bicep
- Homepage:
- Size: 231 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
---
name: Azure Rails Starter
description: Sample Rails application deployed through Azure Developer CLI (azd) on Azure Container App and Azure Database for PostgreSQL
languages:
- ruby
- bicep
- azdeveloper
products:
- azure-container-apps
- azure-database-postgresql
- azure-key-vault
- azure
page_type: sample
urlFragment: azure-rails-starter
---
# Deploy a Rails (Ruby) web app with PostgreSQL In Azure Container Apps
[](https://codespaces.new/dbroeglin/azure-rails-starter?quickstart=1)
This is a starter blueprint for getting your Rails application up and running on Azure using [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/overview) (azd). The Rails application is deployed in an Azure Container App and uses an Azure Postgresql database. The starter uses Infrastructure as Code assets in [Bicep](https://aka.ms/bicep) to get your application up and running quickly.
The following assets have been provided:
- Infrastructure-as-code (IaC) Bicep files under the `infra` folder that demonstrate how to provision resources and setup resource tagging for azd.
- A [dev container](https://containers.dev) configuration file under the `.devcontainer` directory that installs infrastructure tooling by default. This can be readily used to create cloud-hosted developer environments such as [GitHub Codespaces](https://aka.ms/codespaces).
- Ruby 3.3.0
- GitHub Copilot
- Postgresql running in a container (for development)
- Redis running in a container (for development)
- Continuous deployment workflows for CI providers such as GitHub Actions under the `.github` directory, and Azure Pipelines under the `.azdo` directory that work for most use-cases.
- A freshly created Rails 7.1.3 application under directory `src`.
### Getting the Rails app up and running in Azure
Just run `azd up` to run the end-to-end infrastructure provisioning (`azd provision`) and deployment (`azd deploy`) flow. Visit the service endpoint listed to see your application up-and-running!
Quick start:
```bash
SECRET_KEY_BASE="$(src/bin/rails secret)" \
RAILS_MASTER_KEY="$(cat src/config/master.key)" \
azd up
```
## Additional Details
The following section examines different concepts that help tie in application and infrastructure.
### Application settings
It is recommended to have application settings managed in Azure, separating configuration from code. Typically, the service host allows for application settings to be defined.
- Application settings should be defined on the Bicep resource for the Azure Container App. See [main.bicep](./infra/rails.bicep#L43) for an example setting environment variables and using secrets stored in Azure Key Vault.
- Environment variables for your developer environment (Dev Containers or Codespaces) can be defined in [.decontainer/Dockerfile](.devcontainer/Dockerfile).
### Managed identities
[Managed identities](https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview) allows you to secure communication between services. This is done without having the need for you to manage any credentials. It is used between Azure Container Apps and Azure Key Vault to automatically retrieve secrets.s
### Azure Key Vault
[Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/general/overview) allows you to store secrets securely. Your application can access these secrets securely through the use of managed identities.
## Getting started with Rails development
### Provisioning & deploying with Azure Developer CLI
When changes are made, use azd to validate and apply your changes in Azure, to ensure that they are working as expected:
- Run `azd up` to validate both infrastructure and application code changes.
- Run `azd deploy` to validate application code changes only.
### Running Rails commands
Move to the `src` directory:
```bash
cd src
```
Run the Rails server:
```bash
bin/rails server
```
Run the Rails console:
```bash
bin/rails console
```
Run the Rails migration command:
```bash
bin/rails db:migrate
```
### Connecting to the Postgresql database
```bash
psql $DATABASE_URL
```
### Re-creating the Rails application
The rails application has been created by running the following command:
```bash
rails new --database=postgresql --name=azure-rails-starter src
rm -rf src/.git
cd src
sed -i '' 's/# root.*$/root "home#index"/' config/routes.rb
sed -i '' '/azure_rails_starter_production$/,/DATABASE_PASSWORD/c\
url: <%= ENV["DATABASE_URL"] %>
' config/database.yml
cat > app/controllers/home_controller.rb <