RVM 项目技术文档

1. 安装指南

1.1 系统要求

• Chef: 测试于 12.5.1 版本，但较旧版本的 Chef 可能由于资源模型的变化而无法正常工作。如果需要支持旧版本，请提交 Pull Request。
• 平台: 支持以下平台：
  • Ubuntu (12.04 及以上)
  • Debian (6.0 及以上)
  • macOS (10.6/10.7)
  • macOS Server
  • SUSE (openSUSE, SLES)
  • CentOS
  • Amazon (2011.09)
  • Scientific
  • Red Hat
  • Fedora
  • Gentoo

1.2 依赖安装

• 如果安装 [JRuby][jruby]，则需要安装 Java 运行时。可以使用 Opscode 的 [java cookbook][java_cb] 在支持的平台上安装。
• 在 macOS 上，建议使用 homebrew cookbook 来安装编译 Ruby 所需的额外包。

2. 项目安装方式

2.1 使用 Berkshelf 安装

1. 安装 Berkshelf：

   gem install berkshelf
   

2. 初始化 Berkshelf 并添加 RVM cookbook：

   cd chef-repo
   berks init
   echo "cookbook 'rvm', github: 'fnichol/chef-rvm'" >> Berksfile
   berks install
   

2.2 使用 Librarian-Chef 安装

1. 安装 Librarian-Chef：

   gem install librarian-chef
   

2. 初始化 Librarian-Chef 并添加 RVM cookbook：

   cd chef-repo
   librarian-chef init
   cat >> Cheffile <<END_OF_CHEFFILE
   cookbook 'rvm',
     :git => 'git://github.com/fnichol/chef-rvm.git', :ref => 'v0.10.1'
   END_OF_CHEFFILE
   librarian-chef install
   

3. 项目的使用说明

3.1 默认 Recipe

default recipe 安装 RVM gem 并初始化 Chef，以便使用本 cookbook 中的资源来安装和管理 RVM。

3.2 管理 RVM 和 Ruby

• 系统级 RVM: 可以安装和管理系统级的 RVM。
• 用户级 RVM: 可以为特定用户安装和管理 RVM。
• Ruby 管理: 可以管理已安装的 Ruby 版本。

4. 项目 API 使用文档

4.1 RVM 资源

• rvm_install: 安装 RVM。
• rvm_ruby: 安装和管理 Ruby 版本。
• rvm_gemset: 管理 RVM 中的 gemset。

4.2 示例

rvm_install 'install rvm' do
  user 'username'
  version 'latest'
end

rvm_ruby 'install ruby' do
  version '2.7.2'
  user 'username'
end

rvm_gemset 'create gemset' do
  ruby_string '2.7.2@mygemset'
  user 'username'
end

5. 贡献与测试

5.1 贡献

请参阅 CONTRIBUTING.md 文件了解如何贡献代码。

5.2 测试

• 确保安装了以下工具：
  • [Vagrant][vagrant]
  • [vagrant-berkshelf][vagrant-berkshelf]
• 运行 bundle install 后，执行 rake 进行单元测试，执行 kitchen test 进行集成测试。

6. 许可证与作者

• 作者: Aaron Kalin ([e-mail])
• 贡献者: 贡献者列表
• 许可证: Apache License, Version 2.0