GoogleContainerTools/skaffold

Document an example on remote modules + local module

Open

#7,392 opened on 2022年5月10日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.