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.
Document an example on remote modules + local module · GoogleContainerTools/skaffold#7392 | Good First Issue