GoogleContainerTools/skaffold

Document an example on remote modules + local module

Open

#7,392 创建于 2022年5月10日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Go (12,822 star) (1,416 fork)batch import
bugbash/q4-2022help wantedkind/todometa/examples

描述

When talking with @russwolf, I realized we dont have an example demo for an application where there is one remote module along with local module.

e.g.

apiVersion: skaffold/v2beta11
kind: Config
requires:
- git:
    repo: https://github.com/GoogleContainerTools/skaffold
    path: examples/multi-config-microservices/leeroy-app
    ref: main

- path: ./leeroy-web

and

apiVersion: skaffold/v2beta22
kind: Config
metadata:
  name: web-config
requires:
- path: ../base
build:
  artifacts:
  - image: leeroy-web
    requires:
    - image: base
      alias: BASE
deploy:
  kubectl:
    manifests:
    - kubernetes/*
portForward:
- resourceType: deployment
  resourceName: leeroy-web
  port: 8080
  localPort: 9000

It will be cool to demo this set up to your users.

贡献者指南

技术栈
go
领域
documentationdevops
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Skaffold basicsKubernetes concepts
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
The issue provides two YAML configuration snippets: one for a skaffold config that requires a remote module (Git repo) and a local module, and another for a config that uses a local base module. To complete this task, look at existing examples in the repository under the 'examples/' directory, such as 'examples/multi config microservices/leeroy app'. Create a new example or add to existing documentation that demonstrates how to set up a Skaffold project with both remote and local modules. The example should include the provided YAML and explain the structure. Ensure the example is clear and testable.