Updating Ruby Package in CAPI Release

A ruby package spec file contains metadata providing which version of ruby, rubygems, and other supportive libraries. The packaging scripts specifies un-compressing these dependencies and installing them on our instances. (Q: Where does bosh get the ruby source code from?)

Steps to update ruby package (metadata for the ruby run for capi jobs)

1. Get the most up-to-date version of bosh ruby-release:

git clone https://github.com/cloudfoundry/bosh-package-ruby-release

2. Navigate to capi-release:

cd ~/workspace/capi-release

3. touch config/private.yml
4. Populate the new private.yml with the blobstore credentials found in the ARI GCP project
5. Run the vendor-package command to create 2 new directories that point to the updated ruby package (replace ruby-3.3 with your desired version)

bosh vendor-package ruby-3.3 ~/workspace/ruby-release/
# It creates .final_builds/packages/ruby-3.3/ and packages/ruby-3.3/

6. Delete the old ruby package rm -rf packages/ruby-3.2/
7. Go to capi-release/packages. Search recursively and replace each instance of ruby-3.2 with ruby-3.3
8. Go into the capi-release/jobs directory. Search recursively and replace each instance of ruby-3.2 with ruby-3.3
9. The resulting git diff should be similar to https://github.com/cloudfoundry/capi-release/pull/237/files
10. Commit and create a PR for capi-release

Updating cloud_controller_ng

1. In capi-release/src/cloud_controller_ng/.ruby-version update to your new version (e.g. bump 3.2 to 3.3.
2. Commit and create a pull request for cloud_controller_ng

Testing the updated ruby package

1. Target a bosh-lite. run deploy_only_new_capi. This creates and uploads capi-release, and does a bosh deploy.
2. Validate that it works:

bosh ssh api
/var/vcap/packaging/ruby/bin/ruby -v
# Should see "ruby NEW-VERSION"

3. Also run CATs

Updating Capi-workspace

Update this file: https://github.com/cloudfoundry/capi-workspace/blob/ebf062d2037b3fc788993aa49d03026bddc2e84f/install-scripts/ruby.sh#L6

Updating Bundler

If you updated bundler, rebundle (bundle update --bundler) with the new version in the following repos/directories:

• https://github.com/cloudfoundry/cloud_controller_ng
• https://github.com/cloudfoundry/cloud_controller_ng/tree/main/docs/v3
• https://github.com/cloudfoundry/capi-release/tree/develop/spec
• https://github.com/cloudfoundry/capi-release/blob/develop/packages/cloud_controller_ng/packaging

Updating Dockerfiles:

These Dockerfiles are all in the same repository. Create one PR to update the following:

• capi-runtime-ci
  • this Dockerfile is used for creating the capi-release tarball in the https://ci.cake.capi.land/teams/main/pipelines/capi/jobs/create-capi-release job
• capi-migration-compatibility
• capi-ruby-units
  • This Dockerfile is used for running unit tests in Concourse
  • It's best to test out changes to this Dockerfile manually. There can be several gotchas as the container needs to run bundle, mysql, and postgres. See detailed instructions on how to test changes to this Dockerfile here.

After merging in your PR, be sure to watch the https://ci.cake.capi.land/teams/main/pipelines/docker-images pipeline for failures.

---

Updating the capi-ruby-units Dockerfile detailed steps

Updating ruby in the ruby-units Dockerfile may cause additional failures, as different linux releases may install different versions of dependencies in the following apt-get install command. In particular, look out for upgrades in MariaDB (mysql) and Postgres.

To update your Dockerfile, follow these steps:

1. cd ~/workspace/capi-dockerfiles/capi-ruby-units
2. Open Dockerfile. check the official ruby docker images for an appropriate base image, and replaced the existing one (e.g. replace FROM ruby:2.5-stretch with FROM ruby:2.7-buster).
3. Update any other steps as necessary (e.g. replace RUN gem install bundler -v 1.17.3 with RUN gem install bundler -v 2.2.4)
4. run docker build . to see if the docker image builds successfully
5. Test the resulting dockerfile. To do so, run the image in interactive mode: docker run -it <image_name> /bin/bash
6. clone CCNG: git clone https://github.com/cloudfoundry/cloud_controller_ng.git
7. cd cloud_controller_ng
8. start mysql: service mysql start
9. run unit tests for MySql: DB=mysql ./bin/bundle exec rake spec
10. start postgres: service postgresql start
11. run unit tests for PostgreSql: DB=postgres ./bin/bundle exec rake spec

If both unit tests for mysql and postgres pass, then you may be ready to push the updated Dockerfile. However, beware that the pipeline actually runs this script: https://github.com/cloudfoundry/capi-ci/blob/d358203acbd0e5be4a5ce6ecb61e2c9115118dc2/ci/test-unit/run_cc_unit_tests. You may see failures depending on any differences from the above commands do to what this script runs.