knife-github-cookbooks 项目教程

knife-github-cookbooks 项目教程

knife-github-cookbooksA knife plugin facilitating installing, updating, and tracking Chef cookbooks found on Github. 项目地址:https://gitcode.com/gh_mirrors/kn/knife-github-cookbooks

1. 项目的目录结构及介绍

knife-github-cookbooks/
├── lib/
│   └── chef/
│       └── knife/
│           ├── cookbook_github_install.rb
│           └── core/
│               └── cookbook_scm_repo_extensions.rb
├── .gitignore
├── LICENSE
├── README.md
└── knife-github-cookbooks.gemspec

• lib/: 包含项目的核心代码。
  • chef/knife/: 包含 knife 插件的主要实现文件。
    • cookbook_github_install.rb: 主要启动文件，负责安装和更新 GitHub 上的 Chef cookbooks。
    • core/cookbook_scm_repo_extensions.rb: 提供与 cookbook 版本控制相关的扩展功能。
• .gitignore: 指定不需要跟踪的文件和目录。
• LICENSE: 项目的许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目说明文档。
• knife-github-cookbooks.gemspec: 项目的 gem 规范文件，定义了项目的依赖和元数据。

2. 项目的启动文件介绍

lib/chef/knife/cookbook_github_install.rb 是项目的启动文件，负责处理从 GitHub 安装和更新 Chef cookbooks 的逻辑。以下是该文件的关键部分：

require 'chef/knife'
require 'tempfile'

class Chef
  class Knife
    class CookbookGithubInstall < Knife
      deps do
        require 'chef/mixin/shell_out'
        require 'chef/knife/core/cookbook_scm_repo'
        require File.join(File.dirname(__FILE__), 'core', 'cookbook_scm_repo_extensions')
      end

      banner "knife cookbook github install USER/REPO [USER/REPO/BRANCH] (options)"

      # 其他代码...
    end
  end
end

• require 'chef/knife': 引入 Chef 的 knife 模块。
• require 'tempfile': 引入临时文件处理模块。
• CookbookGithubInstall: 定义了一个继承自 Knife 的类，用于处理 GitHub cookbook 的安装。
• deps do: 定义了该类依赖的其他模块和文件。
• banner: 定义了命令行使用说明。

3. 项目的配置文件介绍

项目中没有显式的配置文件，但可以通过命令行选项进行配置。例如，安装私有仓库时可以使用 -S 选项：

knife cookbook github install my_stealthy_startup/secret_sauce -S

此外，项目的依赖和元数据在 knife-github-cookbooks.gemspec 文件中定义：

Gem::Specification.new do |s|
  s.name        = 'knife-github-cookbooks'
  s.version     = '0.1.8'
  s.summary     = "Github Cookbook installation support for Chef's Knife Command"
  s.description = "A knife plugin facilitating installing, updating and tracking Chef cookbooks found on Github"
  s.authors     = ["Jesse Newland"]
  s.email       = 'jesse@websterclay.com'
  s.files       = `git ls-files`.split("\n")
  s.homepage    = 'https://github.com/websterclay/knife-github-cookbooks'
  s.license     = 'Apache-2.0'
  s.add_runtime_dependency 'chef', '>= 0'
  s.add_runtime_dependency 'launchy', '~> 0.4.0'
end

• s.name: 项目的名称。
• s.version: 项目的版本。
• s.summary: 项目的简要描述。
• s.description: 项目的详细描述。
• s.authors: 项目的作者。
• s.email: 作者的联系邮箱。
• s.files: 项目文件列表。
• s.homepage: 项目的主页。
• s.license: 项目的许可证。
• s.add_runtime_dependency: 定义项目的运行时依赖。

knife-github-cookbooksA knife plugin facilitating installing, updating, and tracking Chef cookbooks found on Github. 项目地址:https://gitcode.com/gh_mirrors/kn/knife-github-cookbooks