Garden项目CLI工具使用完全指南

Garden项目CLI工具使用完全指南

garden Automation for Kubernetes development and testing. Spin up production-like environments for development, testing, and CI on demand. Use the same configuration and workflows at every step of the process. Speed up your builds and test runs via shared result caching 项目地址: https://gitcode.com/gh_mirrors/ga/garden

前言

Garden是一个现代化的开发工作流工具，它通过统一的命令行接口(CLI)简化了云原生应用的开发、测试和部署流程。本文将深入解析Garden CLI的核心功能和使用技巧，帮助开发者高效利用这一工具提升开发效率。

CLI基础介绍

Garden CLI是开发者与Garden交互的主要方式，无论是本地开发环境还是CI/CD流水线中。它提供了丰富的命令集，每个命令都支持多种选项参数和输出格式。

安装与帮助系统

在开始使用前，请确保已正确安装Garden CLI。安装完成后，可以通过以下命令获取帮助信息：

# 查看所有可用命令
garden --help

# 查看特定命令的详细帮助
garden <command> --help

常用全局选项

所有Garden命令都支持一组通用选项：

• --env：指定目标环境(environment)和命名空间(namespace)，格式为命名空间.环境
• --log-level/-l：设置日志级别，如-l=debug可获取调试日志
• --output/-o：设置输出格式，支持json和yaml两种结构化输出

核心功能详解

部署(Deploy)操作

部署是Garden最常用的功能之一，支持多种部署场景：

# 部署项目中的所有Deploy到默认环境
garden deploy

# 部署到特定环境和命名空间
garden deploy --env my-namespace.dev

# 部署单个服务
garden deploy my-service

# 部署多个指定服务
garden deploy service-a service-b

对于需要快速迭代的场景，可以使用同步模式：

garden deploy my-service --sync=*

测试(Test)操作

Garden提供了便捷的测试执行功能：

# 运行所有测试
garden test

# 运行单个测试并实时查看日志
garden test my-test -i

构建(Build)操作

构建相关命令支持多种构建场景：

# 构建所有组件
garden build

# 强制重新构建所有组件
garden build --force

# 构建单个组件
garden build my-component

运行(Run)操作

执行一次性任务：

garden run my-task

工作流(Workflow)操作

执行预定义的工作流：

garden workflow my-workflow --env=my-namespace.dev

开发辅助功能

日志管理

Garden提供了强大的日志查看功能：

# 查看所有服务的日志
garden logs

# 查看特定服务的日志
garden logs my-service

# 实时跟踪日志
garden logs my-service --follow

交互式开发控制台

Garden的交互式开发控制台大大提升了开发效率：

garden dev

在控制台中，可以执行各种Garden命令，并实时查看结果。

高级功能

项目输出管理

项目输出(Project Outputs)是从项目中提取生成值的便捷方式：

# 打印项目输出
garden get outputs

# 获取JSON格式的输出(适合脚本处理)
garden get outputs --output=json

配置创建

快速创建新项目或组件：

# 创建新项目
garden create project

# 创建新组件(需参考Garden基础指南)

远程源管理

Garden支持连接多个代码仓库，形成统一的项目视图。相关命令可帮助管理这些远程源。

插件系统

Garden的插件系统扩展了其核心功能：

插件命令

每个插件都可能提供特定命令：

# 列出所有可用插件命令
garden plugins

Kubernetes集群初始化

对于远程Kubernetes集群：

garden plugins kubernetes cluster-init --env=dev

Terraform集成

Terraform插件提供了与Terraform栈交互的命令。

插件工具管理

Garden可以管理插件依赖的工具：

# 使用Garden管理的工具
garden tools kubectl -- <args>

# 获取工具路径
garden tools kubectl --get-path

为提高效率，可以创建shell快捷方式：

function gt() {
  garden tools $1 -- "${@:2}"
}

最佳实践与注意事项

1. 避免并行运行dev、build、deploy或test命令，它们可能会相互干扰
2. 对于生产环境，建议使用结构化输出(JSON/YAML)以便于自动化处理
3. 开发阶段可以利用交互式控制台提高效率
4. 使用同步模式可以显著加快开发迭代速度

结语

Garden CLI是一个功能强大且灵活的工具，通过本文的介绍，您应该已经掌握了其核心功能和使用技巧。随着对Garden的深入使用，您会发现它能够显著简化云原生应用的开发流程，提高团队协作效率。

garden Automation for Kubernetes development and testing. Spin up production-like environments for development, testing, and CI on demand. Use the same configuration and workflows at every step of the process. Speed up your builds and test runs via shared result caching 项目地址: https://gitcode.com/gh_mirrors/ga/garden