Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ruby: puma is default in latest RoR #4094

Merged
merged 2 commits into from
Jul 9, 2024
Merged

ruby: puma is default in latest RoR #4094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8b8686
ruby: puma is default in latest RoR
spk Jul 4, 2024
35183e3
Merge branch 'main' into ruby-puma
chadwcarlson Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 45 additions & 69 deletions sites/platform/src/languages/ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Ruby"
description: |
{{% vendor/name %}} supports deploying any Ruby application. Your application can use any Ruby application server such as Unicorn or Puma and deploying a Rails or a Sinatra app is very straight forward.
{{% vendor/name %}} supports deploying any Ruby application. Your application can use any Ruby application server such as Puma or Unicorn and deploying a Rails or a Sinatra app is very straight forward.
---

{{% composable/disclaimer %}}
Expand Down Expand Up @@ -49,10 +49,10 @@ type: 'ruby:{{% latest "ruby" %}}'

{{< image-versions image="ruby" status="deprecated" >}}

## Unicorn based Rails configuration
## Puma based Rails configuration

This example uses Unicorn to run a Ruby application.
You could use any Ruby application server such as Puma or Thin.
This example uses Puma to run a Ruby application.
You could use any Ruby application server such as Unicorn.

Configure the `{{< vendor/configfile "app" >}}` file with a few key settings as listed below.
A complete example is included at the end of this section.
Expand All @@ -72,24 +72,22 @@ type: 'ruby:{{% latest "ruby" %}}'
```yaml {configFile="app"}
variables:
env:
BUNDLE_CACHE_ALL: '1'
BUNDLE_CLEAN: '1' # /!\ if you are working with Ruby <2.7, this doesn't work well
BUNDLE_DEPLOYMENT: '1'
BUNDLE_ERROR_ON_STDERR: '1'
PIDFILE: "tmp/server.pid" # Allow to start puma directly even if `tmp/pids` directory is not created
RAILS_ENV: "production"
BUNDLE_WITHOUT: 'development:test'
DEFAULT_BUNDLER_VERSION: "2.2.26" # in case none is mentioned in Gemfile.lock
EXECJS_RUNTIME: 'Node'
NODE_ENV: 'production'
NODE_VERSION: v14.17.6
NVM_VERSION: v0.38.0
RACK_ENV: 'production'
RAILS_ENV: 'production'
RAILS_LOG_TO_STDOUT: '1' # log to /var/log/app.log
RAILS_TMP: '/tmp'
TARGET_RUBY_VERSION: '~>{{% latest "ruby" %}}' # this will allow to not fail on PATCH update of the image
```

The `SECRET_KEY_BASE` variable is generated automatically based on the [`PLATFORM_PROJECT_ENTROPY` variable](../development/variables/use-variables.md#use-provided-variables).
You can change it.
The `SECRET_KEY_BASE` variable is generated automatically based on the
[`PLATFORM_PROJECT_ENTROPY`
variable](../development/variables/use-variables.md#use-provided-variables) but you can change it.

Based on TARGET_RUBY_VERSION, we recommand to set on your Gemfile so next
PATCH release of ruby doesn't fail the build:

```ruby
ruby ENV["TARGET_RUBY_VERSION"] || File.read(File.join(File.dirname(__FILE__), ".ruby-version")).strip
```

3. Build your application with the build hook.

Expand All @@ -100,43 +98,8 @@ You can change it.
hooks:
build: |
set -e

echo "Installing NVM $NVM_VERSION"
unset NPM_CONFIG_PREFIX
export NVM_DIR="$PLATFORM_APP_DIR/.nvm"
# install.sh automatically installs NodeJS based on the presence of $NODE_VERSION
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/$NVM_VERSION/install.sh | bash
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

# we install the bundled bundler version and fallback to a default (in env vars above)
export BUNDLER_VERSION="$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" || $DEFAULT_BUNDLER_VERSION
echo "Install bundler $BUNDLER_VERSION"
gem install --no-document bundler -v $BUNDLER_VERSION

echo "Installing gems"
# We copy the bundle directory to the {{% vendor/name %}} cache directory for
# safe keeping, then restore from there on the next build. That allows
# bundler to skip downloading code it doesn't need to.
[ -d "$PLATFORM_CACHE_DIR/bundle" ] && \
rsync -az --delete "$PLATFORM_CACHE_DIR/bundle/" vendor/bundle/
mkdir -p "$PLATFORM_CACHE_DIR/bundle"
bundle install
# synchronize updated cache for next build
[ -d "vendor/bundle" ] && \
rsync -az --delete vendor/bundle/ "$PLATFORM_CACHE_DIR/bundle/"

# precompile assets
echo "Precompiling assets"
# We copy the webpacker directory to the {{% vendor/name %}} cache directory for
# safe keeping, then restore from there on the next build. That allows
# bundler to skip downloading code it doesn't need to.
mkdir -p "$PLATFORM_CACHE_DIR/webpacker"
mkdir -p "$RAILS_TMP/cache/webpacker"
[ -d "$PLATFORM_CACHE_DIR/webpacker" ] && \
rsync -az --delete "$PLATFORM_CACHE_DIR/webpacker/" $RAILS_TMP/cache/webpacker/
# We dont need secret here https://github.com/rails/rails/issues/32947
SECRET_KEY_BASE=1 bundle exec rails assets:precompile
rsync -az --delete $RAILS_TMP/cache/webpacker/ "$PLATFORM_CACHE_DIR/webpacker/"
bundle exec rails assets:precompile
deploy: bundle exec rake db:migrate
```

Expand All @@ -158,13 +121,15 @@ web:
upstream:
socket_family: unix
commands:
start: "bundle exec unicorn -l $SOCKET"
# for puma
start: "bundle exec puma -b unix://$SOCKET"
# for unicorn
# start: "bundle exec unicorn -l $SOCKET"
```
This assumes you have Unicorn as a dependency in your Gemfile:

```ruby
# Use Unicorn as the app server
gem "unicorn", "~> 6.0", :group => :production
gem "puma", ">= 5.0"
```

5. Define the web locations your application is using:
Expand Down Expand Up @@ -229,26 +194,27 @@ dependencies:
# The example below shows simplified configuration leveraging a default service (identified from the relationship name) and a default endpoint.
# See the Application reference for all options for defining relationships and endpoints.
relationships:
mysql:
mysql:

disk: 2048

variables:
env:
BUNDLE_CACHE_ALL: '1'
BUNDLE_CLEAN: '1' # /!\ if you are working with Ruby<2.7 this doesn't work well
BUNDLE_DEPLOYMENT: '1'
BUNDLE_ERROR_ON_STDERR: '1'
BUNDLE_CACHE_ALL: '1' # Default, Cache all gems, including path and git gems.
BUNDLE_CLEAN: '1' # /!\ if you are working with Ruby<2.7 this doesn't work well, but should be safe on modern Rubies.
BUNDLE_DEPLOYMENT: '1' # Default, Disallow changes to the Gemfile.
BUNDLE_ERROR_ON_STDERR: '1' # Default.
BUNDLE_WITHOUT: 'development:test'
PIDFILE: "tmp/server.pid" # Allow to start puma directly even if `tmp/pids` directory is not created
DEFAULT_BUNDLER_VERSION: "2.2.26" # in case none is mentioned in Gemfile.lock
EXECJS_RUNTIME: 'Node'
EXECJS_RUNTIME: 'Node' # If you need one on your assets https://github.com/rails/execjs#readme
NODE_ENV: 'production'
NODE_VERSION: v14.17.6
NVM_VERSION: v0.38.0
RACK_ENV: 'production'
RAILS_ENV: 'production'
RAILS_LOG_TO_STDOUT: '1'
RAILS_TMP: '/tmp'
RAILS_LOG_TO_STDOUT: '1' # Default
RAILS_TMP: '/tmp' # Default

hooks:
build: |
Expand Down Expand Up @@ -283,6 +249,7 @@ hooks:
# We copy the webpacker directory to the {{% vendor/name %}} cache directory for
# safe keeping, then restore from there on the next build. That allows
# bundler to skip downloading code it doesn't need to.
# https://guides.rubyonrails.org/asset_pipeline.html
mkdir -p "$PLATFORM_CACHE_DIR/webpacker"
mkdir -p "$RAILS_TMP/cache/webpacker"
[ -d "$PLATFORM_CACHE_DIR/webpacker" ] && \
Expand All @@ -307,7 +274,10 @@ web:
upstream:
socket_family: unix
commands:
start: "bundle exec unicorn -l $SOCKET"
# for puma
start: "bundle exec puma -b unix://$SOCKET"
# for unicorn
# start: "bundle exec unicorn -l $SOCKET"

locations:
"/":
Expand All @@ -333,7 +303,7 @@ Once you have a service, link to it in your [app configuration](../create-apps/_

```yaml {configFile="app"}
relationships:
mysql:
mysql:
```
By using the following Ruby function calls, you can obtain the database details.

Expand Down Expand Up @@ -387,7 +357,13 @@ For Rails, you have two choices:
and look for [discourse configurations](https://github.com/discourse/discourse_docker/blob/b259c8d38e0f42288fd279c9f9efd3cefbc2c1cb/templates/web.template.yml#L8)

- New images are released on a regular basis to apply security patches.
To avoid issues when such updates are performed, use `ruby "~>3.1"` in your `Gemfile`.
To avoid issues when such updates are performed, use

``` ruby
ruby ENV["TARGET_RUBY_VERSION"] || File.read(File.join(File.dirname(__FILE__), ".ruby-version")).strip
```

in your `Gemfile`.

## Troubleshooting

Expand Down
Loading
Loading